Skip to main content
POST
Create Discontinued Medication

Requirements

The med_order referenced in the request body must be a signed medication order (one created with is_doc_med: true). Medication orders created as unsigned drafts (is_doc_med: false) cannot be discontinued.
Attempting to discontinue a thread that has only unsigned draft orders returns a 400 error:
Attempting to discontinue a thread that has already been discontinued also returns a 400 error:

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
med_order
integer<int64>
required

The id of the medication which we discontinued.

chart_date
string<date-time>

The timestamp at which this discontinue was available in the patient's chart

discontinue_date
string<date>

The date when the medication was discontinued.

document_date
string<date-time>

The timestamp at which we've documented this discontinue occurred.

documenting_personnel
integer<int64>

The user who documented this discontinue.

is_documented
boolean
medication
object

The medication that was discontinued.

patient
integer<int64>

The id of the patient chart.

practice
integer<int64>

The id of the practice.

prescribing_physician
integer<int64>

The id of the physician who prescribed the medication.

reason
string | null

The discontinue reason.

signed_date
string<date-time> | null

The timestamp at which a user signed off on the discontinue.

supervising_physician
integer<int64> | null

If the prescribing physician requires supervision, this will reference the physician who is in that role.

thread
integer<int64>

Response

201 - application/json
med_order
integer<int64>
required

The id of the medication which we discontinued.

chart_date
string<date-time>

The timestamp at which this discontinue was available in the patient's chart

created_date
string<date-time> | null
read-only

The timestamp at which this discontinue was created in our database.

deleted_date
string<date-time> | null
read-only

The timestamp at which the discontinue was marked as deleted, usually occurs when a user wants to 'undiscontinue' the medication.

discontinue_date
string<date>

The date when the medication was discontinued.

document_date
string<date-time>

The timestamp at which we've documented this discontinue occurred.

documenting_personnel
integer<int64>

The user who documented this discontinue.

id
integer
read-only

The id of the discontinue medication.

is_documented
boolean
last_medication_order
integer | null
read-only

The id of the last medication ordered before we discontinued this thread of med orders.

medication
object

The medication that was discontinued.

patient
integer<int64>

The id of the patient chart.

practice
integer<int64>

The id of the practice.

prescribing_physician
integer<int64>

The id of the physician who prescribed the medication.

reason
string | null

The discontinue reason.

signed_by
integer<int64>
read-only
signed_date
string<date-time> | null

The timestamp at which a user signed off on the discontinue.

supervising_physician
integer<int64> | null

If the prescribing physician requires supervision, this will reference the physician who is in that role.

thread
integer<int64>