AU Medicine List - 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 Medicine List

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

This profile defines a list structure that localises core concepts for use as a medicines list in an Australian context. This profile is intended to offer a common structure and expectations for a list of medications associated with a patient in an Australian healthcare context.

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 or no history of vaccination), List.entry.item with a reference to a supported FHIR resource containing the record of assertion should be sent. AU Assertion of No Relevant Finding is defined in this implementation guide for this concept.
- 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), List.emptyReason should be sent with an appropriate code from the ListEmptyReasons value set.
When a related person is the author of the list, the Author as a RelatedPerson extension is used and List.source is not included.
If both the List.entry.changeDescription extension and List.entry.flag are populated, the extension is expected to only be used to expand on the List.entry.flag concept and not contradict its meaning.

Usage:

Examples for this Resource Profile: List/example0, List/example1, List/example2 and List/example3

Formal Views of Profile Content

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

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
List		0..*	List	A list of medications in an Australian healthcare context
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
entry		0..*	BackboneElement	Entries in the list
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
changeDescription	D	0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change) `http://terminology.hl7.org.au/ValueSet/medicine-item-change` from this IG

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list of medications in an Australian healthcare context 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 lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
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
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person 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	current \| retired \| entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children
mode	?!Σ	1..1	code	working \| snapshot \| changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children
entry	C	0..*	BackboneElement	Entries in the list 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
changeDescription	D	0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description 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 even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred) ele-1: All FHIR elements must have a @value or children
deleted	?!C	0..1	boolean	If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
List.status	required	ListStatus `http://hl7.org/fhir/ValueSet/list-status\|4.0.1` from the FHIR Standard
List.mode	required	ListMode `http://hl7.org/fhir/ValueSet/list-mode\|4.0.1` from the FHIR Standard
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change) `http://terminology.hl7.org.au/ValueSet/medicine-item-change` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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	List	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	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	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()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Description & Constraints

List

C

0..*

List

A list of medications in an Australian healthcare context
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

List.language

preferred

CommonLanguages

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

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

required

ListStatus

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

from the FHIR Standard

List.mode

required

ListMode

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

from the FHIR Standard

List.code

example

ExampleUseCodesForList

http://hl7.org/fhir/ValueSet/list-example-codes

from the FHIR Standard

List.orderedBy

preferred

ListOrderCodes

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

from the FHIR Standard

List.entry.flag

preferred

MedicineItemChange (a valid code from Medicine Item Change)

http://terminology.hl7.org.au/ValueSet/medicine-item-change

from this IG

List.emptyReason

preferred

ListEmptyReasons

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

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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	List	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	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	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()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List

Summary

Structures

This structure refers to these other structures:

AU Assertion of No Relevant Finding (http://hl7.org.au/fhir/StructureDefinition/au-norelevantfinding)

Extensions

This structure refers to these extensions:

Maturity: 1

Differential View

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints
List		0..*	List	A list of medications in an Australian healthcare context
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
entry		0..*	BackboneElement	Entries in the list
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
changeDescription	D	0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change) `http://terminology.hl7.org.au/ValueSet/medicine-item-change` from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list of medications in an Australian healthcare context 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 lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working"
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
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person 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	current \| retired \| entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children
mode	?!Σ	1..1	code	working \| snapshot \| changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children
entry	C	0..*	BackboneElement	Entries in the list 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
changeDescription	D	0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description 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 even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred) ele-1: All FHIR elements must have a @value or children
deleted	?!C	0..1	boolean	If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
List.status	required	ListStatus `http://hl7.org/fhir/ValueSet/list-status\|4.0.1` from the FHIR Standard
List.mode	required	ListMode `http://hl7.org/fhir/ValueSet/list-mode\|4.0.1` from the FHIR Standard
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change) `http://terminology.hl7.org.au/ValueSet/medicine-item-change` from this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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	List	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	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	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()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

Snapshot View

Description & Constraints

List

C

0..*

List

A list of medications in an Australian healthcare context
lst-1: A list can only have an emptyReason if it is empty
lst-2: The deleted flag can only be used if the mode of the list is "changes"
lst-3: An entry date can only be used if the mode of the list is "working"

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path Conformance ValueSet URI

List.language

preferred

CommonLanguages

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

from the FHIR Standard

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

required

ListStatus

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

from the FHIR Standard

List.mode

required

ListMode

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

from the FHIR Standard

List.code

example

ExampleUseCodesForList

http://hl7.org/fhir/ValueSet/list-example-codes

from the FHIR Standard

List.orderedBy

preferred

ListOrderCodes

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

from the FHIR Standard

List.entry.flag

preferred

MedicineItemChange (a valid code from Medicine Item Change)

http://terminology.hl7.org.au/ValueSet/medicine-item-change

from this IG

List.emptyReason

preferred

ListEmptyReasons

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

from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	List	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	List	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	List	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	List	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	List	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()
lst-1	error	List	A list can only have an emptyReason if it is empty : emptyReason.empty() or entry.empty()
lst-2	error	List	The deleted flag can only be used if the mode of the list is "changes" : mode = 'changes' or entry.deleted.empty()
lst-3	error	List	An entry date can only be used if the mode of the list is "working" : mode = 'working' or entry.date.empty()

This structure is derived from List

Summary

Structures

This structure refers to these other structures:

AU Assertion of No Relevant Finding (http://hl7.org.au/fhir/StructureDefinition/au-norelevantfinding)

Extensions

This structure refers to these extensions:

Maturity: 1

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