AU Patient Summary Implementation Guide
0.2.0-preview - Preview

AU Patient Summary Implementation Guide - Local Development build (v0.2.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

## Resource Profile: AU PS Bundle

Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-bundle | Version: 0.2.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUPSBundle
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved.

This profile sets minimum expectations for a Bundle resource in the context of a patient summary in an Australian context. It is based on core FHIR Bundle, and applies the constraints of Bundle (IPS) and AU Patient Summary.

Usages:

- Examples for this Profile: Bundle/aups-basicsummary, Bundle/aups-gpvisit-retrieval, Bundle/aups-referral-endoconsult-autogen, Bundle/aups-referral-endoconsult-curated and Bundle/aups-section-emptyreason

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

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

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) Constraints: bdl-ips-1
identifier | S | 1..1 | Identifier | Persistent identifier for the bundle
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp | S | 1..1 | instant | When the bundle was assembled
Slices for entry |  | 2..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource
entry:All Slices |  |  |  | Content/Rules for all slices
fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
search |  | 0..0 |  |
request |  | 0..0 |  |
response |  | 0..0 |  |
entry:composition | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource | S | 1..1 | AUPSComposition | Patient Summary composition
entry:patient |  | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Device | A resource in the bundle
entry:deviceusestatement |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry: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:clinicalimpression |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | ClinicalImpression | A resource in the bundle
entry:careplan |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | CarePlan | A resource in the bundle
entry:consent |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Consent | A resource in the bundle
entry:documentreference |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DocumentReference | A resource in the bundle
entry:encounter |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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 | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
identifier | S Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
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 Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first 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 | S | 1..1 | AUPSComposition | 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | Device | A resource in the bundle
entry:deviceusestatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry:flag | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | FlagAlertUvIps | Key information to flag to healthcare providers
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 | S Σ | 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: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 | S Σ | 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: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 | S Σ | 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:documentreference | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | DocumentReference | A resource in the bundle
entry:encounter | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, 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 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, 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 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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:condition.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: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: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:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation.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
Bundle.entry:flag.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:careplan.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:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:encounter.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:location.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.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:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | 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() |

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) 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 | S Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
total | Σ C | 0..1 | unsignedInt | If search, the total number of matches
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 Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first 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 | S | 1..1 | AUPSComposition | 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | Device | A resource in the bundle
entry:deviceusestatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry:flag | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | FlagAlertUvIps | Key information to flag to healthcare providers
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 | S Σ | 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: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 | S Σ | 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: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 | S Σ | 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:documentreference | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | DocumentReference | A resource in the bundle
entry:encounter | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined 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 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined 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 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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: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: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: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: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: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:observation.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation.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
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: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: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: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: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:encounter.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:encounter.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:location.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:location.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.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:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | 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(25 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- AU PS Composition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-composition)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS AllergyIntolerance (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-allergyintolerance)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)
- DeviceUseStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips)
- DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)
- ImagingStudy (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips)
- AU PS Immunization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization)
- AU PS Medication (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication)
- AU PS MedicationRequest (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationrequest)
- AU PS MedicationStatement (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationstatement)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS Procedure (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-procedure)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- 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)
- AU PS Smoking Status (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-smokingstatus)
- AU PS Pathology Result Observation (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-diagnosticresult-path)
- 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)
- Specimen (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips)
- Flag - Alert (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Flag-alert-uv-ips)
- AU PS Encounter (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter)
- AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Bundle.entry

Maturity: 0

Differential View

