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.

Changes since version 6.0.0:

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list of medications in an Australian healthcare context Constraints: lst-1, lst-2, lst-3
List.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
List.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
List.mode	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
List.entry	C	0..*	BackboneElement	Entries in the list
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.deleted	?! This element is a modifier element. C	0..1	boolean	If this item is actually marked as deleted
List.entry.item		1..1	Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
List.status	Base	required	ListStatus	📍4.0.1	FHIR Std.
List.mode	Base	required	ListMode	📍4.0.1	FHIR Std.
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List		0..*	List	A list of medications in an Australian healthcare context
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.entry		0..*	BackboneElement	Entries in the list
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.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	Status	Usage	ValueSet	Version	Source
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list of medications in an Australian healthcare context Constraints: lst-1, lst-2, lst-3
List.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
List.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
List.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
List.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
List.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
List.contained		0..*	Resource	Contained, inline Resources
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
List.identifier		0..*	Identifier	Business identifier
List.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
List.mode	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
List.title	Σ This element is included in summaries.	0..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
List.code	Σ This element is included in summaries.	0..1	CodeableConcept	What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
List.subject	Σ This element is included in summaries.	0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
List.encounter		0..1	Reference(Encounter)	Context in which list created
List.date	Σ This element is included in summaries.	0..1	dateTime	When the list was prepared
List.source	Σ This element is included in summaries.	0..1	Reference(Practitioner | PractitionerRole | Patient | Device)	Who and/or what defined the list contents (aka Author)
List.orderedBy		0..1	CodeableConcept	What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
List.note		0..*	Annotation	Comments about the list
List.entry	C	0..*	BackboneElement	Entries in the list
List.entry.id		0..1	string	Unique id for inter-element referencing
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.deleted	?! This element is a modifier element. C	0..1	boolean	If this item is actually marked as deleted
List.entry.date		0..1	dateTime	When item added to list
List.entry.item		1..1	Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)	Actual entry
List.emptyReason	C	0..1	CodeableConcept	Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
List.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
List.status	Base	required	ListStatus	📍4.0.1	FHIR Std.
List.mode	Base	required	ListMode	📍4.0.1	FHIR Std.
List.code	Base	example	Example Use Codes for List	📍4.0.1	FHIR Std.
List.orderedBy	Base	preferred	List Order Codes	📍4.0.1	FHIR Std.
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG
List.emptyReason	Base	preferred	List Empty Reasons	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list of medications in an Australian healthcare context Constraints: lst-1, lst-2, lst-3
List.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
List.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
List.mode	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
List.entry	C	0..*	BackboneElement	Entries in the list
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.deleted	?! This element is a modifier element. C	0..1	boolean	If this item is actually marked as deleted
List.entry.item		1..1	Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)	Actual entry
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
List.status	Base	required	ListStatus	📍4.0.1	FHIR Std.
List.mode	Base	required	ListMode	📍4.0.1	FHIR Std.
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
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()

Differential View

This structure is derived from List

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List		0..*	List	A list of medications in an Australian healthcare context
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.entry		0..*	BackboneElement	Entries in the list
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.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	Status	Usage	ValueSet	Version	Source
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
List	C	0..*	List	A list of medications in an Australian healthcare context Constraints: lst-1, lst-2, lst-3
List.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
List.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
List.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
List.language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
List.text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
List.contained		0..*	Resource	Contained, inline Resources
List.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.Slices for extension.extension:sourceRelatedPerson		0..1	Reference(RelatedPerson)	Related person that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
List.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
List.identifier		0..*	Identifier	Business identifier
List.status	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	current | retired | entered-in-error Binding: ListStatus (required): The current state of the list.
List.mode	?! This element is a modifier element. Σ This element is included in summaries.	1..1	code	working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list.
List.title	Σ This element is included in summaries.	0..1	string	Descriptive name for the list Example General: Dr. Jane's Patients
List.code	Σ This element is included in summaries.	0..1	CodeableConcept	What the purpose of this list is Binding: ExampleUseCodesForList (example): What the purpose of a list is.
List.subject	Σ This element is included in summaries.	0..1	Reference(Patient | Group | Device | Location)	If all resources have the same subject
List.encounter		0..1	Reference(Encounter)	Context in which list created
List.date	Σ This element is included in summaries.	0..1	dateTime	When the list was prepared
List.source	Σ This element is included in summaries.	0..1	Reference(Practitioner | PractitionerRole | Patient | Device)	Who and/or what defined the list contents (aka Author)
List.orderedBy		0..1	CodeableConcept	What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list.
List.note		0..*	Annotation	Comments about the list
List.entry	C	0..*	BackboneElement	Entries in the list
List.entry.id		0..1	string	Unique id for inter-element referencing
List.entry.Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
List.entry.Slices for extension.extension:changeDescription		0..1	string	Change description URL: http://hl7.org.au/fhir/StructureDefinition/change-description
List.entry.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored even if unrecognized
List.entry.flag		0..1	CodeableConcept	Medicine item change Binding: Medicine Item Change (preferred)
List.entry.deleted	?! This element is a modifier element. C	0..1	boolean	If this item is actually marked as deleted
List.entry.date		0..1	dateTime	When item added to list
List.entry.item		1..1	Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)	Actual entry
List.emptyReason	C	0..1	CodeableConcept	Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
List.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
List.status	Base	required	ListStatus	📍4.0.1	FHIR Std.
List.mode	Base	required	ListMode	📍4.0.1	FHIR Std.
List.code	Base	example	Example Use Codes for List	📍4.0.1	FHIR Std.
List.orderedBy	Base	preferred	List Order Codes	📍4.0.1	FHIR Std.
List.entry.flag	Base	preferred	Medicine Item Change	📦7.0.0-ci-build	This IG
List.emptyReason	Base	preferred	List Empty Reasons	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:

• http://hl7.org.au/fhir/StructureDefinition/author-related-person
• http://hl7.org.au/fhir/StructureDefinition/change-description

Maturity: 1