Medication - Olira

Medication actions, doses, and adverse events. Submit these via POST /v1/logs/batch or the Python SDK; see How logs work for submission fields and the difference between lifecycle-tracked and point-in-time log types.

Medication adherence

Type: medication_adherence · Source: Python SDK / REST · Extensible Reserved for recording dose outcomes (taken or skipped): medication_adherence[] with status (taken/skipped) per medication; rxnorm_cui or medication_name; scheduled_time optional. Payload

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

medication_adherence

object[]

required

Show fields

status

string

required

Whether the scheduled dose was taken or skipped.. One of: taken, skipped

rxnorm_cui

string

Preferred medication identifier (RXCUI). When provided, medication_name is resolved server-side.

medication_name

string

Fallback name when rxnorm_cui is not available.

scheduled_time

string

ISO 8601 UTC scheduled dose time. Enables timing deviation to be computed internally.

dose_amount

number

Actual amount taken if different from the prescribed dose.

dose_unit

string

Unit for dose_amount (e.g. mg, ml).

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.MEDICATION_ADHERENCE,
    patient_id="your-patient-id",
    payload={
        "medication_adherence": [...]
    },
)

Related types: Use medication_list_update for adding, changing, or removing a medication from the list, medication_adverse_event for adverse reaction to a medication.

Medication list update

Type: medication_list_update · Source: Python SDK / REST, Integration · Extensible Reserved for adding, updating, or removing medications from the patient’s list: medications[] with action (add/update/delete) per item; add/update carry dose, frequency, route, etc.; delete needs identifier only. Payload

medications

object[]

required

Show fields

action

string

required

add = new or currently prescribed/ongoing; update = change to existing regimen; delete = discontinue or remove.. One of: add, update, delete

medication_name

string

Generic or brand name. Fallback when rxnorm_cui is not provided.

rxnorm_cui

string

Preferred identifier. When provided for add, medication_name and therapeutic_class are resolved server-side.

ndc_code

string

Package-level identifier. Used for pill-bottle scanning; not used for identity matching.

dose

string

Dose amount as a string (e.g. ‘10 mg’, ‘500 mg’).

dose_unit

string

Unit for dose (e.g. mg, ml).

frequency

string

Dosing frequency string (e.g. QD, BID, TID, once weekly).

route

string

Optional route of administration (e.g. oral, iv); empty string or omit when unknown.

form

string

Optional dosage form (e.g. tablet, capsule); empty string or omit when unknown.

therapeutic_class

string

Therapeutic class (e.g. ACE inhibitor, SSRI, beta-blocker). Resolved server-side when rxnorm_cui is provided.

start_date

string

ISO 8601 date the medication was started or is scheduled to start.

schedule_times

string[]

Array of daily dose times (HH:MM). Required to activate adherence tracking for this medication.

adherence_window_minutes

integer

Minutes around scheduled_time within which a dose is considered on-time. Default 60.

prescribed_by

object

Show fields

name

string

Prescribing provider’s name.

npi

string

Prescribing provider’s NPI.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.MEDICATION_LIST_UPDATE,
    patient_id="your-patient-id",
    payload={
        "medications": [...]
    },
)

Related types: Use medication_adherence for dose taken or skipped, medication_adverse_event for adverse event. Not intended for standing medication instructions in plan (clinical_plan_item is also wrong — use medication_list_update for regimen).

Medication adverse event

Type: medication_adverse_event · Source: Python SDK / REST, Integration · Extensible Reserved for medication-related adverse events (side effects, reactions): events[] with medication_identifier and description (severity, onset_date optional). Payload

events

object[]

required

Show fields

medication_identifier

string

required

RxNorm CUI or medication name of the causative medication.

description

string

Description of the adverse event or side effect (e.g. nausea, neutropenia, hepatotoxicity).

severity

string

Severity of the adverse event.. Example: mild, moderate, severe

onset_date

string

ISO 8601 date when the adverse event began.

recorded_at

string

ISO 8601 UTC datetime when the event was recorded.

extensions

object

Open key/value bag for client/source-specific fields that lack a typed slot; merged into the entry’s extensions (leaf-level, last-writer-wins by event timestamp).

source

string | object

Who asserted this fact. Accepts a legacy string (e.g. ‘patient_self_report’) or a structured Source object.

Example

import olira
from olira import OliraLogType

olira.log(
    log_type=OliraLogType.MEDICATION_ADVERSE_EVENT,
    patient_id="your-patient-id",
    payload={
        "events": [...]
    },
)

Related types: Use medication_adherence for dose taken/skipped, medication_list_update for add/change/stop medication.

​Medication adherence

​Medication list update

​Medication adverse event

Medication adherence

Medication list update

Medication adverse event