AU Medicine List - AU Base Implementation Guide v4.1.2-preview

AU Base Implementation Guide
4.1.2-preview - Preview Australia flag

This page is part of the Australian Base IG (v4.1.2-preview: AU Base) based on FHIR R4. 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: 4.1.2-preview
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.

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
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change)

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list of medications in an Australian healthcare context
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
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current \| retired \| entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working \| snapshot \| changes Binding: ListMode (required): The processing mode that applies to this list.
entry	C	0..*	BackboneElement	Entries in the list
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
deleted	?!C	0..1	boolean	If this item is actually marked as deleted
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
List.status	required	ListStatus
List.mode	required	ListMode
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change)

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

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

List.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

List.mode

List.code

ExampleUseCodesForList

List.orderedBy

preferred

ListOrderCodes

List.entry.flag

preferred

MedicineItemChange (a valid code from Medicine Item Change)

List.emptyReason

preferred

ListEmptyReasons

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
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
List	C	0..*	List	A list of medications in an Australian healthcare context
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
sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
status	?!Σ	1..1	code	current \| retired \| entered-in-error Binding: ListStatus (required): The current state of the list.
mode	?!Σ	1..1	code	working \| snapshot \| changes Binding: ListMode (required): The processing mode that applies to this list.
entry	C	0..*	BackboneElement	Entries in the list
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
deleted	?!C	0..1	boolean	If this item is actually marked as deleted
item		1..1	Reference(MedicationStatement \| MedicationRequest \| MedicationDispense \| MedicationAdministration \| Immunization \| AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
List.status	required	ListStatus
List.mode	required	ListMode
List.entry.flag	preferred	MedicineItemChange (a valid code from Medicine Item Change)

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

id

Σ

0..1

id

Logical id of this artifact

Terminology Bindings

Path

Conformance

ValueSet

List.language

preferred

CommonLanguages

Additional Bindings

Purpose

AllLanguages

Max Binding

List.status

List.mode

List.code

ExampleUseCodesForList

List.orderedBy

preferred

ListOrderCodes

List.entry.flag

preferred

MedicineItemChange (a valid code from Medicine Item Change)

List.emptyReason

preferred

ListEmptyReasons

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#4.1.2-preview based on FHIR 4.0.1. Generated 2023-11-15
Links: Table of Contents | QA Report | Version History | | Propose a change