Da Vinci - Payer Coverage Decision Exchange (PCDE)
1.0.0 - STU 1

Da Vinci - Payer Coverage Decision Exchange (PCDE), published by HL7 International - Financial Management Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/davinci-pcde/ and changes regularly. See the Directory of published versions

## Resource Profile: PCDE Coverage Transition Bundle Profile

Official URL: http://hl7.org/fhir/us/davinci-pcde/StructureDefinition/profile-pcde-bundle | Version: 1.0.0
Active as of 2022-08-29 | Computable Name: PCDEBundle

Constraints on Bundle to reflect the contents of a Coverage Transition Document

This simple profile enforces the rules for a FHIR document Bundle, with an additional constraint that forces the first resource to be a Composition that complies with the PCDE Composition profile.

Usage:

- This Resource Profile is not used by any profiles in this Implementation Guide

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

This structure is derived from Bundle

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 3 elements

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources pcde-bdl-1: First entry must be a valid PCDE Composition
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
entry | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | S | 1..1 | Resource | A resource in the bundle
search |  | 0..0 |  |
request |  | 0..0 |  |
response |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources pcde-bdl-1: First entry must be a valid PCDE Composition
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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: document
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
entry | S Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | S Σ | 1..1 | Resource | A resource in the bundle
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 pcde-bdl-1: First entry must be a valid PCDE Composition
entry | Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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
fullUrl | Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | Resource | A resource in the bundle
Documentation for this format

This structure is derived from Bundle

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 3 elements

Differential View

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources pcde-bdl-1: First entry must be a valid PCDE Composition
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
entry | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | S | 1..1 | Resource | A resource in the bundle
search |  | 0..0 |  |
request |  | 0..0 |  |
response |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Bundle | I | 0..* | Bundle | Contains a collection of resources pcde-bdl-1: First entry must be a valid PCDE Composition
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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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: document
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
entry | S Σ I | 0..* | BackboneElement | Entry in the bundle - will have a resource or information 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | S Σ | 1..1 | Resource | A resource in the bundle
signature | Σ | 0..1 | Signature | Digital Signature
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Bundle.language | preferred | CommonLanguages Max Binding: AllLanguages
Bundle.type | required | Fixed Value: document
Bundle.entry.search.mode | required | SearchEntryMode
Bundle.entry.request.method | required | HTTPVerb

#### Constraints

Id | Grade | Path | Details | Requirements
bdl-1 | error | Bundle | total only when a search or history : total.empty() or (type = 'searchset') or (type = 'history') |
bdl-2 | error | Bundle | entry.search only when a search : entry.search.empty() or (type = 'searchset') |
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history')) |
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited : entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history')) |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
bdl-9 | error | Bundle | A document must have an identifier with a system and a value : type = 'document' implies (identifier.system.exists() and identifier.value.exists()) |
bdl-10 | error | Bundle | A document must have a date : type = 'document' implies (timestamp.hasValue()) |
bdl-11 | error | Bundle | A document must have a Composition as the first resource : type = 'document' implies entry.first().resource.is(Composition) |
bdl-12 | error | Bundle | A message must have a MessageHeader as the first resource : type = 'message' implies entry.first().resource.is(MessageHeader) |
pcde-bdl-1 | error | Bundle | First entry must be a valid PCDE Composition : entry.first().resource.conformsTo('http://hl7.org/fhir/us/davinci-pcde/StructureDefinition/profile-composition') |
ele-1 | error | Bundle.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.timestamp | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.total | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.link.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.link.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.link.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.link.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.link.relation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.link.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
bdl-5 | error | Bundle.entry | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-8 | error | Bundle.entry | fullUrl cannot be a version specific reference : fullUrl.contains('/_history/').not() |
ele-1 | error | Bundle.entry | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.link | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.fullUrl | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.search.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.search.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.search.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.search.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.search.mode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.search.score | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.request.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.request.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.request.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.request.method | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.url | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.ifNoneMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.ifModifiedSince | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.ifMatch | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.request.ifNoneExist | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | Bundle.entry.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | error | Bundle.entry.response.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.response.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.response.etag | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.entry.response.lastModified | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | error | Bundle.signature | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |