Entity: Medication

Owned by Tom Pick
Last updated: Jan 22, 2024
1 min read

Class Diagram

Medication

Display

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

Please see the manual for more information.

Mappings

 

HL7 API

FHIR API

(Customer boxes support full CRUD)

Web

Custom REST API

 

 

Facade (STU3)

Aggregated (R4)

This is a summary. See the web spec for full details.

 

Summary of interactions

Create

A28/A31

 

 

 

Medicines

/v1/medications

Read

 

 

/MedicationRequest

/MedicationStatement

Medicines

/v1/medications
/v1/medications/active
/v1/medications/forPatient/[patientId]/active
/v1/medications/forPatient/[patientId]

Update

A28/A31

 

 

 

Medicines

/v1/medications

Delete

A28/A31

(replace, but cannot delete all)

 

 

 

Medicines

 

Entity: Medication - Extends: Data Point

Status Enum

  • ACTIVE

  • INACTIVE

 

 

status

status

The web interface separates current medications from past medications.

The distinction is made by inspecting the End Timestamp and Status values.

 

Substance CodeableConcept

The medication.

ZRX-2

 

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

When the medication was started.

ZRX-1.4

 

zib-Medication-PeriodOfUse

authoredOn

effectivePeriod

The web interface permits entry of date but not time.

startDate

End Timestamp Timestamp

When the medication was finished.

ZRX-1.5

 

zib-Medication-PeriodOfUse

effectivePeriod

The web interface permits entry of date but not time.

endDate

Frequency Text String

How frequently the medication should be taken.

ZRX-1.2

 

dosageInstruction

dosage

Shown.

frequency

Frequency Value Number

A representation of how frequently the medication should be taken, when combined with Frequency Units.

 

 

dosageInstruction

dosage

Shown.

frequency

Frequency Units Enum

  • HOUR

 

 

dosageInstruction

dosage

Shown.

frequency

Frequency Priority Enum

Can be used to capture a frequency instruction of:

  • AS_DIRECTED

  • AS_NEEDED

 

 

dosageInstruction

dosage

Shown.

frequency

Dose Value Number

How much should be taken.

ZRX-3.1

 

dosageInstruction

dosage

Shown.

doseValue

Dose Units CodeableConcept

The units of the Dose Value.

ZRX-5

 

 

dosage

Shown.

doseUnit

Medication Unit Enum

  • 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

How to take the medication.

ZRX-7.2

 

dosageInstruction

dosage

Shown.

additionalInstructions