Patient Cost Transparency Implementation Guide
2.0.2 - STU 2
Patient Cost Transparency Implementation Guide
2.0.2 - STU 2
Patient Cost Transparency Implementation Guide, published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pct/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-aeob-packet | Version: 2.0.2 | ||||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: PCTAEOBPacket | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.60 | |||||
PCT AEOB Packet that contains necessary resources for one or more an AEOBs. Organizations for both the payer and provider SHALL be included. An AEOB Summary SHALL be included and reflect the total estimate for the patient, including all AEOB resources within the Bundle. This version of the Bundle is a document type that will enable versioning, signing and being referenced by a DocumentReference for searching and subscription notifications.
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 1.1.0:
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, pct-aeob-packet-1, pct-aeob-packet-2 |
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |
 identifier |
1..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: document (no extensions allowed) | |
| timestamp |
1..1 | instant | When the bundle was assembled | |
  Slices for entry |
C | 6..* | 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
   entry:All Slices |
Content/Rules for all slices | |||
  modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
 entry:composition |
C | 1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition 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 |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
 resource |
1..1 | PCTAdvancedEOBComposition  |
A set of resources composed into a single coherent clinical statement with clinical attestation | |
| entry:aeob |
C | 2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB 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 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTAdvancedEOBSummary , PCTAdvancedEOB  |
Explanation of Benefit resource | |
| entry:patient |
C | 1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | USCorePatientProfile(7.0.0) |
Information about an individual or animal receiving health care services | |
| entry:coverage |
C | 1..1 | BackboneElement | SHALL have one Coverage Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTCoverage |
Insurance or medical plan or a payment agreement | |
| entry:organization |
C | 1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTOrganization |
A grouping of people or organizations with a common purpose | |
| entry:practitioner |
C | 0..* | BackboneElement | MAY have the provider Practitioner(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:gfeBundle |
C | 0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTGFEBundle , PCTGFEMissingBundle |
Contains a collection of resources | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: pct-aeob-packet-1, pct-aeob-packet-2 |
| identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document (no extensions allowed) | |
| timestamp |
1..1 | instant | When the bundle was assembled | |
| Slices for entry |
6..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:All Slices |
Content/Rules for all slices | |||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| search |
0..0 | Search related information | ||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||
| response |
0..0 | Results of execution (transaction/batch/history) | ||
| entry:composition |
1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition resource | |
| resource |
1..1 | PCTAdvancedEOBComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| entry:aeob |
2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB resource | |
| resource |
1..1 | PCTAdvancedEOBSummary, PCTAdvancedEOB | Explanation of Benefit resource | |
| entry:patient |
1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber | |
| resource |
1..1 | USCorePatientProfile(7.0.0) | Information about an individual or animal receiving health care services | |
| entry:coverage |
1..1 | BackboneElement | SHALL have one Coverage | |
| resource |
1..1 | PCTCoverage | Insurance or medical plan or a payment agreement | |
| entry:organization |
1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) | |
| resource |
1..1 | PCTOrganization | A grouping of people or organizations with a common purpose | |
| entry:practitioner |
0..* | BackboneElement | MAY have the provider Practitioner(s) | |
| resource |
1..1 | PCTPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:gfeBundle |
0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) | |
| resource |
1..1 | PCTGFEBundle, PCTGFEMissingBundle | Contains a collection of resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, pct-aeob-packet-1, pct-aeob-packet-2 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier |
1..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: document (no extensions allowed) | |||||
| timestamp |
1..1 | instant | When the bundle was assembled | |||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
0..* | BackboneElement | Links related to this Bundle | |||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||
| url |
1..1 | uri | Reference details for the link | |||||
| Slices for entry |
C | 6..* | 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | Resource | A resource in the bundle | |||||
| entry:composition |
C | 1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition 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 | ||||
| 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 |
1..1 | PCTAdvancedEOBComposition |
A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:aeob |
C | 2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB 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 | ||||
| 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 |
1..1 | PCTAdvancedEOBSummary , PCTAdvancedEOB |
Explanation of Benefit resource | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:patient |
C | 1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | USCorePatientProfile(7.0.0) |
Information about an individual or animal receiving health care services | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:coverage |
C | 1..1 | BackboneElement | SHALL have one Coverage Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTCoverage |
Insurance or medical plan or a payment agreement | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:organization |
C | 1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTOrganization |
A grouping of people or organizations with a common purpose | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:practitioner |
C | 0..* | BackboneElement | MAY have the provider Practitioner(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:gfeBundle |
C | 0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTGFEBundle , PCTGFEMissingBundle |
Contains a collection of resources | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:aeob.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:aeob.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:coverage.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:gfeBundle.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:gfeBundle.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
This structure is derived from Bundle
Summary
Mandatory: 12 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, pct-aeob-packet-1, pct-aeob-packet-2 |
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |
| identifier |
1..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: document (no extensions allowed) | |
| timestamp |
1..1 | instant | When the bundle was assembled | |
| Slices for entry |
C | 6..* | 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them |
| entry:All Slices |
Content/Rules for all slices | |||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| entry:composition |
C | 1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition 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 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTAdvancedEOBComposition |
A set of resources composed into a single coherent clinical statement with clinical attestation | |
| entry:aeob |
C | 2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB 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 |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTAdvancedEOBSummary , PCTAdvancedEOB |
Explanation of Benefit resource | |
| entry:patient |
C | 1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | USCorePatientProfile(7.0.0) |
Information about an individual or animal receiving health care services | |
| entry:coverage |
C | 1..1 | BackboneElement | SHALL have one Coverage Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTCoverage |
Insurance or medical plan or a payment agreement | |
| entry:organization |
C | 1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTOrganization |
A grouping of people or organizations with a common purpose | |
| entry:practitioner |
C | 0..* | BackboneElement | MAY have the provider Practitioner(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:gfeBundle |
C | 0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
| resource |
1..1 | PCTGFEBundle , PCTGFEMissingBundle |
Contains a collection of resources | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
Differential View
This structure is derived from Bundle
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: pct-aeob-packet-1, pct-aeob-packet-2 |
| identifier |
1..1 | Identifier | Persistent identifier for the bundle | |
| type |
1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document (no extensions allowed) | |
| timestamp |
1..1 | instant | When the bundle was assembled | |
| Slices for entry |
6..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:resource Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| entry:All Slices |
Content/Rules for all slices | |||
| fullUrl |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |
| search |
0..0 | Search related information | ||
| request |
0..0 | Additional execution information (transaction/batch/history) | ||
| response |
0..0 | Results of execution (transaction/batch/history) | ||
| entry:composition |
1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition resource | |
| resource |
1..1 | PCTAdvancedEOBComposition | A set of resources composed into a single coherent clinical statement with clinical attestation | |
| entry:aeob |
2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB resource | |
| resource |
1..1 | PCTAdvancedEOBSummary, PCTAdvancedEOB | Explanation of Benefit resource | |
| entry:patient |
1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber | |
| resource |
1..1 | USCorePatientProfile(7.0.0) | Information about an individual or animal receiving health care services | |
| entry:coverage |
1..1 | BackboneElement | SHALL have one Coverage | |
| resource |
1..1 | PCTCoverage | Insurance or medical plan or a payment agreement | |
| entry:organization |
1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) | |
| resource |
1..1 | PCTOrganization | A grouping of people or organizations with a common purpose | |
| entry:practitioner |
0..* | BackboneElement | MAY have the provider Practitioner(s) | |
| resource |
1..1 | PCTPractitioner | A person with a formal responsibility in the provisioning of healthcare or related services | |
| entry:gfeBundle |
0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) | |
| resource |
1..1 | PCTGFEBundle, PCTGFEMissingBundle | Contains a collection of resources | |
| Documentation for this format | ||||
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Bundle |
C | 0..* | Bundle | Contains a collection of resources Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, pct-aeob-packet-1, pct-aeob-packet-2 | ||||
| id |
0..1 | id | Logical id of this artifact | |||||
| meta |
0..1 | Meta | Metadata about the resource | |||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| identifier |
1..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: document (no extensions allowed) | |||||
| timestamp |
1..1 | instant | When the bundle was assembled | |||||
| total |
C | 0..1 | unsignedInt | If search, the total number of matches | ||||
| link |
0..* | BackboneElement | Links related to this Bundle | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| relation |
1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | |||||
| url |
1..1 | uri | Reference details for the link | |||||
| Slices for entry |
C | 6..* | 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||||
| 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 |
1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
0..1 | Resource | A resource in the bundle | |||||
| entry:composition |
C | 1..1 | BackboneElement | SHALL have a PCTAdvancedEOBComposition 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 | ||||
| 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 |
1..1 | PCTAdvancedEOBComposition |
A set of resources composed into a single coherent clinical statement with clinical attestation | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:aeob |
C | 2..* | BackboneElement | SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB 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 | ||||
| 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 |
1..1 | PCTAdvancedEOBSummary , PCTAdvancedEOB |
Explanation of Benefit resource | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:patient |
C | 1..2 | BackboneElement | SHALL have the patient subject of care and may be a separate subscriber Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | USCorePatientProfile(7.0.0) |
Information about an individual or animal receiving health care services | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:coverage |
C | 1..1 | BackboneElement | SHALL have one Coverage Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTCoverage |
Insurance or medical plan or a payment agreement | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:organization |
C | 1..* | BackboneElement | SHALL have the payer organization and may have provider organization(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTOrganization |
A grouping of people or organizations with a common purpose | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:practitioner |
C | 0..* | BackboneElement | MAY have the provider Practitioner(s) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTPractitioner |
A person with a formal responsibility in the provisioning of healthcare or related services | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| entry:gfeBundle |
C | 0..* | BackboneElement | MAY include GFE contributor specific GFE bundle or information about a unfulfilled GFE request (GFE Missing Bundle) Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| link |
0..* | See link (Bundle) | Links related to this entry | |||||
| fullUrl |
0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | |||||
| resource |
1..1 | PCTGFEBundle , PCTGFEMissingBundle |
Contains a collection of resources | |||||
| search |
C | 0..1 | BackboneElement | Search related information | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| mode |
0..1 | code | match | include | outcome - why this is in the result set Binding: SearchEntryMode (required): Why an entry is in the result set - whether it's included as a match or because of an _include requirement, or to convey information or warning information about the search process. | |||||
| score |
0..1 | decimal | Search ranking (between 0 and 1) | |||||
| request |
C | 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 |
C | 0..1 | BackboneElement | Results of execution (transaction/batch/history) | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
| status |
1..1 | string | Status response code (text optional) | |||||
| location |
0..1 | uri | The location (if the operation returns a location) | |||||
| etag |
0..1 | string | The Etag for the resource (if relevant) | |||||
| lastModified |
0..1 | instant | Server's date time modified | |||||
| outcome |
0..1 | Resource | OperationOutcome with hints and warnings (for batch/transaction) | |||||
| signature |
0..1 | Signature | Digital Signature | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:aeob.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:aeob.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:coverage.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:coverage.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:gfeBundle.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:gfeBundle.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| pct-aeob-packet-1 | error | Bundle | All references resources SHALL be contained within the Bundle with the exception of the PCT GFE Bundle (referenced from the gfeReference extension in the AEOB), which MAY be present |
Bundle.entry.descendants().reference.distinct().all(resolve().exists())
|
| pct-aeob-packet-2 | error | Bundle | SHALL have at least one entry for a payer organization. |
entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
|
This structure is derived from Bundle
Summary
Mandatory: 12 elements(2 nested mandatory elements)
Must-Support: 7 elements
Fixed: 1 element
Prohibited: 3 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Financial Management.
Package hl7.fhir.us.davinci-pct#2.0.2 based on FHIR 4.0.1.
Generated
2026-11-09
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change