HL7 Europe Hospital Discharge Report
0.1.0-ballot - draft 150

This page is part of the HL7 Europe Hospital Discharge Report (v0.1.0-ballot: STU 1 Ballot 1) 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: Bundle (HDR)

Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/bundle-eu-hdr Version: 0.1.0-ballot
Draft as of 2025-06-03 Computable Name: BundleEuHdr

Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

Clinical document used to represent a Hospital Discharge Report for the scope of this guide.

Usages:

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 Hospital Discharge Report bundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-hdr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 1..1 Identifier Instance identifier
... 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
... Slices for entry ΣC 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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)
..... resource Σ 1..1 Resource A resource in the bundle
.... entry:composition ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
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 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Media A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Observation A resource in the bundle
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FlagEuHdr Key information to flag to healthcare providers
.... entry:location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 LocationEu Details and position information for a physical place
.... entry:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 CarePlan A resource in the bundle
... signature Σ 0..1 Signature Report Digital Signature
.... type Σ 1..* Coding Digital Signature Purposes
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when Σ 1..1 instant When was signed
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... data 0..1 base64Binary Signature content

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:encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:condition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:media.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medication.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.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:practitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:procedure.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:observation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:specimen.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:flag.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:careplan.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.signature.typepreferredSignatureTypeCodes
http://hl7.org/fhir/ValueSet/signature-type
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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanmust 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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanfullUrl 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)
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()
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()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-hdr-1
... identifier 1..1 Identifier Instance identifier
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp 1..1 instant Instance identifier
... Slices for entry 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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)
..... resource 1..1 Resource A resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter 1..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Media A resource in the bundle
.... entry:medication 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Observation A resource in the bundle
.... entry:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DocumentReference A resource in the bundle
.... entry:flag 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FlagEuHdr Key information to flag to healthcare providers
.... entry:location 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 LocationEu Details and position information for a physical place
.... entry:careplan 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CarePlan A resource in the bundle
... signature 0..1 Signature Report Digital Signature
.... type 1..* Coding Digital Signature Purposes
.... when 1..1 instant When was signed
.... who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... data 0..1 base64Binary Signature content

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-hdr-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
... identifier Σ 1..1 Identifier Instance identifier
... 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 Instance identifier
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry ΣC 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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 Σ 1..1 Resource A resource in the bundle
.... entry:composition ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
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 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Media A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Observation A resource in the bundle
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FlagEuHdr Key information to flag to healthcare providers
.... entry:location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 LocationEu Details and position information for a physical place
.... entry:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 CarePlan A resource in the bundle
... signature Σ 0..1 Signature Report Digital Signature
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 1..* Coding Digital Signature Purposes
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when Σ 1..1 instant When was signed
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... data 0..1 base64Binary Signature content

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:encounter.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:condition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:condition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:device.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunization.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:media.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:media.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medication.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medication.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.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:practitionerRole.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:practitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:procedure.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:procedure.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:observation.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:observation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:specimen.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:specimen.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:flag.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:flag.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:location.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:careplan.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:careplan.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.signature.typepreferredSignatureTypeCodes
http://hl7.org/fhir/ValueSet/signature-type
From the FHIR Standard
Bundle.signature.targetFormatrequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Bundle.signature.sigFormatrequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanmust 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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanfullUrl 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)
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()
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()

This structure is derived from Bundle

Summary

