Australian Digital Health Agency FHIR Implementation Guide
1.2.0-ci-build - draft
Australian Digital Health Agency FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 1.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/ci-fhir-r4/ and changes regularly. See the Directory of published versions
| Official URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-list-medication-use-pmr-1 | Version: 0.0.2 | |||
| Draft as of 2024-12-19 | Computable Name: ADHAListPractitionerMedicineReview | |||
Copyright/Legal: Copyright © 2023 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/. |
||||
The purpose of this profile is to define a representation of list from a review of a patient's medicines by a practitioner at a point in time. The list may be partial, or complete, and may be a history or scoped to may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. This profile is used to group individual statements of medicine item use in the List resource to construct various types of medication usage lists for the electronic exchange of health information between individuals, healthcare providers, and the My Health Record system infrastructure in Australia.
This profile identifies the additional constraints, extensions, and value sets that build on and extend List that are supported.
This profile is designed to set a List standard for:
This profile may be referred to by APIs, which will be listed here when available.
None.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ADHAListMedicationUse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 |
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   sourceRelatedPerson |
0..0 | Reference(RelatedPerson) | ||
 packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid  (required) |
  title |
1..1 | string | Descriptive name for the list | |
| encounter |
1..1 | Reference(ADHA Core Encounter) | Context in which list created | |
 source |
1..1 | Reference(ADHA Authoring PractitionerRole) | Who and/or what defined the list contents (aka Author) | |
 entry |
0..* | BackboneElement | Medicine item information, may include change information | |
  flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid (required)ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 identifier |
S | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children Required Pattern: current |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Descriptive name for the list ele-1: All FHIR elements must have a @value or children Example General: Dr. Jane's Patients |
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: History Of Medication Use List Type (required)ele-1: All FHIR elements must have a @value or children |
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children inv-dh-lst-04: At least reference or a valid identifier shall be present |
| encounter |
S | 1..1 | Reference(ADHA Core Encounter) | Context in which list created ele-1: All FHIR elements must have a @value or children |
| date |
SΣC | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children inv-dh-lst-06: Date shall be at least to day |
| source |
SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children |
| entry |
SC | 0..* | BackboneElement | Medicine item information, may include change information ele-1: All FHIR elements must have a @value or children inv-dh-lst-05: All observations shall conform to ADHA Simple Observation |
 Slices for extension |
