Extensions for Using Data Elements from FHIR STU3 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_Bundle_R4B

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Bundle Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_Bundle_R4B

This cross-version profile allows STU3 Bundle content to be represented via FHIR R4B Bundle resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(4.3.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1 error Bundle.implicitRules, Bundle.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle(4.3.0) Contains a collection of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.meta
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.identifier
... signature
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:signature 0..1 Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(4.3.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource Σ 0..1 Resource A resource in the bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
..... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... ifNoneMatch Σ 0..1 string For managing cache currency
..... ifModifiedSince Σ 0..1 instant For managing cache currency
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
..... location Σ 0..1 uri The location (if the operation returns a location)
..... etag Σ 0..1 string The Etag for the resource (if relevant)
..... lastModified Σ 0..1 instant Server's date time modified
..... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:signature 0..1 Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.signature
Constraints: ext-1
.... type Σ 1..* Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred)
.... when Σ 1..1 instant When the signature was created
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data 0..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Bundle.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Bundle.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Bundle.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Bundle.type Base required BundleType 📍4.3.0 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.3.0 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.3.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.3.0 FHIR Std.
Bundle.signature.targetFormat Base required MimeType 📍4.3.0 FHIR Std.
Bundle.signature.sigFormat Base required MimeType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1 error Bundle.meta, Bundle.meta.extension, Bundle.meta.extension:meta, Bundle.meta.versionId, Bundle.meta.lastUpdated, Bundle.meta.source, Bundle.meta.profile, Bundle.meta.security, Bundle.meta.tag, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.identifier.extension, Bundle.identifier.extension:identifier, Bundle.identifier.use, Bundle.identifier.type, Bundle.identifier.system, Bundle.identifier.value, Bundle.identifier.period, Bundle.identifier.assigner, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.signature, Bundle.signature.extension, Bundle.signature.extension:signature, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.onBehalfOf, Bundle.signature.targetFormat, Bundle.signature.sigFormat, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.meta.extension, Bundle.meta.extension:meta, Bundle.identifier.extension, Bundle.identifier.extension:identifier, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.signature.extension, Bundle.signature.extension:signature Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(4.3.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1 error Bundle.implicitRules, Bundle.type All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle(4.3.0) Contains a collection of resources
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.meta
... identifier
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.identifier
... signature
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:signature 0..1 Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.signature

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle(4.3.0) Contains a collection of resources
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..1 Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
... timestamp Σ 0..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... entry ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... resource Σ 0..1 Resource A resource in the bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... mode Σ 0..1 code match | include | outcome - why this is in the result set
Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... method Σ 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.
..... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... ifNoneMatch Σ 0..1 string For managing cache currency
..... ifModifiedSince Σ 0..1 instant For managing cache currency
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... status Σ 1..1 string Status response code (text optional)
..... location Σ 0..1 uri The location (if the operation returns a location)
..... etag Σ 0..1 string The Etag for the resource (if relevant)
..... lastModified Σ 0..1 instant Server's date time modified
..... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:signature 0..1 Signature STU3: signature additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Bundle.signature
Constraints: ext-1
.... type Σ 1..* Coding Indication of the reason the entity signed the object(s)
Binding: SignatureTypeCodes (preferred)
.... when Σ 1..1 instant When the signature was created
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
.... data 0..1 base64Binary The actual signature content (XML DigSig. JWS, picture, etc.)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Bundle.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Bundle.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Bundle.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Bundle.identifier.type Base extensible IdentifierType 📍4.3.0 FHIR Std.
Bundle.type Base required BundleType 📍4.3.0 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.3.0 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.3.0 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.3.0 FHIR Std.
Bundle.signature.targetFormat Base required MimeType 📍4.3.0 FHIR Std.
Bundle.signature.sigFormat Base required MimeType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference fullUrl.exists() implies fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
ele-1 error Bundle.meta, Bundle.meta.extension, Bundle.meta.extension:meta, Bundle.meta.versionId, Bundle.meta.lastUpdated, Bundle.meta.source, Bundle.meta.profile, Bundle.meta.security, Bundle.meta.tag, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.identifier.extension, Bundle.identifier.extension:identifier, Bundle.identifier.use, Bundle.identifier.type, Bundle.identifier.system, Bundle.identifier.value, Bundle.identifier.period, Bundle.identifier.assigner, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.signature, Bundle.signature.extension, Bundle.signature.extension:signature, Bundle.signature.type, Bundle.signature.when, Bundle.signature.who, Bundle.signature.onBehalfOf, Bundle.signature.targetFormat, Bundle.signature.sigFormat, Bundle.signature.data All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Bundle.meta.extension, Bundle.meta.extension:meta, Bundle.identifier.extension, Bundle.identifier.extension:identifier, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.signature.extension, Bundle.signature.extension:signature Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron