---
title: "Entity: Medication"
canonical: "https://wiki.patientsknowbest.com/space/api/3738402817/Entity%3A%20Medication"
format: markdown
---
> Macro (pagetree)



> Macro (toc)

# Class Diagram

<u>[Medication](https://miro.com/app/board/uXjVMNUR7lQ=/?share_link_id=330931584012)</u>

# Display

Medications appear in the Treatments > Medicines page of the patient's record.

Please see[ ](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fmedicines&sa=D&sntz=1&usg=AOvVaw3gd5KaLpexrycNxvS9jxhH)<u>[the manual](https://www.google.com/url?q=https%3A%2F%2Fmanual.patientsknowbest.com%2Fpatient%2Fmedicines&sa=D&sntz=1&usg=AOvVaw3gd5KaLpexrycNxvS9jxhH)</u> for more information.

# Mappings

|  |  |  |  |  |
| --- | --- | --- | --- | --- |
|  | **HL7 API** | **FHIR API**<br>(Customer boxes support full CRUD) | **Web** | **Custom REST API** |
|  |  | **Facade (STU3)** | **Aggregated (R4)** | This is a summary. See [the web spec for full details](https://wiki.patientsknowbest.com/space/api/3867574409/Entity%3A+Medication+%5Bweb%5D). |  |
| **Summary of interactions** |
| Create | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) |  |  |  | [Medicines](https://manual.patientsknowbest.com/patient/medicines) |  |
| Read |  |  | /MedicationRequest | [/MedicationStatement](http://fhir.patientsknowbest.com/structuredefinition/aggregated-medicationstatement) | [Medicines](https://manual.patientsknowbest.com/patient/medicines) |  |
| Update | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31) |  |  |  | [Medicines](https://manual.patientsknowbest.com/patient/medicines) |  |
| Delete | [A28](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28)/[A31](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a31)<br>(replace, but cannot delete all) |  |  |  | [Medicines](https://manual.patientsknowbest.com/patient/medicines) | Please discuss use case with our integrations team. |
| **Entity: Medication - Extends: ****[Data Point](https://wiki.patientsknowbest.com/space/api/3750395905/Entity%3A+Data+Point)** |
| **Status** `Enum`<br>- ACTIVE
- INACTIVE |  |  | status | status | The web interface separates current medications from past medications.<br>The distinction is made by inspecting the End Timestamp and Status values. |  |
| **Substance** `CodeableConcept`<br>The medication. | [ZRX-2](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | medicationCodeableConcept | medicationCodeableConcept | A display-friendly representation of the medication is shown; not every component of the CodeableConcept is shown in all circumstances. | substance |
| **Start Timestamp** `Timestamp`<br>When the medication was started. | [ZRX-1.4](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | [zib-Medication-PeriodOfUse](http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse)<br>authoredOn | effectivePeriod | The web interface permits entry of date but not time. | startDate |
| **End Timestamp** `Timestamp`<br>When the medication was finished. | [ZRX-1.5](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | [zib-Medication-PeriodOfUse](http://nictiz.nl/fhir/StructureDefinition/zib-Medication-PeriodOfUse) | effectivePeriod | The web interface permits entry of date but not time. | endDate |
| **Frequency Text** `String`<br>How frequently the medication should be taken. | [ZRX-1.2](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | dosageInstruction | dosage | Shown. | frequency |
| **Frequency Value** `Number`<br>A representation of how frequently the medication should be taken, when combined with Frequency Units. |  |  | dosageInstruction | dosage | Shown. | frequency |
| **Frequency Units** `Enum`<br>- HOUR |  |  | dosageInstruction | dosage | Shown. | frequency |
| **Frequency Priority** `Enum`<br>Can be used to capture a frequency instruction of:<br>- AS_DIRECTED
- AS_NEEDED |  |  | dosageInstruction | dosage | Shown. | frequency |
| **Dose Value** `Number`<br>How much should be taken. | [ZRX-3.1](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | dosageInstruction | dosage | Shown. | doseValue |
| **Dose Units** `CodeableConcept`<br>The units of the Dose Value. | [ZRX-5](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  |  | dosage | Shown. | doseUnit |
| **Medication Unit** `Enum`<br>- MG
- ML
- UNITS
- TABLETS
- MCG
- DAYS
- DROPS
- INJECTION
- PATCHES
- PUFFS
- MEQ
- MEQL
- MGML
- GRAMS
- LMIN
- NGHR
- MGHR
- SACHETS
- NG
- SPRAY
- MILLION_UNITS
- MCG_HR
- CAPSULES
- DOSES
- MMOL
- APPLICATIONS |  |  | dosageInstruction | dosage | Shown. | doseUnit |
| **Instructions** `String`<br>How to take the medication. | [ZRX-7.2](https://dev.patientsknowbest.com/home/hl7-api/messages/adt-a28) |  | dosageInstruction | dosage | Shown. | additionalInstructions |