Profile: Medication (Submission)

Simplifier project page: Medication DHDR 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

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
strengthS C0..1Extension(string)
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
codeS Σ1..1CodeableConceptEHRBinding
statusΣ ?!0..1codeBinding
manufacturerΣ C0..1Reference(Organization)
formS0..1CodeableConceptEHRBinding
amountΣ C0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
itemCodeableConceptCodeableConceptEHR
isActive0..1boolean
strengthC0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
lotNumber0..1string
expirationDate0..1dateTime

Hybrid View

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
strengthS C0..1Extension(string)
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
codeS Σ1..1CodeableConceptEHRBinding
statusΣ ?!0..1codeBinding
manufacturerΣ C0..1Reference(Organization)
formS0..1CodeableConceptEHRBinding
amountΣ C0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
itemCodeableConceptCodeableConceptEHR
isActive0..1boolean
strengthC0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
lotNumber0..1string
expirationDate0..1dateTime

Snapshot View

idΣ0..1id
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
strengthS C0..1Extension(string)
modifierExtension?! C0..*Extension
identifierΣ0..*Identifier
codeS Σ1..1CodeableConceptEHRBinding
statusΣ ?!0..1codeBinding
manufacturerΣ C0..1Reference(Organization)
formS0..1CodeableConceptEHRBinding
amountΣ C0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
itemCodeableConceptCodeableConceptEHR
isActive0..1boolean
strengthC0..1Ratio
id0..1string
extensionC0..*Extension
modifierExtensionΣ ?! C0..*Extension
lotNumber0..1string
expirationDate0..1dateTime

Table View

Medication..
Medication.extension..
Medication.extension:strengthExtension..1
Medication.codeCodeableConceptEHR1..
Medication.formCodeableConceptEHR..
Medication.ingredient..
Medication.ingredient.item[x]CodeableConceptEHR..

JSON View

{
"resourceType": "StructureDefinition",
"id": "Medication-DHDRsubmission",
"url": "http://ehealthontario.ca/fhir/StructureDefinition/ca-on-medications-profile-Medication-submission",
"version": "4.0.1",
"name": "MedicationDHDRSubmission",
"title": "Medication DHDR 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",
"element": [
{
"id": "Medication.extension",
"path": "Medication.extension",
"mustSupport": true
},
{
"id": "Medication.extension:strength",
"path": "Medication.extension",
"sliceName": "strength",
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://prescribeit.ca/fhir/StructureDefinition/ext-medication-strength-description"
]
}
],
"mustSupport": true,
"isModifier": false
},
{
"id": "Medication.code",
"path": "Medication.code",
"comment": "Generic medications will have a fixed value of https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name on coding.system",
"min": 1,
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/CodeableConcept-oh-ehr"
]
}
],
"mustSupport": true,
"binding": {
{
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts"
},
{
"url": "documentation",
"valueMarkdown": "All Natural Product Number (NPN) and Homeopathic Medicine Number (DIN-HM) codes that are licensed by Health Canada and present in the Licensed Natural Health Products Database."
},
{
"url": "key",
"valueId": "medCodeLNHP"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
}
},
{
"id": "Medication.form",
"path": "Medication.form",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/CodeableConcept-oh-ehr"
]
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/pharmaceuticaldoseformcode"
}
},
{
"id": "Medication.ingredient",
"path": "Medication.ingredient",
"mustSupport": true
},
{
"id": "Medication.ingredient.item[x]",
"path": "Medication.ingredient.item[x]",
"comment": "Generic medications will have a fixed value of https://ehealthontario.ca/fhir/NamingSystem/ca-drug-gen-name on coding.system",
"type": [
{
"code": "CodeableConcept",
"profile": [
"http://ontariohealth.ca/fhir/ehr/StructureDefinition/CodeableConcept-oh-ehr"
]
}
],
"mustSupport": true,
"binding": {
{
{
"url": "purpose",
"valueCode": "candidate"
},
{
"url": "valueSet",
"valueCanonical": "https://fhir.infoway-inforoute.ca/ValueSet/LicensedNaturalHealthProducts"
},
{
"url": "documentation",
"valueMarkdown": "All Natural Product Number (NPN) and Homeopathic Medicine Number (DIN-HM) codes that are licensed by Health Canada and present in the Licensed Natural Health Products Database."
},
{
"url": "key",
"valueId": "ingredientLNHP"
}
],
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-binding"
}
],
"strength": "preferred",
"valueSet": "https://fhir.infoway-inforoute.ca/ValueSet/prescriptionmedicinalproduct"
}
}
]
}
}

Usage

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

Notes

.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 For hospital administered medication record:
    1. If at least one drug product (i.e., has CCDD-MP, CCDD-NTP code(s)) is ordered/administered, parent Medication resource SHOULD be sent as CCDD TM code (if no CCDD TM code, then free text). Child Medication resource SHALL be sent as CCDD-NTP or CCDD-MP code.
    2. For natural products, HC-NPN.
    3. If no CCDD or HC-NPN code available, then submit text.

      For community dispensed medication record: CCDD-MP, CCDD-NTP or TM code of the medication, CCDD-NTP device code, or HC-NPN for natural products. For medications, submission of the MP code is preferred, followed by NTP code and then TM code. If no CCDD or HC-NPN code available, then submit text.
  • code.coding.display SHALL be set with Formal Name as associated with the contributed code (e.g., if CCDD-MP Code is contributed, then must contribute CCDD-MP Formal Name).
  • code.text a textual description of the device, service or drug.
    • The element SHALL be mandatory if category is "Service", or for devices and drugs if no CCDD or HC-NPN code is available.
    • For devices where a CCDD code is available this element is optional.
    • If sending a Medication Dispense record for a vaccination event, then description should indicate vaccine and administration event where possible (e.g., “Administration of Shingrex”)

.form

  • The dosage form indicates the manner in which the medication/treatment is aggregated for administration/dispense, e.g., tablets, capsules, suppositories. In some cases, this information is implied by the drug code in code.coding.code. Use this field when the code does not specify the dosage form. SHOULD be contributed if TM code contributed.

.ingredient

  • list of all the ingredients that make up a compound, including their identifier (i.e. CCDD or HC-NPN identifier) when available.
  • the element SHALL be mandatory for all compounded medications.
  • item[x].coding.code This field must contain a code indicating the ingredient. CCDD is the required terminology for drug identifiers. Contributing HICs must support CCDD Manufactured Product (MP), Non-proprietary Therapeutic Product (NTP) or Therapeutic Moiety (TM) codes for this data element. NPN may also be used if a CCDD-MP, CCDD-NTP or TM code is not available. If a suitable drug code is not available in CCDD-MP, CCDD-NTP, TM or NPN, the system SHALL send the ingredient name (with strength, strength units, and form if available) only as text in the item[x].text field.