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.

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

This structure is derived from Composition

Name	Flags	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
date	Σ	1..1	dateTime	Composition editing time
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition
title	Σ	1..1	string	Human Readable name/title
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()

Name	Flags	Card.	Type	Description & Constraints
Composition		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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Version-independent identifier for the Composition
status	?!Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
category	Σ	0..*	CodeableConcept	Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
subject	Σ	0..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 | PractitionerRole | Device | Patient | RelatedPerson | Organization)	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: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
attester		0..*	BackboneElement	Attests to accuracy of composition
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	code	personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
time		0..1	dateTime	When the composition was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the composition
custodian	Σ	0..1	Reference(Organization)	Organization which maintains the composition
relatesTo		0..*	BackboneElement	Relationships to other compositions/documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target[x]		1..1		Target of the relationship
targetIdentifier			Identifier
targetReference			Reference(Composition)
event	Σ	0..*	BackboneElement	The clinical service(s) being documented
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..*	CodeableConcept	Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	Σ	0..1	Period	The period covered by the documentation
detail	Σ	0..*	Reference(Resource)	The event(s) being documented
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
title		0..1	string	Label for section (e.g. for ToC)
code		0..1	CodeableConcept	Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
author		0..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the section
focus		0..1	Reference(Resource)	Who/what the section is about, when it is not about the subject of composition
text	C	0..1	Narrative	Text summary of the section, for human interpretation
mode		0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
orderedBy		0..1	CodeableConcept	Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
section	C	0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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	Flags	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
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
date	Σ	1..1	dateTime	Composition editing time
author	Σ	1..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the composition
title	Σ	1..1	string	Human Readable name/title
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

Name	Flags	Card.	Type	Description & Constraints
Composition		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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
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
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..1	Identifier	Version-independent identifier for the Composition
status	?!Σ	1..1	code	preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): The workflow/clinical status of the composition.
type	Σ	1..1	CodeableConcept	Kind of composition (LOINC if possible) Binding: FHIRDocumentTypeCodes (preferred): Type of a composition.
category	Σ	0..*	CodeableConcept	Categorization of Composition Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.
subject	Σ	0..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 | PractitionerRole | Device | Patient | RelatedPerson | Organization)	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: v3.ConfidentialityClassification (2014-03-26) (required): Codes specifying the level of confidentiality of the composition.
attester		0..*	BackboneElement	Attests to accuracy of composition
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
mode		1..1	code	personal | professional | legal | official Binding: CompositionAttestationMode (required): The way in which a person authenticated a composition.
time		0..1	dateTime	When the composition was attested
party		0..1	Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization)	Who attested the composition
custodian	Σ	0..1	Reference(Organization)	Organization which maintains the composition
relatesTo		0..*	BackboneElement	Relationships to other compositions/documents
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents.
target[x]		1..1		Target of the relationship
targetIdentifier			Identifier
targetReference			Reference(Composition)
event	Σ	0..*	BackboneElement	The clinical service(s) being documented
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	Σ	0..*	CodeableConcept	Code(s) that apply to the event being documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.
period	Σ	0..1	Period	The period covered by the documentation
detail	Σ	0..*	Reference(Resource)	The event(s) being documented
section	C	0..*	BackboneElement	Composition is broken into sections cmp-1: A section must contain at least one of text, entries, or sub-sections cmp-2: A section can only have an emptyReason if it is empty
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
title		0..1	string	Label for section (e.g. for ToC)
code		0..1	CodeableConcept	Classification of section (recommended) Binding: DocumentSectionCodes (example): Classification of a section of a composition/document.
author		0..*	Reference(Practitioner | PractitionerRole | Device | Patient | RelatedPerson | Organization)	Who and/or what authored the section
focus		0..1	Reference(Resource)	Who/what the section is about, when it is not about the subject of composition
text	C	0..1	Narrative	Text summary of the section, for human interpretation
mode		0..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this section.
orderedBy		0..1	CodeableConcept	Order of section entries Binding: ListOrderCodes (preferred): What order applies to the items in the entry.
entry	C	0..*	Reference(Resource)	A reference to data that supports this section
emptyReason	C	0..1	CodeableConcept	Why the section is empty Binding: ListEmptyReasons (preferred): If a section is empty, why it is empty.
section	C	0..*	See section (Composition)	Nested Section
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Composition.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
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