This page is part of the Da Vinci Risk Adjustment FHIR Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle |
Version: | 0.1.0 |
Name: | RAMeasureReportBundle |
Title: | Risk Adjustment Coding Gap Report Bundle Profile |
Status: | Active as of 10/24/21 |
Definition: | The Risk Adjustment Coding Gap Report Bundle Profile describes a collection bundle returned by the report operation. This bundle is a collection of Risk Adjustment Coding Gap Reports. |
Publisher: | HL7 Clinical Quality Information Work Group |
Copyright: | Used by permission of HL7 International - Clinical Quality Information Work Group, all rights reserved Creative Commons License |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/davinci-ra/StructureDefinition/ra-measurereport-bundle
This profile builds on Bundle.
The following data-elements are mandatory (i.e data MUST be present).
Each must have:
Bundle.type
with a fixed code “collection”Bundle
contains one to many Bundle.entry
Bundle
contains one Bundle.entry
that is a US Core PatientEach should have ([Must Support]):
Bundle.entry
that contains a MeasureReport using the Risk Adjustment Coding Gap Report Profile for a particular Risk Adjustment ModelAdditional Profile specific implementation guidance:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Bundle
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | Bundle | Contains a collection of resources | |
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
Slices for entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
entry:ra_measurereport_entry | S | 0..* | BackboneElement | Risk Adjustment Coding Gap Reports for a patient. The reports contained in a bundle must be for the same patient. |
resource | S | 1..1 | RiskAdjustmentCodingGapReport | A patient's Risk Adjustment Coding Gap Report for a Risk Adjustment Model. |
entry:ra_patient_entry | S | 1..1 | BackboneElement | This is the patient of the Risk Adjustment Coding Gap Report. If the Sever does not have Risk Adjustment Coding Gap Reports for the patient, then then patient resource is returned without the Risk Adjustment MeasureReport entries. |
resource | S | 1..1 | USCorePatientProfile | This is the Patient resource. |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | Σ | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
Slices for entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:All Slices | Content/Rules for all slices | |||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:ra_measurereport_entry | SΣI | 0..* | BackboneElement | Risk Adjustment Coding Gap Reports for a patient. The reports contained in a bundle must be for the same patient. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SI | 1..1 | RiskAdjustmentCodingGapReport | A patient's Risk Adjustment Coding Gap Report for a Risk Adjustment Model. |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:ra_patient_entry | SΣI | 1..1 | BackboneElement | This is the patient of the Risk Adjustment Coding Gap Report. If the Sever does not have Risk Adjustment Coding Gap Reports for the patient, then then patient resource is returned without the Risk Adjustment MeasureReport entries. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | S | 1..1 | USCorePatientProfile | This is the Patient resource. |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | Σ | 0..1 | Signature | Digital Signature |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources |
Slices for entry | ΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:ra_measurereport_entry | ΣI | 0..* | BackboneElement | Risk Adjustment Coding Gap Reports for a patient. The reports contained in a bundle must be for the same patient. 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 |
resource | I | 1..1 | RiskAdjustmentCodingGapReport | A patient's Risk Adjustment Coding Gap Report for a Risk Adjustment Model. |
entry:ra_patient_entry | ΣI | 1..1 | BackboneElement | This is the patient of the Risk Adjustment Coding Gap Report. If the Sever does not have Risk Adjustment Coding Gap Reports for the patient, then then patient resource is returned without the Risk Adjustment MeasureReport entries. 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 |
resource | 1..1 | USCorePatientProfile | This is the Patient resource. | |
Documentation for this format |
This structure is derived from Bundle
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 5 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Bundle
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | 0..* | Bundle | Contains a collection of resources | |
type | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: collection | |
Slices for entry | S | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource |
entry:ra_measurereport_entry | S | 0..* | BackboneElement | Risk Adjustment Coding Gap Reports for a patient. The reports contained in a bundle must be for the same patient. |
resource | S | 1..1 | RiskAdjustmentCodingGapReport | A patient's Risk Adjustment Coding Gap Report for a Risk Adjustment Model. |
entry:ra_patient_entry | S | 1..1 | BackboneElement | This is the patient of the Risk Adjustment Coding Gap Report. If the Sever does not have Risk Adjustment Coding Gap Reports for the patient, then then patient resource is returned without the Risk Adjustment MeasureReport entries. |
resource | S | 1..1 | USCorePatientProfile | This is the Patient resource. |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Bundle | I | 0..* | Bundle | Contains a collection of resources |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
identifier | Σ | 0..1 | Identifier | Persistent identifier for the bundle |
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: collection |
timestamp | Σ | 0..1 | instant | When the bundle was assembled |
total | ΣI | 0..1 | unsignedInt | If search, the total number of matches |
link | Σ | 0..* | BackboneElement | Links related to this Bundle |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
relation | Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 |
url | Σ | 1..1 | uri | Reference details for the link |
Slices for entry | SΣI | 1..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
entry:All Slices | Content/Rules for all slices | |||
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | Σ | 0..1 | Resource | A resource in the bundle |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:ra_measurereport_entry | SΣI | 0..* | BackboneElement | Risk Adjustment Coding Gap Reports for a patient. The reports contained in a bundle must be for the same patient. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | SI | 1..1 | RiskAdjustmentCodingGapReport | A patient's Risk Adjustment Coding Gap Report for a Risk Adjustment Model. |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
entry:ra_patient_entry | SΣI | 1..1 | BackboneElement | This is the patient of the Risk Adjustment Coding Gap Report. If the Sever does not have Risk Adjustment Coding Gap Reports for the patient, then then patient resource is returned without the Risk Adjustment MeasureReport entries. This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
link | Σ | 0..* | See link (Bundle) | Links related to this entry |
fullUrl | Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) |
resource | S | 1..1 | USCorePatientProfile | This is the Patient resource. |
search | ΣI | 0..1 | BackboneElement | Search related information |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
mode | Σ | 0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. |
score | Σ | 0..1 | decimal | Search ranking (between 0 and 1) |
request | ΣI | 0..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 | Σ | 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 currency |
ifModifiedSince | Σ | 0..1 | instant | For managing cache currency |
ifMatch | Σ | 0..1 | string | For managing update contention |
ifNoneExist | Σ | 0..1 | string | For conditional creates |
response | ΣI | 0..1 | BackboneElement | Results of execution (transaction/batch/history) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
status | Σ | 1..1 | string | Status response code (text optional) |
location | Σ | 0..1 | uri | The location (if the operation returns a location) |
etag | Σ | 0..1 | string | The Etag for the resource (if relevant) |
lastModified | Σ | 0..1 | instant | Server's date time modified |
outcome | Σ | 0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) |
signature | Σ | 0..1 | Signature | Digital Signature |
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages |
Bundle.type | required | Fixed Value: collection |
Bundle.entry.search.mode | required | SearchEntryMode |
Bundle.entry.request.method | required | HTTPVerb |
Bundle.entry:ra_measurereport_entry.search.mode | required | SearchEntryMode |
Bundle.entry:ra_measurereport_entry.request.method | required | HTTPVerb |
Bundle.entry:ra_patient_entry.search.mode | required | SearchEntryMode |
Bundle.entry:ra_patient_entry.request.method | required | HTTPVerb |
Id | Path | Details | Requirements |
bdl-1 | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') | |
bdl-2 | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') | |
bdl-3 | 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 | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) | |
bdl-7 | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() | |
bdl-9 | 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 | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) | |
bdl-11 | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) | |
bdl-12 | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) | |
ele-1 | Bundle.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.total | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.link.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.link.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
bdl-5 | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
ele-1 | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.search | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
bdl-5 | Bundle.entry:ra_measurereport_entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | Bundle.entry:ra_measurereport_entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
ele-1 | Bundle.entry:ra_measurereport_entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
dom-2 | Bundle.entry:ra_measurereport_entry.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Bundle.entry:ra_measurereport_entry.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | Bundle.entry:ra_measurereport_entry.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | Bundle.entry:ra_measurereport_entry.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Bundle.entry:ra_measurereport_entry.resource | A resource should have narrative for robust management : text.`div`.exists() | |
mrp-1 | Bundle.entry:ra_measurereport_entry.resource | Measure Reports used for data collection SHALL NOT communicate group and score information : (type != 'data-collection') or group.exists().not() | |
mrp-2 | Bundle.entry:ra_measurereport_entry.resource | Stratifiers SHALL be either a single criteria or a set of criteria components : group.stratifier.stratum.all(value.exists() xor component.exists()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.search | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_measurereport_entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_measurereport_entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
bdl-5 | Bundle.entry:ra_patient_entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() | |
bdl-8 | Bundle.entry:ra_patient_entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() | |
ele-1 | Bundle.entry:ra_patient_entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
dom-2 | Bundle.entry:ra_patient_entry.resource | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Bundle.entry:ra_patient_entry.resource | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | Bundle.entry:ra_patient_entry.resource | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | Bundle.entry:ra_patient_entry.resource | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Bundle.entry:ra_patient_entry.resource | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.search | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Bundle.entry:ra_patient_entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Bundle.entry:ra_patient_entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.entry:ra_patient_entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Bundle.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |