Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot
Canonical Resource Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishable-bundle | Version: 2.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: CRMIPublishableBundle | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.83 | ||||
A publishable bundle is a Bundle resource that represents a collection of FHIR resources that can be published as a cohesive unit.
The bundle must be of type 'transaction' and must contain an ImplementationGuide resource as the first entry. This ensures that the bundle represents a complete, publishable package with proper metadata and resource organization defined by the implementation guide.
This profile supports the distribution and management of knowledge artifacts as atomic units, enabling consistent publication and deployment of related clinical decision support resources, quality measures, and other healthcare knowledge content.
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-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-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&resource.meta.versionId).isDistinct()
|
| 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)
|
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist |
 type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction | |
 entry |
||||
 request |
1..1 | BackboneElement | Transaction request for each bundle entry | |
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction | ||||
| timestamp |
Σ | 0..1 | instant | When the bundle was assembled | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
 link |
Σ | 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 |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| entry |
Σ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 |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
Σ | 0..1 | Resource | A resource in the bundle | ||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request |
ΣC | 1..1 | BackboneElement | Transaction request for each bundle entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry | 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&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference |
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)
|
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
| 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()
|
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-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-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&resource.meta.versionId).isDistinct()
|
| 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)
|
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: transaction | |
| entry |
||||
| request |
1..1 | BackboneElement | Transaction request for each bundle entry | |
| method |
1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Required Pattern: POST | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, crmi-bundle-first-entry-ig, crmi-bundle-canonical-ifnoneexist | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| identifier |
Σ | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Required Pattern: transaction | ||||
| timestamp |
Σ | 0..1 | instant | When the bundle was assembled | ||||
| total |
ΣC | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
Σ | 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 |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
| url |
Σ | 1..1 | uri | Reference details for the link | ||||
| entry |
Σ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 |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
| resource |
Σ | 0..1 | Resource | A resource in the bundle | ||||
| search |
ΣC | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| mode |
Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | ||||
| score |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) | ||||
| request |
ΣC | 1..1 | BackboneElement | Transaction request for each bundle entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. Required Pattern: POST | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache currency | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| response |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status |
Σ | 1..1 | string | Status response code (text optional) | ||||
| location |
Σ | 0..1 | uri | The location (if the operation returns a location) | ||||
| etag |
Σ | 0..1 | string | The Etag for the resource (if relevant) | ||||
| lastModified |
Σ | 0..1 | instant | Server's date time modified | ||||
| outcome |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | ||||
| signature |
Σ | 0..1 | Signature | Digital Signature | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry | 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&resource.meta.versionId).isDistinct()
|
| bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference |
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)
|
| crmi-bundle-canonical-ifnoneexist | error | Bundle | For canonical resources, Bundle.entry.request must have ifNoneExist parameter based on url and version |
entry.where( resource.is(ActivityDefinition) or resource.is(CapabilityStatement) or resource.is(ChargeItemDefinition) or resource.is(CodeSystem) or resource.is(CompartmentDefinition) or resource.is(ConceptMap) or resource.is(EventDefinition) or resource.is(Evidence) or resource.is(EvidenceVariable) or resource.is(ExampleScenario) or resource.is(GraphDefinition) or resource.is(ImplementationGuide) or resource.is(Library) or resource.is(Measure) or resource.is(MessageDefinition) or resource.is(NamingSystem) or resource.is(OperationDefinition) or resource.is(PlanDefinition) or resource.is(Questionnaire) or resource.is(ResearchDefinition) or resource.is(ResearchElementDefinition) or resource.is(RiskEvidenceSynthesis) or resource.is(SearchParameter) or resource.is(StructureDefinition) or resource.is(StructureMap) or resource.is(TerminologyCapabilities) or resource.is(TestScript) or resource.is(ValueSet)).all( request.ifNoneExist.exists() and request.ifNoneExist.contains('url=') and request.ifNoneExist.contains('version='))
|
| crmi-bundle-first-entry-ig | error | Bundle | The first entry in a PublishableBundle must be an ImplementationGuide resource |
entry.first().resource.is(ImplementationGuide)
|
| 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()
|
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / Clinical Decision Support. Package hl7.fhir.uv.crmi#2.0.0-ballot based on FHIR 4.0.1. Generated 2025-10-06
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change