Skip to main content
POST
/
api
/
2.0
/
patients
Create Patient
curl --request POST \
  --url https://sandbox.elationemr.com/api/2.0/patients/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "caregiver_practice": 123,
  "dob": "2023-12-25",
  "first_name": "<string>",
  "last_name": "<string>",
  "primary_physician": 123,
  "sex": "Unknown",
  "actual_name": "<string>",
  "address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "consents": [
    {}
  ],
  "emails": [
    {
      "email": "jsmith@example.com"
    }
  ],
  "emergency_contact": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "relationship": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "employer": {
    "code": "<string>"
  },
  "guarantor": {
    "address": "<string>",
    "city": "<string>",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "insurances": [
    {
      "address": "<string>",
      "carrier": "<string>",
      "city": "<string>",
      "copay": "<string>",
      "deductible": "<string>",
      "end_date": "2023-12-25",
      "extension": "<string>",
      "group_id": "<string>",
      "id": 123,
      "insurance_company": 123,
      "insurance_plan": 123,
      "insured_person_address": "<string>",
      "insured_person_city": "<string>",
      "insured_person_dob": "<string>",
      "insured_person_first_name": "<string>",
      "insured_person_gender": "<string>",
      "insured_person_id": "<string>",
      "insured_person_last_name": "<string>",
      "insured_person_ssn": "<string>",
      "insured_person_state": "<string>",
      "insured_person_zip": "<string>",
      "member_id": "<string>",
      "phone": "<string>",
      "plan": "<string>",
      "start_date": "2023-12-25",
      "state": "<string>",
      "suite": "<string>",
      "zip": "<string>"
    }
  ],
  "last_modified": "2023-11-07T05:31:56Z",
  "metadata": {
    "data": {},
    "object_id": "<string>",
    "object_web_link": "<string>"
  },
  "middle_name": "<string>",
  "mothers_maiden_name": "<string>",
  "notes": "<string>",
  "patient_status": {
    "deceased_date": "2023-12-25",
    "notes": "<string>"
  },
  "phones": [
    {
      "phone": "<string>"
    }
  ],
  "preference": {
    "preferred_pharmacy_1": "<string>",
    "preferred_pharmacy_2": "<string>"
  },
  "preferred_language": "<string>",
  "preferred_service_location": 123,
  "previous_address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "previous_first_name": "<string>",
  "previous_last_name": "<string>",
  "previous_name": {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "suffix": "<string>"
  },
  "primary_care_provider_npi": "<string>",
  "sms_opt_in_status": true,
  "ssn": "<string>",
  "suffix": "<string>",
  "tags": [
    "<unknown>"
  ],
  "verified": true,
  "vip": true
}
'
{
  "caregiver_practice": 123,
  "dob": "2023-12-25",
  "first_name": "<string>",
  "last_name": "<string>",
  "primary_physician": 123,
  "sex": "Unknown",
  "actual_name": "<string>",
  "address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "consents": [
    {
      "application": "<string>",
      "consented": true,
      "is_active": true,
      "last_modified_date": "2023-11-07T05:31:56Z"
    }
  ],
  "created_date": "2023-11-07T05:31:56Z",
  "deleted_date": "2023-11-07T05:31:56Z",
  "deleted_insurances": [
    {
      "address": "<string>",
      "carrier": "<string>",
      "city": "<string>",
      "copay": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "deductible": "<string>",
      "deleted_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-12-25",
      "extension": "<string>",
      "group_id": "<string>",
      "id": 123,
      "insurance_company": 123,
      "insurance_plan": 123,
      "insured_person_address": "<string>",
      "insured_person_city": "<string>",
      "insured_person_dob": "<string>",
      "insured_person_first_name": "<string>",
      "insured_person_gender": "<string>",
      "insured_person_id": "<string>",
      "insured_person_last_name": "<string>",
      "insured_person_ssn": "<string>",
      "insured_person_state": "<string>",
      "insured_person_zip": "<string>",
      "member_id": "<string>",
      "phone": "<string>",
      "plan": "<string>",
      "start_date": "2023-12-25",
      "state": "<string>",
      "suite": "<string>",
      "zip": "<string>"
    }
  ],
  "emails": [
    {
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z",
      "email": "jsmith@example.com"
    }
  ],
  "emergency_contact": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "first_name": "<string>",
    "id": 123,
    "last_name": "<string>",
    "phone": "<string>",
    "relationship": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "employer": {
    "code": "<string>",
    "description": "<string>",
    "name": "<string>"
  },
  "guarantor": {
    "address": "<string>",
    "city": "<string>",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "id": 123,
    "last_name": "<string>",
    "phone": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "id": 123,
  "insurances": [
    {
      "address": "<string>",
      "carrier": "<string>",
      "city": "<string>",
      "copay": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "deductible": "<string>",
      "deleted_date": "2023-11-07T05:31:56Z",
      "end_date": "2023-12-25",
      "extension": "<string>",
      "group_id": "<string>",
      "id": 123,
      "insurance_company": 123,
      "insurance_plan": 123,
      "insured_person_address": "<string>",
      "insured_person_city": "<string>",
      "insured_person_dob": "<string>",
      "insured_person_first_name": "<string>",
      "insured_person_gender": "<string>",
      "insured_person_id": "<string>",
      "insured_person_last_name": "<string>",
      "insured_person_ssn": "<string>",
      "insured_person_state": "<string>",
      "insured_person_zip": "<string>",
      "member_id": "<string>",
      "phone": "<string>",
      "plan": "<string>",
      "start_date": "2023-12-25",
      "state": "<string>",
      "suite": "<string>",
      "zip": "<string>"
    }
  ],
  "last_modified": "2023-11-07T05:31:56Z",
  "master_patient": 123,
  "merged_into_chart": 123,
  "metadata": {
    "data": {},
    "object_id": "<string>",
    "object_web_link": "<string>"
  },
  "middle_name": "<string>",
  "mothers_maiden_name": "<string>",
  "notes": "<string>",
  "occupation": "<string>",
  "patient_status": {
    "deceased_date": "2023-12-25",
    "last_status_change": "2023-11-07T05:31:56Z",
    "notes": "<string>"
  },
  "phones": [
    {
      "phone": "<string>",
      "created_date": "2023-11-07T05:31:56Z",
      "deleted_date": "2023-11-07T05:31:56Z"
    }
  ],
  "preference": {
    "preferred_pharmacy_1": "<string>",
    "preferred_pharmacy_2": "<string>"
  },
  "preferred_language": "<string>",
  "preferred_service_location": 123,
  "previous_address": {
    "address_line1": "<string>",
    "address_line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>"
  },
  "previous_first_name": "<string>",
  "previous_last_name": "<string>",
  "previous_name": {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "suffix": "<string>"
  },
  "primary_care_provider": 123,
  "primary_care_provider_npi": "<string>",
  "sms_opt_in_status": true,
  "ssn": "<string>",
  "suffix": "<string>",
  "tags": [
    "<unknown>"
  ],
  "verified": true,
  "vip": true
}

