AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
AU Base Implementation Guide
4.1.0-ballot - CI Build
AU
This page is part of AU Base v4.1.0 based on FHIR R4. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medlist | Version: 4.1.0-ballot | |||
| Active as of 2022-11-10 | Maturity Level: 1 | Computable Name: AUMedicineList | ||
Copyright/Legal: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. |
||||
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.
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.
An 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, the extension Author as a Related Person should be used and List.source should not be included.
Usage:
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 | 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 | ||||
| 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 | ||||
| Path | Conformance | ValueSet |
| List.status | required | ListStatus |
| List.mode | required | ListMode |
| 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 | ||||
| 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| 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 | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| 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. | ||||
| 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: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| 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 | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note | 0..* | Annotation | Comments about the list | |||||
 entry | C | 0..* | BackboneElement | Entries in the list | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | ||||
| 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 | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | ListStatus | ||||
| List.mode | required | ListMode | ||||
| List.code | example | ExampleUseCodesForList | ||||
| List.orderedBy | preferred | ListOrderCodes | ||||
| List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change) | ||||
| List.emptyReason | preferred | ListEmptyReasons |
This structure is derived from List
Summary
Structures
This structure refers to these other structures:
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 | 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 | ||||
| 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 | ||||
| Path | Conformance | ValueSet |
| List.status | required | ListStatus |
| List.mode | required | ListMode |
| List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List | C | 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: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| 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 | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| 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. | ||||
| 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: ExampleUseCodesForList (example): What the purpose of a list is. | ||||
| 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 | PractitionerRole | Patient | Device) | Who and/or what defined the list contents (aka Author) | ||||
| orderedBy | 0..1 | CodeableConcept | What order the list has Binding: ListOrderCodes (preferred): What order applies to the items in a list. | |||||
| note | 0..* | Annotation | Comments about the list | |||||
| entry | C | 0..* | BackboneElement | Entries in the list | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| 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 | ||||
| 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 | C | 0..1 | CodeableConcept | Why list is empty Binding: ListEmptyReasons (preferred): If a list is empty, why it is empty. | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| List.language | preferred | CommonLanguages
| ||||
| List.status | required | ListStatus | ||||
| List.mode | required | ListMode | ||||
| List.code | example | ExampleUseCodesForList | ||||
| List.orderedBy | preferred | ListOrderCodes | ||||
| List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change) | ||||
| List.emptyReason | preferred | ListEmptyReasons |
This structure is derived from List
Summary
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
none defined
IG © 2017+ HL7 Australia. Package hl7.fhir.au.base#4.1.0-ballot based on FHIR 4.0.1. Generated 2022-11-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change