SMART Health Cards: Vaccination & Testing Implementation Guide
1.0.0 - STU1 Release International flag

SMART Health Cards: Vaccination & Testing Implementation Guide, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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: Vaccination Bundle - Data Minimization

Official URL: http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-bundle-dm Version: 1.0.0
Draft as of 2023-12-27 Computable Name: SHCVaccinationBundleDM

Defines a primary (DM) profile representing a bundle of patient and vaccination data for health cards.

See here for implementation details.

Start here!
Profile Group: Bundles

Description:

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

Primary profile (DM) Fallback profile (AD) Scope of profile pair
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.

Usage:

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

Formal Views of Profile Content

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

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... id C0..0
... meta 0..0
... implicitRules 0..0
... identifier 0..0
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: collection
... timestamp 0..0
... total 0..0
... link 0..0
... 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..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl S1..1uriLocally unique identifier like resource:0
..... resource S0..1ResourceA resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:patient S1..1BackboneElementPatient
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl SC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:immunization S1..*BackboneElementImmunization
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl SC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information
..... search 0..0
..... request 0..0
..... response 0..0
... signature 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... 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.


Fixed Value: collection
... Slices for entry SΣC2..*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 SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
.... entry:patient SΣC1..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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:immunization SΣC1..*BackboneElementImmunization
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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: collection
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:immunization.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:patient.resource, Bundle.entry:immunization.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-4errorBundle.entry:patient.resource, Bundle.entry:immunization.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-5errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:patient.resource, Bundle.entry:immunization.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... 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.


Fixed Value: collection
... Slices for entry SΣC2..*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 SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
.... entry:patient SΣC1..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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:immunization SΣC1..*BackboneElementImmunization
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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: collection
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:patient.search.moderequiredSearchEntryMode
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:immunization.search.moderequiredSearchEntryMode
Bundle.entry:immunization.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:patient.resource, Bundle.entry:immunization.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-4errorBundle.entry:patient.resource, Bundle.entry:immunization.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-5errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:patient.resource, Bundle.entry:immunization.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 1 element
Prohibited: 30 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 C0..0
... meta 0..0
... implicitRules 0..0
... identifier 0..0
... type S1..1codedocument | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: collection
... timestamp 0..0
... total 0..0
... link 0..0
... 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..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl S1..1uriLocally unique identifier like resource:0
..... resource S0..1ResourceA resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:patient S1..1BackboneElementPatient
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl SC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:immunization S1..*BackboneElementImmunization
..... id 0..0
..... extension 0..0
..... modifierExtension 0..0
..... link 0..0
..... fullUrl SC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information
..... search 0..0
..... request 0..0
..... response 0..0
... signature 0..0

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... 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.


Fixed Value: collection
... Slices for entry SΣC2..*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 SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
.... entry:patient SΣC1..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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:immunization SΣC1..*BackboneElementImmunization
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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: collection
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:immunization.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:patient.resource, Bundle.entry:immunization.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-4errorBundle.entry:patient.resource, Bundle.entry:immunization.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-5errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:patient.resource, Bundle.entry:immunization.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... 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.


Fixed Value: collection
... Slices for entry SΣC2..*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 SΣ1..1uriLocally unique identifier like resource:0
..... resource SΣ0..1ResourceA resource in the bundle
.... entry:patient SΣC1..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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCPatientGeneralDMInformation about an individual receiving an individual receiving a vaccination or infectious disease-related laboratory test
.... entry:immunization SΣC1..*BackboneElementImmunization
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 SΣC1..1uriLocally unique identifier like resource:0
vc-shall-be-resource-uri: IDs SHALL use resource:# format
..... resource 1..1SHCVaccinationDMImmunization event information

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredFixed Value: collection
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:patient.search.moderequiredSearchEntryMode
Bundle.entry:patient.request.methodrequiredHTTPVerb
Bundle.entry:immunization.search.moderequiredSearchEntryMode
Bundle.entry:immunization.request.methodrequiredHTTPVerb

Constraints

IdGradePath(s)DetailsRequirements
bdl-1errorBundletotal only when a search or history
: total.empty() or (type = 'searchset') or (type = 'history')
bdl-2errorBundleentry.search only when a search
: entry.search.empty() or (type = 'searchset')
bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
: entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationmust be a resource unless there's a request or response
: resource.exists() or request.exists() or response.exists()
bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:patient, Bundle.entry:immunizationfullUrl cannot be a version specific reference
: fullUrl.contains('/_history/').not()
bdl-9errorBundleA document must have an identifier with a system and a value
: type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10errorBundleA document must have a date
: type = 'document' implies (timestamp.hasValue())
bdl-11errorBundleA document must have a Composition as the first resource
: type = 'document' implies entry.first().resource.is(Composition)
bdl-12errorBundleA message must have a MessageHeader as the first resource
: type = 'message' implies entry.first().resource.is(MessageHeader)
dom-2errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:patient.resource, Bundle.entry:immunization.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-4errorBundle.entry:patient.resource, Bundle.entry:immunization.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-5errorBundle.entry:patient.resource, Bundle.entry:immunization.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:patient.resource, Bundle.entry:immunization.resourceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vc-shall-be-resource-urierrorBundle.entry:patient.fullUrl, Bundle.entry:immunization.fullUrlIDs SHALL use resource:# format
: $this.matches('^resource:[0-9]+$')

This structure is derived from Bundle

Summary

Mandatory: 7 elements
Must-Support: 8 elements
Fixed Value: 1 element
Prohibited: 30 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)

 

Other representations of profile: CSV, Excel, Schematron