Aged Care Clinical Note - Local Development build (v0.1.0-preview) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/cn/StructureDefinition/au-aged-care-clin-note-bundle | Version: 0.1.0-preview | |||
| Standards status: Draft | Maturity Level: 0 | Computable Name: AUAgedCareClinNoteBundle | ||
Usage:Jurisdiction: Australia |
||||
Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
This profile specialises the FHIR Clinical Document Bundle for the purposes of the Aged Care Clinical Note in Australia.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, clindoc-timestamp-ge-compoDate |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
Σ | 1..1 | string | Identifier system+value must be globally unique Example General: 123456 |
![]() ![]() |
Σ | 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. Required Pattern: document |
![]() ![]() |
SΣ | 1..1 | instant | When the bundle was assembled |
![]() ![]() |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:$this.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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | First entry is a composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note 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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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)
|
| clindoc-timestamp-ge-compoDate | error | Bundle | For a FHIR Clinical Document the Bundle timestamp must be the same or after the Composition date |
timestamp >= entry.first().resource.date
|
| 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 ClinicalDocumentBundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle | |
![]() ![]() |
S | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() |
S | 1..1 | instant | When the bundle was assembled |
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | First entry is a composition | |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note Composition | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, clindoc-timestamp-ge-compoDate | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Identifier system+value must be globally unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 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. Required Pattern: document | ||||
![]() ![]() |
SΣ | 1..1 | instant | When the bundle was assembled | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:$this.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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | First entry is a composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note 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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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)
|
| clindoc-timestamp-ge-compoDate | error | Bundle | For a FHIR Clinical Document the Bundle timestamp must be the same or after the Composition date |
timestamp >= entry.first().resource.date
|
| 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 ClinicalDocumentBundle
Summary
Mandatory: 1 element
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, clindoc-timestamp-ge-compoDate |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() |
Σ | 1..1 | string | Identifier system+value must be globally unique Example General: 123456 |
![]() ![]() |
Σ | 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. Required Pattern: document |
![]() ![]() |
SΣ | 1..1 | instant | When the bundle was assembled |
![]() ![]() |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:$this.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 |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle |
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | First entry is a composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note 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 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement |
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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)
|
| clindoc-timestamp-ge-compoDate | error | Bundle | For a FHIR Clinical Document the Bundle timestamp must be the same or after the Composition date |
timestamp >= entry.first().resource.date
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from ClinicalDocumentBundle
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle | |
![]() ![]() |
S | 1..1 | Identifier | Persistent identifier for the bundle |
![]() ![]() |
S | 1..1 | instant | When the bundle was assembled |
![]() ![]() |
2..* | BackboneElement | Entry in the bundle - will have a resource or information | |
![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() |
1..1 | BackboneElement | First entry is a composition | |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note Composition | |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement | |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Entry in the bundle - will have a resource or information |
![]() ![]() ![]() ![]() |
1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ClinicalDocumentBundle | Australian Aged Care Clinical Note document Bundle Constraints: bdl-1, bdl-2, bdl-3, bdl-4, bdl-7, bdl-9, bdl-10, bdl-11, bdl-12, clindoc-timestamp-ge-compoDate | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
SΣ | 1..1 | Identifier | Persistent identifier for the bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | Identifier system+value must be globally unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
Σ | 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. Required Pattern: document | ||||
![]() ![]() |
SΣ | 1..1 | instant | When the bundle was assembled | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | Links related to this Bundle | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | string | See http://www.iana.org/assignments/link-relations/link-relations.xhtml#link-relations-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | uri | Reference details for the link | ||||
![]() ![]() |
SΣC | 2..* | BackboneElement | Entry in the bundle - will have a resource or information Slice: Unordered, Open by type:$this.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 | ||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Resource | A resource in the bundle | ||||
![]() ![]() ![]() |
SΣC | 1..1 | BackboneElement | First entry is a composition Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteComposition | Australian Aged Care Clinical Note 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 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePatient | Australian Aged Care Clinical Note Patient | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteOrganization, AUAgedCareClinNoteDepartment | Australian Aged Care Clinical Note Organization | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitionerRole | Australian Aged Care Clinical Note PractitionerRole | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNotePractitioner | Australian Aged Care Clinical Note Practitioner | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteDocumentReference | Australian Aged Care Clinical Note DocumentReference | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedication | Australian Aged Care Clinical Note Medication | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUAgedCareClinNoteMedicationStatement | Australian Aged Care Clinical Note MedicationStatement | ||||
![]() ![]() ![]() |
SΣC | 0..* | BackboneElement | Entry in the bundle - will have a resource or information Constraints: bdl-5, bdl-8 This repeating element order: For bundles of type 'document' and 'message', the first resource is special (must be Composition or MessageHeader respectively). For all bundles, the meaning of the order of entries depends on the bundle type | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | See link (Bundle) | Links related to this entry | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | URI for resource (Absolute URL server address or URI for UUID/OID) | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | AUCoreMedicationRequest | A request for a medication for a patient in an Australian healthcare context | ||||
![]() ![]() |
Σ | 0..1 | Signature | Digital Signature | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Bundle.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Bundle.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std. |
| Bundle.identifier.type | Base | extensible | IdentifierType | 📦4.0.1 | FHIR Std. |
| Bundle.type | Base | required | BundleType | 📍4.0.1 | FHIR Std. |
| Bundle.entry.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:clinical-document-composition.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:patient.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:organization.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitionerRole.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:practitioner.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:documentReference.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medication.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationStatement.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.search.mode | Base | required | SearchEntryMode | 📍4.0.1 | FHIR Std. |
| Bundle.entry:medicationRequest.request.method | Base | required | HTTPVerb | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| bdl-1 | error | Bundle | total only when a search or history |
total.empty() or (type = 'searchset') or (type = 'history')
|
| bdl-2 | error | Bundle | entry.search only when a search |
entry.search.empty() or (type = 'searchset')
|
| bdl-3 | error | Bundle | entry.request mandatory for batch/transaction/history, otherwise prohibited |
entry.all(request.exists() = (%resource.type = 'batch' or %resource.type = 'transaction' or %resource.type = 'history'))
|
| bdl-4 | error | Bundle | entry.response mandatory for batch-response/transaction-response/history, otherwise prohibited |
entry.all(response.exists() = (%resource.type = 'batch-response' or %resource.type = 'transaction-response' or %resource.type = 'history'))
|
| bdl-5 | error | Bundle.entry, Bundle.entry:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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:clinical-document-composition, Bundle.entry:patient, Bundle.entry:organization, Bundle.entry:practitionerRole, Bundle.entry:practitioner, Bundle.entry:documentReference, Bundle.entry:medication, Bundle.entry:medicationStatement, Bundle.entry:medicationRequest | 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)
|
| clindoc-timestamp-ge-compoDate | error | Bundle | For a FHIR Clinical Document the Bundle timestamp must be the same or after the Composition date |
timestamp >= entry.first().resource.date
|
| 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 ClinicalDocumentBundle
Summary
Mandatory: 1 element
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron