3.38 StructureDefinition: Shared Health Bundle
The official URL for this profile is:
http://sharedhealth.exchange/fhir/StructureDefinition/profile-bundle
3.38.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Bundle | 0..* | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. | |
 id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT™ system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT™ system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
 meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
 profile | 1..* | uri | Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. |
 system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
 code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Bundle | S | 0..* | ||
| id | S | 0..1 | id | |
| meta | S | 1..1 | Meta | |
| profile | S | 1..* | uri | |
 tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Contains a collection of resources | |
 id | SΣ | 0..1 | id | Logical id of this artifact |
 meta | SΣ | 1..1 | Meta | Metadata about the resource |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) |
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | 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 | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | Σ | 0..* | Unknown reference to #Bundle.link 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 | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | id | 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) |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | 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) |
| 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 | ΣI | 0..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | 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 |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Grid View
This structure is derived from Bundle
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Bundle | 0..* | bdl-2: entry.search only when a search bdl-1: total only when a search or history bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId bdl-3: entry.request only for some types of bundles bdl-4: entry.response only for some types of bundles Definition: A container for a collection of resources. | |
| id | 0..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This value is assigned by the PrescribeIT™ system upon receipt of a bundle and returned synchronously in the response to that bundle. This ID should not be confused with the traceID that is also returned in the response and is generally used when diagnosing message failures within the PrescribeIT™ system logs. The Bundle.id is also used by receiving systems to remove the bundle from their inbox after they have successfully retrieved the bundle. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
| profile | 1..* | uri | Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
| tag | 1..* | Coding | Slice: Unordered, Open by value:system Binding: (unbound) (example) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
| tag (version) | 1..1 | Coding | Binding: SharedSpecificationVersion (required) Definition: Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. Comments: Usage Note: This the version of the specification the Bundle claims to be conformant with. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
This structure is derived from Bundle
Summary
Mandatory: 6 elements
Must-Support: 7 elements
Fixed Value: 1 element
Slices
This structure defines the following Slices:
- The element Bundle.meta.tag is sliced based on the value of value:system
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | S | 0..* | ||
| id | S | 0..1 | id | |
| meta | S | 1..1 | Meta | |
| profile | S | 1..* | uri | |
| tag | S | Coding | Slice: Unordered, Open by value:system | |
| tag | S | 1..1 | Coding | Binding: SharedSpecificationVersion (required) |
| system | S | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| code | S | 1..1 | code | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Bundle | SΣI | 0..* | Contains a collection of resources | |
| id | SΣ | 0..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | SΣ | Coding | Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example) | |
| tag | SΣ | 1..1 | Coding | Tags applied to this resource Binding: SharedSpecificationVersion (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required) | |
| type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required) |
| total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
| link | Σ | 0..* | BackboneElement | Links related to this Bundle |
| id | 0..1 | id | 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 | http://www.iana.org/assignments/link-relations/link-relations.xhtml |
| url | Σ | 1..1 | uri | Reference details for the link |
| entry | ΣI | 0..* | BackboneElement | Entry in the bundle - will have a resource, or information bdl-5: must be a resource unless there's a request or response bdl-6: The fullUrl element must be present when a resource is present, and not present otherwise |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| link | Σ | 0..* | Unknown reference to #Bundle.link 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 | ΣI | 0..1 | BackboneElement | Search related information |
| id | 0..1 | id | 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) |
| score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
| request | ΣI | 0..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | 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) |
| 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 | ΣI | 0..1 | BackboneElement | Transaction Related Information |
| id | 0..1 | id | 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 |
| signature | Σ | 0..1 | Signature | Digital Signature |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.38.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Bundle.meta.security | All Security Labels | extensible | All Security Labels |
| Bundle.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Bundle.meta.tag | SharedSpecificationVersion | required | SharedSpecificationVersion |
| Bundle.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Bundle.type | BundleType | required | BundleType |
| Bundle.entry.search.mode | SearchEntryMode | required | SearchEntryMode |
| Bundle.entry.request.method | HTTPVerb | required | HTTPVerb |
3.38.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
| bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
| bdl-7 | 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-3 | Bundle | entry.request only for some types of bundles : entry.request.empty() or type = 'batch' or type = 'transaction' or type = 'history' | |
| bdl-4 | Bundle | entry.response only for some types of bundles : entry.response.empty() or type = 'batch-response' or type = 'transaction-response' | |
| bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
| bdl-6 | Bundle.entry | The fullUrl element must be present when a resource is present, and not present otherwise : fullUrl.empty() xor resource.exists() |