Documentation Index

Fetch the complete documentation index at: https://help.elationhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
caregiver_practice
integer<int64>
required
​
dob
string<date>
required
​
first_name
string
required
Maximum string length: 70
​
last_name
string
required
Maximum string length: 70
​
primary_physician
integer<int64>
required

Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.

​
sex
enum<string>
default:Unknown
required
Available options:
Female,
Male,
Other,
Unknown
​
actual_name
string | null
Maximum string length: 150
​
address
object
​
consents
object[]
​
emails
object[] | null
​
emergency_contact
object
​
employer
object
​
ethnicity
enum<string>
Available options:
Declined to specify,
Hispanic or Latino,
No ethnicity specified,
Not Hispanic or Latino
​
gender_identity
enum<string>
Available options:
man,
nonbinary,
option_not_listed,
prefer_not_to_say,
transgender_man,
transgender_woman,
two_spirit,
unknown,
woman
​
guarantor
object
​
insurances
object[]
​
last_modified
string<date-time>
​
legal_gender_marker
enum<string> | null
Available options:
F,
M,
U,
X,
None
​
legal_gender_marker_display
enum<string> | null
Available options:
F,
M,
None Selected,
X,
None
​
metadata
object
​
middle_name
string
Maximum string length: 50
​
mothers_maiden_name
string | null
Maximum string length: 70
​
notes
string | null
​
patient_status
object
​
phones
object[]
​
preference
object
​
preferred_contact
enum<string> | null
Available options:
email,
passport,
phone,
sms
​
preferred_language
string | null
​
preferred_service_location
integer<int64> | null
​
previous_address
object
​
previous_first_name
string | null
Maximum string length: 70
​
previous_last_name
string | null
Maximum string length: 70
​
previous_name
object
​
primary_care_provider_npi
string | null

Represents the patient's primary care provider. This person may be in a different practice.

