CMS ACCESS Model API
0.9.8 - draft
US
This page is part of the ACCESS Model IG v0.9.8 DRAFT (v0.9.8: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: https://dsacms.github.io/cmmi-access-model/StructureDefinition/access-data-reporting-bundle | Version: 0.9.8 | ||||
| Draft as of 2026-05-20 | Computable Name: ACCESSDataReportingBundle | ||||
The ACCESS Data Reporting Bundle Profile defines the structure for packaging clinical data submissions. It is a document-type Bundle that SHALL contain a Patient resource and an ACCESS Data Reporting Composition resource.
The ACCESS Data Reporting Bundle Profile defines the structure for packaging clinical data submissions. It is a document-type Bundle that SHALL contain a Patient resource and an ACCESS Data Reporting Composition resource.
documentpatient entry (1..1): References a US Core Patient resourceaccess-data-reporting-composition entry (1..1): References an ACCESS Data Reporting CompositionAll resources referenced in the Composition SHALL be included in the Bundle.
For examples and submission workflows, see the Data Reporting API section in the Operations Manual.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, access-data-reporting-bundle-composition-refs-in-bundle |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
Σ | 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: document |
![]() ![]() |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
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. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
| 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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)
|
| ele-1 | error | Bundle.implicitRules, Bundle.language, Bundle.type, Bundle.entry, Bundle.entry.modifierExtension, Bundle.entry:patient, Bundle.entry:patient.modifierExtension, Bundle.entry:access-data-reporting-composition, Bundle.entry:access-data-reporting-composition.modifierExtension | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Bundle.entry.modifierExtension, Bundle.entry:patient.modifierExtension, Bundle.entry:access-data-reporting-composition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: document | |
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, access-data-reporting-bundle-composition-refs-in-bundle |
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() |
Σ | 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: document |
![]() ![]() |
Σ | 0..1 | instant | When the bundle was assembled |
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches |
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link |
![]() ![]() |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() |
Σ | 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. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:access-data-reporting-composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:access-data-reporting-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
| 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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)
|
| ele-1 | error | Bundle.meta, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.entry:patient, Bundle.entry:patient.extension, Bundle.entry:patient.modifierExtension, Bundle.entry:patient.link, Bundle.entry:patient.fullUrl, Bundle.entry:patient.search, Bundle.entry:patient.search.extension, Bundle.entry:patient.search.modifierExtension, Bundle.entry:patient.search.mode, Bundle.entry:patient.search.score, Bundle.entry:patient.request, Bundle.entry:patient.request.extension, Bundle.entry:patient.request.modifierExtension, Bundle.entry:patient.request.method, Bundle.entry:patient.request.url, Bundle.entry:patient.request.ifNoneMatch, Bundle.entry:patient.request.ifModifiedSince, Bundle.entry:patient.request.ifMatch, Bundle.entry:patient.request.ifNoneExist, Bundle.entry:patient.response, Bundle.entry:patient.response.extension, Bundle.entry:patient.response.modifierExtension, Bundle.entry:patient.response.status, Bundle.entry:patient.response.location, Bundle.entry:patient.response.etag, Bundle.entry:patient.response.lastModified, Bundle.entry:access-data-reporting-composition, Bundle.entry:access-data-reporting-composition.extension, Bundle.entry:access-data-reporting-composition.modifierExtension, Bundle.entry:access-data-reporting-composition.link, Bundle.entry:access-data-reporting-composition.fullUrl, Bundle.entry:access-data-reporting-composition.search, Bundle.entry:access-data-reporting-composition.search.extension, Bundle.entry:access-data-reporting-composition.search.modifierExtension, Bundle.entry:access-data-reporting-composition.search.mode, Bundle.entry:access-data-reporting-composition.search.score, Bundle.entry:access-data-reporting-composition.request, Bundle.entry:access-data-reporting-composition.request.extension, Bundle.entry:access-data-reporting-composition.request.modifierExtension, Bundle.entry:access-data-reporting-composition.request.method, Bundle.entry:access-data-reporting-composition.request.url, Bundle.entry:access-data-reporting-composition.request.ifNoneMatch, Bundle.entry:access-data-reporting-composition.request.ifModifiedSince, Bundle.entry:access-data-reporting-composition.request.ifMatch, Bundle.entry:access-data-reporting-composition.request.ifNoneExist, Bundle.entry:access-data-reporting-composition.response, Bundle.entry:access-data-reporting-composition.response.extension, Bundle.entry:access-data-reporting-composition.response.modifierExtension, Bundle.entry:access-data-reporting-composition.response.status, Bundle.entry:access-data-reporting-composition.response.location, Bundle.entry:access-data-reporting-composition.response.etag, Bundle.entry:access-data-reporting-composition.response.lastModified, Bundle.signature | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry:patient.extension, Bundle.entry:patient.modifierExtension, Bundle.entry:patient.search.extension, Bundle.entry:patient.search.modifierExtension, Bundle.entry:patient.request.extension, Bundle.entry:patient.request.modifierExtension, Bundle.entry:patient.response.extension, Bundle.entry:patient.response.modifierExtension, Bundle.entry:access-data-reporting-composition.extension, Bundle.entry:access-data-reporting-composition.modifierExtension, Bundle.entry:access-data-reporting-composition.search.extension, Bundle.entry:access-data-reporting-composition.search.modifierExtension, Bundle.entry:access-data-reporting-composition.request.extension, Bundle.entry:access-data-reporting-composition.request.modifierExtension, Bundle.entry:access-data-reporting-composition.response.extension, Bundle.entry:access-data-reporting-composition.response.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, access-data-reporting-bundle-composition-refs-in-bundle |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
Σ | 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: document |
![]() ![]() |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
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. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
| 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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)
|
| ele-1 | error | Bundle.implicitRules, Bundle.language, Bundle.type, Bundle.entry, Bundle.entry.modifierExtension, Bundle.entry:patient, Bundle.entry:patient.modifierExtension, Bundle.entry:access-data-reporting-composition, Bundle.entry:access-data-reporting-composition.modifierExtension | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Bundle.entry.modifierExtension, Bundle.entry:patient.modifierExtension, Bundle.entry:access-data-reporting-composition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Required Pattern: document | |
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | Bundle(4.0.1) | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, access-data-reporting-bundle-composition-refs-in-bundle |
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact |
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) | |
![]() ![]() |
Σ | 0..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() |
Σ | 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: document |
![]() ![]() |
Σ | 0..1 | instant | When the bundle was assembled |
![]() ![]() |
ΣC | 0..1 | unsignedInt | If search, the total number of matches |
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle |
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link |
![]() ![]() |
ΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | A resource in the bundle |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | USCorePatientProfile(6.1.0) | Information about an individual or animal receiving health care services |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry |
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
![]() ![]() ![]() ![]() |
S | 1..1 | ACCESSDataReportingComposition(0.9.8) | A set of resources composed into a single coherent clinical statement with clinical attestation |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Search related information |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Additional execution information (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | GET | HEAD | POST | PUT | DELETE | PATCH Binding: HTTPVerb (required): HTTP verbs (in the HTTP command line). See HTTP rfc for details. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | URL for HTTP equivalent of this entry |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | For managing cache currency |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For managing update contention |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | For conditional creates |
![]() ![]() ![]() ![]() |
ΣC | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Status response code (text optional) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The location (if the operation returns a location) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | The Etag for the resource (if relevant) |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | instant | Server's date time modified |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
![]() ![]() |
Σ | 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. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:access-data-reporting-composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:access-data-reporting-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| access-data-reporting-bundle-composition-refs-in-bundle | error | Bundle | All resources referenced from the data reporting Composition must be included in the enclosing data reporting Bundle. |
entry.resource.ofType(Composition).descendants().ofType(Reference).all(resolve() in %resource.entry.resource)
|
| 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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, Bundle.entry:patient, Bundle.entry:access-data-reporting-composition | 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)
|
| ele-1 | error | Bundle.meta, Bundle.implicitRules, Bundle.language, Bundle.identifier, Bundle.type, Bundle.timestamp, Bundle.total, Bundle.link, Bundle.link.extension, Bundle.link.modifierExtension, Bundle.link.relation, Bundle.link.url, Bundle.entry, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.link, Bundle.entry.fullUrl, Bundle.entry.search, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.search.mode, Bundle.entry.search.score, Bundle.entry.request, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.request.method, Bundle.entry.request.url, Bundle.entry.request.ifNoneMatch, Bundle.entry.request.ifModifiedSince, Bundle.entry.request.ifMatch, Bundle.entry.request.ifNoneExist, Bundle.entry.response, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry.response.status, Bundle.entry.response.location, Bundle.entry.response.etag, Bundle.entry.response.lastModified, Bundle.entry:patient, Bundle.entry:patient.extension, Bundle.entry:patient.modifierExtension, Bundle.entry:patient.link, Bundle.entry:patient.fullUrl, Bundle.entry:patient.search, Bundle.entry:patient.search.extension, Bundle.entry:patient.search.modifierExtension, Bundle.entry:patient.search.mode, Bundle.entry:patient.search.score, Bundle.entry:patient.request, Bundle.entry:patient.request.extension, Bundle.entry:patient.request.modifierExtension, Bundle.entry:patient.request.method, Bundle.entry:patient.request.url, Bundle.entry:patient.request.ifNoneMatch, Bundle.entry:patient.request.ifModifiedSince, Bundle.entry:patient.request.ifMatch, Bundle.entry:patient.request.ifNoneExist, Bundle.entry:patient.response, Bundle.entry:patient.response.extension, Bundle.entry:patient.response.modifierExtension, Bundle.entry:patient.response.status, Bundle.entry:patient.response.location, Bundle.entry:patient.response.etag, Bundle.entry:patient.response.lastModified, Bundle.entry:access-data-reporting-composition, Bundle.entry:access-data-reporting-composition.extension, Bundle.entry:access-data-reporting-composition.modifierExtension, Bundle.entry:access-data-reporting-composition.link, Bundle.entry:access-data-reporting-composition.fullUrl, Bundle.entry:access-data-reporting-composition.search, Bundle.entry:access-data-reporting-composition.search.extension, Bundle.entry:access-data-reporting-composition.search.modifierExtension, Bundle.entry:access-data-reporting-composition.search.mode, Bundle.entry:access-data-reporting-composition.search.score, Bundle.entry:access-data-reporting-composition.request, Bundle.entry:access-data-reporting-composition.request.extension, Bundle.entry:access-data-reporting-composition.request.modifierExtension, Bundle.entry:access-data-reporting-composition.request.method, Bundle.entry:access-data-reporting-composition.request.url, Bundle.entry:access-data-reporting-composition.request.ifNoneMatch, Bundle.entry:access-data-reporting-composition.request.ifModifiedSince, Bundle.entry:access-data-reporting-composition.request.ifMatch, Bundle.entry:access-data-reporting-composition.request.ifNoneExist, Bundle.entry:access-data-reporting-composition.response, Bundle.entry:access-data-reporting-composition.response.extension, Bundle.entry:access-data-reporting-composition.response.modifierExtension, Bundle.entry:access-data-reporting-composition.response.status, Bundle.entry:access-data-reporting-composition.response.location, Bundle.entry:access-data-reporting-composition.response.etag, Bundle.entry:access-data-reporting-composition.response.lastModified, Bundle.signature | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Bundle.link.extension, Bundle.link.modifierExtension, Bundle.entry.extension, Bundle.entry.modifierExtension, Bundle.entry.search.extension, Bundle.entry.search.modifierExtension, Bundle.entry.request.extension, Bundle.entry.request.modifierExtension, Bundle.entry.response.extension, Bundle.entry.response.modifierExtension, Bundle.entry:patient.extension, Bundle.entry:patient.modifierExtension, Bundle.entry:patient.search.extension, Bundle.entry:patient.search.modifierExtension, Bundle.entry:patient.request.extension, Bundle.entry:patient.request.modifierExtension, Bundle.entry:patient.response.extension, Bundle.entry:patient.response.modifierExtension, Bundle.entry:access-data-reporting-composition.extension, Bundle.entry:access-data-reporting-composition.modifierExtension, Bundle.entry:access-data-reporting-composition.search.extension, Bundle.entry:access-data-reporting-composition.search.modifierExtension, Bundle.entry:access-data-reporting-composition.request.extension, Bundle.entry:access-data-reporting-composition.request.modifierExtension, Bundle.entry:access-data-reporting-composition.response.extension, Bundle.entry:access-data-reporting-composition.response.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 4 elements
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron