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

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

Resource Profile: Profile_R4_Bundle_R3

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

This cross-version profile allows R4 Bundle content to be represented via FHIR STU3 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 Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2
... 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 was intended to be used.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍3.0.2 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 only for some types of bundles entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4 error Bundle entry.response only for some types of bundles entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId entry.where(fullUrl).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())

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
​... Slices for extension 0..* Slice: Unordered, Open by value:url
​.... extension:timestamp 0..1 instant R4: When the bundle was assembled (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Bundle.timestamp
... entry
.... request
..... method
​...... Slices for extension 0..* Slice: Unordered, Open by value:url
​....... extension:method 0..1 code R4: GET | HEAD | POST | PUT | DELETE | PATCH
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Bundle.entry.request.method
Binding: R4HttpVerbForR3 (0.1.0) (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... 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 was intended to be used.
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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-8, bdl-5
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri Absolute URL for resource (server address, or UUID/OID)
.... resource Σ 0..1 Resource A resource in the bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Transaction Related Information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... method Σ 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb . (required): HTTP verbs (in the HTTP command line).
..... 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 update contention
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Transaction Related Information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Bundle.type Base required BundleType 📍3.0.2 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb . 📍3.0.2 tx.fhir.org

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 only for some types of bundles entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4 error Bundle entry.response only for some types of bundles entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
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 entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference 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())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2
... 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 was intended to be used.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍3.0.2 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 only for some types of bundles entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4 error Bundle entry.response only for some types of bundles entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId entry.where(fullUrl).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())

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle 0..* Bundle Contains a collection of resources
​... Slices for extension 0..* Slice: Unordered, Open by value:url
​.... extension:timestamp 0..1 instant R4: When the bundle was assembled (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Bundle.timestamp
... entry
.... request
..... method
​...... Slices for extension 0..* Slice: Unordered, Open by value:url
​....... extension:method 0..1 code R4: GET | HEAD | POST | PUT | DELETE | PATCH
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-Bundle.entry.request.method
Binding: R4HttpVerbForR3 (0.1.0) (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Contains a collection of resources
Constraints: bdl-7, bdl-9, bdl-3, bdl-4, bdl-1, bdl-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 0..1 Identifier Persistent identifier for the bundle
... 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 was intended to be used.
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... 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-8, bdl-5
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... link Σ 0..* See link (Bundle) Links related to this entry
.... fullUrl Σ 0..1 uri Absolute URL for resource (server address, or UUID/OID)
.... resource Σ 0..1 Resource A resource in the bundle
.... search ΣC 0..1 BackboneElement Search related information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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.
..... score Σ 0..1 decimal Search ranking (between 0 and 1)
.... request ΣC 0..1 BackboneElement Transaction Related Information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... method Σ 1..1 code GET | POST | PUT | DELETE
Binding: HTTPVerb . (required): HTTP verbs (in the HTTP command line).
..... 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 update contention
..... ifMatch Σ 0..1 string For managing update contention
..... ifNoneExist Σ 0..1 string For conditional creates
.... response ΣC 0..1 BackboneElement Transaction Related Information
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base extensible Common Languages 📍3.0.2 FHIR Std.
Bundle.type Base required BundleType 📍3.0.2 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍3.0.2 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb . 📍3.0.2 tx.fhir.org

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 only for some types of bundles entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history'
bdl-4 error Bundle entry.response only for some types of bundles entry.response.empty() or type = 'batch-response' or type = 'transaction-response'
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 entry.where(fullUrl).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry fullUrl cannot be a version specific reference 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())
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())

 

Other representations of profile: CSV, Excel, Schematron