SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI United States of America flag

SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: ProductSubmissionBundle

Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/ProductSubmissionBundle Version: 0.2.1
Standards status: Trial-use Maturity Level: 1 Computable Name: ProductSubmissionBundle

A profile that represents the Bundle that contains the Product Submission document.

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..* Bundle Contains a collection of resources
... identifier S 1..1 Identifier Persistent identifier for the bundle
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: document
... timestamp S 1..1 instant When the bundle was assembled
.... entry:All Slices Content/Rules for all slices
..... fullUrl S 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource S 1..1 Resource A resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:Composition S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
.... entry:Labeler S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
.... entry:Registrant S 0..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
.... entry:Establishment S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
.... entry:Product S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
.... entry:Marketing S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
.... entry:Packaging S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
.... entry:Ingredient S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
.... entry:Substance S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
.... entry:Item S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
bdl-14: entry.request.method PATCH not allowed for history
bdl-15: Bundle 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
bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
bdl-18: Self link is required for searchsets.
bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣC 1..1 Identifier Persistent identifier for the bundle
... type SΣC 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: document
... Slices for entry ΣC 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣC 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource SΣC 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Labeler SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Registrant SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Establishment SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Product SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Marketing SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Packaging SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Ingredient SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Substance SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Item SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
... issues ΣC 0..1 OperationOutcome Issues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: document
http://hl7.org/fhir/ValueSet/bundle-type|5.0.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Product.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Substance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Item.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard

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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Itemmust 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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:ItemfullUrl 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())
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
bdl-14: entry.request.method PATCH not allowed for history
bdl-15: Bundle 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
bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
bdl-18: Self link is required for searchsets.
bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣC 1..1 Identifier Persistent identifier for the bundle
... type SΣC 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: document
... timestamp SΣC 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link ΣC 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation ΣC 1..1 code See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC 1..1 uri Reference details for the link
... Slices for entry ΣC 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣC 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource SΣC 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Labeler SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Registrant SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Establishment SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Product SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Marketing SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Packaging SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Ingredient SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Substance SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Item SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature
... issues ΣC 0..1 OperationOutcome Issues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Bundle.typerequiredPattern: document
http://hl7.org/fhir/ValueSet/bundle-type|5.0.0
from the FHIR Standard
Bundle.link.relationrequiredLinkRelationTypes
http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Composition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Product.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Product.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Substance.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Substance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Item.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Item.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard

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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Itemmust 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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:ItemfullUrl 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())
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()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle 0..* Bundle Contains a collection of resources
... identifier S 1..1 Identifier Persistent identifier for the bundle
... type S 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Required Pattern: document
... timestamp S 1..1 instant When the bundle was assembled
.... entry:All Slices Content/Rules for all slices
..... fullUrl S 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource S 1..1 Resource A resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:Composition S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
.... entry:Labeler S 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
.... entry:Registrant S 0..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
.... entry:Establishment S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
.... entry:Product S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
.... entry:Marketing S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
.... entry:Packaging S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
.... entry:Ingredient S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
.... entry:Substance S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
.... entry:Item S 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
bdl-14: entry.request.method PATCH not allowed for history
bdl-15: Bundle 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
bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
bdl-18: Self link is required for searchsets.
bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣC 1..1 Identifier Persistent identifier for the bundle
... type SΣC 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: document
... Slices for entry ΣC 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl SΣC 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource SΣC 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Labeler SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Registrant SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Establishment SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Product SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Marketing SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Packaging SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Ingredient SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Substance SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
.... entry:Item SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
... issues ΣC 0..1 OperationOutcome Issues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.typerequiredPattern: document
http://hl7.org/fhir/ValueSet/bundle-type|5.0.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Product.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Substance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Item.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard

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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Itemmust 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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:ItemfullUrl 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())
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Bundle C 0..* Bundle Contains a collection of resources
bdl-1: total only when a search or history
bdl-2: entry.search only when a search
bdl-7: FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles)
bdl-9: A document must have an identifier with a system and a value
bdl-10: A document must have a date
bdl-11: A document must have a Composition as the first resource
bdl-12: A message must have a MessageHeader as the first resource
bdl-13: A subscription-notification must have a SubscriptionStatus as the first resource
bdl-14: entry.request.method PATCH not allowed for history
bdl-15: Bundle 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
bdl-16: Issue.severity for all issues within the OperationOutcome must be either 'information' or 'warning'.
bdl-17: Use and meaning of issues for documents has not been validated because the content will not be rendered in the document.
bdl-18: Self link is required for searchsets.
bdl-3a: For collections of type document, message, searchset or collection, all entries must contain resources, and not have request or response elements
bdl-3b: For collections of type history, all entries must contain request or response elements, and resources if the method is POST, PUT or PATCH
bdl-3c: For collections of type transaction or batch, all entries must contain request elements, and resources if the method is POST, PUT or PATCH
bdl-3d: For collections of type transaction-response or batch-response, all entries must contain response elements
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣC 1..1 Identifier Persistent identifier for the bundle
... type SΣC 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.


