Australian Base Implementation Guide (AU Base 1.1.1)
This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions 
AU Composition [FMM Level 2]
This profile defines a composition structure that includes core localisation concepts for use in an Australian context.
When capturing a composition practitioner role as the sole author of the composition, a practitioner linked to that practitioner role is required to be supplied as a composition author. Where there is more than one author this is not necessary or recommended.
Where practicable it is preferred that the assertion of clinical judgement that there are no known items for this list is handled via an entry with the appropriate negation code over making use of section emptyReason. For example the instantiation of an AllergyIntolerance with code that is a child of 716186003 |No known allergy| from SNOMED CT[1].
Extensions used in this profile:
Examples
Composition with multiple information recipients and one author role
Composition with some sections having a different section author to the composition author
Patient’s preference upon death
The official URL for this profile is:
http://hl7.org.au/fhir/StructureDefinition/au-composition
This profile defines a composition structure that includes core localisation concepts for use in an Australian context.
This profile builds on Composition.
This profile was published on Wed Jan 22 10:17:54 AEDT 2020 as a draft by Health Level Seven Australia (Patient Administration WG).
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Composition | I | 0..* | Composition | Composition for the Australian realm |
  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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 composition-author-role | I | 0..* | Reference(PractitionerRole) | Practitioner role that authored the composition URL: http://hl7.org.au/fhir/StructureDefinition/composition-author-role |
| information-recipient | I | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Who and/or what should receive a copy of the composition URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
 subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | Device | Patient | RelatedPerson) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition inv-com-0: Related party and party shall not coexist |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| attester-related-party | I | 0..1 | Reference(RelatedPerson) | Related person that attested the composition URL: http://hl7.org.au/fhir/StructureDefinition/attester-related-party |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
 party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
 target[x] | Σ | 1..1 | Target of the relationship | |
 targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 0..* | BackboneElement | Composition is broken into sections |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| section-author | I | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Who and/or what authored the section URL: http://hl7.org.au/fhir/StructureDefinition/section-author |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
 section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Composition | I | 0..* | Composition | Composition for the Australian realm |
| 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| composition-author-role | I | 0..* | Reference(PractitionerRole) | Practitioner role that authored the composition URL: http://hl7.org.au/fhir/StructureDefinition/composition-author-role |
| information-recipient | I | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Who and/or what should receive a copy of the composition URL: http://hl7.org.au/fhir/StructureDefinition/information-recipient |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Logical identifier of composition (version-independent) |
| status | ?!Σ | 1..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required) |
| type | Σ | 1..1 | CodeableConcept | Kind of composition (LOINC if possible) Binding: FHIR Document Type Codes (preferred) |
| class | Σ | 0..1 | CodeableConcept | Categorization of Composition Binding: FHIR Document Class Codes (example) |
| subject | Σ | 1..1 | Reference(Resource) | Who and/or what the composition is about |
| encounter | Σ | 0..1 | Reference(Encounter) | Context of the Composition |
| date | Σ | 1..1 | dateTime | Composition editing time |
| author | Σ | 1..* | Reference(Practitioner | Device | Patient | RelatedPerson) | Who and/or what authored the composition |
| title | Σ | 1..1 | string | Human Readable name/title |
| confidentiality | ?!Σ | 0..1 | code | As defined by affinity domain Binding: ConfidentialityClassification (required) |
| attester | ΣI | 0..* | BackboneElement | Attests to accuracy of composition inv-com-0: Related party and party shall not coexist |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| attester-related-party | I | 0..1 | Reference(RelatedPerson) | Related person that attested the composition URL: http://hl7.org.au/fhir/StructureDefinition/attester-related-party |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| mode | Σ | 1..* | code | personal | professional | legal | official Binding: CompositionAttestationMode (required) |
| time | Σ | 0..1 | dateTime | When the composition was attested |
| party | Σ | 0..1 | Reference(Patient | Practitioner | Organization) | Who attested the composition |
| custodian | Σ | 0..1 | Reference(Organization) | Organization which maintains the composition |
| relatesTo | ΣI | 0..* | BackboneElement | Relationships to other compositions/documents |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required) |
| target[x] | Σ | 1..1 | Target of the relationship | |
| targetIdentifier | Identifier | |||
| targetReference | Reference(Composition) | |||
| event | ΣI | 0..* | BackboneElement | The clinical service(s) being documented |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| code | Σ | 0..* | CodeableConcept | Code(s) that apply to the event being documented Binding: ActCode (example) |
| period | Σ | 0..1 | Period | The period covered by the documentation |
| detail | Σ | 0..* | Reference(Resource) | The event(s) being documented |
| section | I | 0..* | BackboneElement | Composition is broken into sections |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| section-author | I | 0..* | Reference(Practitioner | Device | Patient | RelatedPerson | PractitionerRole | Organization) | Who and/or what authored the section URL: http://hl7.org.au/fhir/StructureDefinition/section-author |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| title | 0..1 | string | Label for section (e.g. for ToC) | |
| code | 0..1 | CodeableConcept | Classification of section (recommended) Binding: Document Section Codes (example) | |
| text | I | 0..1 | Narrative | Text summary of the section, for human interpretation |
| mode | ?!Σ | 0..1 | code | working | snapshot | changes Binding: ListMode (required) |
| orderedBy | 0..1 | CodeableConcept | Order of section entries Binding: List Order Codes (preferred) | |
| entry | I | 0..* | Reference(Resource) | A reference to data that supports this section |
| emptyReason | I | 0..1 | CodeableConcept | Why the section is empty Binding: List Empty Reasons (preferred) |
| section | I | 0..* | Unknown reference to #Composition.section Nested Section | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-composition
none defined
© AU Base 1.1.1 on FHIR STU3 (IG Publisher v3.0.2-11200) generated on Wed, Jan 22, 2020 10:17+1100. |