This structure is derived from Bundle

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) Constraints: bdl-ips-1
identifier | S | 1..1 | Identifier | Persistent identifier for the bundle
type |  | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Fixed Value: document
timestamp | S | 1..1 | instant | When the bundle was assembled
Slices for entry |  | 2..* | BackboneElement | Entry resource in the patient summary bundle Slice: Unordered, Open by type:resource
entry:All Slices |  |  |  | Content/Rules for all slices
fullUrl | S | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
search |  | 0..0 |  |
request |  | 0..0 |  |
response |  | 0..0 |  |
entry:composition | S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource | S | 1..1 | AUPSComposition | Patient Summary composition
entry:patient |  | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Device | A resource in the bundle
entry:deviceusestatement |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry: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:clinicalimpression |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | ClinicalImpression | A resource in the bundle
entry:careplan |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | CarePlan | A resource in the bundle
entry:consent |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | Consent | A resource in the bundle
entry:documentreference |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | DocumentReference | A resource in the bundle
entry:encounter |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson |  | 0..* | BackboneElement | Entry in the bundle - will have a resource or information
resource |  | 1..1 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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() |

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, bdl-ips-1
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
identifier | S Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
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 Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first 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 | S | 1..1 | AUPSComposition | 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | Device | A resource in the bundle
entry:deviceusestatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry:flag | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | FlagAlertUvIps | Key information to flag to healthcare providers
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 | S Σ | 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: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 | S Σ | 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: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 | S Σ | 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:documentreference | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | DocumentReference | A resource in the bundle
entry:encounter | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, 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 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, 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 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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:condition.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: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: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:organization.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:observation.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
Bundle.entry:flag.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:careplan.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:documentreference.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:encounter.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:location.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.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:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | 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() |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Bundle | C | 0..* | Bundle | AU Patient Summary Bundle This profile also complies with the profile Bundle (IPS) 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 | S Σ | 1..1 | Identifier | Persistent identifier for the bundle
type | Σ | 1..1 | code | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection Binding: BundleType (required): Indicates the purpose of a bundle - how it is intended to be used. Fixed Value: document
timestamp | S Σ | 1..1 | instant | When the bundle was assembled
total | Σ C | 0..1 | unsignedInt | If search, the total number of matches
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 Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first 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 | S | 1..1 | AUPSComposition | 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 | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPatient | A patient in the context of electronic exchange of health information
entry:allergyintolerance | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSAllergyIntolerance | An allergy or intolerance statement in an Australian healthcare context
entry:condition | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSCondition | A condition, problem or diagnosis statement in an Australian healthcare context
entry:device | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | Device | A resource in the bundle
entry:deviceusestatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DeviceUseStatementUvIps | Record of use of a device
entry:diagnosticreport | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | DiagnosticReportUvIps | A Diagnostic report - a combination of request information, atomic results, images, interpretation, as well as formatted reports
entry:imagingstudy | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | ImagingStudyUvIps | A set of images produced in single study (one or more series of references images)
entry:immunization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSImmunization | An immunisation statement in an Australian healthcare context
entry:medication | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedication | A medication in an Australian healthcare context
entry:medicationrequest | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationRequest | A request for a medication for a patient in an Australian healthcare context
entry:medicationstatement | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSMedicationStatement | A record of medication being taken by a patient in an Australian healthcare context
entry:practitioner | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitioner | A person with a formal responsibility in the provisioning of services
entry:practitionerrole | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSPractitionerRole | A person with formal responsibility in a role providing one or more services
entry:procedure | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSProcedure | A procedure in an Australian healthcare context
entry:organization | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUPSOrganization | An organisation in an Australian healthcare context
entry:observation | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | Observation, ObservationPregnancyEddUvIps, ObservationPregnancyOutcomeUvIps, ObservationPregnancyStatusUvIps, ObservationAlcoholUseUvIps, AUPSSmokingStatus, AUPSPathologyResult, ObservationResultsRadiologyUvIps, observation-vitalsigns | Measurements and simple assertions
entry:specimen | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | SpecimenUvIps | Sample for analysis
entry:flag | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | FlagAlertUvIps | Key information to flag to healthcare providers
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 | S Σ | 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: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 | S Σ | 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: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 | S Σ | 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:documentreference | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource | Σ | 1..1 | DocumentReference | A resource in the bundle
entry:encounter | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined 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 | AUPSEncounter | An encounter in an Australian healthcare context
entry:location | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
link | Σ | 0..* | See link (Bundle) | Links related to this entry
fullUrl | S Σ | 1..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID)
resource |  | 1..1 | AUCoreLocation | A location in an Australian healthcare context
entry:relatedperson | Σ C | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined 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 | AUPSRelatedPerson | A person related to a patient in an Australian healthcare context
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: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: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: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: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: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:observation.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:observation.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
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: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: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: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: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:encounter.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:encounter.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:location.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:location.request.method | required | HTTPVerb `http://hl7.org/fhir/ValueSet/http-verb|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.search.mode | required | SearchEntryMode `http://hl7.org/fhir/ValueSet/search-entry-mode|4.0.1` From the FHIR Standard
Bundle.entry:relatedperson.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:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | must be a resource unless there's a request or response : resource.exists() or request.exists() or response.exists() |
bdl-7 | error | Bundle | FullUrl must be unique in a bundle, or else entries with the same fullUrl must have different meta.versionId (except in history bundles) : (type = 'history') or entry.where(fullUrl.exists()).select(fullUrl&resource.meta.versionId).isDistinct() |
bdl-8 | error | Bundle.entry, Bundle.entry:composition, Bundle.entry:patient, Bundle.entry:allergyintolerance, Bundle.entry:condition, Bundle.entry:device, Bundle.entry:deviceusestatement, Bundle.entry:diagnosticreport, Bundle.entry:imagingstudy, Bundle.entry:immunization, Bundle.entry:medication, Bundle.entry:medicationrequest, Bundle.entry:medicationstatement, Bundle.entry:practitioner, Bundle.entry:practitionerrole, Bundle.entry:procedure, Bundle.entry:organization, Bundle.entry:observation, Bundle.entry:specimen, Bundle.entry:flag, Bundle.entry:clinicalimpression, Bundle.entry:careplan, Bundle.entry:consent, Bundle.entry:documentreference, Bundle.entry:encounter, Bundle.entry:location, Bundle.entry:relatedperson | 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(25 nested mandatory elements)
Must-Support: 5 elements
Fixed: 1 element
Prohibited: 3 elements

Structures

This structure refers to these other structures:

- AU PS Composition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-composition)
- AU PS Patient (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-patient)
- AU PS AllergyIntolerance (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-allergyintolerance)
- AU PS Condition (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-condition)
- DeviceUseStatement (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DeviceUseStatement-uv-ips)
- DiagnosticReport (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/DiagnosticReport-uv-ips)
- ImagingStudy (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/ImagingStudy-uv-ips)
- AU PS Immunization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-immunization)
- AU PS Medication (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication)
- AU PS MedicationRequest (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationrequest)
- AU PS MedicationStatement (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medicationstatement)
- AU PS Practitioner (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitioner)
- AU PS PractitionerRole (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-practitionerrole)
- AU PS Procedure (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-procedure)
- AU PS Organization (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-organization)
- 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)
- AU PS Smoking Status (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-smokingstatus)
- AU PS Pathology Result Observation (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-diagnosticresult-path)
- 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)
- Specimen (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips)
- Flag - Alert (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Flag-alert-uv-ips)
- AU PS Encounter (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-encounter)
- AU Core Location (http://hl7.org.au/fhir/core/StructureDefinition/au-core-location)
- AU PS RelatedPerson (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-relatedperson)

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Bundle.entry

Maturity: 0

Other representations of profile: CSV, Excel, Schematron