Patient Cost Transparency Implementation Guide
2.0.0-draft - 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-draft 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 GFE Packet

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-packet Version: 2.0.0-draft
Standards status: Trial-use Maturity Level: 1 Computable Name: PCTGFEPacket
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.61

PCT GFE Packet that contains GFE Bundles from GFE contributors. This document type bundle of GFE Bundles from GFE contributors that can then be made available to the patient or sent to a payer for insurance estimation. The scope of this guide does not include coordination of benefits or more than one coverage. This does not serve as a replacement for eligibility, prior authorization or other financial and administrative use cases.

Usages:

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-gfe-packet-1, pct-gfe-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 2..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by type:resource
    Constraints: bdl-5, bdl-8
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... 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 PCTGFEComposition 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 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient ΣC 1..2 BackboneElement SHALL have the patient subject of care and may have 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 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    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 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    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..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    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:gfe-bundle SΣC 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    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
    .... entry:attachment SΣC 0..* BackboneElement MAY have attachments as DocumentReference resource(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 DocumentReference A resource in the bundle

    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: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:gfe-bundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentmust 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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentfullUrl 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-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))

    This structure is derived from Bundle

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    Constraints: pct-gfe-packet-1, pct-gfe-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 2..* 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 PCTGFEComposition resource
    ..... resource 1..1 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient 1..2 BackboneElement SHALL have the patient subject of care and may have a separate subscriber
    ..... resource 1..1 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage S 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    ..... resource 1..1 PCTOrganization A grouping of people or organizations with a common purpose
    .... entry:practitioner S 0..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    ..... resource 1..1 PCTPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
    .... entry:gfe-bundle S 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources
    .... entry:attachment S 0..* BackboneElement MAY have attachments as DocumentReference resource(s)
    ..... resource 1..1 DocumentReference A resource in the bundle

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    pct-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))
    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-gfe-packet-1, pct-gfe-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 2..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by type:resource
    Constraints: bdl-5, bdl-8
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... 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 PCTGFEComposition 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 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient ΣC 1..2 BackboneElement SHALL have the patient subject of care and may have 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 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    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 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    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..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    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:gfe-bundle SΣC 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    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
    .... entry:attachment SΣC 0..* BackboneElement MAY have attachments as DocumentReference resource(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 DocumentReference A resource in the bundle
    ... 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: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:gfe-bundle.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:gfe-bundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentmust 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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentfullUrl 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-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))

    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-gfe-packet-1, pct-gfe-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 2..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by type:resource
    Constraints: bdl-5, bdl-8
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... 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 PCTGFEComposition 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 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient ΣC 1..2 BackboneElement SHALL have the patient subject of care and may have 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 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    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 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    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..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    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:gfe-bundle SΣC 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    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
    .... entry:attachment SΣC 0..* BackboneElement MAY have attachments as DocumentReference resource(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 DocumentReference A resource in the bundle

    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: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:gfe-bundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentmust 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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentfullUrl 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-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))

    Differential View

    This structure is derived from Bundle

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Bundle C 0..* Bundle Contains a collection of resources
    Constraints: pct-gfe-packet-1, pct-gfe-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 2..* 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 PCTGFEComposition resource
    ..... resource 1..1 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient 1..2 BackboneElement SHALL have the patient subject of care and may have a separate subscriber
    ..... resource 1..1 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage S 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    ..... resource 1..1 PCTOrganization A grouping of people or organizations with a common purpose
    .... entry:practitioner S 0..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    ..... resource 1..1 PCTPractitioner A person with a formal responsibility in the provisioning of healthcare or related services
    .... entry:gfe-bundle S 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    ..... resource 1..1 PCTGFEBundle, PCTGFEMissingBundle Contains a collection of resources
    .... entry:attachment S 0..* BackboneElement MAY have attachments as DocumentReference resource(s)
    ..... resource 1..1 DocumentReference A resource in the bundle

    doco Documentation for this format

    Constraints

    IdGradePath(s)DetailsRequirements
    pct-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))

    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-gfe-packet-1, pct-gfe-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 2..* BackboneElement Entry in the bundle - will have a resource or information
    Slice: Unordered, Open by type:resource
    Constraints: bdl-5, bdl-8
    This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
    .... 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 PCTGFEComposition 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 PCTGFEComposition A set of resources composed into a single coherent clinical statement with clinical attestation
    .... entry:patient ΣC 1..2 BackboneElement SHALL have the patient subject of care and may have 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 HRexPatientDemographics Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY have one Coverage. SHALL be present submitted to a payer in the $gfe-submit operation.
    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 0..2 BackboneElement SHALL have an initiating provider or initiating organization, but not both. May also have a payer organization. Payer Organization SHALL be present when being submitted to a payer in the $gfe-submit operation.
    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..1 BackboneElement SHALL have a initiating provider or initiating organization, but not both.
    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:gfe-bundle SΣC 0..* BackboneElement MAY include GFE contributor specific GFE bundle and MAY include bundle(s) with information about a unfulfilled GFE request
    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
    .... entry:attachment SΣC 0..* BackboneElement MAY have attachments as DocumentReference resource(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 DocumentReference A resource in the bundle
    ... 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: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:gfe-bundle.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:gfe-bundle.request.methodrequiredHTTPVerb
    http://hl7.org/fhir/ValueSet/http-verb|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.search.moderequiredSearchEntryMode
    http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
    From the FHIR Standard
    Bundle.entry:attachment.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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentmust 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:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:practitioner, Bundle.entry:gfe-bundle, Bundle.entry:attachmentfullUrl 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-gfe-packet-1errorBundleSHALL have a initiating provider or initiating organization, but not both.
    : Bundle.entry.resource.ofType(Practitioner).exists() or Bundle.entry.resource.ofType(Organization).exists()
    pct-gfe-packet-2errorBundleAll references resources SHALL be contained within the Bundle
    : Bundle.entry.resource.descendants().reference.where($this.startsWith('#').not()).all((%resource.entry.fullUrl.join('|')&'|').contains(($this&'|')))

     

    Other representations of profile: CSV, Excel, Schematron