Required Pattern: document
... timestamp SΣC 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link ΣC 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation ΣC 1..1 code See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
Binding: LinkRelationTypes (required)
.... url ΣC 1..1 uri Reference details for the link
... Slices for entry ΣC 2..* BackboneElement Entry in the bundle - will have a resource or information
Slice: Unordered, Open by profile:resource
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl SΣC 1..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource SΣC 1..1 Resource A resource in the bundle
.... entry:Composition SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 ProductSubmissionDocument A set of resources composed into a single coherent clinical statement with clinical attestation
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Labeler SΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedLabeler A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Registrant SΣC 0..1 BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishmentRegistrant A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Establishment SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 IdentifiedEstablishment A grouping of people or organizations with a common purpose
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Product SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProduct Detailed definition of a medicinal product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Marketing SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductMarketing Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Packaging SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalPackaging A medically related item or items, in a container or package
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Ingredient SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedMedicinalProductIngredient An ingredient of a manufactured item or pharmaceutical product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Substance SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedIngredientDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
.... entry:Item SΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
bdl-5: must be a resource unless there's a request or response
bdl-8: fullUrl cannot be a version specific reference
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..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl ΣC 0..1 uri URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.)
..... resource 0..1 SubmittedManufacturedItem The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product
..... search ΣC 0..1 BackboneElement Search related information
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... mode Σ 0..1 code match | 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..1 decimal Search ranking (between 0 and 1)
..... request ΣC 0..1 BackboneElement Additional execution information (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... method ΣC 1..1 code GET | HEAD | POST | PUT | DELETE | PATCH
Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details.

...... url Σ 1..1 uri URL for HTTP equivalent of this entry
...... ifNoneMatch Σ 0..1 string For managing cache validation
...... ifModifiedSince Σ 0..1 instant For managing cache currency
...... ifMatch Σ 0..1 string For managing update contention
...... ifNoneExist Σ 0..1 string For conditional creates
..... response ΣC 0..1 BackboneElement Results of execution (transaction/batch/history)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... status Σ 1..1 string Status response code (text optional)
...... location Σ 0..1 uri The location (if the operation returns a location)
...... etag Σ 0..1 string The Etag for the resource (if relevant)
...... lastModified Σ 0..1 instant Server's date time modified
...... outcome Σ 0..1 Resource OperationOutcome with hints and warnings (for batch/transaction)
... signature Σ 0..1 Signature Digital Signature
... issues ΣC 0..1 OperationOutcome Issues with the Bundle

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Bundle.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
Bundle.typerequiredPattern: document
http://hl7.org/fhir/ValueSet/bundle-type|5.0.0
from the FHIR Standard
Bundle.link.relationrequiredLinkRelationTypes
http://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0
from the FHIR Standard
Bundle.entry.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Composition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Composition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Labeler.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Registrant.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Establishment.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Product.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Product.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Marketing.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Packaging.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Ingredient.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Substance.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Substance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard
Bundle.entry:Item.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0
from the FHIR Standard
Bundle.entry:Item.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|5.0.0
from the FHIR Standard

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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Itemmust 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:Composition, Bundle.entry:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:ItemfullUrl 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())
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()

 

Other representations of profile: CSV, Excel, Schematron