XpanDH Hospital Discharge Report
0.1.0 - ci-build 150

XpanDH Hospital Discharge Report, published by XpanDH Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xpandh-hdr/ and changes regularly. See the Directory of published versions

Resource Profile: Bundle: EU Hospital Discharge Report

Official URL: http://hl7.eu/fhir/ig/xpandh/hdr/StructureDefinition/Bundle-hdr-xpandh Version: 0.1.0
Draft as of 2025-10-10 Computable Name: BundleHdrXpandh

Copyright/Legal: XpanDH Project

Clinical document used to represent a Hospital Discharge Report for the scope of the XpanDH project.

Usages:

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

You can also check for usages in the FHIR IG Statistics

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-ips-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... Slices for entry SΣC 2..* 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionHdrXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AllergyIntoleranceUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps, Condition Documentation of a health problem of the patient
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 DeviceUseStatementUvIps 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 SΣ 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationRequestIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationStatementIPS Record of medication being taken by 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationDispense A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationAdministration A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 FamilyMemberHistory A resource in the bundle
.... 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagXpandh Key information to flag to healthcare providers
... 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

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:condition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:media.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:flag.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-ips-1 error Bundle An IPS document must have no additional Composition (including Composition subclass) resources besides the first. entry.tail().where(resource is Composition).empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-ips-1
... identifier S 1..1 Identifier Persistent identifier for the bundle
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp S 1..1 instant When the bundle was assembled
... Slices for entry S 2..* 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 S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CompositionHdrXpandh Hospital Discharge Report composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... entry:allergyintolerance 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AllergyIntoleranceUvIps 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 ConditionUvIps, Condition Documentation of a health problem of the patient
.... entry:device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Device A resource in the bundle
.... entry:deviceusestatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceUseStatementUvIps 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 ImmunizationUvIps Immunization event information
.... entry:media 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... entry:medication 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationIPS Definition of a Medication
.... entry:medicationrequest 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationRequestIPS Ordering of medication for patient or group
.... entry:medicationstatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationStatementIPS Record of medication being taken by a patient
.... entry:practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerXpandh 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 PractitionerRoleXpandh Roles/organizations the practitioner is associated with
.... entry:procedure 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ProcedureUvIps 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 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... entry:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis
.... entry:medicationDispense 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationDispense A resource in the bundle
.... entry:medicationAdministration 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationAdministration A resource in the bundle
.... entry:familyMemberHistory 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FamilyMemberHistory A resource in the bundle
.... 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 FlagXpandh Key information to flag to healthcare providers
... 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

Id Grade Path(s) Description Expression
bdl-ips-1 error Bundle An 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-ips-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 SΣ 1..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry SΣC 2..* 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:composition Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionHdrXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AllergyIntoleranceUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps, Condition Documentation of a health problem of the patient
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 DeviceUseStatementUvIps 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 SΣ 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationRequestIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationStatementIPS Record of medication being taken by 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationDispense A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationAdministration A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 FamilyMemberHistory A resource in the bundle
.... 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagXpandh Key information to flag to healthcare providers
... 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

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:composition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:condition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:condition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:media.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:media.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medication.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:flag.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:flag.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Bundle.signature.targetFormat Base required MimeType 📍4.0.1 FHIR Std.
Bundle.signature.sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-ips-1 error Bundle An IPS document must have no additional Composition (including Composition subclass) resources besides the first. entry.tail().where(resource is Composition).empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 6 elements(28 nested mandatory elements)
Must-Support: 4 elements
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-ips-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... identifier SΣ 1..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... Slices for entry SΣC 2..* 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionHdrXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AllergyIntoleranceUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps, Condition Documentation of a health problem of the patient
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 DeviceUseStatementUvIps 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 SΣ 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationRequestIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationStatementIPS Record of medication being taken by 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationDispense A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationAdministration A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 FamilyMemberHistory A resource in the bundle
.... 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagXpandh Key information to flag to healthcare providers
... 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

