Profiles & Operations Index > Profile: Medication

Profile: Medication

Simplifier project page: Medication

Derived from: Medication (R4)

Canonical_URLProfile_StatusProfile_VersionFHIR_Version
http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Medicationactive4.0.14.0.1

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
monitoredDrugIndicatorS I0..1Extension(boolean)
compoundIndicatorS I0..1Extension(boolean)
identifierΣ0..*Identifier
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
statusΣ ?!0..1codeBinding
manufacturerΣ I0..1Reference(Organization)
form0..1CodeableConcept
amountΣ I0..1Ratio
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Hybrid View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
monitoredDrugIndicatorS I0..1Extension(boolean)
compoundIndicatorS I0..1Extension(boolean)
identifierΣ0..*Identifier
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
statusΣ ?!0..1codeBinding
manufacturerΣ I0..1Reference(Organization)
form0..1CodeableConcept
amountΣ I0..1Ratio
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Snapshot View

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
monitoredDrugIndicatorS I0..1Extension(boolean)
compoundIndicatorS I0..1Extension(boolean)
identifierΣ0..*Identifier
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
statusΣ ?!0..1codeBinding
manufacturerΣ I0..1Reference(Organization)
form0..1CodeableConcept
amountΣ I0..1Ratio
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeΣ0..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Table View

Medication..
Medication.id..
Medication.meta1..
Medication.meta.profile1..
Medication.extension..
Medication.extensionExtension..1
Medication.extensionExtension..
Medication.code1..
Medication.code.coding..
Medication.code.coding..1
Medication.code.coding.system1..
Medication.code.coding.code1..
Medication.code.coding.display1..
Medication.code.coding..1
Medication.code.coding.system1..
Medication.code.coding.display1..
Medication.code.coding..1
Medication.code.coding.system1..
Medication.code.coding.code1..
Medication.code.coding.display1..
Medication.code.coding..1
Medication.code.coding.system1..
Medication.code.coding.code1..
Medication.code.coding.display1..
Medication.code.text..
Medication.ingredient..
Medication.ingredient.item[x]CodeableConcept..
Medication.ingredient.item[x].coding..
Medication.ingredient.item[x].coding..1
Medication.ingredient.item[x].coding.system1..
Medication.ingredient.item[x].coding.code1..
Medication.ingredient.item[x].coding.display1..
Medication.ingredient.item[x].coding..1
Medication.ingredient.item[x].coding.system1..
Medication.ingredient.item[x].coding.code1..
Medication.ingredient.item[x].coding.display1..
Medication.ingredient.item[x].coding..1
Medication.ingredient.item[x].coding.system1..
Medication.ingredient.item[x].coding.display1..
Medication.ingredient.item[x].coding..1
Medication.ingredient.item[x].coding.system1..
Medication.ingredient.item[x].coding.code1..
Medication.ingredient.item[x].coding.display1..
Medication.ingredient.item[x].text..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "9de0a159-f64e-4a20-8f98-96d1ef353042",
    "meta": {
        "lastUpdated": "2023-11-09T20:35:42.3698985+00:00"
    },
    "text": {
        "status": "empty",
        --- We have skipped the narrative for better readability of the resource ---
    },
    "url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Medication",
    "version": "4.0.1",
    "name": "Medication",
    "status": "active",
    "date": "2022-01-19T16:27:26.8383497+00:00",
    "description": "This resource is used for the identification and definition of a medication for the purposes of prescribing, dispensing, and administering a medication.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "acCDR-HL7v2-mapping",
            "name": "acCDR HL7v2 mapping"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "Medication",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Medication",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "Medication",
                "path": "Medication",
                "mustSupport": true
            },
            {
                "id": "Medication.id",
                "path": "Medication.id",
                "mustSupport": true
            },
            {
                "id": "Medication.meta",
                "path": "Medication.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.meta.profile",
                "path": "Medication.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.extension",
                "path": "Medication.extension",
                "mustSupport": true
            },
            {
                "id": "Medication.extension:monitoredDrugIndicator",
                "path": "Medication.extension",
                "sliceName": "monitoredDrugIndicator",
                "max": "1",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-monitored-drug-indicator"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Medication.extension:compoundIndicator",
                "path": "Medication.extension",
                "sliceName": "compoundIndicator",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-ext-compound-indicator"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "Medication.code",
                "path": "Medication.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding",
                "path": "Medication.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        },
                        {
                            "type": "value",
                            "path": "code"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugDIN",
                "path": "Medication.code.coding",
                "sliceName": "drugDIN",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://www.canada.ca/en/health-canada/services/drugs-health-products/drug-products/drug-product-database-3"
                }
            },
            {
                "id": "Medication.code.coding:drugDIN.system",
                "path": "Medication.code.coding.system",
                "min": 1,
                "fixedUri": "http://hl7.org/fhir/NamingSystem/ca-hc-din",
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugDIN.code",
                "path": "Medication.code.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugDIN.display",
                "path": "Medication.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugGeneric",
                "path": "Medication.code.coding",
                "sliceName": "drugGeneric",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugGeneric.system",
                "path": "Medication.code.coding.system",
                "min": 1,
                "fixedUri": "https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name",
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugGeneric.display",
                "path": "Medication.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugCCDD",
                "path": "Medication.code.coding",
                "sliceName": "drugCCDD",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
                }
            },
            {
                "id": "Medication.code.coding:drugCCDD.system",
                "path": "Medication.code.coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/hc-CCDD",
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugCCDD.code",
                "path": "Medication.code.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugCCDD.display",
                "path": "Medication.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugNatural",
                "path": "Medication.code.coding",
                "sliceName": "drugNatural",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/LicensedNaturalHealthProducts"
                }
            },
            {
                "id": "Medication.code.coding:drugNatural.system",
                "path": "Medication.code.coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-hc-npn",
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugNatural.code",
                "path": "Medication.code.coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding:drugNatural.display",
                "path": "Medication.code.coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.text",
                "path": "Medication.code.text",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient",
                "path": "Medication.ingredient",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x]",
                "path": "Medication.ingredient.item[x]",
                "type":  [
                    {
                        "code": "CodeableConcept"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding",
                "path": "Medication.ingredient.item[x].coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugCCDD",
                "path": "Medication.ingredient.item[x].coding",
                "sliceName": "drugCCDD",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
                }
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugCCDD.system",
                "path": "Medication.ingredient.item[x].coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/hc-CCDD",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugCCDD.code",
                "path": "Medication.ingredient.item[x].coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugCCDD.display",
                "path": "Medication.ingredient.item[x].coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugNatural",
                "path": "Medication.ingredient.item[x].coding",
                "sliceName": "drugNatural",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://fhir.infoway-inforoute.ca/io/psca/ValueSet/LicensedNaturalHealthProducts"
                }
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugNatural.system",
                "path": "Medication.ingredient.item[x].coding.system",
                "min": 1,
                "fixedUri": "http://terminology.hl7.org/CodeSystem/v3-hc-npn",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugNatural.code",
                "path": "Medication.ingredient.item[x].coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugNatural.display",
                "path": "Medication.ingredient.item[x].coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugGeneric",
                "path": "Medication.ingredient.item[x].coding",
                "sliceName": "drugGeneric",
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugGeneric.system",
                "path": "Medication.ingredient.item[x].coding.system",
                "min": 1,
                "fixedUri": "https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugGeneric.display",
                "path": "Medication.ingredient.item[x].coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugDIN",
                "path": "Medication.ingredient.item[x].coding",
                "sliceName": "drugDIN",
                "max": "1",
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://www.canada.ca/en/health-canada/services/drugs-health-products/drug-products/drug-product-database-3"
                }
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugDIN.system",
                "path": "Medication.ingredient.item[x].coding.system",
                "min": 1,
                "fixedUri": "http://hl7.org/fhir/NamingSystem/ca-hc-din",
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugDIN.code",
                "path": "Medication.ingredient.item[x].coding.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].coding:drugDIN.display",
                "path": "Medication.ingredient.item[x].coding.display",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.ingredient.item[x].text",
                "path": "Medication.ingredient.item[x].text",
                "mustSupport": true
            }
        ]
    }
}

