Global Core Electronic Medicinal Product Information (ePI), published by HL7 International - Biomedical Research & Regulation Work Group. This guide is not an authorized publication; it is the continuous build for version 1.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/emedicinal-product-info/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/Bundle-uv-epi | Version: 1.1.0 | |||
Standards status: Trial-use | Maturity Level: 2 | Computable Name: BundleUvEpi |
Medicinal product information is a pivotal source of regulated and scientifically validated information that assists healthcare professionals in prescribing and dispensing the medicine and informs consumers about its safe and effective use. This profile represents the constraints applied to the Bundle resource used in the Electronic Product Information (ePI) FHIR Implementation Guide.
This profile represents the constraints applied to the Bundle resource used to create an Electronic Product Information (ePI) document.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-epi-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() |
Σ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. Fixed Value: document |
![]() ![]() ![]() |
ΣC | 1..1 | instant | Persistent original date of approval |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | BackboneElement | ePI Composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Organization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Regulated Authorization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Medicinal Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Packaged Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Administrable Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Manufactured Item Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Ingredient Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | ClinicalUseDefinition | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Substance Definition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Binary Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Binary | A resource in the bundle |
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature. |
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | 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 : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.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-17 | error | Bundle | Use 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-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For 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-3b | error | Bundle | For 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-3c | error | Bundle | For 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-3d | error | Bundle | For 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()) | |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-epi-1 |
![]() ![]() ![]() |
1..1 | Identifier | Persistent identifier for the bundle | |
![]() ![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: document | |
![]() ![]() ![]() |
1..1 | instant | Persistent original date of approval | |
![]() ![]() ![]() |
1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Resource | A resource in the bundle | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | ePI Composition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Organization | |
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Regulated Authorization | |
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Medicinal Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Packaged Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Administrable Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Manufactured Item | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Ingredient | |
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ClinicalUseDefinition | A resource in the bundle | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Substance Definition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Binary | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Binary | A resource in the bundle | |
![]() ![]() ![]() |
0..1 | Signature | Digital Signature. | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-epi-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
Σ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. Fixed Value: document | ||||
![]() ![]() ![]() |
ΣC | 1..1 | instant | Persistent original date of approval | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | BackboneElement | ePI Composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Organization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Regulated Authorization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Medicinal Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Packaged Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Administrable Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Manufactured Item Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Ingredient Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | ClinicalUseDefinition | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Substance Definition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Binary Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Binary | A resource in the bundle | ||||
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 From the FHIR Standard | |
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | 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 : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.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-17 | error | Bundle | Use 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-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For 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-3b | error | Bundle | For 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-3c | error | Bundle | For 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-3d | error | Bundle | For 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()) | |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 5 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-epi-1 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() |
Σ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. Fixed Value: document |
![]() ![]() ![]() |
ΣC | 1..1 | instant | Persistent original date of approval |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 1..1 | BackboneElement | ePI Composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Organization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Regulated Authorization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Medicinal Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Packaged Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Administrable Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Manufactured Item Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Ingredient Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | ClinicalUseDefinition | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Substance Definition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Binary Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Binary | A resource in the bundle |
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature. |
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | 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 : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.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-17 | error | Bundle | Use 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-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For 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-3b | error | Bundle | For 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-3c | error | Bundle | For 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-3d | error | Bundle | For 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()) | |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-epi-1 |
![]() ![]() ![]() |
1..1 | Identifier | Persistent identifier for the bundle | |
![]() ![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: document | |
![]() ![]() ![]() |
1..1 | instant | Persistent original date of approval | |
![]() ![]() ![]() |
1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource | |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Resource | A resource in the bundle | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
1..1 | BackboneElement | ePI Composition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Organization | |
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Regulated Authorization | |
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Medicinal Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Packaged Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Administrable Product | |
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Manufactured Item | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Ingredient | |
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications | |
![]() ![]() ![]() ![]() ![]() |
1..1 | ClinicalUseDefinition | A resource in the bundle | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Substance Definition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Binary | |
![]() ![]() ![]() ![]() ![]() |
1..1 | Binary | A resource in the bundle | |
![]() ![]() ![]() |
0..1 | Signature | Digital Signature. | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Bundle | Electronic Product Information Bundle Document Constraints: bdl-1, bdl-2, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-13, bdl-14, bdl-15, bdl-16, bdl-17, bdl-18, bdl-3a, bdl-3b, bdl-3c, bdl-3d, bdl-epi-1 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
ΣC | 1..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
Σ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. Fixed Value: document | ||||
![]() ![]() ![]() |
ΣC | 1..1 | instant | Persistent original date of approval | ||||
![]() ![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | code | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 Binding: LinkRelationTypes (required) | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | Reference details for the link | ||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Entry resource in the ePI bundle Slice: Unordered, Open by type:$this.resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | BackboneElement | ePI Composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | CompositionUvEpi | A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Organization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | OrganizationUvEpi | A grouping of people or organizations with a common purpose | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Regulated Authorization Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | RegulatedAuthorizationUvEpi | Regulatory approval, clearance or licencing related to a regulated product, treatment, facility or activity e.g. Market Authorization for a Medicinal Product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Medicinal Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | MedicinalProductDefinitionUvEpi | Detailed definition of a medicinal product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Packaged Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | PackagedProductDefinitionUvEpi | A medically related item or items, in a container or package | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Administrable Product Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | AdministrableProductDefinitionUvEpi | A medicinal product in the final form, suitable for administration - after any mixing of multiple components | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Manufactured Item Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | ManufacturedItemDefinitionUvEpi | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Ingredient Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | IngredientUvEpi | An ingredient of a manufactured item or pharmaceutical product | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Interactions, Warnings, Indications,Contraindications Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | ClinicalUseDefinition | A resource in the bundle | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Substance Definition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | SubstanceDefinitionUvEpi | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Binary Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 1..1 | Binary | A resource in the bundle | ||||
![]() ![]() ![]() |
Σ | 0..1 | Signature | Digital Signature. | ||||
![]() ![]() ![]() |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
![]() |
Path | Conformance | ValueSet / Code | URI |
Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard | |
Bundle.type | required | Fixed Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0 From the FHIR Standard | |
Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0 From the FHIR Standard | |
Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:organization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:authorization.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:medicinalProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:packagedProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:administrableProduct.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:manufacturedItem.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:clinicalUse.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:substanceDefinition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0 From the FHIR Standard | |
Bundle.entry:binary.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | error | Bundle | entry.search only when a search : (type = 'searchset') or entry.search.empty() | |
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&iif(resource.meta.versionId.exists(), resource.meta.versionId, '')).isDistinct() | |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:organization, Bundle.entry:authorization, Bundle.entry:medicinalProduct, Bundle.entry:packagedProduct, Bundle.entry:administrableProduct, Bundle.entry:manufacturedItem, Bundle.entry:ingredient, Bundle.entry:clinicalUse, Bundle.entry:substanceDefinition, Bundle.entry:binary | fullUrl cannot be a version specific reference : fullUrl.exists() implies fullUrl.contains('/_history/').not() | |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) | |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
bdl-13 | error | Bundle | A subscription-notification must have a SubscriptionStatus as the first resource : type = 'subscription-notification' implies entry.first().resource.is(SubscriptionStatus) | |
bdl-14 | error | Bundle | entry.request.method PATCH not allowed for history : type = 'history' implies entry.request.method != 'PATCH' | |
bdl-15 | error | Bundle | 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 : type='transaction' or type='transaction-response' or type='batch' or type='batch-response' or entry.all(fullUrl.exists() or request.method='POST') | |
bdl-16 | error | Bundle | Issue.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-17 | error | Bundle | Use 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-18 | error | Bundle | Self link is required for searchsets. : type = 'searchset' implies link.where(relation = 'self' and url.exists()).exists() | |
bdl-3a | error | Bundle | For 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-3b | error | Bundle | For 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-3c | error | Bundle | For 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-3d | error | Bundle | For 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()) | |
bdl-epi-1 | error | Bundle | An ePI document must have no additional Composition (including Composition subclass) resources besides the first. : entry.tail().where(resource is Composition).empty() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Bundle
Summary
Mandatory: 5 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron