1.0.0 - release
            
          
CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.cambio.se/StructureDefinition/BundleNews2/v1 | Version: 1.0.0 | |||
| Active as of 2021-01-27 | Computable Name: BundleNews2 | |||
The BundleNews2 profile may be used as a container for sending a NEWS2 and the vital signs used to calculate the NEWS2 to COSMIC. The bundle should contain all vital sign profiles used for calculating a NEWS2 and an observation profile for the NEWS2. The BundleNews2 profile is created from the Bundle resource in FHIR R4 edition.
If the NEWS2 observation is sent in a Bundle where all resources related to the NEWS2 observation are included, the Mediator construct an observation with resources from the bundle as contained resources. When the Observation has been resolved, the Mediator calls the Clinical care module (CCM) to create the NEWS2 score in COSMIC. In COSMIC CCM, the related vital sign resources are used to calculate a NEWS2 total score. If no NEWS2 total score is included in the observation the calculated score is saved on the contact. If the NEWS2 observation includes a NEWS2 total score, this score is validated with the use of the calculated score. If they do not match, an error is sent back to the sending system.
When a NEWS2 observation is created, the internal id of this observation (COSMIC care entry) is included in the content-location header in the response from Mediator.
| Type | Description | 
|---|---|
| Rule | For creating a NEWS2 the external user must not be the patient. E.g. A healthcare professional is the intended user to create a NEWS2 with this API. | 
| COS version | Profile version | Required COSMIC version | Date | Description | 
|---|---|---|---|---|
| 3.0.0 | 1.0.0 | R8.3.05 | June 2021 | Initial version, support for PUT. | 
| HTTP Method | Description | 
|---|---|
| PUT | Create and update the NEWS2 score | 
PUT [baseURL]/subscription/Bundle/external-ID (create/update)Specific error messages for Bundle are listed below.
| Code | Description | Comment | 
|---|---|---|
| 400 | Bundle entries may only contain Observations | The NEWS2 bundle may only contain resources of type Observation | 
| 400 | NEWS2 Observation must contain references to observations in the bundle | The NEWS2 Observation may only contain references to observations that exist in the NEWS2 bundle | 
| 400 | NEWS2 Observation can only contain references to the following observations: ACVPU, Blood pressure, Body temperature, Heart rate, Oxygen saturation, Respiratory rate | The News2 observation may only contain references to one of each of the stated observations | 
| 400 | News2 observation must be included. | The NEWS2 bundle must contain a NEWS2 Observation | 
| 400 | NEWS2 total score is invalid | The NEWS2 score provided in the request does not match with the value calculated by COSMIC | 
| 400 | The Snomed Code for […] could not be translated | There is no mapping between the entered SNOMED code and the corresponding OpenEHR code on the FHIR server | 
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | 
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Σ | 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. Fixed Value: collection  | 
![]() ![]()  | 
ΣC | 7..7 | 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  | 
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Bundle.type | required | Fixed Value: collectionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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.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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Bundle | Contains a collection of resources | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection  | |
![]() ![]()  | 
7..7 | BackboneElement | Entry in the bundle - will have a resource or information | |
  Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]()  | 
Σ | 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. Fixed Value: collection  | ||||
![]() ![]()  | 
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]()  | 
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]()  | 
ΣC | 7..7 | 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  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]()  | 
Σ | 0..1 | Signature | Digital Signature | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.type | required | Fixed Value: collectionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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.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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | 
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | 
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
Σ | 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. Fixed Value: collection  | 
![]() ![]()  | 
ΣC | 7..7 | 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  | 
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Bundle.type | required | Fixed Value: collectionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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.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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
0..* | Bundle | Contains a collection of resources | |
![]() ![]()  | 
||||
![]() ![]() ![]()  | 
S | 0..1 | uri | Identifies where the resource comes from | 
![]() ![]() ![]()  | 
1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | |
![]() ![]()  | 
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection  | |
![]() ![]()  | 
7..7 | BackboneElement | Entry in the bundle - will have a resource or information | |
  Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]()  | 
SΣ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.  | ||||
![]() ![]() ![]()  | 
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".  | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]()  | 
Σ | 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. Fixed Value: collection  | ||||
![]() ![]()  | 
Σ | 0..1 | instant | When the bundle was assembled | ||||
![]() ![]()  | 
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]()  | 
ΣC | 7..7 | 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  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Search related information | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 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.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing cache currency | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | For managing cache currency | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For managing update contention | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | For conditional creates | ||||
![]() ![]() ![]()  | 
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | Status response code (text optional) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | instant | Server's date time modified | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
![]() ![]()  | 
Σ | 0..1 | Signature | Digital Signature | ||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Bundle.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labelsFrom the FHIR Standard  | ||||
| Bundle.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsFrom the FHIR Standard  | ||||
| Bundle.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Bundle.type | required | Fixed Value: collectionhttp://hl7.org/fhir/ValueSet/bundle-type|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1From the FHIR Standard  | ||||
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| 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.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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | 
This structure is derived from Bundle
Other representations of profile: CSV, Excel, Schematron