The Letter Object

{
    'id': 140754680348890,
    'send_to_contact': {'id': 64062029826,
        'first_name': 'First',
        'last_name': 'Last',
        'org_name': 'Org Name',
        'specialties': [{'id': 1335, 'name': 'Cardiology'],
        'npi': 'NPI2222',
    },
    'send_to_name': 'Test Name',
    'send_to_elation_user': 12345,
    'fax_to': '5555555555',
    'display_to': 'Test Name',
    'to_number': '5555555555',
    'subject': 'Test Subject',
    'body': 'Test Body Message',
    'fax_status': 'success',
    'fax_attachments': True,
    'delivery_method': 'printed',
    'failure_unacknowledged': False,
    'direct_message_to': 'Test',
    'email_to': '[email protected]',
    'viewed_at': '2021-05-11T21: 16: 23Z',
    'send_to_access_user_id': 1234,
    'delivery_date': '2021-05-11T21: 16: 23Z',
    'with_archive': False,
    'is_processed': True,
    'letter_type': 'provider',
    'attachments': [
        {
            'id': 64414089501,
            'document_type': 'MedsList'
        }
    ],
    'sign_date': '2021-05-11T21: 16: 23Z',
    'signed_by': 12323455,
    'document_date': '2021-05-11T21: 16: 23Z',
    'patient': 140754680086529,
    'practice': 140754674450436
}

Attribute

Type

Allowed Values

Description

id

bigint(20)

ID

send_to_contact

object

send_to_contact.id

int(11)

send_to_contact.first_name

string

send_to_contact.middle_name

string

send_to_contact.last_name

string

send_to_contact.org_name

string

send_to_contact.npi

string

send_to_contact.specialties

list

send_to_contact.specialties[].id

int(11)

send_to_contact.specialties[].name

string

send_to_elation_user

int(11)

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

send_to_name

string

fax_to

string

display_to

string

to_number

string

subject

string(200)

body

longtext

fax_status

string

"pending",
"success",
"failed"

fax_attachments

bool

delivery_method

string

"emr",
"passport",
"fax",
"email",
"printed",
"direct"

failure_unacknowledge

bool

direct_message_to

string(200)

email_to

string(200)

viewed_at

datetime

send_to_access_user_id

int(11)

delivery_date

datetime

with_archive

bool

is_processed

bool

letter_type

string

"patient_initiated",
"patient", "referral",
"provider"

attachments.id

int

attachments.document_type

string

"Entity",
"RefPanel",
"PatientDemog",
"ImmHistory",
"MedsList",
"WhoHeightChart",
"WhoWeightChart",
"WhoHcChart",
"CdcHeightChart",
"CdcWeightChart",
"CdcBmiChart",
"CompMedsList",
"CdcHcChart",

sign_date

datetime

signed_by

int(11)

The user who signed the letter.

document_date

datetime

patient

int

practice

int