Australian Base Implementation Guide (AU Base 2)

This page is part of the Australian Base IG (v2.1.0: AU Base 2 on R4) based on FHIR R4. For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-au-medlist

AU Medicine List [FMM Level 1]

This profile defines a list structure including core localisation concepts for use as a medicines list in an Australian context. This profile is intended to offer a common structure and expectations to record, exchange, and fetch a list of medications associated with a patient in an Australian healthcare context. 

Assertion of no relevant finding can be used to positively state that there is no history of immunisations for a patient or that the patient is known not to have current medications.

When capturing a related person as the author of the list, an authoring practitioner role or another source should not be provided.

Forthcoming work around this profile is expected to result in guidance and additional structures that define types of medication lists, e.g. current medications or medication changes or prescription history.

Extensions

Extensions used in this profile:

  • List: Author as a Related Person [1]
  • List.entry: Change Description [1]

Examples

Current medicine list, authored by practitioner role, with referenced medication statements

Current medicine list, source of practitioner, with assertion of no known current medicines

Current medicine on discharge (Bundle)

Current and ceased medicines

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-medlist

This profile defines a list structure including core localisation concepts for use as a medicines list in an Australian context. This profile is intended to offer a common structure and expectations to record, exchange, and fetch a list of medications associated with a patient in an Australian healthcare context.

This profile builds on List.

This profile was published on Fri Nov 30 00:00:00 AEDT 2018 as a draft by Health Level Seven Australia (Medications WG).

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list of medications in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person 0..1Reference(RelatedPerson)Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... entry 0..*BackboneElementMedicine list entry
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description 0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... flag 0..1CodeableConceptMedicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... item 1..1Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)Actual entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list of medications in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference(RelatedPerson)Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date ΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry I0..*BackboneElementMedicine list entry
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description I0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConceptMedicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item I1..1Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List 0..*ListA list of medications in an Australian healthcare context
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person 0..1Reference(RelatedPerson)Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... entry 0..*BackboneElementMedicine list entry
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description 0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... flag 0..1CodeableConceptMedicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... item 1..1Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)Actual entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. List I0..*ListA list of medications in an Australian healthcare context
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
... author-related-person I0..1Reference(RelatedPerson)Related person that defined the list contents (aka Author)
URL: http://hl7.org.au/fhir/StructureDefinition/author-related-person
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier I0..*IdentifierBusiness identifier
... status ?!ΣI1..1codecurrent | retired | entered-in-error
Binding: ListStatus (required)
... mode ?!ΣI1..1codeworking | snapshot | changes
Binding: ListMode (required)
... title ΣI0..1stringDescriptive name for the list
Example General: Dr. Jane's Patients
... code ΣI0..1CodeableConceptWhat the purpose of this list is
Binding: ExampleUseCodesForList (example)
... subject ΣI0..1Reference(Patient | Group | Device | Location)If all resources have the same subject
... encounter I0..1Reference(Encounter)Context in which list created
... date ΣI0..1dateTimeWhen the list was prepared
... source ΣI0..1Reference(Practitioner | PractitionerRole | Patient | Device)Who and/or what defined the list contents (aka Author)
... orderedBy I0..1CodeableConceptWhat order the list has
Binding: ListOrderCodes (preferred)
... note I0..*AnnotationComments about the list
... entry I0..*BackboneElementMedicine list entry
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... change-description I0..1stringDescription of the change to the item
URL: http://hl7.org.au/fhir/StructureDefinition/change-description
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... flag I0..1CodeableConceptMedicine item change
Binding: http://hl7.org.au/fhir/ValueSet/medicine-item-change (preferred)
.... deleted ?!I0..1booleanIf this item is actually marked as deleted
.... date I0..1dateTimeWhen item added to list
.... item I1..1Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding)Actual entry
... emptyReason I0..1CodeableConceptWhy list is empty
Binding: ListEmptyReasons (preferred)

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-au-medlist

none defined