Maximum string length: 10
​
pronouns
enum<string> | null
Available options:
he_him_his,
not_listed,
she_her_hers,
they_them_theirs,
None
​
pronouns_display
enum<string> | null
Available options:
He/Him/His,
Option not listed,
She/Her/Hers,
They/Them/Theirs,
None
​
race
enum<string>
Available options:
American Indian or Alaska Native,
Asian,
Black or African American,
Declined to specify,
Native Hawaiian or Other Pacific Islander,
No race specified,
White
​
sexual_orientation
enum<string>
Available options:
asexual,
bisexual,
gay,
lesbian,
option_not_listed,
prefer_not_to_say,
queer,
straight,
unknown
​
sms_opt_in_status
boolean | null
​
ssn
string | null
Maximum string length: 37
​
suffix
string
Maximum string length: 20
​
tags
any[] | null
​
timezone
enum<string> | null
Available options:
Africa/Abidjan,
Africa/Accra,
Africa/Addis_Ababa,
Africa/Algiers,
Africa/Asmara,
Africa/Bamako,
Africa/Bangui,
Africa/Banjul,
Africa/Bissau,
Africa/Blantyre,
Africa/Brazzaville,
Africa/Bujumbura,
Africa/Cairo,
Africa/Casablanca,
Africa/Ceuta,
Africa/Conakry,
Africa/Dakar,
Africa/Dar_es_Salaam,
Africa/Djibouti,
Africa/Douala,
Africa/El_Aaiun,
Africa/Freetown,
Africa/Gaborone,
Africa/Harare,
Africa/Johannesburg,
Africa/Juba,
Africa/Kampala,
Africa/Khartoum,
Africa/Kigali,
Africa/Kinshasa,
Africa/Lagos,
Africa/Libreville,
Africa/Lome,
Africa/Luanda,
Africa/Lubumbashi,
Africa/Lusaka,
Africa/Malabo,
Africa/Maputo,
Africa/Maseru,
Africa/Mbabane,
Africa/Mogadishu,
Africa/Monrovia,
Africa/Nairobi,
Africa/Ndjamena,
Africa/Niamey,
Africa/Nouakchott,
Africa/Ouagadougou,
Africa/Porto-Novo,
Africa/Sao_Tome,
Africa/Tripoli,
Africa/Tunis,
Africa/Windhoek,
America/Adak,
America/Anchorage,
America/Anguilla,
America/Antigua,
America/Araguaina,
America/Argentina/Buenos_Aires,
America/Argentina/Catamarca,
America/Argentina/Cordoba,
America/Argentina/Jujuy,
America/Argentina/La_Rioja,
America/Argentina/Mendoza,
America/Argentina/Rio_Gallegos,
America/Argentina/Salta,
America/Argentina/San_Juan,
America/Argentina/San_Luis,
America/Argentina/Tucuman,
America/Argentina/Ushuaia,
America/Aruba,
America/Asuncion,
America/Atikokan,
America/Bahia,
America/Bahia_Banderas,
America/Barbados,
America/Belem,
America/Belize,
America/Blanc-Sablon,
America/Boa_Vista,
America/Bogota,
America/Boise,
America/Cambridge_Bay,
America/Campo_Grande,
America/Cancun,
America/Caracas,
America/Cayenne,
America/Cayman,
America/Chicago,
America/Chihuahua,
America/Ciudad_Juarez,
America/Costa_Rica,
America/Creston,
America/Cuiaba,
America/Curacao,
America/Danmarkshavn,
America/Dawson,
America/Dawson_Creek,
America/Denver,
America/Detroit,
America/Dominica,
America/Edmonton,
America/Eirunepe,
America/El_Salvador,
America/Fort_Nelson,
America/Fortaleza,
America/Glace_Bay,
America/Goose_Bay,
America/Grand_Turk,
America/Grenada,
America/Guadeloupe,
America/Guatemala,
America/Guayaquil,
America/Guyana,
America/Halifax,
America/Havana,
America/Hermosillo,
America/Indiana/Indianapolis,
America/Indiana/Knox,
America/Indiana/Marengo,
America/Indiana/Petersburg,
America/Indiana/Tell_City,
America/Indiana/Vevay,
America/Indiana/Vincennes,
America/Indiana/Winamac,
America/Inuvik,
America/Iqaluit,
America/Jamaica,
America/Juneau,
America/Kentucky/Louisville,
America/Kentucky/Monticello,
America/Kralendijk,
America/La_Paz,
America/Lima,
America/Los_Angeles,
America/Lower_Princes,
America/Maceio,
America/Managua,
America/Manaus,
America/Marigot,
America/Martinique,
America/Matamoros,
America/Mazatlan,
America/Menominee,
America/Merida,
America/Metlakatla,
America/Mexico_City,
America/Miquelon,
America/Moncton,
America/Monterrey,
America/Montevideo,
America/Montserrat,
America/Nassau,
America/New_York,
America/Nome,
America/Noronha,
America/North_Dakota/Beulah,
America/North_Dakota/Center,
America/North_Dakota/New_Salem,
America/Nuuk,
America/Ojinaga,
America/Panama,
America/Paramaribo,
America/Phoenix,
America/Port-au-Prince,
America/Port_of_Spain,
America/Porto_Velho,
America/Puerto_Rico,
America/Punta_Arenas,
America/Rankin_Inlet,
America/Recife,
America/Regina,
America/Resolute,
America/Rio_Branco,
America/Santarem,
America/Santiago,
America/Santo_Domingo,
America/Sao_Paulo,
America/Scoresbysund,
America/Sitka,
America/St_Barthelemy,
America/St_Johns,
America/St_Kitts,
America/St_Lucia,
America/St_Thomas,
America/St_Vincent,
America/Swift_Current,
America/Tegucigalpa,
America/Thule,
America/Tijuana,
America/Toronto,
America/Tortola,
America/Vancouver,
America/Whitehorse,
America/Winnipeg,
America/Yakutat,
Antarctica/Casey,
Antarctica/Davis,
Antarctica/DumontDUrville,
Antarctica/Macquarie,
Antarctica/Mawson,
Antarctica/McMurdo,
Antarctica/Palmer,
Antarctica/Rothera,
Antarctica/Syowa,
Antarctica/Troll,
Antarctica/Vostok,
Arctic/Longyearbyen,
Asia/Aden,
Asia/Almaty,
Asia/Amman,
Asia/Anadyr,
Asia/Aqtau,
Asia/Aqtobe,
Asia/Ashgabat,
Asia/Atyrau,
Asia/Baghdad,
Asia/Bahrain,
Asia/Baku,
Asia/Bangkok,
Asia/Barnaul,
Asia/Beirut,
Asia/Bishkek,
Asia/Brunei,
Asia/Chita,
Asia/Choibalsan,
Asia/Colombo,
Asia/Damascus,
Asia/Dhaka,
Asia/Dili,
Asia/Dubai,
Asia/Dushanbe,
Asia/Famagusta,
Asia/Gaza,
Asia/Hebron,
Asia/Ho_Chi_Minh,
Asia/Hong_Kong,
Asia/Hovd,
Asia/Irkutsk,
Asia/Jakarta,
Asia/Jayapura,
Asia/Jerusalem,
Asia/Kabul,
Asia/Kamchatka,
Asia/Karachi,
Asia/Kathmandu,
Asia/Khandyga,
Asia/Kolkata,
Asia/Krasnoyarsk,
Asia/Kuala_Lumpur,
Asia/Kuching,
Asia/Kuwait,
Asia/Macau,
Asia/Magadan,
Asia/Makassar,
Asia/Manila,
Asia/Muscat,
Asia/Nicosia,
Asia/Novokuznetsk,
Asia/Novosibirsk,
Asia/Omsk,
Asia/Oral,
Asia/Phnom_Penh,
Asia/Pontianak,
Asia/Pyongyang,
Asia/Qatar,
Asia/Qostanay,
Asia/Qyzylorda,
Asia/Riyadh,
Asia/Sakhalin,
Asia/Samarkand,
Asia/Seoul,
Asia/Shanghai,
Asia/Singapore,
Asia/Srednekolymsk,
Asia/Taipei,
Asia/Tashkent,
Asia/Tbilisi,
Asia/Tehran,
Asia/Thimphu,
Asia/Tokyo,
Asia/Tomsk,
Asia/Ulaanbaatar,
Asia/Urumqi,
Asia/Ust-Nera,
Asia/Vientiane,
Asia/Vladivostok,
Asia/Yakutsk,
Asia/Yangon,
Asia/Yekaterinburg,
Asia/Yerevan,
Atlantic/Azores,
Atlantic/Bermuda,
Atlantic/Canary,
Atlantic/Cape_Verde,
Atlantic/Faroe,
Atlantic/Madeira,
Atlantic/Reykjavik,
Atlantic/South_Georgia,
Atlantic/St_Helena,
Atlantic/Stanley,
Australia/Adelaide,
Australia/Brisbane,
Australia/Broken_Hill,
Australia/Darwin,
Australia/Eucla,
Australia/Hobart,
Australia/Lindeman,
Australia/Lord_Howe,
Australia/Melbourne,
Australia/Perth,
Australia/Sydney,
Canada/Atlantic,
Canada/Central,
Canada/Eastern,
Canada/Mountain,
Canada/Newfoundland,
Canada/Pacific,
Europe/Amsterdam,
Europe/Andorra,
Europe/Astrakhan,
Europe/Athens,
Europe/Belgrade,
Europe/Berlin,
Europe/Bratislava,
Europe/Brussels,
Europe/Bucharest,
Europe/Budapest,
Europe/Busingen,
Europe/Chisinau,
Europe/Copenhagen,
Europe/Dublin,
Europe/Gibraltar,
Europe/Guernsey,
Europe/Helsinki,
Europe/Isle_of_Man,
Europe/Istanbul,
Europe/Jersey,
Europe/Kaliningrad,
Europe/Kirov,
Europe/Kyiv,
Europe/Lisbon,
Europe/Ljubljana,
Europe/London,
Europe/Luxembourg,
Europe/Madrid,
Europe/Malta,
Europe/Mariehamn,
Europe/Minsk,
Europe/Monaco,
Europe/Moscow,
Europe/Oslo,
Europe/Paris,
Europe/Podgorica,
Europe/Prague,
Europe/Riga,
Europe/Rome,
Europe/Samara,
Europe/San_Marino,
Europe/Sarajevo,
Europe/Saratov,
Europe/Simferopol,
Europe/Skopje,
Europe/Sofia,
Europe/Stockholm,
Europe/Tallinn,
Europe/Tirane,
Europe/Ulyanovsk,
Europe/Vaduz,
Europe/Vatican,
Europe/Vienna,
Europe/Vilnius,
Europe/Volgograd,
Europe/Warsaw,
Europe/Zagreb,
Europe/Zurich,
GMT,
Indian/Antananarivo,
Indian/Chagos,
Indian/Christmas,
Indian/Cocos,
Indian/Comoro,
Indian/Kerguelen,
Indian/Mahe,
Indian/Maldives,
Indian/Mauritius,
Indian/Mayotte,
Indian/Reunion,
Pacific/Apia,
Pacific/Auckland,
Pacific/Bougainville,
Pacific/Chatham,
Pacific/Chuuk,
Pacific/Easter,
Pacific/Efate,
Pacific/Fakaofo,
Pacific/Fiji,
Pacific/Funafuti,
Pacific/Galapagos,
Pacific/Gambier,
Pacific/Guadalcanal,
Pacific/Guam,
Pacific/Honolulu,
Pacific/Kanton,
Pacific/Kiritimati,
Pacific/Kosrae,
Pacific/Kwajalein,
Pacific/Majuro,
Pacific/Marquesas,
Pacific/Midway,
Pacific/Nauru,
Pacific/Niue,
Pacific/Norfolk,
Pacific/Noumea,
Pacific/Pago_Pago,
Pacific/Palau,
Pacific/Pitcairn,
Pacific/Pohnpei,
Pacific/Port_Moresby,
Pacific/Rarotonga,
Pacific/Saipan,
Pacific/Tahiti,
Pacific/Tarawa,
Pacific/Tongatapu,
Pacific/Wake,
Pacific/Wallis,
US/Alaska,
US/Arizona,
US/Central,
US/Eastern,
US/Hawaii,
US/Mountain,
US/Pacific,
UTC
​
verified
boolean
default:true
​
vip
boolean | null

