Get

Beta
GET
/patients/v1/:id

Gets a patient.

Path parameters

idstringRequired

The unique identifier for a Patient

Response

This endpoint returns an object.
biological_sexenum
Allowed values: FEMALEMALEUNKNOWNREFUSED

The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html

birth_datedate
contactslist of objects

Contacts for the patient.

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

filing_orderobject

The patient’s active coverages, in order of primary, secondary, etc.

general_practitionerslist of objects
idstring

The unique UUID identifier for a Patient. Patient ID is used in machine contexts.

mrnstring

The medical record number for the patient. Human-friendly Candid generated MRNs are of the form “YYMMDDXXXX”, where “YYYYMMDD” is the date of patient creation and “XXXX” is a zero-padded incrementing integer.

nameobject
organization_idstring

The organization that owns this object.

other_addresseslist of objects

Other addresses for the patient.

other_nameslist of objects

Other names for the patient.

other_telecomslist of objects

Other phone numbers for the patient.

primary_addressobject

The primary address for the patient.

primary_telecomobject

The primary phone number for the patient.

updated_atdatetime
updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

authorizationslist of objectsOptional
deceaseddatetimeOptional

Time of death for the patient. Leave unset if the patient is not deceased.

disability_status"DISABLED" or "NON_DISABLED"Optional
Allowed values: DISABLEDNON_DISABLED
do_not_invoice_reasonenumOptional
Allowed values: BANKRUPTCYDECEASEDHARDSHIPOTHER

If this value is defined, the customer will not be invoiced.

electronic_communication_opt_inbooleanOptional
emailstringOptional
ethnicityenumOptional
Allowed values: HISPANIC_OR_LATINONOT_HISPANIC_OR_LATINOUNKNOWNREFUSED
external_provenanceobjectOptional

Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data.

genderenumOptional
guarantorobjectOptional
languagestringOptional
marital_statusenumOptional
multiple_birthintegerOptional

The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.

non_insurance_payer_associationslist of objectsOptional
note_idslist of stringsOptional
photostringOptional
primary_service_facility_idstringOptional
raceenumOptional
referralslist of objectsOptional
self_paybooleanOptional
sexual_orientationenumOptional

The sexual orientation of the patient.

social_security_numberstringOptional
tag_idslist of stringsOptional
non_insurance_payerslist of stringsOptionalDeprecated

Errors