Create Discontinued Medication - Elation Help Center

POST

api

2.0

discontinued_medications

Create Discontinued Medication

curl --request POST \
  --url https://sandbox.elationemr.com/api/2.0/discontinued_medications/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "med_order": 123,
  "chart_date": "2023-11-07T05:31:56Z",
  "discontinue_date": "2023-12-25",
  "document_date": "2023-11-07T05:31:56Z",
  "documenting_personnel": 123,
  "is_documented": true,
  "medication": {
    "active_ndcs": [
      "<string>"
    ],
    "id": 123,
    "is_controlled": false,
    "market_end_date": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "ndcs": [
      "<string>"
    ],
    "obsolete_date": "2023-11-07T05:31:56Z",
    "practice": 123,
    "rxnorm_cuis": [
      "<string>"
    ],
    "strength": "<string>",
    "type": "prescription"
  },
  "patient": 123,
  "practice": 123,
  "prescribing_physician": 123,
  "reason": "<string>",
  "signed_date": "2023-11-07T05:31:56Z",
  "supervising_physician": 123,
  "thread": 123
}
'

{
  "med_order": 123,
  "chart_date": "2023-11-07T05:31:56Z",
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "discontinue_date": "2023-12-25",
  "document_date": "2023-11-07T05:31:56Z",
  "documenting_personnel": 123,
  "id": 123,
  "is_documented": true,
  "last_medication_order": 123,
  "medication": {
    "active_ndcs": [
      "<string>"
    ],
    "brand_name": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "creation_type": "user",
    "form": "<string>",
    "generic_name": "<string>",
    "id": 123,
    "is_controlled": false,
    "market_end_date": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "ndcs": [
      "<string>"
    ],
    "obsolete_date": "2023-11-07T05:31:56Z",
    "practice": 123,
    "route": "<string>",
    "rxnorm_cuis": [
      "<string>"
    ],
    "strength": "<string>",
    "type": "prescription"
  },
  "patient": 123,
  "practice": 123,
  "prescribing_physician": 123,
  "reason": "<string>",
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "supervising_physician": 123,
  "thread": 123
}

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:

{
  "med_order": "No signed medication order found to discontinue."
}

Attempting to discontinue a thread that has already been discontinued also returns a 400 error:

{
  "med_order": "Med has already been discontinued!"
}

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.

Show child attributes

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.

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.

Show child attributes

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>

Retrieve Discontinued Medication

⌘I

Create Discontinued Medication

curl --request POST \
  --url https://sandbox.elationemr.com/api/2.0/discontinued_medications/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "med_order": 123,
  "chart_date": "2023-11-07T05:31:56Z",
  "discontinue_date": "2023-12-25",
  "document_date": "2023-11-07T05:31:56Z",
  "documenting_personnel": 123,
  "is_documented": true,
  "medication": {
    "active_ndcs": [
      "<string>"
    ],
    "id": 123,
    "is_controlled": false,
    "market_end_date": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "ndcs": [
      "<string>"
    ],
    "obsolete_date": "2023-11-07T05:31:56Z",
    "practice": 123,
    "rxnorm_cuis": [
      "<string>"
    ],
    "strength": "<string>",
    "type": "prescription"
  },
  "patient": 123,
  "practice": 123,
  "prescribing_physician": 123,
  "reason": "<string>",
  "signed_date": "2023-11-07T05:31:56Z",
  "supervising_physician": 123,
  "thread": 123
}
'

{
  "med_order": 123,
  "chart_date": "2023-11-07T05:31:56Z",
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "discontinue_date": "2023-12-25",
  "document_date": "2023-11-07T05:31:56Z",
  "documenting_personnel": 123,
  "id": 123,
  "is_documented": true,
  "last_medication_order": 123,
  "medication": {
    "active_ndcs": [
      "<string>"
    ],
    "brand_name": "<string>",
    "created_date": "2023-11-07T05:31:56Z",
    "creation_type": "user",
    "form": "<string>",
    "generic_name": "<string>",
    "id": 123,
    "is_controlled": false,
    "market_end_date": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "ndcs": [
      "<string>"
    ],
    "obsolete_date": "2023-11-07T05:31:56Z",
    "practice": 123,
    "route": "<string>",
    "rxnorm_cuis": [
      "<string>"
    ],
    "strength": "<string>",
    "type": "prescription"
  },
  "patient": 123,
  "practice": 123,
  "prescribing_physician": 123,
  "reason": "<string>",
  "signed_by": 123,
  "signed_date": "2023-11-07T05:31:56Z",
  "supervising_physician": 123,
  "thread": 123
}

​Requirements

Authorizations

Body

Response

Requirements