Pharmaceutical Quality (Industry)
1.0.0-ballot - ballot International flag

This page is part of the Pharmaceutical Quality (Industry) (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions

Resource Profile: Profile: Bundle - Batch Formula

Official URL: http://hl7.org/fhir/uv/pharm-quality/StructureDefinition/Bundle-batch-formula-pq Version: 1.0.0-ballot
Active as of 2023-12-18 Computable Name: BundleBatchFormulaPq

Bundle – Batch Formula PQ

Usage:

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
... identifier S0..1IdentifierPersistent identifier for the bundle
... type S1..1codecollection
Required Pattern: collection
... timestamp S0..1instantWhen the bundle was assembled
.... entry:Product-Identification 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
.... entry:Product-Ingredient 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
.... entry:Component-Substance 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
.... entry:Batch-Lot-Information 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier SΣC0..1IdentifierPersistent identifier for the bundle
... type SΣC1..1codecollection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: collection
... Slices for entry SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open 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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC0..1ResourceA resource in the bundle
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Product-Identification ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Product-Ingredient ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource C0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Component-Substance ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Batch-Lot-Information ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
... issues ΣC0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredPattern: collection
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:Product-Identification.request.methodrequiredHTTPVerb
Bundle.entry:Product-Ingredient.request.methodrequiredHTTPVerb
Bundle.entry:Component-Substance.request.methodrequiredHTTPVerb
Bundle.entry:Batch-Lot-Information.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
: (type = 'searchset') or entry.search.empty()
bdl-5errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-Informationmust 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-InformationfullUrl cannot be a version specific reference
: fullUrl.exists() implies 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)
bdl-13errorBundleA subscription-notification must have a SubscriptionStatus as the first resource
: type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14errorBundleentry.request.method PATCH not allowed for history
: type = 'history' implies entry.request.method != 'PATCH'
bdl-15errorBundleBundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
: type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16errorBundleIssue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
: issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17errorBundleUse and meaning of issues for documents has not been validated because the content will not be rendered in the document.
: type = 'document' implies issues.empty()
bdl-18errorBundleSelf link is required for searchsets.
: type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3aerrorBundleFor collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
: type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3berrorBundleFor collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
: type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3cerrorBundleFor collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
: type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3derrorBundleFor collections of type transaction-response or batch-response, all entries must contain response elements
: type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
dom-2errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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()
ing-1errorBundle.entry:Product-Ingredient.resourceIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier SΣC0..1IdentifierPersistent identifier for the bundle
... type SΣC1..1codecollection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: collection
... timestamp SΣC0..1instantWhen the bundle was assembled
... total ΣC0..1unsignedIntIf search, the total number of matches
... link ΣC0..*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 ΣC1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC1..1uriReference details for the link
... Slices for entry SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open 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..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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC0..1ResourceA resource in the bundle
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Product-Identification ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Product-Ingredient ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource C0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Component-Substance ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Batch-Lot-Information ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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
... issues ΣC0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagerequiredAllLanguages
Bundle.typerequiredPattern: collection
Bundle.link.relationrequiredLinkRelationTypes
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:Product-Identification.search.moderequiredSearchEntryMode
Bundle.entry:Product-Identification.request.methodrequiredHTTPVerb
Bundle.entry:Product-Ingredient.search.moderequiredSearchEntryMode
Bundle.entry:Product-Ingredient.request.methodrequiredHTTPVerb
Bundle.entry:Component-Substance.search.moderequiredSearchEntryMode
Bundle.entry:Component-Substance.request.methodrequiredHTTPVerb
Bundle.entry:Batch-Lot-Information.search.moderequiredSearchEntryMode
Bundle.entry:Batch-Lot-Information.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
: (type = 'searchset') or entry.search.empty()
bdl-5errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-Informationmust 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-InformationfullUrl cannot be a version specific reference
: fullUrl.exists() implies 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)
bdl-13errorBundleA subscription-notification must have a SubscriptionStatus as the first resource
: type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14errorBundleentry.request.method PATCH not allowed for history
: type = 'history' implies entry.request.method != 'PATCH'
bdl-15errorBundleBundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
: type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16errorBundleIssue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
: issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17errorBundleUse and meaning of issues for documents has not been validated because the content will not be rendered in the document.
: type = 'document' implies issues.empty()
bdl-18errorBundleSelf link is required for searchsets.
: type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3aerrorBundleFor collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
: type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3berrorBundleFor collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
: type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3cerrorBundleFor collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
: type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3derrorBundleFor collections of type transaction-response or batch-response, all entries must contain response elements
: type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
dom-2errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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()
ing-1errorBundle.entry:Product-Ingredient.resourceIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..*BundleContains a collection of resources
... identifier S0..1IdentifierPersistent identifier for the bundle
... type S1..1codecollection
Required Pattern: collection
... timestamp S0..1instantWhen the bundle was assembled
.... entry:Product-Identification 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
.... entry:Product-Ingredient 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
.... entry:Component-Substance 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
.... entry:Batch-Lot-Information 0..*BackboneElementEntry in the bundle - will have a resource or information
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier SΣC0..1IdentifierPersistent identifier for the bundle
... type SΣC1..1codecollection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: collection
... Slices for entry SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open 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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC0..1ResourceA resource in the bundle
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Product-Identification ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Product-Ingredient ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource C0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Component-Substance ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
.... entry:Batch-Lot-Information ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... fullUrl ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication
..... request ΣC0..1BackboneElementAdditional execution information (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... method ΣC1..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
..... response ΣC0..1BackboneElementResults of execution (transaction/batch/history)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... status Σ1..1stringStatus response code (text optional)
... issues ΣC0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.typerequiredPattern: collection
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:Product-Identification.request.methodrequiredHTTPVerb
Bundle.entry:Product-Ingredient.request.methodrequiredHTTPVerb
Bundle.entry:Component-Substance.request.methodrequiredHTTPVerb
Bundle.entry:Batch-Lot-Information.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
: (type = 'searchset') or entry.search.empty()
bdl-5errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-Informationmust 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-InformationfullUrl cannot be a version specific reference
: fullUrl.exists() implies 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)
bdl-13errorBundleA subscription-notification must have a SubscriptionStatus as the first resource
: type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14errorBundleentry.request.method PATCH not allowed for history
: type = 'history' implies entry.request.method != 'PATCH'
bdl-15errorBundleBundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
: type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16errorBundleIssue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
: issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17errorBundleUse and meaning of issues for documents has not been validated because the content will not be rendered in the document.
: type = 'document' implies issues.empty()
bdl-18errorBundleSelf link is required for searchsets.
: type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3aerrorBundleFor collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
: type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3berrorBundleFor collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
: type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3cerrorBundleFor collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
: type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3derrorBundleFor collections of type transaction-response or batch-response, all entries must contain response elements
: type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
dom-2errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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()
ing-1errorBundle.entry:Product-Ingredient.resourceIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C0..*BundleContains a collection of resources
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... identifier SΣC0..1IdentifierPersistent identifier for the bundle
... type SΣC1..1codecollection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: collection
... timestamp SΣC0..1instantWhen the bundle was assembled
... total ΣC0..1unsignedIntIf search, the total number of matches
... link ΣC0..*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 ΣC1..1codeSee http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC1..1uriReference details for the link
... Slices for entry SΣC1..*BackboneElementEntry in the bundle - will have a resource or information
Slice: Unordered, Open 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..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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource ΣC0..1ResourceA resource in the bundle
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Product-Identification ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicinalProductDefinitionDrugProductPqDetailed definition of a medicinal product
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Product-Ingredient ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource C0..1IngredientDrugPqAn ingredient of a manufactured item or pharmaceutical product
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Component-Substance ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1SubstanceDefinitionComponentSubstanceDrugPqThe detailed description of a substance, typically at a level beyond what is used for prescribing
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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:Batch-Lot-Information ΣC0..*BackboneElementEntry in the bundle - will have a resource or information
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 ΣC0..1uriURI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1MedicationBatchInformationDrugPqDefinition of a Medication
..... search ΣC0..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 - 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 ΣC0..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 ΣC1..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 validation
...... ifModifiedSince Σ0..1instantFor managing cache currency
...... ifMatch Σ0..1stringFor managing update contention
...... ifNoneExist Σ0..1stringFor conditional creates
..... response ΣC0..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
... issues ΣC0..1OperationOutcomeIssues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Bundle.languagerequiredAllLanguages
Bundle.typerequiredPattern: collection
Bundle.link.relationrequiredLinkRelationTypes
Bundle.entry.search.moderequiredSearchEntryMode
Bundle.entry.request.methodrequiredHTTPVerb
Bundle.entry:Product-Identification.search.moderequiredSearchEntryMode
Bundle.entry:Product-Identification.request.methodrequiredHTTPVerb
Bundle.entry:Product-Ingredient.search.moderequiredSearchEntryMode
Bundle.entry:Product-Ingredient.request.methodrequiredHTTPVerb
Bundle.entry:Component-Substance.search.moderequiredSearchEntryMode
Bundle.entry:Component-Substance.request.methodrequiredHTTPVerb
Bundle.entry:Batch-Lot-Information.search.moderequiredSearchEntryMode
Bundle.entry:Batch-Lot-Information.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
: (type = 'searchset') or entry.search.empty()
bdl-5errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-Informationmust 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&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct()
bdl-8errorBundle.entry, Bundle.entry:Product-Identification, Bundle.entry:Product-Ingredient, Bundle.entry:Component-Substance, Bundle.entry:Batch-Lot-InformationfullUrl cannot be a version specific reference
: fullUrl.exists() implies 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)
bdl-13errorBundleA subscription-notification must have a SubscriptionStatus as the first resource
: type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus)
bdl-14errorBundleentry.request.method PATCH not allowed for history
: type = 'history' implies entry.request.method != 'PATCH'
bdl-15errorBundleBundle resources where type is not transaction, transaction-response, batch, or batch-response or when the request is a POST SHALL have Bundle.entry.fullUrl populated
: type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST')
bdl-16errorBundleIssue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
: issues.exists() implies (issues.issue.severity = 'information' or issues.issue.severity = 'warning')
bdl-17errorBundleUse and meaning of issues for documents has not been validated because the content will not be rendered in the document.
: type = 'document' implies issues.empty()
bdl-18errorBundleSelf link is required for searchsets.
: type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists()
bdl-3aerrorBundleFor collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
: type in ('document' | 'message' | 'searchset' | 'collection') implies entry.all(resource.exists() and request.empty() and response.empty())
bdl-3berrorBundleFor collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
: type = 'history' implies entry.all(request.exists() and response.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3cerrorBundleFor collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
: type in ('transaction' | 'batch') implies entry.all(request.method.exists() and ((request.method in ('POST' | 'PATCH' | 'PUT')) = resource.exists()))
bdl-3derrorBundleFor collections of type transaction-response or batch-response, all entries must contain response elements
: type in ('transaction-response' | 'batch-response') implies entry.all(response.exists())
dom-2errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.resourceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceBundle.entry:Product-Identification.resource, Bundle.entry:Product-Ingredient.resource, Bundle.entry:Component-Substance.resource, Bundle.entry:Batch-Lot-Information.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()
ing-1errorBundle.entry:Product-Ingredient.resourceIf an ingredient is noted as an allergen (allergenicIndicator) then its substance should be a code. If the substance is a SubstanceDefinition, then the allegen information should be documented in that resource
: Ingredient.where(allergenicIndicator=true).count() + Ingredient.substance.code.reference.count() < 2

 

Other representations of profile: CSV, Excel, Schematron