Patient Cost Transparency Implementation Guide
2.0.0 - STU 2 - Draft United States of America flag

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.0 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

Resource Profile: PCT AEOB Packet

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-aeob-packet Version: 2.0.0
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:

  • New Content

    • Formal Views of Profile Content

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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    .... 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 SΣ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
    ..... fullUrl Σ 1..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
    .... entry:aeob SΣ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
    ..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient SΣ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
    ..... fullUrl Σ 1..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
    .... entry:coverage SΣ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
    ..... fullUrl Σ 1..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
    .... entry:organization SΣ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
    ..... fullUrl Σ 1..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
    .... entry:practitioner SΣ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
    ..... fullUrl Σ 1..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
    .... entry:gfeBundle SΣ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
    ..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.typerequiredFixed Value: document
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    From the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    bdl-1errorBundletotal only when a search or history
    : total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2errorBundleentry.search only when a search
    : entry.search.empty() or (type = 'searchset')
    bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
    : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlemust be a resource unless there's a request or response
    : resource.exists() or request.exists() or response.exists()
    bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlefullUrl cannot be a version specific reference
    : fullUrl.contains('/_history/').not()
    bdl-9errorBundleA document must have an identifier with a system and a value
    : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10errorBundleA document must have a date
    : type = 'document' implies (timestamp.hasValue())
    bdl-11errorBundleA document must have a Composition as the first resource
    : type = 'document' implies entry.first().resource.is(Composition)
    bdl-12errorBundleA message must have a MessageHeader as the first resource
    : type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL 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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    .... 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
    ..... request 0..0
    ..... response 0..0
    .... entry:composition S 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 S 2..* BackboneElement SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB resource
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient S 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 S 1..1 BackboneElement SHALL have one Coverage
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 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 S 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 S 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

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL have at least one entry for a payer organization.
    : entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... 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
    .... 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 SΣ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 Σ 1..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
    .... entry:aeob SΣ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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient SΣ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 Σ 1..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
    .... entry:coverage SΣ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 Σ 1..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
    .... entry:organization SΣ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 Σ 1..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
    .... entry:practitioner SΣ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 Σ 1..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
    .... entry:gfeBundle SΣ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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources
    ... signature Σ 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Bundle.typerequiredFixed Value: document
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    From the FHIR Standard
    Bundle.entry.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    bdl-1errorBundletotal only when a search or history
    : total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2errorBundleentry.search only when a search
    : entry.search.empty() or (type = 'searchset')
    bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
    : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlemust be a resource unless there's a request or response
    : resource.exists() or request.exists() or response.exists()
    bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlefullUrl cannot be a version specific reference
    : fullUrl.contains('/_history/').not()
    bdl-9errorBundleA document must have an identifier with a system and a value
    : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10errorBundleA document must have a date
    : type = 'document' implies (timestamp.hasValue())
    bdl-11errorBundleA document must have a Composition as the first resource
    : type = 'document' implies entry.first().resource.is(Composition)
    bdl-12errorBundleA message must have a MessageHeader as the first resource
    : type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL have at least one entry for a payer organization.
    : entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    .... 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 SΣ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
    ..... fullUrl Σ 1..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
    .... entry:aeob SΣ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
    ..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient SΣ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
    ..... fullUrl Σ 1..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
    .... entry:coverage SΣ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
    ..... fullUrl Σ 1..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
    .... entry:organization SΣ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
    ..... fullUrl Σ 1..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
    .... entry:practitioner SΣ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
    ..... fullUrl Σ 1..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
    .... entry:gfeBundle SΣ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
    ..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.typerequiredFixed Value: document
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    From the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    bdl-1errorBundletotal only when a search or history
    : total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2errorBundleentry.search only when a search
    : entry.search.empty() or (type = 'searchset')
    bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
    : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlemust be a resource unless there's a request or response
    : resource.exists() or request.exists() or response.exists()
    bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlefullUrl cannot be a version specific reference
    : fullUrl.contains('/_history/').not()
    bdl-9errorBundleA document must have an identifier with a system and a value
    : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10errorBundleA document must have a date
    : type = 'document' implies (timestamp.hasValue())
    bdl-11errorBundleA document must have a Composition as the first resource
    : type = 'document' implies entry.first().resource.is(Composition)
    bdl-12errorBundleA message must have a MessageHeader as the first resource
    : type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL 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

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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
    ... 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
    .... 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
    ..... request 0..0
    ..... response 0..0
    .... entry:composition S 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 S 2..* BackboneElement SHALL have a PCTAdvancedEOBSummary or PCTAdvancedEOB resource
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient S 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 S 1..1 BackboneElement SHALL have one Coverage
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 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 S 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 S 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

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL have at least one entry for a payer organization.
    : entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. 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.
    Additional BindingsPurpose
    AllLanguages Max Binding
    ... 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
    ... 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
    .... 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 SΣ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 Σ 1..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
    .... entry:aeob SΣ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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTAdvancedEOBSummary, PCTAdvancedEOB Explanation of Benefit resource
    .... entry:patient SΣ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 Σ 1..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
    .... entry:coverage SΣ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 Σ 1..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
    .... entry:organization SΣ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 Σ 1..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
    .... entry:practitioner SΣ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 Σ 1..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
    .... entry:gfeBundle SΣ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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources
    ... signature Σ 0..1 Signature Digital Signature

    doco Documentation for this format

    Terminology Bindings

    PathConformanceValueSet / CodeURI
    Bundle.languagepreferredCommonLanguages
    http://hl7.org/fhir/ValueSet/languages
    From the FHIR Standard
    Additional Bindings Purpose
    AllLanguages Max Binding
    Bundle.typerequiredFixed Value: document
    http://hl7.org/fhir/ValueSet/bundle-type|4.0.1
    From the FHIR Standard
    Bundle.entry.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:composition.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:aeob.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:patient.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:coverage.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:organization.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:practitioner.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:gfeBundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    bdl-1errorBundletotal only when a search or history
    : total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2errorBundleentry.search only when a search
    : entry.search.empty() or (type = 'searchset')
    bdl-3errorBundleentry.request mandatory for batch/transaction/history, otherwise prohibited
    : entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4errorBundleentry.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-5errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlemust be a resource unless there's a request or response
    : resource.exists() or request.exists() or response.exists()
    bdl-7errorBundleFullUrl 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-8errorBundle.entry, Bundle.entry:composition, Bundle.entry:aeob, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfeBundlefullUrl cannot be a version specific reference
    : fullUrl.contains('/_history/').not()
    bdl-9errorBundleA document must have an identifier with a system and a value
    : type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10errorBundleA document must have a date
    : type = 'document' implies (timestamp.hasValue())
    bdl-11errorBundleA document must have a Composition as the first resource
    : type = 'document' implies entry.first().resource.is(Composition)
    bdl-12errorBundleA message must have a MessageHeader as the first resource
    : type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()
    pct-aeob-packet-1errorBundleAll 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-2errorBundleSHALL have at least one entry for a payer organization.
    : entry.resource.ofType(Organization).where(type.coding.where(code='pay').exists()).exists()

     

    Other representations of profile: CSV, Excel, Schematron