healthcare
medication

Retrieve a medication

get/healthcare/{connection_id}/medication/{id}

Request

  • Base URL: http://api.unified.to
  • URL: http://api.unified.to/healthcare/{connection_id}/medication/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Medication

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring

Unique identifier for the medication order/prescription

created_atstring date-time

When the medication record was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

When the medication record was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

patient_idstring

The patient the medication is for

encounter_idstring

The encounter in which the medication was ordered

practitioner_idstring

The practitioner who prescribed the medication

namestring

Human-readable name of the medication

status'DRAFT' | 'ACTIVE' | 'ON_HOLD' | 'COMPLETED' | 'STOPPED' | 'CANCELLED' | 'ENTERED_IN_ERROR' | 'UNKNOWN' | 'OTHER'

Status of the medication order

dosagestring

Free-text dosage instructions (e.g. "1 tablet by mouth twice daily")

refill_countnumber

Number of refills authorized

authored_atstring date-time

When the medication was prescribed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

start_atstring date-time

When the patient should start taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_atstring date-time

When the patient should stop taking the medication (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

notesstring

Free-text notes about the medication

rawunknown

Changes

No recorded changes to this operation across all 1 revision of this API.