SMART Health Cards: Vaccination & Testing Implementation Guide
0.6.2 - STU 1 (Ballot Version)

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 0.6.2). This version is based on the current content of https://github.com/HL7/fhir-shc-vaccination-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Infectious Disease (Generic) Laboratory Test Results Bundle - Allowable Data

Defining URL:http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-infectious-disease-laboratory-bundle-ad
Version:0.6.2
Name:SHCInfectiousDiseaseLaboratoryBundleAD
Title:Infectious Disease (Generic) Laboratory Test Results Bundle - Allowable Data
Status:Active as of 2021-08-11T19:30:57+00:00
Definition:

The bundle of resources that represents the patient identification and clinical content of a SMART Health Card with lab results.

Publisher:HL7 International - Public Health Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-infectious-disease-laboratory-bundle-ad
Bundles: Profile Group Navigation

Defines the contents of the `fhirBundle` element in a SMART Health Card for a given use case.

Primary profile (DM) Fallback Profiles (AD) Scope
Immunization Bundle Fallback Immunization for any infectious disease
COVID-19 Labs Bundle Fallback Lab results for COVID-19 only
Generic Labs Bundle Fallback Lab results for any infections disease
For more information about the types of profiles in this IG, see the profiles page.

Note! This is a fallback “allowable data” (AD) profile. Implementers should validate against the primary “data minimization” (DM) profile if possible.

Formal Views of Profile Content

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

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource (Closed)

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... id I0..1stringShould be omitted
vc-should-be-omitted: SHOULD be omitted for data minimization.
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: collection
... Slices for entry S2..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringShould not be populated
..... fullUrl S1..1uriLocally unique identifier like resource:0
..... resource S0..1ResourceA resource in the bundle
.... entry:patient S1..1BackboneElementPatient
..... fullUrl SI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralADInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:labResult SI1..*BackboneElementLaboratory result
vc-bundle-lab-status-complete: Bundle SHALL only include results with status final or status that is subsequent to final.
..... fullUrl SI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCInfectiousDiseaseLaboratoryResultObservationADMeasurements and simple assertions

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id ΣI0..1stringShould be omitted
vc-should-be-omitted: SHOULD be omitted for data minimization.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | 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.


Required Pattern: collection
... timestamp Σ0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣI2..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringShould not be populated
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣI1..1BackboneElementPatient
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralADInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:labResult SΣI1..*BackboneElementLaboratory result
vc-bundle-lab-status-complete: Bundle SHALL only include results with status final or status that is subsequent to final.
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource I1..1SHCInfectiousDiseaseLaboratoryResultObservationADMeasurements and simple assertions
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... type Σ1..1codedocument | 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.


Required Pattern: collection
... Slices for entry ΣI2..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
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
.... entry:All Slices Content/Rules for all slices
..... fullUrl Σ1..1uriLocally unique identifier like resource:0
..... resource Σ0..1ResourceA resource in the bundle
.... entry:patient ΣI1..1BackboneElementPatient
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
..... fullUrl ΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
.... entry:labResult ΣI1..*BackboneElementLaboratory result
vc-bundle-lab-status-complete: Bundle SHALL only include results with status final or status that is subsequent to final.
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
..... fullUrl ΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format

doco Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Bundle.entry is sliced based on the value of type:resource (Closed)

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... id I0..1stringShould be omitted
vc-should-be-omitted: SHOULD be omitted for data minimization.
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Required Pattern: collection
... Slices for entry S2..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringShould not be populated
..... fullUrl S1..1uriLocally unique identifier like resource:0
..... resource S0..1ResourceA resource in the bundle
.... entry:patient S1..1BackboneElementPatient
..... fullUrl SI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralADInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:labResult SI1..*BackboneElementLaboratory result
vc-bundle-lab-status-complete: Bundle SHALL only include results with status final or status that is subsequent to final.
..... fullUrl SI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCInfectiousDiseaseLaboratoryResultObservationADMeasurements and simple assertions

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle I0..*BundleContains a collection of resources
... id ΣI0..1stringShould be omitted
vc-should-be-omitted: SHOULD be omitted for data minimization.
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier Σ0..1IdentifierPersistent identifier for the bundle
... type SΣ1..1codedocument | 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.