Mandatory: 6 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Bundle.entry

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-hdr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier Σ 1..1 Identifier Instance identifier
... 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
... Slices for entry ΣC 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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)
..... resource Σ 1..1 Resource A resource in the bundle
.... entry:composition ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
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 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Media A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Observation A resource in the bundle
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FlagEuHdr Key information to flag to healthcare providers
.... entry:location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 LocationEu Details and position information for a physical place
.... entry:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 CarePlan A resource in the bundle
... signature Σ 0..1 Signature Report Digital Signature
.... type Σ 1..* Coding Digital Signature Purposes
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when Σ 1..1 instant When was signed
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... data 0..1 base64Binary Signature content

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:encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:condition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:media.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medication.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.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:practitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:procedure.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:observation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:specimen.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:flag.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:careplan.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.signature.typepreferredSignatureTypeCodes
http://hl7.org/fhir/ValueSet/signature-type
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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanmust 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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanfullUrl 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)
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()
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()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-hdr-1
... identifier 1..1 Identifier Instance identifier
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp 1..1 instant Instance identifier
... Slices for entry 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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)
..... resource 1..1 Resource A resource in the bundle
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter 1..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Media A resource in the bundle
.... entry:medication 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Observation A resource in the bundle
.... entry:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DocumentReference A resource in the bundle
.... entry:flag 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FlagEuHdr Key information to flag to healthcare providers
.... entry:location 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 LocationEu Details and position information for a physical place
.... entry:careplan 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CarePlan A resource in the bundle
... signature 0..1 Signature Report Digital Signature
.... type 1..* Coding Digital Signature Purposes
.... when 1..1 instant When was signed
.... who 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... data 0..1 base64Binary Signature content

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-hdr-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
... identifier Σ 1..1 Identifier Instance identifier
... 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 Instance identifier
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry ΣC 3..* BackboneElement Entry resource in the Hospital Discharge Report bundle
Slice: Unordered, Open by type:resource, profile: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 Σ 1..1 Resource A resource in the bundle
.... entry:composition ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 CompositionEuHdr Hospital Discharge Report composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
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 PatientEuCore Information about an individual or animal receiving health care services
.... entry:encounter ΣC 1..* BackboneElement Entry in the bundle - will have a resource or information
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 EncounterEuHdr An interaction during which services are provided to the patient
.... entry:allergyIntolerance ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 AllergyIntoleranceEuHdr Allergy or Intolerance (generally: Risk of adverse reaction to a substance)
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ConditionEuHdr Detailed information about conditions, problems or diagnoses
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceEuHdr Item used in healthcare
.... entry:deviceUseStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DeviceUseStatementEuHdr Record of use of a device
.... entry:diagnosticReport ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 DiagnosticReportUvIps A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
.... entry:imagingStudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationEuHdr Immunization event information
.... entry:immunizationRecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ImmunizationRecommendationEuHdr Guidance or advice relating to an immunization
.... entry:media ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Media A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationEuHdr Definition of a Medication
.... entry:medicationRequest ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationRequestEuHdr Ordering of medication for patient or group
.... entry:medicationStatement ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationStatementEuHdr Record of medication being taken by a patient
.... entry:medicationDispense ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationDispenseEuHdr Dispensing a medication to a named patient
.... entry:medicationAdministration ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 MedicationAdministrationEuHdr Administration of medication to a patient
.... entry:practitioner ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerEuCore A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerRole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 PractitionerRoleEuCore Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 ProcedureEuHdr An action that is being or was performed on a patient
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 OrganizationEuCore A grouping of people or organizations with a common purpose
.... entry:observation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 Observation A resource in the bundle
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 SpecimenUvIps Sample for analysis
.... entry:familyMemberHistory ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FamilyMemberHistoryEuHdr Information about patient's relatives, relevant for patient
.... entry:documentReference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 FlagEuHdr Key information to flag to healthcare providers
.... entry:location ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 LocationEu Details and position information for a physical place
.... entry:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
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 CarePlan A resource in the bundle
... signature Σ 0..1 Signature Report Digital Signature
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... type Σ 1..* Coding Digital Signature Purposes
Binding: SignatureTypeCodes (preferred): An indication of the reason that an entity signed the object.
.... when Σ 1..1 instant When was signed
.... who Σ 1..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who signed.
.... onBehalfOf Σ 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) The party represented
.... targetFormat 0..1 code The technical format of the signed resources
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... sigFormat 0..1 code The technical format of the signature
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.
.... data 0..1 base64Binary Signature content

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:encounter.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:encounter.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:allergyIntolerance.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:condition.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:condition.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:device.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:device.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:deviceUseStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:diagnosticReport.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:imagingStudy.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunization.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunization.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:immunizationRecommendation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:media.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:media.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medication.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medication.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationRequest.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationStatement.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationDispense.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:medicationAdministration.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:practitionerRole.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:practitionerRole.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:procedure.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:procedure.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:observation.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:observation.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:specimen.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:specimen.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:familyMemberHistory.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:documentReference.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:flag.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:flag.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:location.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:location.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.entry:careplan.search.moderequiredSearchEntryMode
http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1
From the FHIR Standard
Bundle.entry:careplan.request.methodrequiredHTTPVerb
http://hl7.org/fhir/ValueSet/http-verb|4.0.1
From the FHIR Standard
Bundle.signature.typepreferredSignatureTypeCodes
http://hl7.org/fhir/ValueSet/signature-type
From the FHIR Standard
Bundle.signature.targetFormatrequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
From the FHIR Standard
Bundle.signature.sigFormatrequiredMime Types(a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanmust 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:encounter, Bundle.entry:allergyIntolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceUseStatement, Bundle.entry:diagnosticReport, Bundle.entry:imagingStudy, Bundle.entry:immunization, Bundle.entry:immunizationRecommendation, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationRequest, Bundle.entry:medicationStatement, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:practitioner, Bundle.entry:practitionerRole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag, Bundle.entry:location, Bundle.entry:careplanfullUrl 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)
bdl-hdr-1errorBundleAn IPS document must have no additional Composition (including Composition subclass) resources besides the first.
: entry.tail().where(resource is Composition).empty()
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()

This structure is derived from Bundle

Summary

Mandatory: 6 elements(1 nested mandatory element)
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Bundle.entry

 

Other representations of profile: CSV, Excel, Schematron