International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

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

Resource Profile: Bundle (IPS)

Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Bundle-uv-ips Version: 2.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: BundleUvIps

This profile represents the constraints applied to the Bundle resource by the International Patient Summary (IPS) FHIR Implementation Guide.

An IPS bundle is an electronic health record extract containing essential healthcare information about a subject of care, comprising at least the required elements of the IPS dataset. The IPS dataset is minimal and non-exhaustive; specialty-agnostic and condition-independent; but still clinically relevant. As specified in ISO 27269, it is designed for supporting the use case scenario for ‘unplanned, cross border care’, but it is not limited to it. It is intended to be international, i.e., to provide generic solutions for global application beyond a particular region or country.

While this Bundle profile lists many resources which may be included in an IPS document, specific requirements, expectations and obligations are described in the IPS Composition profile. Therefore, the only entry obligation shown below is on the IPS Composition, which must be the first entry as explained in the FHIR Documents.

Usages:

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 International Patient Summary 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 SOΣ 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... Slices for entry ΣC 2..* BackboneElement Entry resource in the patient summary bundle
Slice: Unordered, Open by type:resource, profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... entry:composition SOΣ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
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientUvIps 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 Σ 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:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Consent A resource in the bundle
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 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 Σ 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 Σ 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:documentreference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 DocumentReference A resource in the bundle
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagAlertUvIps Key information to flag to healthcare providers
.... entry:imagingstudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... entry:immunizationrecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ImmunizationRecommendation A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 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 Σ 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 Σ 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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerrole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleUvIps Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps An action that is being or was performed on a patient
.... 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 Σ 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 Σ 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 Σ 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 Σ 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 Σ 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-laboratory-pathology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis

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:careplan.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​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:consent.​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: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.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:immunizationrecommendation.​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: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-laboratory-pathology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​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:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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 International Patient Summary Bundle
Constraints: bdl-ips-1
... identifier SO 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp SO 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
.... entry:All Slices Content/Rules for all slices
..... fullUrl 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition SO 1..1 BackboneElement Entry in the bundle - will have a resource or information
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientUvIps 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:careplan 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ClinicalImpression A resource in the bundle
.... entry:condition 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Consent A resource in the bundle
.... 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: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 FlagAlertUvIps Key information to flag to healthcare providers
.... 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:immunizationrecommendation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationRecommendation A resource in the bundle
.... 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 PractitionerUvIps 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 PractitionerRoleUvIps 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: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-laboratory-pathology 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... 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:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis

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 International Patient Summary 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 SOΣ 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... 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 SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 2..* BackboneElement Entry resource in the patient summary bundle
Slice: Unordered, Open by type:resource, profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:composition SOΣ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
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientUvIps 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 Σ 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:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Consent A resource in the bundle
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 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 Σ 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 Σ 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:documentreference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 DocumentReference A resource in the bundle
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagAlertUvIps Key information to flag to healthcare providers
.... entry:imagingstudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... entry:immunizationrecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ImmunizationRecommendation A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 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 Σ 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 Σ 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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerrole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleUvIps Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps An action that is being or was performed on a patient
.... 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 Σ 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 Σ 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 Σ 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 Σ 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 Σ 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-laboratory-pathology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry: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:careplan.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:careplan.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​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:consent.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:consent.​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: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.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:immunizationrecommendation.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:immunizationrecommendation.​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: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-laboratory-pathology.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​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:specimen.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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(30 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 3 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

Maturity: 3

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Bundle C 0..* Bundle International Patient Summary 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 SOΣ 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... type Σ 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used.
Fixed Value: document
... Slices for entry ΣC 2..* BackboneElement Entry resource in the patient summary bundle
Slice: Unordered, Open by type:resource, profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
.... entry:composition SOΣ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
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientUvIps 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 Σ 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:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Consent A resource in the bundle
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 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 Σ 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 Σ 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:documentreference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 DocumentReference A resource in the bundle
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagAlertUvIps Key information to flag to healthcare providers
.... entry:imagingstudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... entry:immunizationrecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ImmunizationRecommendation A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 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 Σ 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 Σ 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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerrole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleUvIps Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps An action that is being or was performed on a patient
.... 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 Σ 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 Σ 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 Σ 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 Σ 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 Σ 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-laboratory-pathology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis

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:careplan.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​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:consent.​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: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.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:immunizationrecommendation.​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: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-laboratory-pathology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​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:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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 International Patient Summary Bundle
Constraints: bdl-ips-1
... identifier SO 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... type 1..1 code document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection
Fixed Value: document
... timestamp SO 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
.... entry:All Slices Content/Rules for all slices
..... fullUrl 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... search 0..0
..... request 0..0
..... response 0..0
.... entry:composition SO 1..1 BackboneElement Entry in the bundle - will have a resource or information
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient 1..1 BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 PatientUvIps 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:careplan 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ClinicalImpression A resource in the bundle
.... entry:condition 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 Consent A resource in the bundle
.... 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: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 FlagAlertUvIps Key information to flag to healthcare providers
.... 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:immunizationrecommendation 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ImmunizationRecommendation A resource in the bundle
.... 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 PractitionerUvIps 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 PractitionerRoleUvIps 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: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-laboratory-pathology 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... 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:specimen 0..* BackboneElement Entry in the bundle - will have a resource or information
..... resource 1..1 SpecimenUvIps Sample for analysis

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 International Patient Summary 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 SOΣ 1..1 Identifier Persistent identifier for the bundle
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... 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 SOΣ 1..1 instant When the bundle was assembled
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
... total ΣC 0..1 unsignedInt If search, the total number of matches
... link Σ 0..* BackboneElement Links related to this Bundle
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relation Σ 1..1 string See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1
.... url Σ 1..1 uri Reference details for the link
... Slices for entry ΣC 2..* BackboneElement Entry resource in the patient summary bundle
Slice: Unordered, Open by type:resource, profile:resource
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
.... entry:All Slices Content/Rules for all slices
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 0..1 Resource A resource in the bundle
.... entry:composition SOΣ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
ObligationsActor
SHALL:populate Creator (IPS)
SHALL:handle Consumer (IPS)
SHOULD:display Consumer (IPS)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 CompositionUvIps International Patient Summary composition
.... entry:patient ΣC 1..1 BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PatientUvIps 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 Σ 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:careplan ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 CarePlan A resource in the bundle
.... entry:clinicalimpression ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ClinicalImpression A resource in the bundle
.... entry:condition ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ConditionUvIps Documentation of a health problem of the patient
.... entry:consent ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 Consent A resource in the bundle
.... entry:device ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 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 Σ 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 Σ 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:documentreference ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 DocumentReference A resource in the bundle
.... entry:flag ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 FlagAlertUvIps Key information to flag to healthcare providers
.... entry:imagingstudy ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImagingStudyUvIps A set of images produced in single study (one or more series of references images)
.... entry:immunization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ImmunizationUvIps Immunization event information
.... entry:immunizationrecommendation ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource Σ 1..1 ImmunizationRecommendation A resource in the bundle
.... entry:medication ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 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 Σ 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 Σ 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 Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerUvIps A person with a formal responsibility in the provisioning of healthcare or related services
.... entry:practitionerrole ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 PractitionerRoleUvIps Roles/organizations the practitioner is associated with
.... entry:procedure ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ProcedureUvIps An action that is being or was performed on a patient
.... 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 Σ 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 Σ 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 Σ 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 Σ 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 Σ 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-laboratory-pathology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsLaboratoryPathologyUvIps Laboratory (including Pathology) result for a simple test or for a panel/study
.... entry:observation-results-radiology ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 ObservationResultsRadiologyUvIps Measurements and simple assertions
.... entry:observation-vital-signs ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 observation-vitalsigns FHIR Vital Signs Profile
.... entry:organization ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 OrganizationUvIps A grouping of people or organizations with a common purpose
.... entry:specimen ΣC 0..* BackboneElement Entry in the bundle - will have a resource or information
Constraints: bdl-5, bdl-8
This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... link Σ 0..* See link (Bundle) Links related to this entry
..... fullUrl Σ 1..1 uri URI for resource (Absolute URL server address or URI for UUID/OID)
..... resource 1..1 SpecimenUvIps Sample for analysis
... signature Σ 0..1 Signature Digital Signature

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Bundle.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Bundle.type Base required BundleType 📍4.0.1 FHIR Std.
Bundle.entry.search.​mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry.request.​method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry: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:careplan.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:careplan.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:clinicalimpression.​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:consent.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:consent.​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: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.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:immunizationrecommendation.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:immunizationrecommendation.​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: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-laboratory-pathology.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-laboratory-pathology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-results-radiology.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:observation-vital-signs.​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:specimen.​search.mode Base required SearchEntryMode 📍4.0.1 FHIR Std.
Bundle.entry:specimen.​request.method Base required HTTPVerb 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
bdl-1 error Bundle total only when a search or history total.empty() or (type = 'searchset') or (type = 'history')
bdl-2 error Bundle entry.search only when a search entry.search.empty() or (type = 'searchset')
bdl-3 error Bundle entry.request mandatory for batch/transaction/history, otherwise prohibited entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
bdl-4 error Bundle entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
bdl-5 error Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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:careplan, Bundle.entry:clinicalimpression, Bundle.entry:condition, Bundle.entry:consent, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:documentreference, Bundle.entry:flag, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:immunizationrecommendation, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, 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-laboratory-pathology, Bundle.entry:observation-results-radiology, Bundle.entry:observation-vital-signs, Bundle.entry:organization, Bundle.entry:specimen 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(30 nested mandatory elements)
Must-Support: 3 elements
Fixed: 1 element
Prohibited: 3 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

Maturity: 3

 

Other representations of profile: CSV, Excel, Schematron