Required Pattern: collection
... timestamp Σ0..1instantWhen the bundle was assembled
... total ΣI0..1unsignedIntIf search, the total number of matches
... link Σ0..*BackboneElementLinks related to this Bundle
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... relation Σ1..1stringSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ1..1uriReference details for the link
... Slices for entry SΣI2..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Closed by type:resource
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
.... entry:All Slices Content/Rules for all slices
..... id 0..1stringShould not be populated
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:patient SΣI1..1BackboneElementPatient
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralADInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
.... entry:labResult SΣI1..*BackboneElementLaboratory result
vc-bundle-lab-status-complete: Bundle SHALL only include results with status final or status that is subsequent to final.
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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... link Σ0..*See link (Bundle)Links related to this entry
..... fullUrl SΣI1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource I1..1SHCInfectiousDiseaseLaboratoryResultObservationADMeasurements and simple assertions
..... search ΣI0..1BackboneElementSearch related information
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... mode Σ0..1codematch | 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..1decimalSearch ranking (between 0 and 1)
..... request ΣI0..1BackboneElementAdditional execution information (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method Σ1..1codeGET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ1..1uriURL for HTTP equivalent of this entry
...... ifNoneMatch Σ0..1stringFor managing cache currency
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣI0..1BackboneElementResults of execution (transaction/batch/history)
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
...... location Σ0..1uriThe location (if the operation returns a location)
...... etag Σ0..1stringThe Etag for the resource (if relevant)
...... lastModified Σ0..1instantServer's date time modified
...... outcome Σ0..1ResourceOperationOutcome with hints and warnings (for batch/transaction)
... signature Σ0..1SignatureDigital Signature

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagepreferredCommonLanguages
Max Binding: AllLanguages
Bundle.typerequiredPattern: collection
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:patient.search.moderequiredSearchEntryMode
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:labResult.search.moderequiredSearchEntryMode
Bundle.entry:labResult.request.methodrequiredHTTPVerb

Constraints

IdPathDetailsRequirements
bdl-1Bundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2Bundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3Bundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4Bundleentry.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-7BundleFullUrl 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-9BundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10BundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11BundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12BundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
vc-should-be-omittedBundle.idSHOULD be omitted for data minimization.
: $this.length() = 0
ele-1Bundle.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.timestampAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.totalAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.link.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.link.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.link.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.link.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.link.relationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.link.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5Bundle.entrymust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8Bundle.entryfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1Bundle.entryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5Bundle.entry:patientmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8Bundle.entry:patientfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1Bundle.entry:patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-shall-be-resource-uriBundle.entry:patient.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')
dom-2Bundle.entry:patient.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3Bundle.entry:patient.resourceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4Bundle.entry:patient.resourceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5Bundle.entry:patient.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Bundle.entry:patient.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1Bundle.entry:patient.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:patient.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:patient.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:patient.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
bdl-5Bundle.entry:labResultmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-8Bundle.entry:labResultfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
ele-1Bundle.entry:labResultAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-bundle-lab-status-completeBundle.entry:labResultBundle SHALL only include results with status final or status that is subsequent to final.
: $this.resource.ofType(Observation).status.lower() in ('final'|'amended'|'corrected')
ele-1Bundle.entry:labResult.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.linkAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.fullUrlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vc-shall-be-resource-uriBundle.entry:labResult.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')
dom-2Bundle.entry:labResult.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3Bundle.entry:labResult.resourceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4Bundle.entry:labResult.resourceIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5Bundle.entry:labResult.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6Bundle.entry:labResult.resourceA resource should have narrative for robust management
: text.`div`.exists()
obs-6Bundle.entry:labResult.resourcedataAbsentReason SHALL only be present if Observation.value[x] is not present
: dataAbsentReason.empty() or value.empty()
obs-7Bundle.entry:labResult.resourceIf Observation.code is the same as an Observation.component.code then the value element associated with the code SHALL NOT be present
: value.empty() or component.code.where(coding.intersect(%resource.code.coding).exists()).empty()
ele-1Bundle.entry:labResult.searchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.search.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.search.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.search.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.search.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.search.modeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.search.scoreAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.requestAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.request.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.request.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.request.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.request.methodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.ifNoneMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.ifModifiedSinceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.ifMatchAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.request.ifNoneExistAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.responseAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.response.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.response.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.response.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Bundle.entry:labResult.response.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Bundle.entry:labResult.response.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.response.locationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.response.etagAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.entry:labResult.response.lastModifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Bundle.signatureAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())