Usage

The Medication Resource describes a medication and pharmacy service from the DHDR

Notes

.meta.profile

  • used to declare conformance to this profile
  • populate with a fixed value: http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Medication|4.0.1

.code

  • code.coding sliced element.
    For Medication Dispense the field may contain Drug Identification Number (DIN), Canadian Clinical Drug Data (CCDD) or Health Canada Natural Product Number (NPN).

  • SHALL be mandatory element if category is "Drug" and for Devices if a CCDD code exists. The element SHALL be optional if category is "Service" or for compound drugs.
    For Medication Administration the field may contain only Drug Identification Number (DIN), Canadian Clinical Drug Data (CCDD) or Health Canada Natural Product Number (NPN).

  • code.coding.system SHALL be
    http://terminology.hl7.org/CodeSystem/hc-CCDD for CCDD,
    http://terminology.hl7.org/CodeSystem/v3-hc-npn for NPN,
    http://hl7.org/fhir/NamingSystem/ca-hc-din for DIN,
    https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name for generic

  • code.coding.code code of the dispensed drug or devices.

  • code.coding.display brand/display name of the dispensed drug, pharmacy service or device.

  • code.text a textual description of the device or service. The element SHALL be mandatory if category "Service" or for devices if no CCDD code available. For drugs, this would include generic name, strength and dosage form.

.ingredient

  • list of all the ingredients that make up a compound, including their identifier (i.e. CCDD or HC-NPN identifier).
  • the element SHALL be mandatory for all compounded medications
  • the code.text element SHALL include generic name, strength and dosage form