v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Clinical

Retrieve an existing patient

get/api/patients/{id}

Path parameters

idstring required

Query parameters

first_namestring
last_namestring
preferred_languagestring
doctorinteger
genderstring
sincestring
date_of_birthstring
racestring
chart_idstring
emailstring
ethnicitystring

Response

OK

medication_history_consentstring
last_namestring
emergency_contact_phonestring
primary_care_physicianstring

Referring doctor for this patient

date_of_first_appointmentstring

Date of first patient visit.

updated_atstring
referring_sourcestring

Referring source.

responsible_party_relationstring
zip_codestring
idinteger
employer_citystring
employer_statestring

Two-letter abbreviation

citystring
first_namestring
middle_namestring
doctorinteger required
disable_sms_messagesboolean

If True, suppress SMS/Txt messages to this patient even if we have a cell phone # for them.

employerstring
preferred_language_descriptionstring
date_of_birthstring
ethnicity'blank' | 'hispanic' | 'not_hispanic' | 'declined'

One of "blank", "hispanic", "not_hispanic" or "declined"

home_phonestring
pronouns'' | 'LA29518-0' | 'LA29519-8' | 'LA29520-6' | 'LA29523-0' | 'LA29521-4' | 'LA29515-6' | 'LA29516-4' | 'LA29517-2' | 'LA29522-2' | 'LA29524-8'
patient_status'A' | 'I' | 'D'

One of "A" (active), "I" (inactive), "D" (inactive-deceased)

patient_photo_datestring

Cannot be passed without patient_photo

gender_identity_descriptionstring
emailstring
responsible_party_emailstring
patient_photostring
responsible_party_phonestring
statestring

Two-letter abbreviation

date_of_last_appointmentstring

Date of previous patient visit

preferred_language_codestring
patient_payment_profile'' | 'Cash' | 'Insurance' | 'Insurance Out of Network' | 'Auto Accident' | 'Worker's Comp'

One of "", "Cash", "Insurance", "Insurance Out of Network", "Auto Accident" or "Worker's Comp".<br>Note: Patient must already have either primary_insurance or secondary_insurance or new primary_insurance or secondary_insurance is passed in request if Insurance, Auto Accident or Worker's Comp payment profiles are chosen.

date_of_deathstring

Available when show_inactive is passed

social_security_numberstring
addressstring
chart_idstring

Automatically set using first & last name if absent

preferred_language'blank' | 'eng' | 'zho' | 'fra' | 'ita' | 'jpn' | 'por' | 'rus' | 'spa' | 'other' | 'unknown' | 'declined'

Use ISO 639 alpha-3 codes

responsible_party_namestring
nick_namestring

Common name for patient, should be used instead of first name if supplied.

copaystring
created_atstring
emergency_contact_relationstring
gender_identity_codestring
office_phonestring
employer_addressstring
race'blank' | 'indian' | 'asian' | 'black' | 'hawaiian' | 'white' | 'other' | 'declined'

One of "blank", "indian", "asian", "black", "hawaiian", "white" or "declined"

officesinteger[]

IDs of every office this patient has been to

preferred_pharmaciesstring[] (string)

ncpdp id of patient's preferred pharmacies

emergency_contact_namestring
gender'' | 'Male' | 'Female' | 'Other' | 'UNK' | 'ASKU' required

One of "Male", "Female", or "Other"

default_pharmacystring

ncpdp id of patient's default pharmacy

cell_phonestring
employer_zip_codestring