AU Core Implementation Guide
0.4.1-preview - Preview
This page is part of the AU Core (v0.4.1-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication | Version: 0.4.1-preview | |||
Standards status: Draft | Maturity Level: 1 | Computable Name: AUCoreMedication | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
This profile sets minimum expectations for a Medication resource to record, search, and fetch medications associated with a patient. It is based on the AU Base Medication profile and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Medication when conforming to this profile. It provides the floor for standards development for specific uses cases in an Australian context.
In AU Core a Medication resource is used within the context of a referencing resource: MedicationAdministration, MedicationDispense, MedicationRequest, or MedicationStatement resource.
The following are supported usage scenarios for this profile:
A resource conforming to this profile is conformant to:
Conformance in reverse is not guaranteed, i.e. a resource conforming to International Patient Access, International Patient Summary, or US Core MAY NOT conform to AU Core.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from AUBaseMedication
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication in an Australian healthcare context | |||||||
code | SO | 1..1 | CodeableConcept | Coding for the medicine
| ||||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||
coding:pbs | SO | 0..* | Coding | PBS Item Code
| ||||||
coding:amt | SO | 0..* | Coding | AMT Medicines
| ||||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication in an Australian healthcare context | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
code | SOΣ | 1..1 | CodeableConcept | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
| ||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:pbs | SOΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred)
| ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||||
coding:amt | SOΣ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred)
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.code.coding:pbs | preferred | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
Medication.code.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
Medication.code.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
Medication.code.coding:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication 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 | |||||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||||
code | SOΣ | 1..1 | CodeableConcept | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:pbs | SOΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:amt | SOΣ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
Slices for extension | Content/Rules for all slices | |||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
text | Σ | 0..1 | string | Medication primary text | ||||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||
manufacturer | Σ | 0..1 | Reference(Organization) | Physical product manufacturer organisation | ||||||
form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: Medication Form (preferred) | |||||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||||
ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
item[x] | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) | ||||||||
itemCodeableConcept | CodeableConcept | |||||||||
itemReference | Reference(Substance | Medication) | |||||||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||||
strength | 0..1 | Ratio | Quantity/strength of ingredient present | |||||||
batch | 0..1 | BackboneElement | Details about packaged medications | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
lotNumber | 0..1 | string | Identifier assigned to batch | |||||||
expirationDate | 0..1 | dateTime | When batch will expire | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
Medication.code.coding:pbs | preferred | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
Medication.code.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
Medication.code.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
Medication.code.coding:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | preferred | MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | ||||
Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
This structure is derived from AUBaseMedication
Differential View
This structure is derived from AUBaseMedication
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication in an Australian healthcare context | |||||||
code | SO | 1..1 | CodeableConcept | Coding for the medicine
| ||||||
Slices for coding | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | |||||||
coding:pbs | SO | 0..* | Coding | PBS Item Code
| ||||||
coding:amt | SO | 0..* | Coding | AMT Medicines
| ||||||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication in an Australian healthcare context | |||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
code | SOΣ | 1..1 | CodeableConcept | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
| ||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:pbs | SOΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred)
| ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||||
coding:amt | SOΣ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred)
| ||||||
Slices for extension | Content/Rules for all slices | |||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | |
Medication.code.coding:pbs | preferred | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | |
Medication.code.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | |
Medication.code.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | |
Medication.code.coding:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | |
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||||
---|---|---|---|---|---|---|---|---|---|---|
Medication | 0..* | AUBaseMedication | A medication 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 | |||||||
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||||
identifier | Σ | 0..* | Identifier | Business identifier for this medication | ||||||
code | SOΣ | 1..1 | CodeableConcept | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example): A coded concept that defines the type of a medication.
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:system | ||||||
coding:pbs | SOΣ | 0..* | Coding | PBS Item Code Binding: PBS Item Codes (preferred)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://pbs.gov.au/code/item | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:gtin | Σ | 0..* | Coding | Medication Package Global Trade Item Number (GTIN) Binding: GTIN (preferred) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.gs1.org/gtin | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:amt | SOΣ | 0..* | Coding | AMT Medicines Binding: Australian Medication (preferred)
| ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||
Slices for extension | Content/Rules for all slices | |||||||||
medicationClass | 0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
coding:mimsPackage | Σ | 0..1 | Coding | MIMS Package Binding: MIMS (preferred) | ||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||
system | Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.mims.com.au/codes | ||||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||||
display | Σ | 0..1 | string | Representation defined by the system | ||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||||
text | Σ | 0..1 | string | Medication primary text | ||||||
status | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: Medication Status Codes (required): A coded concept defining if the medication is in active use. | ||||||
manufacturer | Σ | 0..1 | Reference(Organization) | Physical product manufacturer organisation | ||||||
form | 0..1 | CodeableConcept | powder | tablets | capsule + Binding: Medication Form (preferred) | |||||||
amount | Σ | 0..1 | Ratio | Amount of drug in package | ||||||
ingredient | 0..* | BackboneElement | Active or inactive ingredient | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
item[x] | 1..1 | The actual ingredient or content Binding: AMT Medicinal Product and Substances (preferred) | ||||||||
itemCodeableConcept | CodeableConcept | |||||||||
itemReference | Reference(Substance | Medication) | |||||||||
isActive | 0..1 | boolean | Active ingredient indicator | |||||||
strength | 0..1 | Ratio | Quantity/strength of ingredient present | |||||||
batch | 0..1 | BackboneElement | Details about packaged medications | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||||
extension | 0..* | Extension | Additional content defined by implementations | |||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||
lotNumber | 0..1 | string | Identifier assigned to batch | |||||||
expirationDate | 0..1 | dateTime | When batch will expire | |||||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Medication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Medication.code | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
Medication.code.coding:pbs | preferred | PBSItemCodeshttp://terminology.hl7.org.au/ValueSet/pbs-item | ||||
Medication.code.coding:gtin | preferred | GTINhttp://terminology.hl7.org/ValueSet/v3-GTIN | ||||
Medication.code.coding:amt | preferred | AustralianMedication https://healthterminologies.gov.au/fhir/ValueSet/australian-medication-1 | ||||
Medication.code.coding:mimsPackage | preferred | MIMShttp://terminology.hl7.org.au/ValueSet/mims | ||||
Medication.status | required | Medication Status Codeshttp://hl7.org/fhir/ValueSet/medication-status|4.0.1 from the FHIR Standard | ||||
Medication.form | preferred | MedicationForm https://healthterminologies.gov.au/fhir/ValueSet/medication-form-1 | ||||
Medication.ingredient.item[x] | preferred | AMTMedicinalProductAndSubstanceshttp://terminology.hl7.org.au/ValueSet/amt-mp-codes |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Medication | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Medication | 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 | Medication | 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 | Medication | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Medication | 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() |
This structure is derived from AUBaseMedication
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.
No mandatory search parameters for this profile.
No optional search parameters for this profile.