Path Status Usage ValueSet Version Source
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:condition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:media.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:flag.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-ips-1 error Bundle An IPS document must have no additional Composition (including Composition subclass) resources besides the first. entry.tail().where(resource is Composition).empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Bundle

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle Hospital Discharge Report bundle
Constraints: bdl-ips-1
... identifier S 1..1 Identifier Persistent identifier for the bundle
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp S 1..1 instant When the bundle was assembled
... Slices for entry S 2..* 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 S 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CompositionHdrXpandh Hospital Discharge Report composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... entry:allergyintolerance 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 AllergyIntoleranceUvIps 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 ConditionUvIps, Condition Documentation of a health problem of the patient
.... entry:device 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Device A resource in the bundle
.... entry:deviceusestatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 DeviceUseStatementUvIps 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 ImmunizationUvIps Immunization event information
.... entry:media 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... entry:medication 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationIPS Definition of a Medication
.... entry:medicationrequest 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationRequestIPS Ordering of medication for patient or group
.... entry:medicationstatement 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationStatementIPS Record of medication being taken by a patient
.... entry:practitioner 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PractitionerXpandh 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 PractitionerRoleXpandh Roles/organizations the practitioner is associated with
.... entry:procedure 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ProcedureUvIps 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 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... entry:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis
.... entry:medicationDispense 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationDispense A resource in the bundle
.... entry:medicationAdministration 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 MedicationAdministration A resource in the bundle
.... entry:familyMemberHistory 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 FamilyMemberHistory A resource in the bundle
.... 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 FlagXpandh Key information to flag to healthcare providers
... 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

Id Grade Path(s) Description Expression
bdl-ips-1 error Bundle An 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-ips-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 SΣ 1..1 Identifier Persistent identifier for the bundle
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... timestamp SΣ 1..1 instant When the bundle was assembled
... total ΣC 0..1 unsignedInt If search, the total number of matches
... Slices for entry SΣC 2..* 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:composition Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionHdrXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientXpandh Information about an individual or animal receiving health care services
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 AllergyIntoleranceUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps, Condition Documentation of a health problem of the patient
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Device A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 DeviceUseStatementUvIps 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 SΣ 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MediaObservationUvIps A photo, video, or audio recording acquired or used in healthcare. The actual content may be inline or provided by direct reference
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationRequestIPS 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 MedicationStatementIPS Record of medication being taken by 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleXpandh 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:observation-pregnancy-edd Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyEddUvIps Measurements and simple assertions
.... entry:observation-pregnancy-outcome Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyOutcomeUvIps Measurements and simple assertions
.... entry:observation-pregnancy-status Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationPregnancyStatusUvIps Measurements and simple assertions
.... entry:observation-alcohol-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationAlcoholUseUvIps Measurements and simple assertions
.... entry:observation-tobacco-use Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationTobaccoUseUvIps Measurements and simple assertions
.... entry:observation-results Σ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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsUvIps Measurements and simple assertions
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationDispense A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 MedicationAdministration A resource in the bundle
.... 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 FamilyMemberHistory A resource in the bundle
.... 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 SΣ 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 SΣ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagXpandh Key information to flag to healthcare providers
... 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

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:composition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:composition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:patient.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:patient.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:allergyintolerance.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:condition.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:condition.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:device.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:device.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:deviceusestatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:diagnosticreport.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:imagingstudy.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:immunization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:media.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:media.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medication.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medication.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationrequest.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationstatement.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:practitioner.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:practitionerrole.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:procedure.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:organization.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:organization.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-edd.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-outcome.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-pregnancy-status.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-alcohol-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-tobacco-use.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationDispense.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:medicationAdministration.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:familyMemberHistory.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:documentReference.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:flag.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:flag.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.signature.type Base preferred Signature Type Codes 📍4.0.1 FHIR Std.
Bundle.signature.targetFormat Base required MimeType 📍4.0.1 FHIR Std.
Bundle.signature.sigFormat Base required MimeType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag must be a resource unless there's a request or response resource.exists() or request.exists() or response.exists()
bdl-7 error Bundle FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()
bdl-8 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:media, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation-pregnancy-edd, Bundle.entry:observation-pregnancy-outcome, Bundle.entry:observation-pregnancy-status, Bundle.entry:observation-alcohol-use, Bundle.entry:observation-tobacco-use, Bundle.entry:observation-results, Bundle.entry:specimen, Bundle.entry:medicationDispense, Bundle.entry:medicationAdministration, Bundle.entry:familyMemberHistory, Bundle.entry:documentReference, Bundle.entry:flag fullUrl cannot be a version specific reference fullUrl.contains('/_history/').not()
bdl-9 error Bundle A document must have an identifier with a system and a value type = 'document' implies (identifier.system.exists() and identifier.value.exists())
bdl-10 error Bundle A document must have a date type = 'document' implies (timestamp.hasValue())
bdl-11 error Bundle A document must have a Composition as the first resource type = 'document' implies entry.first().resource.is(Composition)
bdl-12 error Bundle A message must have a MessageHeader as the first resource type = 'message' implies entry.first().resource.is(MessageHeader)
bdl-ips-1 error Bundle An IPS document must have no additional Composition (including Composition subclass) resources besides the first. entry.tail().where(resource is Composition).empty()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Bundle

Summary

Mandatory: 6 elements(28 nested mandatory elements)
Must-Support: 4 elements
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