Response

201 - application/json
​
caregiver_practice
integer<int64>
required
​
dob
string<date>
required
​
first_name
string
required
Maximum string length: 70
​
last_name
string
required
Maximum string length: 70
​
primary_physician
integer<int64>
required

Represents the physician providing care to the patient within your practice. This is a required field. This value must match the id of one of the physicians retrieved via the /physicians/ endpoint.

​
sex
enum<string>
default:Unknown
required
Available options:
Female,
Male,
Other,
Unknown
​
actual_name
string | null
Maximum string length: 150
​
address
object
​
consents
object[]
​
created_date
string<date-time> | null
read-only
​
deleted_date
string<date-time> | null
read-only
​
deleted_insurances
object[]
read-only
​
emails
object[] | null
​
emergency_contact
object
​
employer
object
​
ethnicity
enum<string>
Available options:
Declined to specify,
Hispanic or Latino,
No ethnicity specified,
Not Hispanic or Latino
​
gender_identity
enum<string>
Available options:
man,
nonbinary,
option_not_listed,
prefer_not_to_say,
transgender_man,
transgender_woman,
two_spirit,
unknown,
woman
​
guarantor
object
​
id
integer
read-only
​
insurances
object[]
​
last_modified
string<date-time>
​
legal_gender_marker
enum<string> | null
Available options:
F,
M,
U,
X,
None
​
legal_gender_marker_display
enum<string> | null
Available options:
F,
M,
None Selected,
X,
None
​
master_patient
integer<int64>
read-only
​
merged_into_chart
integer | null
read-only
​
metadata
object
​
middle_name
string
Maximum string length: 50
​
mothers_maiden_name
string | null
Maximum string length: 70
​
notes
string | null
​
occupation
string | null
read-only
Maximum string length: 100
​
patient_status
object
​
phones
object[]
​
preference
object
​
preferred_contact
enum<string> | null
Available options:
email,
passport,
phone,
sms
​
preferred_language
string | null
​
preferred_service_location
integer<int64> | null
​
previous_address
object
​
previous_first_name
string | null
Maximum string length: 70
​
previous_last_name
string | null
Maximum string length: 70
​
previous_name
object
​
primary_care_provider
integer<int64>
read-only

