Profile: Medication (Submission)

Simplifier project page: Medication (Submission)

Derived from: Medication (R4)

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

Formal Views of Profile Content

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

Differential View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
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
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
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Hybrid View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
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
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
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Snapshot View

versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..*canonical(StructureDefinition)
securityΣ0..*CodingBinding
tagΣ0..*Coding
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
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
textS Σ0..1string
isActive0..1boolean
strengthI0..1Ratio
lotNumber0..1string
expirationDate0..1dateTime

Table View

Medication..
Medication.meta1..
Medication.meta.profile1..
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.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].text..


JSON View

{
    "resourceType": "StructureDefinition",
    "id": "9de0a159-f64e-4a20-8f98-96d1ef353042",
    "meta": {
        "lastUpdated": "2023-12-14T21:15:22.3296864+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-submission",
    "version": "4.0.1",
    "name": "Medication",
    "title": "Medication (Submission)",
    "status": "active",
    "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",
    "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.meta",
                "path": "Medication.meta",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.meta.profile",
                "path": "Medication.meta.profile",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code",
                "path": "Medication.code",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "Medication.code.coding",
                "path": "Medication.code.coding",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "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].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-submission|4.0.1

.code

  • code.coding SHOULD be mandatory element if category is "Drug" and for Devices if a CCDD or HC-NPN (natural product) code exists. The element will be optional if category is "Service". The element SHALL be empty for compound drugs.
  • code.coding.system the element SHALL be http://terminology.hl7.org/CodeSystem/hc-CCDD for CCDD or http://terminology.hl7.org/CodeSystem/v3-hc-npn for natural products such as vitamins, minerals, supplements, herbals, proviotics and etc.
  • code.coding.code CCDD of the dispensed drug or devices or HC-NPN for natural products.
  • code.coding.display SHALL be set with CCDD MP Formal Name or NPN Product Name. For devices where code is available it SHALL be CCDD NTP
  • code.text a textual description of the device, service or drug. The element SHALL be mandatory if category service, or for devices and drugs if no CCDD or HC-NPN code available. For devices where a CCDD code is available this element is optional.

.ingredient

  • list of all the ingredients that make up a compound, including their identifier (i.e. CCDD or HC-NPN identifier).
  • the element is mandatory for all compounded medications