Data Model Libraries
    Preparing search index...

    Class Bundle

    Bundle Class

    A container for a collection of resources.

    FHIR Specification

    • Short: Contains a collection of resources
    • Definition: A container for a collection of resources.
    • FHIR Version: 5.0.0

    FHIR Bundle

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? bundleTypeEnum type_ timestamp? total? link? entry? signature? issues?

    Methods

    parse getIdentifier setIdentifier hasIdentifier getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getTimestampElement setTimestampElement hasTimestampElement getTimestamp setTimestamp hasTimestamp getTotalElement setTotalElement hasTotalElement getTotal setTotal hasTotal getLink setLink addLink hasLink getEntry setEntry addEntry hasEntry getSignature setSignature hasSignature getIssues setIssues hasIssues fhirType isEmpty isRequiredFieldsEmpty copy toJSON resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initLink initEntry

    Constructors

    Properties

    identifier?: Identifier

    Bundle.identifier Element

    FHIR Specification

    • Short: Persistent identifier for the bundle
    • Definition: A persistent identifier for the bundle that won't change as a bundle is copied from server to server.
    • Comment: Persistent identity generally only matters for batches of type Document, Message, and Collection. It would not normally be populated for search and history results and servers ignore Bundle.identifier when processing batches and transactions. For Documents the .identifier SHALL be populated such that the .identifier is globally unique.
    • FHIR Type: Identifier
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    bundleTypeEnum: BundleTypeEnum

    FHIR CodeSystem: BundleType

    BundleTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    Bundle.type Element

    FHIR Specification

    • Short: document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
    • Definition: Indicates the purpose of this bundle - how it is intended to be used.
    • Comment: It's possible to use a bundle for other purposes (e.g. a document can be accepted as a transaction). This is primarily defined so that there can be specific rules for some of the bundle types.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: BundleTypeEnum

    timestamp?: InstantType

    Bundle.timestamp Element

    FHIR Specification

    • Short: When the bundle was assembled
    • Definition: The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.
    • Comment: For many bundles, the timestamp is equal to .meta.lastUpdated, because they are not stored (e.g. search results). When a bundle is placed in a persistent store, .meta.lastUpdated will be usually be changed by the server. When the bundle is a message, a middleware agent altering the message (even if not stored) SHOULD update .meta.lastUpdated. .timestamp is used to track the original time of the Bundle, and SHOULD be populated. Usage: * document : the date the document was created. Note: the composition may predate the document, or be associated with multiple documents. The date of the composition - the authoring time - may be earlier than the document assembly time * message : the date that the content of the message was assembled. This date is not changed by middleware engines unless they add additional data that changes the meaning of the time of the message * history : the date that the history was assembled. This time would be used as the _since time to ask for subsequent updates * searchset : the time that the search set was assembled. Note that different pages MAY have different timestamps but need not. Having different timestamps does not imply that subsequent pages will represent or include changes made since the initial query * transaction | transaction-response | batch | batch-response | collection : no particular assigned meaning The timestamp value should be greater than the lastUpdated and other timestamps in the resources in the bundle, and it should be equal or earlier than the .meta.lastUpdated on the Bundle itself.
    • FHIR Type: instant
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    total?: UnsignedIntType

    Bundle.total Element

    FHIR Specification

    • Short: If search, the total number of matches
    • Definition: If a set of search matches, this is the (potentially estimated) total number of entries of type 'match' across all pages in the search. It does not include search.mode = 'include' or 'outcome' entries and it does not provide a count of the number of entries in the Bundle.
    • Comment: Only used if the bundle is a search result set. The total does not include resources such as OperationOutcome and included resources, only the total number of matching resources.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    link?: BundleLinkComponent[]

    Bundle.link Element

    FHIR Specification

    • Short: Links related to this Bundle
    • Definition: A series of links that provide context to this bundle.
    • Comment: Both Bundle.link and Bundle.entry.link are defined to support providing additional context when Bundles are used (e.g. HATEOAS). Bundle.entry.link corresponds to links found in the HTTP header if the resource in the entry was read directly. This specification defines some specific uses of Bundle.link for searching and paging, but no specific uses for Bundle.entry.link, and no defined function in a transaction - the meaning is implementation specific. The behavior of navigation link types (next/prev/first/last) are well defined for searchset and history Bundles but are not currently defined for other types. Implementers who choose to use such link relationships for other bundle types will need to negotiate behavior with their interoperability partners.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Private Optionalentry

    entry?: BundleEntryComponent[]

    Bundle.entry Element

    FHIR Specification

    • Short: Entry in the bundle - will have a resource or information
    • Definition: An entry in a bundle resource - will either contain a resource or information about a resource (transactions and history only).
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    signature?: Signature

    Bundle.signature Element

    FHIR Specification

    • Short: Digital Signature
    • Definition: Digital Signature - base64 encoded. XML-DSig or a JWS.
    • Comment: The signature could be created by the "author" of the bundle or by the originating device. Requirements around inclusion of a signature, verification of signatures and treatment of signed/non-signed bundles is implementation-environment specific.
    • Requirements: A Signature holds an electronic representation of a signature and its supporting context in a FHIR accessible form. The signature may either be a cryptographic type (XML DigSig or a JWS), which is able to provide non-repudiation proof, or it may be a graphical image that represents a signature or a signature process. This element allows capturing signatures on documents, messages, transactions or even search responses, to support content-authentication, non-repudiation or other business cases. This is primarily relevant where the bundle may travel through multiple hops or via other mechanisms where HTTPS non-repudiation is insufficient.
    • FHIR Type: Signature
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    issues?: IResource

    Bundle.issues Element

    FHIR Specification

    • Short: Issues with the Bundle
    • Definition: Captures issues and warnings that relate to the construction of the Bundle and the content within it.
    • Comment: Usage notes: These issues and warnings must apply to the Bundle as a whole, not to individual entries.Messages relating to the processing of individual entries (e.g. in a batch or transaction) SHALL be reported in the entry.response.outcome for that entry. If there are errors that arise in the creation of the Bundle, then that should be handled by an OperationOutcome being returned instead of the Bundle.
    • FHIR Type: Resource
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided Bundle JSON to instantiate the Bundle data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Bundle

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Bundle

      Returns undefined | Bundle

      Bundle data model or undefined for Bundle

      JsonError if the provided JSON is not a valid JSON object

    • Returns string

      the FHIR resource type as defined by the FHIR specification

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Returns undefined | string

      the implicitRules property value as a primitive value

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the system property exists and has a value; false otherwise

    • Assigns the provided PrimitiveType value to the language property.

      Parameters

      • element: undefined | CodeType

        the language value

      Returns this

      this

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive boolean datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive string-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive number-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive bigint-based datatype; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datetime-based datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetIdentifiersetIdentifierhasIdentifiergetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetTimestampElementsetTimestampElementhasTimestampElementgetTimestampsetTimestamphasTimestampgetTotalElementsetTotalElementhasTotalElementgetTotalsetTotalhasTotalgetLinksetLinkaddLinkhasLinkgetEntrysetEntryaddEntryhasEntrygetSignaturesetSignaturehasSignaturegetIssuessetIssueshasIssuesfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitLinkinitEntry