SPL Mapping FHIR R5 Implementation Guide
0.2.8 - Build CI
SPL Mapping FHIR R5 Implementation Guide
0.2.8 - Build CI
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.8 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
| Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/ProductSubmissionBundle | Version: 0.2.8 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: ProductSubmissionBundle | ||
A profile that represents the Bundle that contains the Product Submission document.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Bundle |
C | 0..* | Bundle | Contains a collection of resources 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 |
  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 |
  Slices for entry |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile: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 |
   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 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 |
 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 | 1..1 | ProductSubmissionDocument | A set of resources composed into a single coherent clinical statement with clinical attestation |
| entry:Labeler |
SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedLabeler | A grouping of people or organizations with a common purpose |
| entry:Registrant |
SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose |
| entry:Establishment |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose |
| entry:Product |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product |
| entry:Marketing |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..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ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalPackaging | A medically related item or items, in a container or package |
| entry:Ingredient |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalProductIngredient | An ingredient of a manufactured item or pharmaceutical product |
| entry:Substance |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedIngredientDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing |
 entry:Item |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
 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 | 1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product |
 issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0From the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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()) | |
| 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: |
|---|---|---|---|---|
| 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 |
 Slices for entry |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource | |
| 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 |
1..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 |
1..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 |
1..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 |
1..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 |
1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product | |
| entry:Marketing |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..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 |
1..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 |
1..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 |
1..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 |
1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources 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 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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, Closed by profile: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 | ||||
| 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 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 | ||||
| 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 | 1..1 | ProductSubmissionDocument | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
| entry:Labeler |
SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedLabeler | A grouping of people or organizations with a common purpose | ||||
| entry:Registrant |
SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | ||||
| entry:Establishment |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | ||||
| entry:Product |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product | ||||
| entry:Marketing |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..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ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalPackaging | A medically related item or items, in a container or package | ||||
| entry:Ingredient |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalProductIngredient | An ingredient of a manufactured item or pharmaceutical product | ||||
| entry:Substance |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedIngredientDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | ||||
| entry:Item |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Bundle.type | required | Pattern Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0From the FHIR Standard | |
| Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0From the FHIR Standard | |
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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()) | |
| 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)
Must-Support: 15 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources 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 |
| 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 |
| Slices for entry |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile: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 |
| 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 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 |
| 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 | 1..1 | ProductSubmissionDocument | A set of resources composed into a single coherent clinical statement with clinical attestation |
| entry:Labeler |
SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedLabeler | A grouping of people or organizations with a common purpose |
| entry:Registrant |
SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose |
| entry:Establishment |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose |
| entry:Product |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product |
| entry:Marketing |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..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ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalPackaging | A medically related item or items, in a container or package |
| entry:Ingredient |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedMedicinalProductIngredient | An ingredient of a manufactured item or pharmaceutical product |
| entry:Substance |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedIngredientDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing |
| entry:Item |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 |
| 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 | 1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product |
| issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Pattern Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0From the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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()) | |
| 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: |
|---|---|---|---|---|
| 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 |
| Slices for entry |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Closed by profile:resource | |
| 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 |
1..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 |
1..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 |
1..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 |
1..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 |
1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product | |
| entry:Marketing |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
| resource |
1..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 |
1..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 |
1..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 |
1..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 |
1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources 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 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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, Closed by profile: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 | ||||
| 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 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 | ||||
| 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 | 1..1 | ProductSubmissionDocument | A set of resources composed into a single coherent clinical statement with clinical attestation | ||||
| entry:Labeler |
SΣC | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedLabeler | A grouping of people or organizations with a common purpose | ||||
| entry:Registrant |
SΣC | 0..1 | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedEstablishmentRegistrant | A grouping of people or organizations with a common purpose | ||||
| entry:Establishment |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | IdentifiedEstablishment | A grouping of people or organizations with a common purpose | ||||
| entry:Product |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalProduct | Detailed definition of a medicinal product | ||||
| entry:Marketing |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..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ΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalPackaging | A medically related item or items, in a container or package | ||||
| entry:Ingredient |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedMedicinalProductIngredient | An ingredient of a manufactured item or pharmaceutical product | ||||
| entry:Substance |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedIngredientDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | ||||
| entry:Item |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | ||||
| 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 | 1..1 | SubmittedManufacturedItem | The definition and characteristics of a medicinal manufactured item, such as a tablet or capsule, as contained in a packaged medicinal product | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Bundle.type | required | Pattern Value: documenthttp://hl7.org/fhir/ValueSet/bundle-type|5.0.0From the FHIR Standard | |
| Bundle.link.relation | required | LinkRelationTypeshttp://hl7.org/fhir/ValueSet/iana-link-relations|5.0.0From the FHIR Standard | |
| Bundle.entry.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Composition.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Labeler.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Registrant.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Establishment.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Product.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Marketing.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Packaging.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Ingredient.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Substance.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.search.mode | required | SearchEntryModehttp://hl7.org/fhir/ValueSet/search-entry-mode|5.0.0From the FHIR Standard | |
| Bundle.entry:Item.request.method | required | HTTPVerbhttp://hl7.org/fhir/ValueSet/http-verb|5.0.0From 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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:Labeler, Bundle.entry:Registrant, Bundle.entry:Establishment, Bundle.entry:Product, Bundle.entry:Marketing, Bundle.entry:Packaging, Bundle.entry:Ingredient, Bundle.entry:Substance, Bundle.entry:Item | 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()) | |
| 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)
Must-Support: 15 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.spl#0.2.8 based on FHIR 5.0.0. Generated 2025-07-25
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change