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

This page is part of the Da Vinci Patient Cost Transparency Implementation Guide (v2.0.0: STU 2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: PCT GFE Information Bundle

Official URL: http://hl7.org/fhir/us/davinci-pct/StructureDefinition/davinci-pct-gfe-information-bundle Version: 2.0.0
Standards status: Draft Maturity Level: 0 Computable Name: PCTGFEInformationBundle
Other Identifiers: OID:2.16.840.1.113883.4.642.40.4.42.16

PCT GFE Information Bundle that contains the information necessary for GFE contributors to create their estimates. This bundle may for all GFE Contributors or specific to a single contributor and may include, but is not limited to, the Patient Resource, request resources (such as ServiceRequest, MedicationRequest, and DeviceRequest), Service location information, Coverage and Payer Organization resources (if applicable).

The following profile relates to the Good Faith Estimate (GFE) Coordination workflow and is marked as DRAFT. This content has not yet met the requisite level of testing to be balloted as trial-use. However, this part of the specification has been reviewed by the Da Vinci Patient Cost Transparency (PCT) open community of providers, payers, and health information technology (IT) vendors and was determined to be at a sufficient level of development to be included in this publication for the purposes of soliciting feedback from, and enabling testing by, the larger implementation community with the intention of bringing the content related to the GFE Coordination workflow to full standard for trial use (STU) status in a future version. Feedback is welcome and may be submitted through the FHIR change tracker indicating "US Da Vinci Patient Cost Transparency (PCT)(FHIR)" as the specification.

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-gfe-information-bundle-1
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Fixed Value: collection
    ... timestamp Σ 1..1 instant When the bundle was assembled
    ... Slices for entry ΣC 1..* 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: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 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY 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 0..* BackboneElement MAY 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:service-location SΣC 0..* BackboneElement MAY have Service Location(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 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role SΣC 0..* BackboneElement MAY have the provider PractitionerRole(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 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service SΣC 0..* BackboneElement Items the request is about - PCTServiceRequest
    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 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication SΣC 0..* BackboneElement Items the request is about - PCTMedicationRequest
    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 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device SΣC 0..* BackboneElement Items the request is about - PCTDeviceRequest
    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 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition SΣC 0..* BackboneElement Items the request is about - NutritionOrder
    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 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision SΣC 0..* BackboneElement Items the request is about - VisionPrescription
    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 VisionPrescription A resource in the bundle
    .... 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

    Path Status Usage ValueSet Version Source
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
    bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
    bdl-5 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
    bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
    bdl-8 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
    bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
    bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
    bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    pct-gfe-information-bundle-1 error Bundle All 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-information-bundle-1
    ... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Fixed Value: collection
    ... timestamp 1..1 instant When the bundle was assembled
    ... Slices for entry 1..* 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:patient 1..2 BackboneElement SHALL have the patient subject of care and may have a separate subscriber
    ..... resource 1..1 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage S 0..1 BackboneElement MAY have one Coverage
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 0..* BackboneElement MAY 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:service-location S 0..* BackboneElement MAY have Service Location(s)
    ..... resource 1..1 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role S 0..* BackboneElement MAY have the provider PractitionerRole(s)
    ..... resource 1..1 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service S 0..* BackboneElement Items the request is about - PCTServiceRequest
    ..... resource 1..1 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication S 0..* BackboneElement Items the request is about - PCTMedicationRequest
    ..... resource 1..1 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device S 0..* BackboneElement Items the request is about - PCTDeviceRequest
    ..... resource 1..1 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition S 0..* BackboneElement Items the request is about - NutritionOrder
    ..... resource 1..1 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision S 0..* BackboneElement Items the request is about - VisionPrescription
    ..... resource 1..1 VisionPrescription A resource in the bundle
    .... 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

    Id Grade Path(s) Description Expression
    pct-gfe-information-bundle-1 error Bundle All 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-information-bundle-1
    ... 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 Σ 0..1 Identifier Persistent identifier for the bundle
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Fixed Value: collection
    ... timestamp Σ 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 1..* 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: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 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY 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 0..* BackboneElement MAY 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:service-location SΣC 0..* BackboneElement MAY have Service Location(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 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role SΣC 0..* BackboneElement MAY have the provider PractitionerRole(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 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service SΣC 0..* BackboneElement Items the request is about - PCTServiceRequest
    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 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication SΣC 0..* BackboneElement Items the request is about - PCTMedicationRequest
    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 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device SΣC 0..* BackboneElement Items the request is about - PCTDeviceRequest
    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 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition SΣC 0..* BackboneElement Items the request is about - NutritionOrder
    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 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision SΣC 0..* BackboneElement Items the request is about - VisionPrescription
    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 VisionPrescription A resource in the bundle
    .... 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

    Path Status Usage ValueSet Version Source
    Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
    bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
    bdl-5 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
    bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
    bdl-8 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
    bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
    bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
    bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    pct-gfe-information-bundle-1 error Bundle All 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-information-bundle-1
    ... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Fixed Value: collection
    ... timestamp Σ 1..1 instant When the bundle was assembled
    ... Slices for entry ΣC 1..* 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: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 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY 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 0..* BackboneElement MAY 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:service-location SΣC 0..* BackboneElement MAY have Service Location(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 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role SΣC 0..* BackboneElement MAY have the provider PractitionerRole(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 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service SΣC 0..* BackboneElement Items the request is about - PCTServiceRequest
    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 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication SΣC 0..* BackboneElement Items the request is about - PCTMedicationRequest
    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 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device SΣC 0..* BackboneElement Items the request is about - PCTDeviceRequest
    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 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition SΣC 0..* BackboneElement Items the request is about - NutritionOrder
    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 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision SΣC 0..* BackboneElement Items the request is about - VisionPrescription
    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 VisionPrescription A resource in the bundle
    .... 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

    Path Status Usage ValueSet Version Source
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
    bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
    bdl-5 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
    bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
    bdl-8 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
    bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
    bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
    bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    pct-gfe-information-bundle-1 error Bundle All 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-information-bundle-1
    ... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Fixed Value: collection
    ... timestamp 1..1 instant When the bundle was assembled
    ... Slices for entry 1..* 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:patient 1..2 BackboneElement SHALL have the patient subject of care and may have a separate subscriber
    ..... resource 1..1 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage S 0..1 BackboneElement MAY have one Coverage
    ..... resource 1..1 PCTCoverage Insurance or medical plan or a payment agreement
    .... entry:organization S 0..* BackboneElement MAY 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:service-location S 0..* BackboneElement MAY have Service Location(s)
    ..... resource 1..1 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role S 0..* BackboneElement MAY have the provider PractitionerRole(s)
    ..... resource 1..1 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service S 0..* BackboneElement Items the request is about - PCTServiceRequest
    ..... resource 1..1 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication S 0..* BackboneElement Items the request is about - PCTMedicationRequest
    ..... resource 1..1 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device S 0..* BackboneElement Items the request is about - PCTDeviceRequest
    ..... resource 1..1 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition S 0..* BackboneElement Items the request is about - NutritionOrder
    ..... resource 1..1 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision S 0..* BackboneElement Items the request is about - VisionPrescription
    ..... resource 1..1 VisionPrescription A resource in the bundle
    .... 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

    Id Grade Path(s) Description Expression
    pct-gfe-information-bundle-1 error Bundle All 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-information-bundle-1
    ... 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 Σ 0..1 Identifier Persistent identifier for the bundle
    ... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
    Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
    Fixed Value: collection
    ... timestamp Σ 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 1..* 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: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 USCorePatientProfile(7.0.0) Information about an individual or animal receiving health care services
    .... entry:coverage SΣC 0..1 BackboneElement MAY 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 0..* BackboneElement MAY 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:service-location SΣC 0..* BackboneElement MAY have Service Location(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 PCTServiceLocation Details and position information for a physical place
    .... 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:practitioner-role SΣC 0..* BackboneElement MAY have the provider PractitionerRole(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 USCorePractitionerRoleProfile(7.0.0) Roles/organizations the practitioner is associated with
    .... entry:requested-items-service SΣC 0..* BackboneElement Items the request is about - PCTServiceRequest
    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 PCTServiceRequest A request for a service to be performed
    .... entry:requested-items-medication SΣC 0..* BackboneElement Items the request is about - PCTMedicationRequest
    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 PCTMedicationRequest Ordering of medication for patient or group
    .... entry:requested-items-device SΣC 0..* BackboneElement Items the request is about - PCTDeviceRequest
    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 PCTDeviceRequest Medical device request
    .... entry:requested-items-nutrition SΣC 0..* BackboneElement Items the request is about - NutritionOrder
    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 NutritionOrder A resource in the bundle
    .... entry:requested-items-vision SΣC 0..* BackboneElement Items the request is about - VisionPrescription
    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 VisionPrescription A resource in the bundle
    .... 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

    Path Status Usage ValueSet Version Source
    Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
    Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
    Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:coverage.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:service-location.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:practitioner-role.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-service.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-nutrition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:requested-items-vision.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
    Bundle.entry:attachment.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

    Constraints

    Id Grade Path(s) Description Expression
    bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
    bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
    bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
    bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
    bdl-5 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
    bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
    bdl-8 error Bundle.entry, Bundle.entry:patient, Bundle.entry:coverage, Bundle.entry:organization, Bundle.entry:service-location, Bundle.entry:practitioner, Bundle.entry:practitioner-role, Bundle.entry:requested-items-service, Bundle.entry:requested-items-medication, Bundle.entry:requested-items-device, Bundle.entry:requested-items-nutrition, Bundle.entry:requested-items-vision, Bundle.entry:attachment fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
    bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
    bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
    bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
    bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
    pct-gfe-information-bundle-1 error Bundle All 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