| Name | Value | Comments |
|---|
 abstract | false | |
| baseDefinition | http://hl7.org/fhir/StructureDefinition/Medication | |
| copyright | | Used by permission of HL7 International all rights reserved Creative Commons License | - Added the item 'Used by permission of HL7 International all rights reserved Creative Commons License'
|
| date | 2022-11-22T03:24:39+00:00 | 2022-08-02 | |
| 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. | Minimum expectations for a Medication resource when accessed via a International Patient Access API | |
| experimental | false | |
| fhirVersion | 4.0.1 | |
| jurisdiction | | |
 jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 | |
| kind | resource | |
| name | MedicationIPS | IPAMedication | |
| publisher | Health Level Seven International - Patient Care Work Group | HL7 International - Patient Care Work Group | |
| 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. | | - Removed the item '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 | |
| title | Medication (IPS) | IPA-Medication | |
| type | Medication | |
| url | http://hl7.org/fhir/uv/ips/StructureDefinition/Medication-uv-ips | http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-medication | |
| version | 1.1.0 | 1.0.0 | |
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments |
|---|
 Medication | | 0..* | Medication | Definition of a Medication
| | 0..* | Medication | Definition of a Medication
| |
 id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |
| meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |
| implicitRules | ?!Σ | 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 | |
| language | | 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.
| |
| text | | 0..1 | Narrative | Text summary of the resource, for human interpretation | | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | | 0..* | Resource | Contained, inline Resources
| | 0..* | Resource | Contained, inline Resources
| |
 extension | | 0..* | Extension | Additional content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
| ?! | 0..* | Extension | Extensions that cannot be ignored
| |
| identifier | Σ | 0..* | Identifier | Business identifier for this medication
| Σ | 0..* | Identifier | Business identifier for this medication
| |
| code | S | 1..1 | ?? | Medication that was administered or was to be administered (medication code from any code system)
Binding: ?? (preferred): SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication
| Additional Bindings | Purpose | | ?? | candidate | | ?? | candidate | | ?? | candidate |
| SΣ | 1..1 | CodeableConcept | Codes that identify this medication
Binding: ?? (example): A coded concept that defines the type of a medication.
| - Elements differ in short: 'Medication that was administered or was to be administered (medication code from any code system)' vs 'Codes that identify this medication'
- Elements differ in definition: '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.'
- Elements differ in comments: '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 'Depending on the context of use, the code that was actually selected by the user (prescriber, dispenser, etc.) will have the coding.userSelected set to true. As described in the coding datatype: "A coding may be marked as a "userSelected" if a user selected the particular coded value in a user interface (e.g. the user selects an item in a pick-list). If a user selected coding exists, it is the preferred choice for performing translations etc. Other codes can only be literal translations to alternative code systems, or codes at a lower level of granularity (e.g. a generic code for a vendor-specific primary one).'
- Example/preferred bindings differ at Medication.code using binding from MedicationIPS
- Elements differ in binding.description: 'SNOMED CT medications (Pharmaceutical / biologic product) or a code for absent/unknown medication' vs 'A coded concept that defines the type of a medication.'
|
| status | ?!Σ | 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.
| |
| manufacturer | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | Σ | 0..1 | Reference(Organization) | Manufacturer of the item | |
| form | S | 0..1 | ?? | Concept - reference to a terminology or just text
Binding: ?? (preferred) | | 0..1 | CodeableConcept | powder | tablets | capsule +
Binding: ?? (example): A coded concept defining the form of a medication.
| - Elements differ in short: 'Concept - reference to a terminology or just text' vs 'powder | tablets | capsule +'
- Elements differ in definition: '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.'
- Elements differ in comments: '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.'
- Elements differ in definition for mustSupport: 'true' vs 'false'
- Example/preferred bindings differ at Medication.form using binding from MedicationIPS
|
| amount | Σ | 0..1 | Ratio | Amount of drug in package | Σ | 0..1 | Ratio | Amount of drug in package | |
 ingredient | S | 0..* | BackboneElement | Active or inactive ingredient
| | 0..* | BackboneElement | Active or inactive ingredient
| - Elements differ in definition for mustSupport: 'true' vs 'false'
|
 id | | 0..1 | string | Unique id for inter-element referencing | | 0..1 | string | Unique id for inter-element referencing | |
| extension | | 0..* | Extension | Additional content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| |
| item[x] | S | 1..1 | ??, Reference(Substance | Medication) | The actual ingredient or content
Binding: ?? (preferred): SNOMED CT drug substances
| | 1..1 | CodeableConcept, Reference(Substance | Medication) | The actual ingredient or content | - Elements differ in definition for mustSupport: 'true' vs 'false'
|
| isActive | | 0..1 | boolean | Active ingredient indicator | | 0..1 | boolean | Active ingredient indicator | |
| strength | SC | 0..1 | ?? | A ratio of two Quantity values - a numerator and a denominator | | 0..1 | Ratio | Quantity of ingredient present | - Elements differ in short: 'A ratio of two Quantity values - a numerator and a denominator' vs 'Quantity of ingredient present'
- Elements differ in definition: '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.'
- Elements differ in definition for mustSupport: 'true' vs 'false'
|
 batch | | 0..1 | BackboneElement | Details about packaged medications | | 0..1 | BackboneElement | Details about packaged medications | |
 id | | 0..1 | string | Unique id for inter-element referencing | | 0..1 | string | Unique id for inter-element referencing | |
| extension | | 0..* | Extension | Additional content defined by implementations
| | 0..* | Extension | Additional content defined by implementations
| |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
| |
| lotNumber | | 0..1 | string | Identifier assigned to batch | | 0..1 | string | Identifier assigned to batch | |
| expirationDate | | 0..1 | dateTime | When batch will expire | | 0..1 | dateTime | When batch will expire | |
Documentation for this format |