Medtech ALEX® AU Implementation Guide
1.0.0 - Trial Use

Medtech ALEX® AU Implementation Guide - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: Bundle - IPS (AU)

Official URL: https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-ips | Version: 1.0.0
Active as of 2026-01-12 | Computable Name: AlexIps

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

An International Patient Summary (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 EN 17269 and 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.

Usages:

- Examples for this Profile: Bundle/4f5e9b70-b98f-4af6-9a65-b55a1e845169

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 | Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
entry:composition | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | 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 |  | 1..1 | Identifier | Persistent identifier for the bundle
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp | S | 1..1 | instant | When the bundle was assembled
link |  | 0..0 |  | Links related to this Bundle
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 | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
search |  | 0..0 |  | Search related information
request |  | 0..0 |  | Additional execution information (transaction/batch/history)
response |  | 0..0 |  | Results of execution (transaction/batch/history)
entry:composition | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-ips-1 | error | Bundle | An IPS document must have no additional Composition (including Composition subclass) resources besides the first. | `entry.tail().where(resource is Composition).empty()`

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 | Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
total | Σ C | 0..1 | unsignedInt | If search, the total number of matches
Slices for entry | Σ 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 0..1 | Resource | A resource in the bundle
entry:composition | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
signature | Σ | 0..1 | Signature | Digital Signature
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | 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(3 nested mandatory elements)
Must-Support: 16 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

- Composition IPS (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-composition-ips)
- Patient IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-patient-ips)
- Allergy Intolerance IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-allergyintolerance-ips)
- Condition IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-condition-ips)
- Consultation Notes IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-consultationnotes-ips)
- Device IPS profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-device-ips)
- Diagnostic Report IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-diagnosticreport-ips)
- Discharge Summary IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-dischargesummary-ips)
- Immunisation IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation-ips)
- Medication Statement IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-medicationstatement-ips)
- PractitionerRole IPS profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-practitionerrole-ips)
- Practitioner IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-practitioner-ips)
- Observation IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-observation-ips)
- Observation Inline (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-observation-inline)

Slices

This structure defines the following Slices:

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

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 | Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
entry:composition | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | 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 |  | 1..1 | Identifier | Persistent identifier for the bundle
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp | S | 1..1 | instant | When the bundle was assembled
link |  | 0..0 |  | Links related to this Bundle
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 | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
search |  | 0..0 |  | Search related information
request |  | 0..0 |  | Additional execution information (transaction/batch/history)
response |  | 0..0 |  | Results of execution (transaction/batch/history)
entry:composition | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
Documentation for this format

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-ips-1 | error | Bundle | An IPS document must have no additional Composition (including Composition subclass) resources besides the first. | `entry.tail().where(resource is Composition).empty()`

Snapshot View

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 | Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
total | Σ C | 0..1 | unsignedInt | If search, the total number of matches
Slices for entry | Σ 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 0..1 | Resource | A resource in the bundle
entry:composition | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexCompositionIps | A set of resources composed into a single coherent clinical statement with clinical attestation
entry:patient | S Σ C | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexPatientIps | A patient in an Australian healthcare context
entry:allergyintolerance | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexAllergyIntoleranceIps | An allergy or intolerance statement in an Australian healthcare context
entry:condition | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConditionIps | A condition, problem or diagnosis statement in an Australian healthcare context
entry:consultationnotes | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexConsultationNotesIps | A reference to a document
entry:device | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDeviceIps | Item used in healthcare
entry:diagnosticreport | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexDiagnosticReportIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:dischargesummary | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AlexDischargeSummaryIps | A reference to a document
entry:immunisation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexImmunisationIps | An immunisation statement in an Australian healthcare context
entry:medicationstatement | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexMedicationStatementIps | A record of medication being taken by a patient in an Australian healthcare context
entry:practitionerrole | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerRoleIps | Roles/organizations the practitioner is associated with
entry:practitioner | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexPractitionerIps | A practitioner in an Australian healthcare context
entry:observation | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationIps | Measurements and simple assertions
entry:observationinline | S Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 0..1 | AlexObservationInline | Measurements and simple assertions
signature | Σ | 0..1 | Signature | Digital Signature
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Bundle.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std.
Bundle.entry.search.​mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry.request.​method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:composition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:patient.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:allergyintolerance.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:condition.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:consultationnotes.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:device.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:diagnosticreport.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:dischargesummary.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:immunisation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:medicationstatement.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:practitionerrole.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:practitioner.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:observation.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std.
Bundle.entry:observationinline.​request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
bdl-1 | error | Bundle | total only when a search or history | `total.empty() or (type = 'searchset') or (type = 'history')`
bdl-2 | error | Bundle | entry.search only when a search | `entry.search.empty() or (type = 'searchset')`
bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited | `entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))`
bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited | `entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))`
bdl-5 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | must be a resource unless there's a request or response | `resource.exists() or request.exists() or response.exists()`
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) | `(type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct()`
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:consultationnotes, Bundle.entry:device, Bundle.entry:diagnosticreport, Bundle.entry:dischargesummary, Bundle.entry:immunisation, Bundle.entry:medicationstatement, Bundle.entry:practitionerrole, Bundle.entry:practitioner, Bundle.entry:observation, Bundle.entry:observationinline | 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(3 nested mandatory elements)
Must-Support: 16 elements
Fixed: 1 element
Prohibited: 4 elements

Structures

This structure refers to these other structures:

- Composition IPS (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-composition-ips)
- Patient IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-patient-ips)
- Allergy Intolerance IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-allergyintolerance-ips)
- Condition IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-condition-ips)
- Consultation Notes IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-consultationnotes-ips)
- Device IPS profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-device-ips)
- Diagnostic Report IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-diagnosticreport-ips)
- Discharge Summary IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-dischargesummary-ips)
- Immunisation IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-immunisation-ips)
- Medication Statement IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-medicationstatement-ips)
- PractitionerRole IPS profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-practitionerrole-ips)
- Practitioner IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-practitioner-ips)
- Observation IPS Profile (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-observation-ips)
- Observation Inline (https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-observation-inline)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron