Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Object Definition

{
  "id": 27787290,
  "patient": 13500417,
  "medication": {
    "id": 27590703,
    "is_controlled": true,
    "strength": "80 mg",
    "name": "Butrans Transdermal Patch Weekly 5 MCG/HR",
    "form": "Tab",
    "route": "Oral",
    "generic_name": "Buprenorphine TD Patch Weekly 5 MCG/HR",
    "brand_name": "Butrans",
    "type": "otc",
    "rxnorm_cuis": [
      904880
    ],
    "ndcs": [
      "59011-0750-04"
    ],
    "active_ndcs": [
      "59011-0750-04"
    ]
  },
  "fulfillment": {  // nullable
    "detail": null,
    "pharmacy_ncpdpid": "1655458",
    "service_location": {  // nullable
      "id": 13631735,	
      "name": "Elation North",
      "is_primary": true,
      "place_of_service": "Office",  
      "address_line1": "1234 First Practice Way",
      "address_line2": "",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94114",
      "phone": "",
      "created_date": "2017-01-15T06:46:14.445876Z",
      "deleted_date": null
    },
    "state": "complete",
    "time_completed": "2017-02-11T06:44:31.493753Z",
    "type": "surescripts"
  },
  "thread": { 
    "id": 12341234,
    "dc_date": "2017-02-12T06:44:31.493753Z",
    "is_permanent": true
  },
  "order_type": "New",
  "qty": "10.123456789",
  "qty_units": "ml",
  "auth_refills": "1",
  "num_samples": null,
  "prescribing_physician": 1638402,
  "practice": 140754475089924,
  "medication_type": "prescription",
  "notes": "this is note",
  "start_date": "2017-02-10",
  "is_doc_med": false,
  "documenting_personnel": 1638402,
  "last_modified": "2017-02-10T22:44:31.587079",
  "pharmacy_instructions": "this is pharmacy_instructions",
  "directions": "once a day",
  "document_date": "2017-02-11T06:44:31.493753Z",
  "chart_date": "2017-02-11T06:44:31.493753Z",
  "show_in_chart_feed": true,
  "send_rx_reminder": false,                                // read-only, SMS reminder when RX sent
  "signed_date": "2017-02-11T06:44:31.493753Z",
  "signed_by": 1638402,
  "created_date": "2017-02-11T06:44:31.493753Z",
  "deleted_date": null,
  "icd10_codes": [
      {
          "code": "U07.1",
          "description": "COVID-19"
      }
  ]
}

​
Signed vs. Draft Medication Orders

The is_doc_med field controls whether a medication order created via POST is signed immediately or saved as an unsigned draft.
is_doc_medBehavior
trueThe order is automatically signed on creation. signed_date and signed_by will be populated. The medication appears on the patient’s active medication list immediately.
falseThe order is saved as an unsigned draft. signed_date and signed_by will be null. The order does not appear as an active medication until it is signed.
Note: Only signed medication orders (created with is_doc_med: true) can be discontinued via the Discontinued Medications endpoint. Attempting to discontinue a thread that contains only unsigned drafts will return a 400 error.

​
Allowed Values

AttributeAllowed Values
medication_type”otc”, “prescription”, “discontinued”
fulfillment.state”new”, “sending”, “sent”, “pending_complete”, “complete”, “failure”, “error”
fulfillment.type”fax”, “mdtoolboxepcs”, “paper”, “paper_nonfillable”, “phone”, “surescripts”, “surescripts_cancel”, “surescripts_change”
send_rx_remindertrue, false