| Left: | Medication (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips) |
| Right: | AU PS Medication (http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication) |
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips' vs 'http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication' |
| Error | StructureDefinition.version | Values for version differ: '2.0.0-ballot' vs '0.4.0-draft' |
| Information | StructureDefinition.name | Values for name differ: 'MedicationIPS' vs 'AUPSMedication' |
| Information | StructureDefinition.title | Values for title differ: 'Medication (IPS)' vs 'AU PS Medication' |
| Information | StructureDefinition.status | Values for status differ: 'active' vs 'draft' |
| Information | StructureDefinition.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2025-08-22T04:48:04+00:00' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 Australia' |
| Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001' |
| Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#AU' |
| Error | StructureDefinition.baseDefinition | Values for baseDefinition differ: 'http://hl7.org/fhir/StructureDefinition/Medication' vs 'http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication' |
| Information | StructureDefinition.short | Values for short differ: 'Definition of a Medication' vs 'A medication in an Australian healthcare context' |
| Information | StructureDefinition.comment | Values for comment differ: 'IPS Medication' vs 'For support as text representation of medication strength, for a medication as a whole, consider the [Medication Strength](http://hl7.org.au/fhir/6.0.0-ballot/StructureDefinition-medication-strength.html) extension.' |
| Information | StructureDefinition.short | Values for short differ: 'Medication that was administered or was to be administered (medication code from any code system)' vs 'Coding for the medicine' |
| Information | StructureDefinition.definition | Values for definition differ: 'Medication that was administered or was to be administered. Several kinds of medication coding could be provided as: 1. The IDMP Pharmaceutical Product Identifier (PhPID), Level 1, [Substance(s)]. Example: Amoxicillin and Clavulanate Potassium; or any other equivalent coded concept; 2. The IDMP Pharmaceutical Product Identifier (PhPID), Level 2 [Substance(s) + Strength + reference strength]. Example: Amoxicillin 875 mg and Clavulanate Potassium 125 mg; or any other equivalent coded concept; 3. The IDMP Pharmaceutical Product Identifier (PhPID), Level 3 [Substance(s) + administrable dose form]. Example: Amoxicillin and Clavulanate Potassium, Oral Tablet; or any other equivalent coded concept; 4. The IDMP Pharmaceutical Product Identifier (PhPID), Level 4 [Substance(s) + strength + reference strength + administrable dose form]. Example: Amoxicillin 875 mg and clavulanate potassium 125 mg, oral tablet; or any other equivalent coded concept 5. The IDMP Medicinal Product Identifier (MPID) or any equivalent Medicinal Product Identifier. IDMP MPID uniquely identifies a Medicinal Product, reflecting (but not replacing) any other authorization numbers allocated by a regulator. MPID implies one (set of) PhPID. The MPID shall use a common segment pattern related to a Medicinal Product, which, when each segment is valued shall define a specific MPID concept. 6. The IDMP Packaged Medicinal Product Identifier (PCID) or any equivalent Packaged Medicinal Product Identifier. Uniquely identifies a Medicinal Product based on its packaging. This implies one MPID can be associated with more than one PCID, if the same Medicinal Product has more than one type of package. 7. Any other kind of code that that identifies, classifies or cluster the administered product (e.g. the medicinal product or the product class) The value sets used for the PhPID, MPID and PCID identifiers are provisional and include only few equivalent concepts used for exemplification purposes, they will be updated with real IDMP identifiers when they will become available.' vs 'A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.' |
| Information | StructureDefinition.comment | Values for comment differ: 'Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.' vs 'Australian codings are typical medicine/product concept codes. A code (or set of codes) that specify this medication, or a textual description if no code is available. Usage note: This could be a standard medication code such as a code from RxNorm, SNOMED CT, IDMP etc. It could also be a national or local formulary code, optionally with translations to other code systems.' |
| Information | Medication.code | Example/preferred bindings differ at Medication.code using binding from MedicationIPS |
| Information | StructureDefinition.short | Values for short differ: 'Manufacturer of the item' vs 'Physical product manufacturer organisation' |
| Information | StructureDefinition.definition | Values for definition differ: 'Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product.' vs 'Describes the details of the manufacturer of the medication product. This is not intended to represent the distributor of a medication product it is the manufacturer of the actual physical medicine product.' |
| Information | StructureDefinition.short | Values for short differ: 'Concept - reference to a terminology or just text' vs 'powder | tablets | capsule +' |
| Information | StructureDefinition.definition | Values for definition differ: 'Describes the form of the item. Powder; tablets; capsule. Administrable Pharmaceutical Dose Form. This code represents the form of the medication (e.g. tablet, capsule, liquid) Since the EDQM Standards Terms, together with UCUM, is one of the IDMP terminologies actually available for usage, this code system has been selected as referecne terminology for representing Pharmaceutical Dose forms;Pakages and Route of Administration. It is known that also alternative jurisdictional and international terminologies are known to be used for this concept domain, as NCI or SNOMED CT.' vs 'Describes the form of the item. Powder; tablets; capsule.' |
| Information | StructureDefinition.comment | Values for comment differ: 'Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.' vs 'When Medication is referenced from MedicationRequest, this is the ordered form. When Medication is referenced within MedicationDispense, this is the dispensed form. When Medication is referenced within MedicationAdministration, this is administered form.' |
| Information | Medication.form | Example/preferred bindings differ at Medication.form using binding from MedicationIPS |
| Information | StructureDefinition.definition | Values for definition differ: 'Identifies a particular constituent of interest in the product.' vs 'Identifies a particular constituent of interest in the product. Can be coded with AMT.' |
| Information | StructureDefinition.comment | Values for comment differ: 'The ingredients need not be a complete list. If an ingredient is not specified, this does not indicate whether an ingredient is present or absent. If an ingredient is specified it does not mean that all ingredients are specified. It is possible to specify both inactive and active ingredients.' vs 'When individual ingredient strength is unavailable as a ratio, it can be surfaced as text in `CodeableConcept.text` by using pre-adoption of the FHIR R5 [`Medication.ingredient.strength[x]`](https://www.hl7.org/fhir/R5/medication-definitions.html#Medication.ingredient) element with the extension URL [http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength[x]](http://hl7.org/fhir/5.0/StructureDefinition/extension-Medication.ingredient.strength[x]). Where possible use the existing `Medication.ingredient.strength` element in preference to pre-adopting the FHIR R5 `Medication.ingredient.strength[x]` element.' |
| Information | Medication.ingredient.item[x] | Example/preferred bindings differ at Medication.ingredient.item[x] using binding from MedicationIPS |
| Information | StructureDefinition.short | Values for short differ: 'A ratio of two Quantity values - a numerator and a denominator' vs 'Quantity/strength of ingredient present' |
| Information | StructureDefinition.definition | Values for definition differ: 'A relationship of two Quantity values - expressed as a numerator and a denominator.' vs 'Specifies how many (or how much) of the items there are in this Medication. For example, 250 mg per tablet. This is expressed as a ratio where the numerator is 250mg and the denominator is 1 tablet.' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Medication | http://hl7.org.au/fhir/core/StructureDefinition/au-core-medication |
|
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2022+; Licensed Under Creative Commons No Rights Reserved. |
| |
date | 2024-06-19T10:50:07-05:00 | 2025-08-22T04:48:04+00:00 |
|
description | This profile represents the constraints applied to the Medication resource by the International Patient Summary (IPS) FHIR Implementation Guide, based on FHIR R4. A medication is described in the patient summary as an instance of a Medication resource constrained by this profile. | 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](https://build.fhir.org/ig/hl7au/au-fhir-core/StructureDefinition-au-core-medication.html) profile, and applies the additional requirements from [Medication (IPS)](http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips). |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
![]() jurisdiction[1] | urn:iso:std:iso:3166#AU |
| |
kind | resource | ||
name | MedicationIPS | AUPSMedication |
|
publisher | HL7 International / Patient Care | HL7 Australia |
|
purpose | This profile constrains the representation of a medication, in the context of the international patient summary as specified by the IPS project of HL7 International. |
| |
status | active | draft |
|
title | Medication (IPS) | AU PS Medication |
|
type | Medication | ||
url | http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips | http://hl7.org.au/fhir/ps/StructureDefinition/au-ps-medication |
|
version | 2.0.0-ballot | 0.4.0-draft |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Medication | Definition of a Medication | 0..* | AUCoreMedication | A medication in an Australian healthcare context This profile also complies with the profile Medication (IPS) | |||||||||||||||||||||||||||||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||||||||||||||||||||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||||||||||||||||||||||||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||||||||||||||||||||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||||||||||||||||||||||||||
![]() ![]() | 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 | 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 | |||||||||||||||||||||||||||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||||||||||||||||||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||||||||||||||||||||||||||
![]() ![]() | Σ | 0..* | Identifier | Business identifier for this medication | Σ | 0..* | Identifier | Business identifier for this medication | |||||||||||||||||||||||||||||||||
![]() ![]() | S | 1..1 | ?? | Medication that was administered or was to be administered (medication code from any code system) Binding: ?? (preferred): SNOMED CT medications (Medicinal product) or a code for absent/unknown medication
| SOΣ | 1..1 | ?? | Coding for the medicine Binding: ?? (example)
|
| ||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by pattern:$this |
| ||||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | Σ | 0..1 | string | Medication primary text |
| ||||||||||||||||||||||||||||||||||||
![]() ![]() | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: ?? (required): A coded concept defining if the medication is in active use. | ?!Σ | 0..1 | code | active | inactive | entered-in-error Binding: ?? (required): A coded concept defining if the medication is in active use. | |||||||||||||||||||||||||||||||||
![]() ![]() | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | Σ | 0..1 | Reference(Organization) | Physical product manufacturer organisation | |||||||||||||||||||||||||||||||||
![]() ![]() | S | 0..1 | ?? | Concept - reference to a terminology or just text Binding: ?? (preferred) | SO | 0..1 | ?? | powder | tablets | capsule + Binding: ?? (preferred)
|
| ||||||||||||||||||||||||||||||||
![]() ![]() | Σ | 0..1 | Ratio | Amount of drug in package | Σ | 0..1 | Ratio | Amount of drug in package | |||||||||||||||||||||||||||||||||
![]() ![]() | S | 0..* | BackboneElement | Active or inactive ingredient | SO | 0..* | BackboneElement | Active or inactive ingredient
| |||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
![]() ![]() ![]() | S | 1..1 | ??, Reference(Substance | Medication) | The actual ingredient or content Binding: ?? (preferred): SNOMED CT drug substances | SO | 1..1 | ??, Reference(Substance | Medication) | The actual ingredient or content Binding: ?? (preferred)
|
| ||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | boolean | Active ingredient indicator | 0..1 | boolean | Active ingredient indicator | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | SC | 0..1 | ?? | A ratio of two Quantity values - a numerator and a denominator | SO | 0..1 | Ratio | Quantity/strength of ingredient present
| |||||||||||||||||||||||||||||||||
![]() ![]() | 0..1 | BackboneElement | Details about packaged medications | 0..1 | BackboneElement | Details about packaged medications | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | string | Identifier assigned to batch | 0..1 | string | Identifier assigned to batch | |||||||||||||||||||||||||||||||||||
![]() ![]() ![]() | 0..1 | dateTime | When batch will expire | 0..1 | dateTime | When batch will expire | |||||||||||||||||||||||||||||||||||
Documentation for this format | |||||||||||||||||||||||||||||||||||||||||