Business Context Index > Business Rules
Business Rules
The following Business rules should be considered for implementation:
| Business Rules# | Business Rule Description | FHIR® field /JWT token |
|---|---|---|
| BR-101 | The DHDR Consumer API should support RESTful FHIR interface. | |
| BR-102 | GET query should support search by mandatory patient identity parameter of Patient Identifier (health card number). | patient.identifier |
| BR-103 | The patient information provided in the query must be accurate according to the most recent Ontario Health Card. | patient.identifier |
| BR-104 | Optional search parameter Dispensed Date should be supported if provided by the consuming application. The dispensed date should allow for a date range (FROM date and TO date) or block of time (e.g., last 30 days, last 60 days). If Dispensed Date is not provided by the consumer application, the DHDR response shall provide the records for the last 120 days. |
whenprepared |
| BR-105 | When using End Date, End Date should be greater than the Start Date and should follow the equivalent parameter as in Start Date. | whenprepared |
| BR-106 | Any parameters chosen in the filtering criteria should not have a blank value. | All parameters |
| BR-107 | The DHDR Consumer API shall support READ requests based on MedicationDispense ID. | MedicationDispense ID |
| BR-108 | If no DHDR data falls within the parameters of the request, DHDR must return appropriate notification in the query response. | OperationOutcome |
| BR-109 | All of available DHDR data elements as per the current FHIR specification should be returned in response to the consuming application query. |
DHDR Data Elements
Here is the list of query parameters and data elements with descriptions that consumers may expect from DHDR.
Query Parameters Data
The following table summarizes the mandatory and optional parameters for the query
Mandatory Parameters:
| Data Element | Definition | Example |
|---|---|---|
| Patient identifier | Only the 10 digit Ontario health card number (HCN) is allowed as an ID parameter in the current release. Note: HCN Version is not supported. DHDR uses Ontario HCN for unique identification of a patient while a version number is usually used for verification of the provincial coverage eligibility, which is out of scope for DHDR. |
3821694372 |
Optional Parameter:
| Data Element | Definition | Example |
|---|---|---|
| whenprepared | This parameter contains the dispensed date of the substance. Note: If there is no lower limit in the search request, the server will use a configured default, e.g. 120 days back. |
gt2015-02-24 |
DHDR Data Elements with FHIR Elements Mapping
The following tables summarize the medication data currently available within DHDR. The amount of medication information returned from the DHDR in response to a query depends on the query operation used. Refer to the Profiles and Operations section for further guidance.
Note: DHDR may return COVID-19 vaccination information from COVaxON data source. Those data elements are marked as "Y" in the COVaxON data source column and additional examples where necessary are provided in the tables below.
Patient
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Patient First Name | First name of the patient | MedicationDispense.subject.Patient.name.given | Y | John |
| Patient Last Name | Last name of the patient | MedicationDispense.subject.Patient.name.family | Y | Simpson |
| Patient’s Gender (Administrative Sex) | Gender of the patient | MedicationDispense.subject.Patient.gender | Y | male |
| Patient Date of Birth (DOB) | Date of birth of the patient | MedicationDispense.subject.Patient.birthDate | Y | 1956-05-12 |
| Patient’s Ontario Health Card Number (HCN) | Number on an Ontario Health Card that uniquely identifies a patient | MedicationDispense.subject.Patient.identifier[1].value | Y | ID Issuer: Ontario, Canada Personal Health Number; ID Value: 1234567890 |
Medication
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Drug Identification Number (DIN)/Product Identification Number (PIN) | Drug Identification Number (DIN) assigned by Health Canada to every medication (e.g. Voltaren – DIN 00514012). Product Identification Number (PIN) assigned by the Ministry of Health (MOH) to every pharmacy service (e.g. MedsCheck – PIN 93899981) and some medications. | MedicationDispense.medicationReference.Medication.code.coding[1].code | Y | 00514012 COVaxON source: Pfizer: "02509210" Moderna: "02510014" |
| Brand Name | Brand name or trade name of the prescription drug or the category (type) of pharmacy service dispensed or COVID-19 vaccine administered | MedicationDispense.medicationReference.Medication.code.coding[1].display | Y | Voltaren COVaxON source: PFIZER-BIONTECH COVID-19 mRNA MODERNA COVID-19 mRNA-1273 |
| Generic Name | Non-proprietary name or generic name of the prescription drug dispensed or the description of the pharmacy service rendered, or generic name of the COVID-19 vaccine administeredd | MedicationDispense.medicationReference.Medication.code.coding[2].display | Y | diclofenac sodium COVaxON source: COVID-19 mRNA |
| Therapeutic Classification | Pharmacologic therapeutic classification of the prescription drug dispensed | MedicationDispense.medicationReference.Medication.code.coding[3].display | N/A | analgesics nonsteroidal |
| Therapeutic Sub-Classification | Pharmacologic therapeutic sub-classification of the prescription drug dispensed | MedicationDispense.medicationReference.Medication.code.coding[4].display | N/A | anti- inflammatory agent |
| Strength | The amount of active ingredient in the prescription drug dispensed | MedicationDispense.medicationReference.Medication.extension[1].valueString | Y | 100mg COVaxON source: “30 mcg/0.3 mL” & “100 mcg/0.5 mL” |
| Compound Indicator Note: future release |
Indicates that the drug product identified in the dispensed event was used to prepare a compounded medication | MedicationDispense.medicationReference.Medication.extension[2].valueBoolean | N/A | false |
| Dosage Form | The physical form of a dose of a drug product or dosage form of the COVID-19 vaccine administered | MedicationDispense.medicationReference.Medication.form.text | Y | tablet or capsule COVaxON source: "Inj-Susp" for both Pfizer and Moderna |
Practitioner Prescriber
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Prescriber ID | License/registration number of the prescriber, issued by their licensing college or health care provider who administered the COVID-19 vaccine | MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.identifer.value | Y | 9898789 |
| Prescriber Issuing College | Identifies the registration authority (i.e. regulatory college – CPSO, RCDSO, etc.) which issued the license/registration number to the prescriber of the medication or the health care provider who administered the COVID-19 vaccine | MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.identifer.system | Y | https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-license-physician The DHDR identifier system should be mapped to the college description in the Command 'pagelink' could not render: Page not found. section. |
| Prescriber Name | First and last name of the prescriber that provided the prescription or ordered the pharmacy service or health care provider who administered the COVID-19 vaccine | MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.name.family MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.name.given |
Y | Smith John |
| Prescriber Phone Number | Phone number of the prescriber that provided the prescription or ordered the pharmacy service, or health care provider who administered the COVID-19 vaccine | MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.telecom[1].value | Y | 905-543-2314 |
| Prescriber Fax Number | Fax number of the prescriber that provided the prescription or ordered the pharmacy service, or health care provider who administered the COVID-19 vaccine | MedicationDispense.authorizingPrescription.MedicationRequest.requester.Practitioner.telecom[2].value | N/A | 416-452-3963 |
Practitioner Dispenser
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Pharmacist ID | License/registration number of the dispenser, issued by their licencing college | MedicationDispense.performer[2].actor.Practitioner.identifer.value | N/A | 200087 |
| Pharmacist Issuing College | Identifies the registration authority (i.e. regulatory college) which issued the license/registration number to the dispenser of the medication/pharmacy service. This is OCP in most cases, but may be CPSO in the case of a dispensing physician | MedicationDispense.performer[2].actor.Practitioner.identifer.system | N/A | Fixed to URI of Ontario College of Pharmacists Pharmacy ID: https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-license-pharmacist |
| Pharmacist Name | Name of the pharmacist or dispensing physician that dispensed the medication or provided the pharmacy service Available in ODB if the pharmacist rendered a pharmacy service |
MedicationDispense.performer[2].actor.Practitioner.name.family MedicationDispense.performer[2].actor.Practitioner.name.given |
N/A | Sway Peter |
Organization
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Pharmacy ID | Registration number of the dispensary which dispensed the medication/pharmacy service. Typically, for an accredited pharmacy, this will be the National Pharmacy ID Code, in alignment with the Canadian Pharmacists Association v3 claim standard. Will be a ministry assigned number for other dispensary locations (e.g. dispensing physicians) | MedicationDispense.performer[1].actor.Organization.identifier.value | N/A | ON50533355 |
| Pharmacy Issuing College | Identifies the registration authority (i.e. regulatory college) which issued the license/registration number to the dispensary which dispensed the prescription/pharmacy service - this is OCP in most cases | MedicationDispense.performer[1].actor.Organization.identifier.system | N/A | Fixed to URI of Ontario College of Pharmacists Pharmacy ID: https://fhir.infoway-inforoute.ca/NamingSystem/ca-on-pharmacy-id-ocp |
| Pharmacy Name | Name of the pharmacy that dispensed the prescription or rendered the pharmacy service | MedicationDispense.performer[1].actor.Organization.name | N/A | Good Life Pharmacy |
| Pharmacy Phone Number | Phone number of the pharmacy that dispensed the prescription or rendered the pharmacy service | MedicationDispense.performer[1].actor.Organization.telecom[1].value | N/A | 905-553-2414 |
| Pharmacy Fax Number | Fax number of the pharmacy that dispensed the prescription or rendered the pharmacy service | MedicationDispense.performer[1].actor.Organization.telecom[2].value | N/A | 416-386-7967 |
Medication Request
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Original Rx Number | Number assigned by EMR or ePrescribing system to a new prescription on the original date of prescription | MedicationDispense.authorizingPrescription.MedicationRequest.identifier.value | N/A | 9086374290 |
| Original Rx Number System | Source system of the original Rx Number (e.g EMR, PMS or ePrescribing) | MedicationDispense.authorizingPrescription.MedicationRequest.identifier.system | N/A | http://ehealthontario.ca/fhir/NamingSystem/ca-on-pharmacy-ON01987654-rx-number |
| Medical Condition / Reason for Use | Indicates prescriber’s designation of the medical condition for which the patient is being treated. This data field is only available for Limited Use products (e.g. Acarbose, Aflibercept) | MedicationDispense.authorizingPrescription.MedicationRequest.reasonCode.coding.code MedicationDispense.authorizingPrescription.MedicationRequest.reasonCode.coding.display |
N/A | Rheumatoid arthritis For patients who have had: History of a documented, clinically significant ulcer or GI bleed; or Failure or intolerance to at least three listed NSAIDS. NOTE: The maximum daily dose of celecoxib which will be reimbursed for the treatment of rheumatoid arthritis is 400mg. |
Medication Dispense
| Data Field | Definition | FHIR Resource Mapping | COVaxON Data Source | Example |
|---|---|---|---|---|
| Source | The source of the data being disclosed | MedicationDispense.meta.source | Y | http://ehealthontario.ca/hns COVaxON source: http://ehealthontario.ca/covaxon |
| Refills Remaining Note: future release |
Total number of refills remaining on a prescription | MedicationDispense.extension[1].valueInteger | N/A | 1 |
| Quantity Remaining Note: future release |
Total quantity remaining on a prescription | MedicationDispense.extension[2].valueQuantity.value MedicationDispense.extension[2].valueQuantity.unit |
N/A | 20 |
| Current Prescription Number | Number assigned by the pharmacy that appears on the label of the dispensed medication or unique identifier assigned to the COVID-19 record by COVaxON | MedicationDispense.identifer.value MedicationDispense.identifier.system |
Y | 509799785 http://ehealthontario.ca/fhir/NamingSystem/ca-on-pharmacy-ON50533355-rx-number COVaxON source: http://ehealthontario.ca/fhir/NamingSystem/ca-on-drug-covaxon |
| Category | Type of dispense event | MedicationDispense.category.coding.code | Y | drug COVaxON source: Fixed to "product" |
| Dispense Status | A code specifying the state of the dispense event | MedicationDispense.status | Y | completed COVaxON source: Will get only "completed" status |
| Quantity | Quantity of medication dispensed or COVID-19 vaccine administered | MedicationDispense.quantity.value MedicationDispense.quantity.unit |
Y | 20 Tablet COVaxON source: 0.3 mL & 0.5 mL |
| Estimated Days Supply | Estimated number of days of treatment based on the directions for use on the prescription and/or the pharmacist’s judgment on usage | MedicationDispense.daysSupply.value | N/A | 30 |
| Dispensed Date | Date when the prescription drug was dispensed (prepared) or the pharmacy service was rendered or COVID-19 vaccine administered | MedicationDispense.whenPrepared | Y | 2021-05-17 COVaxON source: Immunization Occurrence Date and Time |
| Last Pickup Date Note: future release |
Date when the last dispensed product was provided to the patient | MedicationDispense.whenHandedOver | N/A | 2021-01-03 |
| Dosage Specification Note: future release |
Free text dosage instructions | MedicationDispense.dosageInstruction.text | N/A | Take 2 tablet Daily |
| Patient Dosage Instruction Note: future release |
The instructions to the patient on how the medication is to be taken | MedicationDispense.dosageInstruction.patientInstruction | N/A | Take 2 tablet Daily |
| Frequency Note: future release |
The frequency with which the medication is to be taken (e.g., once a day, twice a day, every six hours) | MedicationDispense.dosageInstruction.timing.repeat.frequency MedicationDispense.dosageInstruction.timing.repeat.period MedicationDispense.dosageInstruction.timing.repeat.periodMax MedicationDispense.dosageInstruction.timing.repeat.periodUnit |
N/A | frequency: 2 period: 1 periodMax: 12 periodUnit: d |
| PRN Indicator Note: future release |
An indicator that the medication is to be taken “as needed” | MedicationDispense.dosageInstruction.asNeededBoolean | N/A | false |
| Route Note: future release |
The route by which a drug is administered to the patient (e.g., oral, inhalation, transdermal, injectable, rectal) | MedicationDispense.dosageInstruction.route.text | N/A | oral |
| Dose Note: future release |
The dose of the medication to be administered or taken by the patient (e.g. two capsules) | MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.value MedicationDispense.dosageInstruction.doseAndRate.doseQuantity.unit |
N/A | 2 tablet |