organization_idstring required
The unique identifier for an Organization in the database
deactivatedboolean required
True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
versioninteger required
The version of the object. Any update to any property of an object object will create a new version.
updated_atstring date-time required
updating_user_idstring required
The unique identifier for a User in the database
gender'MAN' | 'WOMAN' | 'NON_BINARY' | 'TWO_SPIRIT' | 'FEMALE_TO_MALE' | 'MALE_TO_FEMALE' | 'OTHER' | 'UNKNOWN' | 'REFUSED'
birth_datestring date required
social_security_numberstring
biological_sex'FEMALE' | 'MALE' | 'UNKNOWN' | 'REFUSED' required
sexual_orientation'HETEROSEXUAL' | 'HOMOSEXUAL' | 'BISEXUAL' | 'TWO_SPIRIT' | 'OTHER' | 'UNKNOWN' | 'REFUSED'
pronounsstring[]
The pronouns of the patient.
race'AMERICAN_INDIAN_OR_ALASKA_NATIVE' | 'WHITE' | 'BLACK' | 'ASIAN' | 'NATIVE_HAWAIIAN_OR_OTHER_PACIFIC_ISLANDER' | 'MIDDLE_EASTERN_OR_NORTH_AFRICAN' | 'OTHER' | 'UNKNOWN' | 'REFUSED'
ethnicity'HISPANIC_OR_LATINO' | 'NOT_HISPANIC_OR_LATINO' | 'UNKNOWN' | 'REFUSED'
disability_status'DISABLED' | 'NON_DISABLED'
marital_status'ANNULLED' | 'DIVORCED' | 'INTERLOCUTORY' | 'SEPARATED' | 'MARRIED' | 'COMMON_LAW' | 'POLYGAMOUS' | 'DOMESTIC_PARTNER' | 'UNMARRIED' | 'NEVER_MARRIED' | 'WIDOWED' | 'UNKNOWN'
deceasedstring date-time
Time of death for the patient. Leave unset if the patient is not deceased.
multiple_birthinteger
The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.
electronic_communication_opt_inboolean
Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations.
non_insurance_payersPreEncounterCommonCanonicalNonInsurancePayerId[]
primary_service_facility_idstring
do_not_invoice_reason'BANKRUPTCY' | 'DECEASED' | 'HARDSHIP' | 'OTHER' | 'COLLECTIONS' | 'BAD_ADDRESS' | 'PROFESSIONAL_COURTESY'
note_idsPreEncounterCommonNoteId[]
tag_idsPreEncounterCommonTagId[]
orconboolean
ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false.
advanced_directivesPreEncounterPatientsV1AdvancedDirective[]
idstring required
The unique identifier for a Patient
mrnstring required
The medical record number for the patient. Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer.