International Patient Summary Implementation Guide
2.0.0 - STU 2

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. 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: 2 | 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:

- Examples for this Profile: Bundle/IPS-examples-Bundle-01, Bundle/IPS-examples-Bundle-with-immunization, Bundle/bundle-ips-all-sections, Bundle/bundle-minimal and Bundle/bundle-no-info-required-sections
- CapabilityStatements using this Profile: IPS Server Capability Statement

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Bundle.type | required | Fixed Value: document `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` From the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:composition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:patient.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:careplan.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:condition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:consent.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:device.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:flag.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medication.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:procedure.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:specimen.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | International Patient Summary Bundle Constraints: bdl-ips-1
identifier | SO | 1..1 | Identifier | Persistent identifier for the bundle
Obligations | Actor
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
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for entry |  | 2..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource
entry:All Slices |  |  |  | Content/Rules for all slices
fullUrl |  | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
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
Obligations | Actor
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
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
identifier | SO Σ | 1..1 | Identifier | Persistent identifier for the bundle
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Bundle.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Bundle.type | required | Fixed Value: document `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` From the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:composition.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:composition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:patient.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:patient.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:careplan.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:careplan.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:condition.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:condition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:consent.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:consent.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:device.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:device.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:flag.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:flag.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunization.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:immunization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medication.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medication.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:procedure.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:procedure.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:organization.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:specimen.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:specimen.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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:

- Composition (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)
- AllergyIntolerance (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips)
- Condition (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Condition-uv-ips)
- DeviceUseStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips)
- DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)
- Flag - Alert (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Flag-alert-uv-ips)
- ImagingStudy (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips)
- Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips)
- Medication (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips)
- MedicationRequest (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/MedicationRequest-uv-ips)
- MedicationStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/MedicationStatement-uv-ips)
- Practitioner (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Practitioner-uv-ips)
- PractitionerRole (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/PractitionerRole-uv-ips)
- Procedure (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Procedure-uv-ips)
- Observation Pregnancy - Expected Delivery Date (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-edd-uv-ips)
- Observation Pregnancy - Outcome (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-outcome-uv-ips)
- Observation Pregnancy - Status (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)
- Observation Social History - Alcohol Use (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-alcoholuse-uv-ips)
- Observation Social History - Tobacco Use (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-tobaccouse-uv-ips)
- Observation Results - Laboratory/Pathology (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-laboratory-pathology-uv-ips)
- Observation Results - Radiology (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-radiology-uv-ips)
- Vital Signs Profile (http://hl7.org/fhir/StructureDefinition/vitalsigns)
- Organization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Organization-uv-ips)
- Specimen (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips)

Slices

This structure defines the following Slices:

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

Maturity: 2

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
Obligations | Actor
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
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Bundle.type | required | Fixed Value: document `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` From the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:composition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:patient.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:careplan.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:condition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:consent.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:device.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:flag.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medication.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:procedure.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:specimen.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | International Patient Summary Bundle Constraints: bdl-ips-1
identifier | SO | 1..1 | Identifier | Persistent identifier for the bundle
Obligations | Actor
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
Obligations | Actor
SHALL:populate | Creator (IPS)
SHALL:handle | Consumer (IPS)
Slices for entry |  | 2..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource, profile:resource
entry:All Slices |  |  |  | Content/Rules for all slices
fullUrl |  | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
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
Obligations | Actor
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
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
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
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
identifier | SO Σ | 1..1 | Identifier | Persistent identifier for the bundle
Obligations | Actor
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
Obligations | Actor
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
Obligations | Actor
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
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code | URI
Bundle.language | preferred | CommonLanguages `http://hl7.org/fhir/ValueSet/languages` From the FHIR Standard
Additional Bindings | Purpose
AllLanguages | Max Binding
Bundle.type | required | Fixed Value: document `http://hl7.org/fhir/ValueSet/bundle-type|4.0.1` From the FHIR Standard
Bundle.entry.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:composition.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:composition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:patient.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:patient.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:allergyintolerance.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:careplan.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:careplan.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:clinicalimpression.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:condition.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:condition.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:consent.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:consent.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:device.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:device.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:deviceusestatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:diagnosticreport.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:flag.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:flag.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:imagingstudy.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunization.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:immunization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:immunizationrecommendation.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medication.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medication.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medicationrequest.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:medicationstatement.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:practitioner.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:practitionerrole.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:procedure.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:procedure.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-edd.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-outcome.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-pregnancy-status.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-alcohol-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-tobacco-use.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-laboratory-pathology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-results-radiology.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation-vital-signs.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:organization.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:specimen.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:specimen.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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:

- Composition (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Composition-uv-ips)
- Patient (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Patient-uv-ips)
- AllergyIntolerance (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/AllergyIntolerance-uv-ips)
- Condition (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Condition-uv-ips)
- DeviceUseStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips)
- DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)
- Flag - Alert (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Flag-alert-uv-ips)
- ImagingStudy (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips)
- Immunization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Immunization-uv-ips)
- Medication (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips)
- MedicationRequest (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/MedicationRequest-uv-ips)
- MedicationStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/MedicationStatement-uv-ips)
- Practitioner (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Practitioner-uv-ips)
- PractitionerRole (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/PractitionerRole-uv-ips)
- Procedure (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Procedure-uv-ips)
- Observation Pregnancy - Expected Delivery Date (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-edd-uv-ips)
- Observation Pregnancy - Outcome (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-outcome-uv-ips)
- Observation Pregnancy - Status (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-pregnancy-status-uv-ips)
- Observation Social History - Alcohol Use (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-alcoholuse-uv-ips)
- Observation Social History - Tobacco Use (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-tobaccouse-uv-ips)
- Observation Results - Laboratory/Pathology (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-laboratory-pathology-uv-ips)
- Observation Results - Radiology (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Observation-results-radiology-uv-ips)
- Vital Signs Profile (http://hl7.org/fhir/StructureDefinition/vitalsigns)
- Organization (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Organization-uv-ips)
- Specimen (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips)

Slices

This structure defines the following Slices:

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

Maturity: 2

Other representations of profile: CSV, Excel, Schematron