Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide
1.0.0-ballot - CI Build
Order Catalog Implementation Guide, published by HL7 International / Orders and Observations. This guide is not an authorized publication; it is the continuous build for version 1.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/fhir-order-catalog/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/ItemTransactionRequest | Version: 1.0.0-ballot | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: ItemTransactionRequest | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.999.42.13 | ||||
This profile constrains the Bundle resource to convey a transaction request creating/updating/deleting/patching items and/or supporting resources in a catalog.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Bundle |
0..* | Bundle | Contains a collection of resources | |
  type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: transaction | |
 entry |
1..* | BackboneElement | Entry in the bundle - will have a resource and a request | |
 fullUrl |
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource |
1..1 | Resource | A resource in the bundle | |
| search |
0..0 | |||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
 response |
0..0 | |||
| 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 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| type |
ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction |
  entry |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
ΣC | 1..1 | Resource | A resource in the bundle |
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method |
ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Fixed Value: transactionhttp://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 |
| 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 | 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 | 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() |
| 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 |
ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction | ||||
| timestamp |
ΣC | 0..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 | ||||
| entry |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
ΣC | 1..1 | Resource | A resource in the bundle | ||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache validation | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| 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 | Fixed Value: transactionhttp://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 |
| 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 | 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 | 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 | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Fixed Value: transaction | |
| entry |
1..* | BackboneElement | Entry in the bundle - will have a resource and a request | |
| fullUrl |
1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | |
| resource |
1..1 | Resource | A resource in the bundle | |
| search |
0..0 | |||
| request |
1..1 | BackboneElement | Additional execution information (transaction/batch/history) | |
| response |
0..0 | |||
| Documentation for this format | ||||
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 |
| type |
ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction |
| entry |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) |
| resource |
ΣC | 1..1 | Resource | A resource in the bundle |
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| method |
ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
| issues |
ΣC | 0..1 | OperationOutcome | Issues with the Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Bundle.type | required | Fixed Value: transactionhttp://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 |
| 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 | 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 | 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() |
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 |
ΣC | 0..1 | Identifier | Persistent identifier for the bundle | ||||
| type |
ΣC | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: transaction | ||||
| timestamp |
ΣC | 0..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 | ||||
| entry |
ΣC | 1..* | BackboneElement | Entry in the bundle - will have a resource and a request 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 |
ΣC | 1..1 | uri | URI for resource (e.g. the absolute URL server address, URI for UUID/OID, etc.) | ||||
| resource |
ΣC | 1..1 | Resource | A resource in the bundle | ||||
| request |
ΣC | 1..1 | BackboneElement | Additional execution information (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
ΣC | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. | ||||
| url |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry | ||||
| ifNoneMatch |
Σ | 0..1 | string | For managing cache validation | ||||
| ifModifiedSince |
Σ | 0..1 | instant | For managing cache currency | ||||
| ifMatch |
Σ | 0..1 | string | For managing update contention | ||||
| ifNoneExist |
Σ | 0..1 | string | For conditional creates | ||||
| 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 | Fixed Value: transactionhttp://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 |
| 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 | 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 | 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() |
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 International / Orders and Observations. Package hl7.fhir.uv.order-catalog#1.0.0-ballot based on FHIR 5.0.0. Generated 2025-06-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change