Content/Rules for all slices | |||
| changeDescription |
0..1 | string | Description of the change to medicine item use URL: http://hl7.org.au/fhir/StructureDefinition/change-description ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required)ele-1: All FHIR elements must have a @value or children |
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children |
| item |
SC | 1..1 | Reference(ADHA Core MedicationStatement | AU Assertion of No Relevant Finding) | Actual entry ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required)ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | |
| List.code | required | HistoryOfMedicationUseListType https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1 | |
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 | |
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review 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" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 | ||||
| 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 | |||||
| packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
SΣ | 1..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: History Of Medication Use List Type (required) | ||||
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject inv-dh-lst-04: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 1..1 | Reference(ADHA Core Encounter) | Context in which list created | ||||
| date |
SΣC | 1..1 | dateTime | When the list was prepared inv-dh-lst-06: Date shall be at least to day | ||||
| source |
SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole) | 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 |
S | 0..* | Annotation | Comments about the list | ||||
| entry |
SC | 0..* | BackboneElement | Medicine item information, may include change information inv-dh-lst-05: All observations shall conform to ADHA Simple Observation | ||||
| 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 | Description of the change to medicine item use URL: http://hl7.org.au/fhir/StructureDefinition/change-description | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required) | ||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
SC | 1..1 | Reference(ADHA Core MedicationStatement | AU Assertion of No Relevant Finding) | Actual entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | required | HistoryOfMedicationUseListType https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1 | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 | ||||
| List.entry.item.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
This structure is derived from ADHAListMedicationUse
Differential View
This structure is derived from ADHAListMedicationUse
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| sourceRelatedPerson |
0..0 | Reference(RelatedPerson) | ||
| packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid (required) |
| title |
1..1 | string | Descriptive name for the list | |
| encounter |
1..1 | Reference(ADHA Core Encounter) | Context in which list created | |
| source |
1..1 | Reference(ADHA Authoring PractitionerRole) | Who and/or what defined the list contents (aka Author) | |
| entry |
0..* | BackboneElement | Medicine item information, may include change information | |
| flag |
0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management 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" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid (required)ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier |
S | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children |
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. ele-1: All FHIR elements must have a @value or children Required Pattern: current |
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. ele-1: All FHIR elements must have a @value or children |
| title |
SΣ | 1..1 | string | Descriptive name for the list ele-1: All FHIR elements must have a @value or children Example General: Dr. Jane's Patients |
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: History Of Medication Use List Type (required)ele-1: All FHIR elements must have a @value or children |
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject ele-1: All FHIR elements must have a @value or children inv-dh-lst-04: At least reference or a valid identifier shall be present |
| encounter |
S | 1..1 | Reference(ADHA Core Encounter) | Context in which list created ele-1: All FHIR elements must have a @value or children |
| date |
SΣC | 1..1 | dateTime | When the list was prepared ele-1: All FHIR elements must have a @value or children inv-dh-lst-06: Date shall be at least to day |
| source |
SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole) | Who and/or what defined the list contents (aka Author) ele-1: All FHIR elements must have a @value or children |
| note |
S | 0..* | Annotation | Comments about the list ele-1: All FHIR elements must have a @value or children |
| entry |
SC | 0..* | BackboneElement | Medicine item information, may include change information ele-1: All FHIR elements must have a @value or children inv-dh-lst-05: All observations shall conform to ADHA Simple Observation |
| Slices for extension |
Content/Rules for all slices | |||
| changeDescription |
0..1 | string | Description of the change to medicine item use URL: http://hl7.org.au/fhir/StructureDefinition/change-description ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required)ele-1: All FHIR elements must have a @value or children |
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted ele-1: All FHIR elements must have a @value or children |
| item |
SC | 1..1 | Reference(ADHA Core MedicationStatement | AU Assertion of No Relevant Finding) | Actual entry ele-1: All FHIR elements must have a @value or children |
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required)ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | |
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | |
| List.code | required | HistoryOfMedicationUseListType https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1 | |
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 | |
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| List |
C | 0..* | ADHAListMedicationUse | A list of medicine items for a patient at a point in time from a medicines review 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" inv-dh-lst-01: The list shall have at least a source or a source relating person inv-dh-lst-02: If present, a source shall at least have a reference or a valid identifier inv-dh-lst-03: If present, a source related person (author-related-person) shall at least have a reference or a valid identifier inv-dh-pmr-01: Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 | ||||
| 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 | |||||
| packed-in-daa |
S | 0..1 | CodeableConcept | Inclusion of medicines packed in a Dose Administration Aid (DAA) indicator URL: http://ns.electronichealth.net.au/fhir/StructureDefinition/dh-packed-in-daa-1 Binding: Indicator Of Medicines Packed In A Dose Administration Aid (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 0..* | Identifier | Business identifier | ||||
| status |
?!SΣ | 1..1 | code | current | retired | entered-in-error Binding: ListStatus (required): The current state of the list. Required Pattern: current | ||||
| mode |
?!Σ | 1..1 | code | working | snapshot | changes Binding: ListMode (required): The processing mode that applies to this list. | ||||
| title |
SΣ | 1..1 | string | Descriptive name for the list Example General: Dr. Jane's Patients | ||||
| code |
SΣ | 1..1 | CodeableConcept | What the purpose of this list is Binding: History Of Medication Use List Type (required) | ||||
| subject |
SΣC | 1..1 | Reference(ADHA Core Patient) | If all resources have the same subject inv-dh-lst-04: At least reference or a valid identifier shall be present | ||||
| encounter |
S | 1..1 | Reference(ADHA Core Encounter) | Context in which list created | ||||
| date |
SΣC | 1..1 | dateTime | When the list was prepared inv-dh-lst-06: Date shall be at least to day | ||||
| source |
SΣC | 1..1 | Reference(ADHA Authoring PractitionerRole) | 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 |
S | 0..* | Annotation | Comments about the list | ||||
| entry |
SC | 0..* | BackboneElement | Medicine item information, may include change information inv-dh-lst-05: All observations shall conform to ADHA Simple Observation | ||||
| 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 | Description of the change to medicine item use URL: http://hl7.org.au/fhir/StructureDefinition/change-description | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| flag |
S | 0..1 | CodeableConcept | Status/Workflow information about this item Binding: Medicine Item Change from Practitioner Medicines Review (required) | ||||
| deleted |
?!C | 0..1 | boolean | If this item is actually marked as deleted | ||||
| date |
0..1 | dateTime | When item added to list | |||||
| item |
SC | 1..1 | Reference(ADHA Core MedicationStatement | AU Assertion of No Relevant Finding) | Actual entry | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||
| emptyReason |
SC | 0..1 | CodeableConcept | Why list is empty Binding: Non-Clinical Empty Reason (required) | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| List.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard
| ||||
| List.status | required | Pattern: currenthttp://hl7.org/fhir/ValueSet/list-status|4.0.1from the FHIR Standard | ||||
| List.mode | required | ListModehttp://hl7.org/fhir/ValueSet/list-mode|4.0.1from the FHIR Standard | ||||
| List.code | required | HistoryOfMedicationUseListType https://healthterminologies.gov.au/fhir/ValueSet/history-of-medication-use-list-type-1 | ||||
| List.orderedBy | preferred | ListOrderCodeshttp://hl7.org/fhir/ValueSet/list-orderfrom the FHIR Standard | ||||
| List.entry.flag | required | MedicineItemChangeFromPractitionerMedicinesReview https://healthterminologies.gov.au/fhir/ValueSet/medicine-item-change-from-practitioner-medicines-review-2 | ||||
| List.entry.item.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||
| List.emptyReason | required | NonClinicalEmptyReason https://healthterminologies.gov.au/fhir/ValueSet/non-clinical-empty-reason-2 |
| Id | Grade | Path(s) | Details | Requirements |
| inv-dh-pmr-01 | error | List | Encounter type shall be a member of Medicines Review Type value set https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2 : encounter.resolve().type.memberOf('https://healthterminologies.gov.au/fhir/ValueSet/medicines-review-type-2') |
This structure is derived from ADHAListMedicationUse
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the mandatory and optional search parameters. FHIR search operations and the syntax used to describe the interactions is described here.
IG © 2023+ Australian Digital Health Agency. Package au.digitalhealth.r4#1.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-19
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
