This page is part of the Australian Base IG (v1.1.1: AU Base 1.1 on STU3 Draft) based on FHIR R3. The current version which supercedes this version is 1.0.2. For a full list of available versions, see the Directory of published versions
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 practitioner as the source of the list, an authoring practitioner role may be provided.
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 used in this profile:
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)
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.
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list of medications in an Australian healthcare context |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
author-role | I | 0..1 | Reference(PractitionerRole) | Practitioner role that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-role |
author-related-person | I | 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 |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: Example Use Codes for List (example) |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
date | Σ | 0..1 | dateTime | When the list was prepared |
source | Σ | 0..1 | Reference(Practitioner | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
note | 0..* | Annotation | Comments about the list | |
entry | I | 0..* | BackboneElement | Medicine list entry |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
change-description | I | 0..1 | string | Description of the change to the item URL: http://hl7.org.au/fhir/StructureDefinition/change-description |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
flag | 0..1 | CodeableConcept | Medicine item change Binding: Medicine Item Change (preferred) | |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | 0..1 | dateTime | When item added to list | |
item | 1..1 | Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding) | Actual entry | |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (preferred) |
Documentation for this format |
Differential View
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | I | 0..* | List | A list of medications in an Australian healthcare context |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
author-role | I | 0..1 | Reference(PractitionerRole) | Practitioner role that defined the list contents (aka Author) URL: http://hl7.org.au/fhir/StructureDefinition/author-role |
author-related-person | I | 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 |
identifier | 0..* | Identifier | Business identifier | |
status | ?!Σ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required) |
mode | ?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required) |
title | Σ | 0..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients |
code | Σ | 0..1 | CodeableConcept | What the purpose of this list is Binding: Example Use Codes for List (example) |
subject | Σ | 0..1 | Reference(Patient | Group | Device | Location) | If all resources have the same subject |
encounter | 0..1 | Reference(Encounter) | Context in which list created | |
date | Σ | 0..1 | dateTime | When the list was prepared |
source | Σ | 0..1 | Reference(Practitioner | Patient | Device) | Who and/or what defined the list contents (aka Author) |
orderedBy | 0..1 | CodeableConcept | What order the list has Binding: List Order Codes (preferred) | |
note | 0..* | Annotation | Comments about the list | |
entry | I | 0..* | BackboneElement | Medicine list entry |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
change-description | I | 0..1 | string | Description of the change to the item URL: http://hl7.org.au/fhir/StructureDefinition/change-description |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
flag | 0..1 | CodeableConcept | Medicine item change Binding: Medicine Item Change (preferred) | |
deleted | ?!I | 0..1 | boolean | If this item is actually marked as deleted |
date | 0..1 | dateTime | When item added to list | |
item | 1..1 | Reference(MedicationStatement | MedicationRequest | MedicationDispense | MedicationAdministration | Immunization | AU Assertion of No Relevant Finding) | Actual entry | |
emptyReason | I | 0..1 | CodeableConcept | Why list is empty Binding: List Empty Reasons (preferred) |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Below is an overview of the required search and read operations.
Summary of Search Criteria for StructureDefinition-au-medlist
none defined