AU Base Composition - AU Base Implementation Guide v5.0.0

AU Base Implementation Guide
5.0.0 - Working Standard Australia flag

This page is part of the Australian Base IG (v5.0.0: R4) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: AU Base Composition

Official URL: http://hl7.org.au/fhir/StructureDefinition/au-composition		Version: 5.0.0
Standards status: Trial-use	Maturity Level: 2	Computable Name: AUBaseComposition
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.

This profile defines a composition structure that localises core concepts for use in an Australian context. The purpose of this profile is to provide national level agreement on core localised concepts. This profile does not force conformance to core localised concepts. It enables implementers and modellers to make their own rules, i.e. profiling, about how to support these concepts for specific implementation needs.

Usage Notes

Profile specific implementation guidance:

It is important to clearly differentiate between representing the extent of a system’s information for a patient versus clinical judgement of no relevant finding:
- When asserting clinical judgement that there are no items of specific interest, (e.g. no current medications, no known allergies, or no history of vaccination), Composition.section.entry with a reference to a supported FHIR resource containing the record of assertion should be sent.
  - Guidance is provided in the core FHIR specification for AllergyIntolerance and Condition, and AU Assertion of No Relevant Finding is defined in this implementation guide to support additional concepts.
- When a statement is about the nature or extent of the information the system has access to or is permitted to share, (e.g. not asked or information withheld), Composition.section.emptyReason should be sent with an appropriate code from the ListEmptyReasons value set.

Usage:

Examples for this Resource Profile: Composition/different-authors, Composition/example0 and Composition/multiple-information-recipients

Formal Views of Profile Content

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

This structure is derived from Composition

Name	Card.	Type	Description & Constraints
Composition	0..*	Composition	Composition for the Australian realm
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
informationRecipient	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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	Composition	Composition for the Australian realm dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
informationRecipient		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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	preliminary \| final \| amended \| entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	Composition editing time ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Practitioner \| PractitionerRole \| Device \| Patient \| RelatedPerson \| Organization)	Who and/or what authored the composition ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	Human Readable name/title ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.status	required	CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status\|4.0.1` from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes `http://hl7.org/fhir/ValueSet/doc-typecodes` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
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()

Description & Constraints

Composition

0..*

Composition

Composition for the Australian realm

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Composition.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Composition.status

required

CompositionStatus

http://hl7.org/fhir/ValueSet/composition-status|4.0.1

from the FHIR Standard

Composition.type

preferred

FHIRDocumentTypeCodes

http://hl7.org/fhir/ValueSet/doc-typecodes

from the FHIR Standard

Composition.category

example

DocumentClassValueSet

http://hl7.org/fhir/ValueSet/document-classcodes

from the FHIR Standard

Composition.confidentiality

required

v3.ConfidentialityClassification

http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26

from the FHIR Standard

Composition.attester.mode

required

CompositionAttestationMode

http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1

from the FHIR Standard

Composition.relatesTo.code

required

DocumentRelationshipType

http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1

from the FHIR Standard

Composition.event.code

example

ActCode

http://terminology.hl7.org/ValueSet/v3-ActCode

Composition.section.code

example

DocumentSectionCodes

http://hl7.org/fhir/ValueSet/doc-section-codes

from the FHIR Standard

Composition.section.mode

required

ListMode

http://hl7.org/fhir/ValueSet/list-mode|4.0.1

from the FHIR Standard

Composition.section.orderedBy

preferred

ListOrderCodes

http://hl7.org/fhir/ValueSet/list-order

from the FHIR Standard

Composition.section.emptyReason

preferred

ListEmptyReasons

http://hl7.org/fhir/ValueSet/list-empty-reason

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section	A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
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 Composition

Name	Card.	Type	Description & Constraints
Composition	0..*	Composition	Composition for the Australian realm
Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
informationRecipient	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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Composition		0..*	Composition	Composition for the Australian realm dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
informationRecipient		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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	preliminary \| final \| amended \| entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition. ele-1: All FHIR elements must have a @value or children
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition. ele-1: All FHIR elements must have a @value or children
date	Σ	1..1	dateTime	Composition editing time ele-1: All FHIR elements must have a @value or children
author	Σ	1..*	Reference(Practitioner \| PractitionerRole \| Device \| Patient \| RelatedPerson \| Organization)	Who and/or what authored the composition ele-1: All FHIR elements must have a @value or children
title	Σ	1..1	string	Human Readable name/title ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.status	required	CompositionStatus `http://hl7.org/fhir/ValueSet/composition-status\|4.0.1` from the FHIR Standard
Composition.type	preferred	FHIRDocumentTypeCodes `http://hl7.org/fhir/ValueSet/doc-typecodes` from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
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

Description & Constraints

Composition

0..*

Composition

Composition for the Australian realm

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

Composition.language

preferred

CommonLanguages

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

Composition.status

required

CompositionStatus

http://hl7.org/fhir/ValueSet/composition-status|4.0.1

from the FHIR Standard

Composition.type

preferred

FHIRDocumentTypeCodes

http://hl7.org/fhir/ValueSet/doc-typecodes

from the FHIR Standard

Composition.category

example

DocumentClassValueSet

http://hl7.org/fhir/ValueSet/document-classcodes

from the FHIR Standard

Composition.confidentiality

required

v3.ConfidentialityClassification

http://terminology.hl7.org/ValueSet/v3-ConfidentialityClassification|2014-03-26

from the FHIR Standard

Composition.attester.mode

required

CompositionAttestationMode

http://hl7.org/fhir/ValueSet/composition-attestation-mode|4.0.1

from the FHIR Standard

Composition.relatesTo.code

required

DocumentRelationshipType

http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1

from the FHIR Standard

Composition.event.code

example

ActCode

http://terminology.hl7.org/ValueSet/v3-ActCode

Composition.section.code

example

DocumentSectionCodes

http://hl7.org/fhir/ValueSet/doc-section-codes

from the FHIR Standard

Composition.section.mode

required

ListMode

http://hl7.org/fhir/ValueSet/list-mode|4.0.1

from the FHIR Standard

Composition.section.orderedBy

preferred

ListOrderCodes

http://hl7.org/fhir/ValueSet/list-order

from the FHIR Standard

Composition.section.emptyReason

preferred

ListEmptyReasons

http://hl7.org/fhir/ValueSet/list-empty-reason

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
cmp-1	error	Composition.section	A section must contain at least one of text, entries, or sub-sections : text.exists() or entry.exists() or section.exists()
cmp-2	error	Composition.section	A section can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
dom-2	error	Composition	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Composition	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Composition	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Composition	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Composition	A resource should have narrative for robust management : text.`div`.exists()
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 Composition

Summary

Extensions

This structure refers to these extensions:

http://hl7.org.au/fhir/StructureDefinition/information-recipient

Maturity: 2

Other representations of profile: CSV, Excel, Schematron

IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#5.0.0 based on FHIR 4.0.1. Generated 2025-01-15
Links: Table of Contents | QA Report | Version History | | Propose a change