AU Base Implementation Guide
4.2.2-ci-build - CI Build
AU Base Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 4.2.2-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-base/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/StructureDefinition/au-medlist | Version: 4.2.2-ci-build | |||
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.
Profile specific implementation guidance:
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.List.emptyReason
should be sent with an appropriate code from the ListEmptyReasons value set.List.source
is not 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 | 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 |
Path | Conformance | ValueSet | URI |
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | C | 0..* | List | A list of medications in an Australian healthcare context lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" |
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 | URI |
List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard | |
List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | |
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
List | C | 0..* | List | A list of medications in an Australian healthcare context lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" | ||||
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 | URI | |||
List.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard | ||||
List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard | ||||
List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG | ||||
List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
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:
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 |
Path | Conformance | ValueSet | URI |
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
List | C | 0..* | List | A list of medications in an Australian healthcare context lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" |
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 | URI |
List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard | |
List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | |
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG |
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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
List | C | 0..* | List | A list of medications in an Australian healthcare context lst-1: A list can only have an emptyReason if it is empty lst-2: The deleted flag can only be used if the mode of the list is "changes" lst-3: An entry date can only be used if the mode of the list is "working" | ||||
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 | URI | |||
List.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
List.status | required | ListStatushttp://hl7.org/fhir/ValueSet/list-status|4.0.1 from the FHIR Standard | ||||
List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1 from the FHIR Standard | ||||
List.code | example | ExampleUseCodesForListhttp://hl7.org/fhir/ValueSet/list-example-codes from the FHIR Standard | ||||
List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-order from the FHIR Standard | ||||
List.entry.flag | preferred | MedicineItemChange (a valid code from Medicine Item Change)http://terminology.hl7.org.au/ValueSet/medicine-item-change from this IG | ||||
List.emptyReason | preferred | ListEmptyReasonshttp://hl7.org/fhir/ValueSet/list-empty-reason from the FHIR Standard |
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:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron