v1

latestOpenAPI 3.1.02026-07-2218105157.9 KB

Patients

Update Patient

patch/v1/patients/{id}

Path parameters

idstring uuid required

Query parameters

expand[]PatientExpand[] nullable

Fields to expand in the response

Fields to expand in the response

Request body

first_namestring nullable

Patient's first name

middle_namestring nullable

Patient's middle name

last_namestring nullable

Patient's last name

phone_numberstring nullable

Patient's phone number

additional_phone_numberstring nullable

Patient's additional phone number

emailstring nullable

Patient's email address

date_of_birthstring date nullable

Patient's date of birth (YYYY-MM-DD, MM/DD/YYYY, YYYYMMDD)

gender'male' | 'female' | 'other'

Gender enum matching Prisma

addressstring nullable

Patient's street address

address2string nullable

Patient's address line 2

citystring nullable

Patient's city

state'alabama' | 'alaska' | 'arizona' | 'arkansas' | 'california' | 'colorado' | 'connecticut' | 'delaware' | 'florida' | 'georgia' | 'hawaii' | 'idaho' | 'illinois' | 'indiana' | 'iowa' | 'kansas' | 'kentucky' | 'louisiana' | 'maine' | 'maryland' | 'massachusetts' | 'michigan' | 'minnesota' | 'mississippi' | 'missouri' | 'montana' | 'nebraska' | 'nevada' | 'new_hampshire' | 'new_jersey' | 'new_mexico' | 'new_york' | 'north_carolina' | 'north_dakota' | 'ohio' | 'oklahoma' | 'oregon' | 'pennsylvania' | 'rhode_island' | 'south_carolina' | 'south_dakota' | 'tennessee' | 'texas' | 'utah' | 'vermont' | 'virginia' | 'washington' | 'west_virginia' | 'wisconsin' | 'wyoming' | 'district_of_columbia' | 'puerto_rico' | 'virgin_islands' | 'guam' | 'northern_mariana_islands' | 'american_samoa'

US States enum matching Prisma @map values

zipstring nullable

Patient's ZIP code

workflow_stage_idstring nullable

Workflow stage ID or stage name

assigned_user_idstring nullable

User ID or user email

location_idstring nullable

Company location ID (null clears the location)

organization_idstring nullable

Company organization ID (null clears the organization)

activeboolean nullable

Patient active status

custom_fieldsobject nullable

Custom fields as key-value pairs

commentsstring nullable

Patient comments

tagsstring[] nullable

Tag IDs or names (replaces existing tags)

add_tagsstring[] nullable

Tag IDs or names to add without removing existing

remove_tagsstring[] nullable

Tag IDs or names to remove

versioninteger nullable

Current version number for optimistic locking

Response

Successful Response

idstring uuid required

created_atstring nullable required

updated_atstring nullable required

first_namestring nullable

last_namestring nullable

middle_namestring nullable

phone_numberstring nullable

additional_phone_numberstring nullable

emailstring nullable

date_of_birthstring nullable

gender'male' | 'female' | 'other'

Gender enum matching Prisma

addressstring nullable

address2string nullable

citystring nullable

state'alabama' | 'alaska' | 'arizona' | 'arkansas' | 'california' | 'colorado' | 'connecticut' | 'delaware' | 'florida' | 'georgia' | 'hawaii' | 'idaho' | 'illinois' | 'indiana' | 'iowa' | 'kansas' | 'kentucky' | 'louisiana' | 'maine' | 'maryland' | 'massachusetts' | 'michigan' | 'minnesota' | 'mississippi' | 'missouri' | 'montana' | 'nebraska' | 'nevada' | 'new_hampshire' | 'new_jersey' | 'new_mexico' | 'new_york' | 'north_carolina' | 'north_dakota' | 'ohio' | 'oklahoma' | 'oregon' | 'pennsylvania' | 'rhode_island' | 'south_carolina' | 'south_dakota' | 'tennessee' | 'texas' | 'utah' | 'vermont' | 'virginia' | 'washington' | 'west_virginia' | 'wisconsin' | 'wyoming' | 'district_of_columbia' | 'puerto_rico' | 'virgin_islands' | 'guam' | 'northern_mariana_islands' | 'american_samoa'

US States enum matching Prisma @map values

zipstring nullable

workflow_stage_idstring nullable

assigned_user_idstring nullable

location_idstring nullable

organization_idstring nullable

created_from'form' | 'call' | 'api' | 'file' | 'sms' | 'fax' | 'chat_agent' | 'manual' | 'bulk_import' | 'eligibility' | 'prior_auth'

Patient creation source enum matching Prisma

activeboolean

versioninteger

first_communication_atstring nullable

custom_fieldsobject nullable

commentsstring nullable

Example response

{
  "payors": [
    {
      "services": [
        {
          "copay_in_network": 25,
          "created_at": "2024-01-15T10:30:00Z",
          "eligibility_check_status": "ELIGIBLE",
          "id": "550e8400-e29b-41d4-a716-446655440014",
          "payor_id": "550e8400-e29b-41d4-a716-446655440012",
          "service_type": "PT",
          "updated_at": "2024-01-15T10:30:00Z",
          "verification_benefits_status": "VERIFIED"
        }
      ]
    }
  ]
}