View patient
GET {{baseUrl}}/patients/:id?subdomain={{subdomain}}&include[]=<string>&include[]=<string>
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":{"id":"\u003cinteger\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","middle_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","name":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","institution_id":"\u003cinteger\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","bio":"\u003cobject\u003e","inactive":"\u003cboolean\u003e","last_sync_time":"\u003cstring\u003e","guarantor_id":"\u003cinteger\u003e","unsubscribe_sms":"\u003cboolean\u003e","upcoming_appts":[{"id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","provider_name":"\u003cstring\u003e","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","confirmed":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","provider_name":"\u003cstring\u003e","start_time":"\u003cstring\u003e","end_time":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","confirmed":"\u003cboolean\u003e"}],"procedures":[{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"},{"id":"\u003cinteger\u003e","patient_id":"\u003cinteger\u003e","provider_id":"\u003cinteger\u003e","appointment_id":"\u003cinteger\u003e","code":"\u003cstring\u003e","name":"\u003cstring\u003e","status":"\u003cstring\u003e","body_site":"\u003cobject\u003e","fee":{"amount":"\u003cstring\u003e","currency":"\u003cstring\u003e"},"start_date":"\u003cdate\u003e","end_date":"\u003cdate\u003e"}],"insurance_coverages":[{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e","plan":{"id":"\u003cinteger\u003e","payer_id":"\u003cstring\u003e","name":"\u003cstring\u003e","address":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","group_num":"\u003cstring\u003e","employer_name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","patient_coverages":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}},{"id":"\u003cinteger\u003e","subscription_relation":"\u003cstring\u003e","patient_id":"\u003cinteger\u003e","priority":"\u003cinteger\u003e","subscriber_num":"\u003cstring\u003e","effective_date":"\u003cdate\u003e","expiration_date":"\u003cdate\u003e","plan":{"id":"\u003cinteger\u003e","payer_id":"\u003cstring\u003e","name":"\u003cstring\u003e","address":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","state":"\u003cstring\u003e","zip_code":"\u003cstring\u003e","country_code":"\u003cstring\u003e","group_num":"\u003cstring\u003e","employer_name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","patient_coverages":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}}]},"count":"\u003cinteger\u003e"}