> ## 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. # Partially Update Patient > Retrieve a single patient ## OpenAPI ````yaml patch /api/2.0/patients/{id}/ openapi: 3.1.0 info: contact: name: Elation Health url: https://www.elationhealth.com/ description: Elation Health API v2.0 title: Patient Profile API version: 2.0.0 servers: - description: Sandbox Server url: https://sandbox.elationemr.com - description: Production Server url: https://api.app.elationemr.com security: [] paths: /api/2.0/patients/{id}/: patch: tags: - Patients summary: Partially Update Patient description: Retrieve a single patient operationId: patients_partial_update parameters: - in: path name: id required: true schema: format: int64 type: integer requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedPatient' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Patient' description: '' security: - oauth2: [] components: schemas: PatchedPatient: properties: actual_name: maxLength: 150 type: - string - 'null' address: oneOf: - $ref: '#/components/schemas/Address' - type: 'null' caregiver_practice: format: int64 type: integer consents: items: $ref: '#/components/schemas/Consent' type: array created_date: format: date-time readOnly: true type: - string - 'null' deleted_date: format: date-time readOnly: true type: - string - 'null' deleted_insurances: items: $ref: '#/components/schemas/Insurance' readOnly: true type: array dob: format: date type: string emails: items: $ref: '#/components/schemas/Email' type: - array - 'null' emergency_contact: oneOf: - $ref: '#/components/schemas/EmergencyContact' - type: 'null' employer: oneOf: - $ref: '#/components/schemas/Employer' - type: 'null' ethnicity: $ref: '#/components/schemas/EthnicityEnum' first_name: maxLength: 70 type: string gender_identity: $ref: '#/components/schemas/GenderIdentityEnum' guarantor: oneOf: - $ref: '#/components/schemas/Guarantor' - type: 'null' id: readOnly: true type: integer insurances: items: $ref: '#/components/schemas/Insurance' type: array last_modified: format: date-time type: string last_name: maxLength: 70 type: string legal_gender_marker: oneOf: - $ref: '#/components/schemas/LegalGenderMarkerEnum' - $ref: '#/components/schemas/NullEnum' legal_gender_marker_display: oneOf: - $ref: '#/components/schemas/LegalGenderMarkerDisplayEnum' - $ref: '#/components/schemas/NullEnum' master_patient: format: int64 readOnly: true type: integer merged_into_chart: readOnly: true type: - integer - 'null' metadata: properties: data: type: object object_id: type: string object_web_link: type: string type: - object - 'null' middle_name: maxLength: 50 type: string mothers_maiden_name: maxLength: 70 type: - string - 'null' notes: type: - string - 'null' occupation: maxLength: 100 readOnly: true type: - string - 'null' patient_status: oneOf: - $ref: '#/components/schemas/Status' - type: 'null' phones: items: $ref: '#/components/schemas/Phone' type: array preference: oneOf: - $ref: '#/components/schemas/PatientPreference' - type: 'null' preferred_contact: oneOf: - $ref: '#/components/schemas/PreferredContactEnum' - $ref: '#/components/schemas/NullEnum' preferred_language: type: - string - 'null' preferred_service_location: format: int64 type: - integer - 'null' previous_address: oneOf: - $ref: '#/components/schemas/Address' - type: 'null' previous_first_name: maxLength: 70 type: - string - 'null' previous_last_name: maxLength: 70 type: - string - 'null' previous_name: oneOf: - $ref: '#/components/schemas/PatientPreviousName' - type: 'null' primary_care_provider: description: >- 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. format: int64 readOnly: true type: integer primary_care_provider_npi: description: >- Represents the patient's primary care provider. This person may be in a different practice. maxLength: 10 type: - string - 'null' primary_physician: description: >- 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. format: int64 type: integer pronouns: oneOf: - $ref: '#/components/schemas/PronounsEnum' - $ref: '#/components/schemas/NullEnum' pronouns_display: oneOf: - $ref: '#/components/schemas/PronounsDisplayEnum' - $ref: '#/components/schemas/NullEnum' race: $ref: '#/components/schemas/RaceEnum' sex: allOf: - $ref: '#/components/schemas/PatientSexEnum' default: Unknown sexual_orientation: $ref: '#/components/schemas/SexualOrientationEnum' sms_opt_in_status: type: - boolean - 'null' ssn: maxLength: 37 type: - string - 'null' suffix: maxLength: 20 type: string tags: items: {} type: - array - 'null' timezone: oneOf: - $ref: '#/components/schemas/TimezoneEnum' - $ref: '#/components/schemas/NullEnum' verified: default: true type: boolean vip: type: - boolean - 'null' type: object Patient: properties: actual_name: maxLength: 150 type: - string - 'null' address: oneOf: - $ref: '#/components/schemas/Address' - type: 'null' caregiver_practice: format: int64 type: integer consents: items: $ref: '#/components/schemas/Consent' type: array created_date: format: date-time readOnly: true type: - string - 'null' deleted_date: format: date-time readOnly: true type: - string - 'null' deleted_insurances: items: $ref: '#/components/schemas/Insurance' readOnly: true type: array dob: format: date type: string emails: items: $ref: '#/components/schemas/Email' type: - array - 'null' emergency_contact: oneOf: - $ref: '#/components/schemas/EmergencyContact' - type: 'null' employer: oneOf: - $ref: '#/components/schemas/Employer' - type: 'null' ethnicity: $ref: '#/components/schemas/EthnicityEnum' first_name: maxLength: 70 type: string gender_identity: $ref: '#/components/schemas/GenderIdentityEnum' guarantor: oneOf: - $ref: '#/components/schemas/Guarantor' - type: 'null' id: readOnly: true type: integer insurances: items: $ref: '#/components/schemas/Insurance' type: array last_modified: format: date-time type: string last_name: maxLength: 70 type: string legal_gender_marker: oneOf: - $ref: '#/components/schemas/LegalGenderMarkerEnum' - $ref: '#/components/schemas/NullEnum' legal_gender_marker_display: oneOf: - $ref: '#/components/schemas/LegalGenderMarkerDisplayEnum' - $ref: '#/components/schemas/NullEnum' master_patient: format: int64 readOnly: true type: integer merged_into_chart: readOnly: true type: - integer - 'null' metadata: properties: data: type: object object_id: type: string object_web_link: type: string type: - object - 'null' middle_name: maxLength: 50 type: string mothers_maiden_name: maxLength: 70 type: - string - 'null' notes: type: - string - 'null' occupation: maxLength: 100 readOnly: true type: - string - 'null' patient_status: oneOf: - $ref: '#/components/schemas/Status' - type: 'null' phones: items: $ref: '#/components/schemas/Phone' type: array preference: oneOf: - $ref: '#/components/schemas/PatientPreference' - type: 'null' preferred_contact: oneOf: - $ref: '#/components/schemas/PreferredContactEnum' - $ref: '#/components/schemas/NullEnum' preferred_language: type: - string - 'null' preferred_service_location: format: int64 type: - integer - 'null' previous_address: oneOf: - $ref: '#/components/schemas/Address' - type: 'null' previous_first_name: maxLength: 70 type: - string - 'null' previous_last_name: maxLength: 70 type: - string - 'null' previous_name: oneOf: - $ref: '#/components/schemas/PatientPreviousName' - type: 'null' primary_care_provider: description: >- 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. format: int64 readOnly: true type: integer primary_care_provider_npi: description: >- Represents the patient's primary care provider. This person may be in a different practice. maxLength: 10 type: - string - 'null' primary_physician: description: >- 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. format: int64 type: integer pronouns: oneOf: - $ref: '#/components/schemas/PronounsEnum' - $ref: '#/components/schemas/NullEnum' pronouns_display: oneOf: - $ref: '#/components/schemas/PronounsDisplayEnum' - $ref: '#/components/schemas/NullEnum' race: $ref: '#/components/schemas/RaceEnum' sex: allOf: - $ref: '#/components/schemas/PatientSexEnum' default: Unknown sexual_orientation: $ref: '#/components/schemas/SexualOrientationEnum' sms_opt_in_status: type: - boolean - 'null' ssn: maxLength: 37 type: - string - 'null' suffix: maxLength: 20 type: string tags: items: {} type: - array - 'null' timezone: oneOf: - $ref: '#/components/schemas/TimezoneEnum' - $ref: '#/components/schemas/NullEnum' verified: default: true type: boolean vip: type: - boolean - 'null' required: - caregiver_practice - dob - first_name - last_name - primary_physician - sex type: object Address: properties: address_line1: maxLength: 200 type: string address_line2: maxLength: 35 type: - string - 'null' city: maxLength: 50 type: string state: maxLength: 2 type: string zip: maxLength: 10 type: string type: object Consent: description: This is the serializer for PatientConsent. It's all read-only properties: application: readOnly: true type: string consented: readOnly: true type: boolean is_active: readOnly: true type: boolean last_modified_date: format: date-time readOnly: true type: string type: object Insurance: properties: address: maxLength: 200 type: - string - 'null' carrier: maxLength: 200 type: - string - 'null' city: maxLength: 50 type: - string - 'null' copay: format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ type: - string - 'null' created_date: format: date-time readOnly: true type: - string - 'null' deductible: format: decimal pattern: ^-?\d{0,8}(?:\.\d{0,2})?$ type: - string - 'null' deleted_date: format: date-time readOnly: true type: - string - 'null' end_date: format: date type: - string - 'null' extension: maxLength: 6 type: - string - 'null' group_id: maxLength: 50 type: - string - 'null' id: type: - integer - 'null' insurance_company: format: int64 type: - integer - 'null' insurance_plan: format: int64 type: - integer - 'null' insured_person_address: maxLength: 200 type: - string - 'null' insured_person_city: maxLength: 50 type: - string - 'null' insured_person_dob: maxLength: 50 type: - string - 'null' insured_person_first_name: maxLength: 200 type: - string - 'null' insured_person_gender: maxLength: 1 type: - string - 'null' insured_person_id: maxLength: 50 type: - string - 'null' insured_person_last_name: maxLength: 200 type: - string - 'null' insured_person_ssn: maxLength: 11 type: - string - 'null' insured_person_state: maxLength: 2 type: - string - 'null' insured_person_zip: maxLength: 10 type: - string - 'null' member_id: maxLength: 50 type: - string - 'null' payment_program: $ref: '#/components/schemas/PaymentProgramEnum' phone: maxLength: 20 type: - string - 'null' plan: maxLength: 200 type: - string - 'null' rank: $ref: '#/components/schemas/RankEnum' relationship_to_insured: oneOf: - $ref: '#/components/schemas/InsurerRelationshipType' - $ref: '#/components/schemas/NullEnum' start_date: format: date type: - string - 'null' state: maxLength: 2 type: - string - 'null' suite: maxLength: 35 type: - string - 'null' zip: maxLength: 10 type: - string - 'null' required: - rank type: object Email: properties: created_date: format: date-time readOnly: true type: - string - 'null' deleted_date: format: date-time readOnly: true type: - string - 'null' email: format: email maxLength: 254 type: - string - 'null' type: object EmergencyContact: properties: address_line1: maxLength: 200 type: - string - 'null' address_line2: maxLength: 35 type: - string - 'null' city: maxLength: 50 type: - string - 'null' first_name: maxLength: 70 type: - string - 'null' id: readOnly: true type: integer last_name: maxLength: 70 type: - string - 'null' phone: maxLength: 20 type: - string - 'null' relationship: maxLength: 30 type: - string - 'null' state: maxLength: 2 type: - string - 'null' zip: maxLength: 10 type: - string - 'null' type: object Employer: properties: code: maxLength: 50 type: string description: readOnly: true type: - string - 'null' name: readOnly: true type: - string - 'null' required: - code type: object EthnicityEnum: enum: - Declined to specify - Hispanic or Latino - No ethnicity specified - Not Hispanic or Latino type: string GenderIdentityEnum: enum: - man - nonbinary - option_not_listed - prefer_not_to_say - transgender_man - transgender_woman - two_spirit - unknown - woman type: string Guarantor: properties: address: maxLength: 200 type: string city: maxLength: 50 type: string email: format: email maxLength: 254 type: - string - 'null' first_name: maxLength: 105 type: - string - 'null' id: readOnly: true type: integer last_name: maxLength: 105 type: - string - 'null' phone: maxLength: 20 type: - string - 'null' relationship: oneOf: - $ref: '#/components/schemas/InsurerRelationshipType' - $ref: '#/components/schemas/NullEnum' state: maxLength: 2 type: string zip: maxLength: 10 type: string type: object LegalGenderMarkerEnum: enum: - F - M - U - X - None type: string NullEnum: type: 'null' LegalGenderMarkerDisplayEnum: enum: - F - M - None Selected - X - None type: string Status: properties: deceased_date: format: date type: - string - 'null' inactive_reason: oneOf: - $ref: '#/components/schemas/InactiveReasonEnum' - $ref: '#/components/schemas/NullEnum' last_status_change: format: date-time readOnly: true type: string notes: type: - string - 'null' status: $ref: '#/components/schemas/StatusStatusEnum' type: object Phone: properties: created_date: format: date-time readOnly: true type: - string - 'null' deleted_date: format: date-time readOnly: true type: - string - 'null' phone: type: string phone_type: $ref: '#/components/schemas/PhoneTypeEnum' required: - phone - phone_type type: object PatientPreference: properties: preferred_pharmacy_1: type: - string - 'null' preferred_pharmacy_2: type: - string - 'null' type: object PreferredContactEnum: enum: - email - passport - phone - sms type: string PatientPreviousName: properties: first_name: maxLength: 70 type: - string - 'null' last_name: maxLength: 70 type: - string - 'null' middle_name: maxLength: 50 type: - string - 'null' suffix: maxLength: 20 type: - string - 'null' type: object PronounsEnum: enum: - he_him_his - not_listed - she_her_hers - they_them_theirs - None type: string PronounsDisplayEnum: enum: - He/Him/His - Option not listed - She/Her/Hers - They/Them/Theirs - None type: string RaceEnum: enum: - American Indian or Alaska Native - Asian - Black or African American - Declined to specify - Native Hawaiian or Other Pacific Islander - No race specified - White type: string PatientSexEnum: enum: - Female - Male - Other - Unknown type: string SexualOrientationEnum: enum: - asexual - bisexual - gay - lesbian - option_not_listed - prefer_not_to_say - queer - straight - unknown type: string TimezoneEnum: enum: - 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 type: string PaymentProgramEnum: enum: - Commercial - HMSA - Commercial - Other - Commercial - SFHP - Medicaid - Medicare Advantage - Medicare Part B - Worker's Compensation type: string RankEnum: enum: - primary - secondary - tertiary type: string InsurerRelationshipType: enum: - Child - Other - Spouse type: string InactiveReasonEnum: description: |- * `left_good_terms` - Patient Left on Good Terms * `left_bad_terms` - Patient Left on Bad Terms * `practice_ended` - Practice Ended Relationship * `other` - Other * `unknown` - Unknown enum: - left_good_terms - left_bad_terms - practice_ended - other - unknown type: string StatusStatusEnum: description: |- * `active` - Active * `inactive` - Inactive * `prospect` - Prospect * `deceased` - Deceased enum: - active - inactive - prospect - deceased type: string PhoneTypeEnum: enum: - Fax - Home - Main - Mobile - Night - Other - Work type: string securitySchemes: oauth2: flows: clientCredentials: scopes: act_as_user: >- Impersonate a provider via X-On-Behalf-Of (combinable with apiv2 or system scopes) apiv2: Full access to the API system/{resource_name}.read: Read access to a specific resource system/{resource_name}.write: Write access to a specific resource tokenUrl: /api/2.0/oauth2/token/ type: oauth2 ````