AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide
1.0.1-ci-build - CI Build
AU Patient Summary Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 1.0.1-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-ps/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication | Version: 1.0.1-ci-build | |||
| Standards status: Trial-use | Maturity Level: 2 | Computable Name: AUPSMedication | ||
Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved. |
||||
This profile sets minimum expectations for a Medication resource in the context of a patient summary in an Australian context. It is based on the AU Core Medication profile, and applies the additional requirements from Medication (IPS).
See Comparison With Other National and International IGs for a comparison between AU Patient Summary (AU PS) profiles and profiles in other implementation guides.
Medication.code producers SHALL correctly populate Medication.code.coding with either a code from Australian Medication or PBS Item Codes, or both, if a coded value is known and MAY populate with a code from another code system.
Examples for this Profile: Bundle/aups-gpvisit-retrieval, Bundle/aups-referral-endoconsult-autogen and Bundle/aups-referral-endoconsult-curated
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Medication |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
  code |
1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
   Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
   coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
 extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
 coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication  (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| 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. | |||||||||||||||||||
| form |
0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred)
| |||||||||||||||||||
| ingredient |
0..* | BackboneElement | Active or inactive ingredient
| |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
 item[x] |
1..1 | The actual ingredient or content Binding: Medication Ingredient (preferred)
| ||||||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
  itemReference |
Reference(Substance | Medication) | |||||||||||||||||||||
| strength |
0..1 | Ratio | Quantity/strength of ingredient present
| |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Medication.code.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| Medication.code.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred |
Medication Form
|
⏿1.1.1 | tx.hl7.org.au |
| Medication.ingredient.item[x] | Base | preferred |
Medication Ingredient
|
⏿1.0.0 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreMedication
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| identifier |
0..* | Identifier | Business identifier for this medication | |||||||||||||||||||
| code |
1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| 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 pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
 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 | |||||||||||||||||||||
 extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| 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 |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| 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 | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| 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 | CodeableConceptIPS | 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: Medication Ingredient (preferred)
| ||||||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| 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 | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Medication.code | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Medication.code.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| Medication.code.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred |
Medication Form
|
⏿1.1.1 | tx.hl7.org.au |
| Medication.ingredient.item[x] | Base | preferred |
Medication Ingredient
|
⏿1.0.0 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreMedication
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 2
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| code |
1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| Slices for coding |
0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| 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. | |||||||||||||||||||
| form |
0..1 | CodeableConceptIPS | powder | tablets | capsule + Binding: Medication Form (preferred)
| |||||||||||||||||||
| ingredient |
0..* | BackboneElement | Active or inactive ingredient
| |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||
| item[x] |
1..1 | The actual ingredient or content Binding: Medication Ingredient (preferred)
| ||||||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||||||||||||
| strength |
0..1 | Ratio | Quantity/strength of ingredient present
| |||||||||||||||||||
| Documentation for this format | ||||||||||||||||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Medication.code | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Medication.code.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| Medication.code.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred |
Medication Form
|
⏿1.1.1 | tx.hl7.org.au |
| Medication.ingredient.item[x] | Base | preferred |
Medication Ingredient
|
⏿1.0.0 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from AUCoreMedication
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||
| code |
1..1 | CodeableConceptIPS | Coding for the medicine
| |||||||||
| Slices for coding |
Content/Rules for all slices | |||||||||||
 coding:pbs |
0..* | Coding | Code defined by a terminology system
| |||||||||
| coding:amt |
0..* | Coding | Code defined by a terminology system
| |||||||||
| form |
0..1 | CodeableConceptIPS | powder | tablets | capsule +
| |||||||||
 ingredient |
0..* | BackboneElement | Active or inactive ingredient
| |||||||||
| item[x] |
1..1 | The actual ingredient or content
| ||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||
| itemReference |
Reference(Substance | Medication) | |||||||||||
| strength |
0..1 | Ratio | Quantity/strength of ingredient present
| |||||||||
| Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Medication |
0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||
| 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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||||||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||||||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||
| identifier |
0..* | Identifier | Business identifier for this medication | |||||||||||||||||||
| code |
1..1 | CodeableConceptIPS | Coding for the medicine Binding: SNOMEDCTMedicationCodes (example)
| |||||||||||||||||||
| 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 pattern:$this Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||||||||||||
| coding:pbs |
0..* | Coding | Code defined by a terminology system Binding: PBS Item Codes (required)
| |||||||||||||||||||
| 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 | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| 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 |
0..* | Coding | Code defined by a terminology system Binding: Australian Medication (required)
| |||||||||||||||||||
| 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 | |||||||||||||||||||||
| extension:medicationClass |
0..1 | Coding | Medication type URL: http://hl7.org.au/fhir/StructureDefinition/medication-type Binding: Medication Type (required) | |||||||||||||||||||
| system |
0..1 | uri | Identity of the terminology system | |||||||||||||||||||
| 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 | CodeableConceptIPS | 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: Medication Ingredient (preferred)
| ||||||||||||||||||||
| itemCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||||||||||||||||
| 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 | Status | Usage | ValueSet | Version | Source |
| Medication.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Medication.code | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Medication.code.coding:pbs | Base | required | PBS Item Codes | 📦7.0.0-ci-build | AU Base Implementation Guide vnull |
| Medication.code.coding:amt | Base | required |
Australian Medication
|
⏿1.0.2 | tx.hl7.org.au |
| Medication.status | Base | required | Medication status codes | 📍4.0.1 | FHIR Std. |
| Medication.form | Base | preferred |
Medication Form
|
⏿1.1.1 | tx.hl7.org.au |
| Medication.ingredient.item[x] | Base | preferred |
Medication Ingredient
|
⏿1.0.0 | tx.hl7.org.au |
| Id | Grade | Path(s) | Description | Expression |
| 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 AUCoreMedication
Summary
Must-Support: 4 elements
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2024+ HL7 Australia. Package hl7.fhir.au.ps#1.0.1-ci-build based on FHIR 4.0.1. Generated 2026-10-11
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change