Skip to main content
GET
/
api
/
2.0
/
letters
/
{id}
Retrieve Letter
curl --request GET \
  --url https://sandbox.elationemr.com/api/2.0/letters/{id}/ \
  --header 'Authorization: Bearer <token>'
{
  "patient": 123,
  "practice": 123,
  "send_to_contact": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "npi": "<string>",
    "org_name": "<string>",
    "specialties": [
      "<unknown>"
    ]
  },
  "attachments": [
    {
      "entity_date": "2023-11-07T05:31:56Z",
      "entity_description": "<string>",
      "entity_id": 123,
      "entity_type": 123,
      "handout": 123,
      "id": 123,
      "summary": "<string>"
    }
  ],
  "body": "<string>",
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "delivery_date": "2023-11-07T05:31:56Z",
  "direct_message_status": "<string>",
  "direct_message_to": "<string>",
  "display_to": "<string>",
  "document_date": "2023-11-07T05:31:56Z",
  "email_to": "<string>",
  "failure_unacknowledged": "<string>",
  "fax_attachments": true,
  "fax_status": "<string>",
  "fax_to": "<string>",
  "id": 123,
  "is_processed": true,
  "letter_type": "<string>",
  "referral_order": 123,
  "send_out": true,
  "send_to_elation_user": 123,
  "send_to_name": "<string>",
  "sign_date": "2023-11-07T05:31:56Z",
  "signed_by": 123,
  "subject": "<string>",
  "tags": [
    123
  ],
  "to_number": "<string>",
  "viewed_at": "2023-11-07T05:31:56Z",
  "with_archive": true
}

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.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
integer<int64>
required

Response

200 - application/json
patient
integer<int64>
required
practice
integer<int64>
required
send_to_contact
object
required
attachments
object[]
body
string

The body of the letter.

created_date
string<date-time> | null
read-only
deleted_date
string<date-time> | null
read-only
delivery_date
string<date-time> | null
delivery_method
enum<string>
Available options:
direct,
email,
emr,
fax,
passport,
printed
direct_message_status
string | null
read-only
direct_message_to
string | null
Maximum string length: 200
display_to
string | null
read-only
document_date
string<date-time>
email_to
string | null
Maximum string length: 200
failure_unacknowledged
string
fax_attachments
boolean
fax_status
string
read-only
fax_to
string | null
Maximum string length: 20
id
integer
read-only
is_processed
boolean
read-only
letter_type
string
read-only
referral_order
integer<int64> | null
send_out
boolean
send_to_elation_user
integer
read-only

If a letter is sent to another elation user, this will be that user's id.

send_to_name
string | null
Maximum string length: 200
sign_date
string<date-time> | null
signed_by
integer<int64> | null

The user who signed the letter.

subject
string

The subject of the letter (Not needed with referral_order).

Maximum string length: 200
tags
integer<int64>[]

A list of Document Tags associated with the letter.

to_number
string | null
read-only
viewed_at
string<date-time> | null
with_archive
boolean