A read-only field that provides the internal Elation id of the collaborator record that is created within your practice to represent your practice's connection with the patient's primary care provider.

​
primary_care_provider_npi
string | null

Represents the patient's primary care provider. This person may be in a different practice.

Maximum string length: 10
​
pronouns
enum<string> | null
Available options:
he_him_his,
not_listed,
she_her_hers,
they_them_theirs,
None
​
pronouns_display
enum<string> | null
Available options:
He/Him/His,
Option not listed,
She/Her/Hers,
They/Them/Theirs,
None
​
race
enum<string>
Available options:
American Indian or Alaska Native,
Asian,
Black or African American,
Declined to specify,
Native Hawaiian or Other Pacific Islander,
No race specified,
White
​
sexual_orientation
enum<string>
Available options:
asexual,
bisexual,
gay,
lesbian,
option_not_listed,
prefer_not_to_say,
queer,
straight,
unknown
​
sms_opt_in_status
boolean | null
​
ssn
string | null
Maximum string length: 37
​
suffix
string
Maximum string length: 20
​
tags
any[] | null
​
timezone
enum<string> | null
Available options:
Africa/Abidjan,
Africa/Accra,
Africa/Addis_Ababa,
Africa/Algiers,
Africa/Asmara,
Africa/Bamako,
Africa/Bangui,
Africa/Banjul,
Africa/Bissau,
Africa/Blantyre,
Africa/Brazzaville,
Africa/Bujumbura,
Africa/Cairo,
Africa/Casablanca,
Africa/Ceuta,
Africa/Conakry,
Africa/Dakar,
Africa/Dar_es_Salaam,
Africa/Djibouti,
Africa/Douala,
Africa/El_Aaiun,
Africa/Freetown,
Africa/Gaborone,
Africa/Harare,
Africa/Johannesburg,
Africa/Juba,
Africa/Kampala,
Africa/Khartoum,
Africa/Kigali,
Africa/Kinshasa,
Africa/Lagos,
Africa/Libreville,
Africa/Lome,
Africa/Luanda,
Africa/Lubumbashi,
Africa/Lusaka,
Africa/Malabo,
Africa/Maputo,
Africa/Maseru,
Africa/Mbabane,
Africa/Mogadishu,
Africa/Monrovia,
Africa/Nairobi,
Africa/Ndjamena,
Africa/Niamey,
Africa/Nouakchott,
Africa/Ouagadougou,
Africa/Porto-Novo,
Africa/Sao_Tome,
Africa/Tripoli,
Africa/Tunis,
Africa/Windhoek,
America/Adak,
America/Anchorage,
America/Anguilla,
America/Antigua,
America/Araguaina,
America/Argentina/Buenos_Aires,
America/Argentina/Catamarca,
America/Argentina/Cordoba,
America/Argentina/Jujuy,
America/Argentina/La_Rioja,
America/Argentina/Mendoza,
America/Argentina/Rio_Gallegos,
America/Argentina/Salta,
America/Argentina/San_Juan,
America/Argentina/San_Luis,
America/Argentina/Tucuman,
America/Argentina/Ushuaia,
America/Aruba,
America/Asuncion,
America/Atikokan,
America/Bahia,
America/Bahia_Banderas,
America/Barbados,
America/Belem,
America/Belize,
America/Blanc-Sablon,
America/Boa_Vista,
America/Bogota,
America/Boise,
America/Cambridge_Bay,
America/Campo_Grande,
America/Cancun,
America/Caracas,
America/Cayenne,
America/Cayman,
America/Chicago,
America/Chihuahua,
America/Ciudad_Juarez,
America/Costa_Rica,
America/Creston,
America/Cuiaba,
America/Curacao,
America/Danmarkshavn,
America/Dawson,
America/Dawson_Creek,
America/Denver,
America/Detroit,
America/Dominica,
America/Edmonton,
America/Eirunepe,
America/El_Salvador,
America/Fort_Nelson,
America/Fortaleza,
America/Glace_Bay,
America/Goose_Bay,
America/Grand_Turk,
America/Grenada,
America/Guadeloupe,
America/Guatemala,
America/Guayaquil,
America/Guyana,
America/Halifax,
America/Havana,
America/Hermosillo,
America/Indiana/Indianapolis,
America/Indiana/Knox,
America/Indiana/Marengo,
America/Indiana/Petersburg,
America/Indiana/Tell_City,
America/Indiana/Vevay,
America/Indiana/Vincennes,
America/Indiana/Winamac,
America/Inuvik,
America/Iqaluit,
America/Jamaica,
America/Juneau,
America/Kentucky/Louisville,
America/Kentucky/Monticello,
America/Kralendijk,
America/La_Paz,
America/Lima,
America/Los_Angeles,
America/Lower_Princes,
America/Maceio,
America/Managua,
America/Manaus,
America/Marigot,
America/Martinique,
America/Matamoros,
America/Mazatlan,
America/Menominee,
America/Merida,
America/Metlakatla,
America/Mexico_City,
America/Miquelon,
America/Moncton,
America/Monterrey,
America/Montevideo,
America/Montserrat,
America/Nassau,
America/New_York,
America/Nome,
America/Noronha,
America/North_Dakota/Beulah,
America/North_Dakota/Center,
America/North_Dakota/New_Salem,
America/Nuuk,
America/Ojinaga,
America/Panama,
America/Paramaribo,
America/Phoenix,
America/Port-au-Prince,
America/Port_of_Spain,
America/Porto_Velho,
America/Puerto_Rico,
America/Punta_Arenas,
America/Rankin_Inlet,
America/Recife,
America/Regina,
America/Resolute,
America/Rio_Branco,
America/Santarem,
America/Santiago,
America/Santo_Domingo,
America/Sao_Paulo,
America/Scoresbysund,
America/Sitka,
America/St_Barthelemy,
America/St_Johns,
America/St_Kitts,
America/St_Lucia,
America/St_Thomas,
America/St_Vincent,
America/Swift_Current,
America/Tegucigalpa,
America/Thule,
America/Tijuana,
America/Toronto,
America/Tortola,
America/Vancouver,
America/Whitehorse,
America/Winnipeg,
America/Yakutat,
Antarctica/Casey,
Antarctica/Davis,
Antarctica/DumontDUrville,
Antarctica/Macquarie,
Antarctica/Mawson,
Antarctica/McMurdo,
Antarctica/Palmer,
Antarctica/Rothera,
Antarctica/Syowa,
Antarctica/Troll,
Antarctica/Vostok,
Arctic/Longyearbyen,
Asia/Aden,
Asia/Almaty,
Asia/Amman,
Asia/Anadyr,
Asia/Aqtau,
Asia/Aqtobe,
Asia/Ashgabat,
Asia/Atyrau,
Asia/Baghdad,
Asia/Bahrain,
Asia/Baku,
Asia/Bangkok,
Asia/Barnaul,
Asia/Beirut,
Asia/Bishkek,
Asia/Brunei,
Asia/Chita,
Asia/Choibalsan,
Asia/Colombo,
Asia/Damascus,
Asia/Dhaka,
Asia/Dili,
Asia/Dubai,
Asia/Dushanbe,
Asia/Famagusta,
Asia/Gaza,
Asia/Hebron,
Asia/Ho_Chi_Minh,
Asia/Hong_Kong,
Asia/Hovd,
Asia/Irkutsk,
Asia/Jakarta,
Asia/Jayapura,
Asia/Jerusalem,
Asia/Kabul,
Asia/Kamchatka,
Asia/Karachi,
Asia/Kathmandu,
Asia/Khandyga,
Asia/Kolkata,
Asia/Krasnoyarsk,
Asia/Kuala_Lumpur,
Asia/Kuching,
Asia/Kuwait,
Asia/Macau,
Asia/Magadan,
Asia/Makassar,
Asia/Manila,
Asia/Muscat,
Asia/Nicosia,
Asia/Novokuznetsk,
Asia/Novosibirsk,
Asia/Omsk,
Asia/Oral,
Asia/Phnom_Penh,
Asia/Pontianak,
Asia/Pyongyang,
Asia/Qatar,
Asia/Qostanay,
Asia/Qyzylorda,
Asia/Riyadh,
Asia/Sakhalin,
Asia/Samarkand,
Asia/Seoul,
Asia/Shanghai,
Asia/Singapore,
Asia/Srednekolymsk,
Asia/Taipei,
Asia/Tashkent,
Asia/Tbilisi,
Asia/Tehran,
Asia/Thimphu,
Asia/Tokyo,
Asia/Tomsk,
Asia/Ulaanbaatar,
Asia/Urumqi,
Asia/Ust-Nera,
Asia/Vientiane,
Asia/Vladivostok,
Asia/Yakutsk,
Asia/Yangon,
Asia/Yekaterinburg,
Asia/Yerevan,
Atlantic/Azores,
Atlantic/Bermuda,
Atlantic/Canary,
Atlantic/Cape_Verde,
Atlantic/Faroe,
Atlantic/Madeira,
Atlantic/Reykjavik,
Atlantic/South_Georgia,
Atlantic/St_Helena,
Atlantic/Stanley,
Australia/Adelaide,
Australia/Brisbane,
Australia/Broken_Hill,
Australia/Darwin,
Australia/Eucla,
Australia/Hobart,
Australia/Lindeman,
Australia/Lord_Howe,
Australia/Melbourne,
Australia/Perth,
Australia/Sydney,
Canada/Atlantic,
Canada/Central,
Canada/Eastern,
Canada/Mountain,
Canada/Newfoundland,
Canada/Pacific,
Europe/Amsterdam,
Europe/Andorra,
Europe/Astrakhan,
Europe/Athens,
Europe/Belgrade,
Europe/Berlin,
Europe/Bratislava,
Europe/Brussels,
Europe/Bucharest,
Europe/Budapest,
Europe/Busingen,
Europe/Chisinau,
Europe/Copenhagen,
Europe/Dublin,
Europe/Gibraltar,
Europe/Guernsey,
Europe/Helsinki,
Europe/Isle_of_Man,
Europe/Istanbul,
Europe/Jersey,
Europe/Kaliningrad,
Europe/Kirov,
Europe/Kyiv,
Europe/Lisbon,
Europe/Ljubljana,
Europe/London,
Europe/Luxembourg,
Europe/Madrid,
Europe/Malta,
Europe/Mariehamn,
Europe/Minsk,
Europe/Monaco,
Europe/Moscow,
Europe/Oslo,
Europe/Paris,
Europe/Podgorica,
Europe/Prague,
Europe/Riga,
Europe/Rome,
Europe/Samara,
Europe/San_Marino,
Europe/Sarajevo,
Europe/Saratov,
Europe/Simferopol,
Europe/Skopje,
Europe/Sofia,
Europe/Stockholm,
Europe/Tallinn,
Europe/Tirane,
Europe/Ulyanovsk,
Europe/Vaduz,
Europe/Vatican,
Europe/Vienna,
Europe/Vilnius,
Europe/Volgograd,
Europe/Warsaw,
Europe/Zagreb,
Europe/Zurich,
GMT,
Indian/Antananarivo,
Indian/Chagos,
Indian/Christmas,
Indian/Cocos,
Indian/Comoro,
Indian/Kerguelen,
Indian/Mahe,
Indian/Maldives,
Indian/Mauritius,
Indian/Mayotte,
Indian/Reunion,
Pacific/Apia,
Pacific/Auckland,
Pacific/Bougainville,
Pacific/Chatham,
Pacific/Chuuk,
Pacific/Easter,
Pacific/Efate,
Pacific/Fakaofo,
Pacific/Fiji,
Pacific/Funafuti,
Pacific/Galapagos,
Pacific/Gambier,
Pacific/Guadalcanal,
Pacific/Guam,
Pacific/Honolulu,
Pacific/Kanton,
Pacific/Kiritimati,
Pacific/Kosrae,
Pacific/Kwajalein,
Pacific/Majuro,
Pacific/Marquesas,
Pacific/Midway,
Pacific/Nauru,
Pacific/Niue,
Pacific/Norfolk,
Pacific/Noumea,
Pacific/Pago_Pago,
Pacific/Palau,
Pacific/Pitcairn,
Pacific/Pohnpei,
Pacific/Port_Moresby,
Pacific/Rarotonga,
Pacific/Saipan,
Pacific/Tahiti,
Pacific/Tarawa,
Pacific/Tongatapu,
Pacific/Wake,
Pacific/Wallis,
US/Alaska,
US/Arizona,
US/Central,
US/Eastern,
US/Hawaii,
US/Mountain,
US/Pacific,
UTC
​
verified
boolean
default:true
​
vip
boolean | null