Patients

Create Patient

Request body

first_namestring nullable

Patient's first name

last_namestring nullable

Patient's last name

middle_namestring nullable

Patient's middle name

phone_numberstring nullable

Patient's phone number (optional if demographics provided)

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

US States enum matching Prisma @map values

zipstring nullable

Patient's ZIP code

commentsstring nullable

Patient comments

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

organization_idstring nullable

Company organization ID

tagsstring[] nullable

Tag IDs or tag names

Patient creation source enum matching Prisma

custom_fieldsobject nullable

Custom fields as key-value pairs

activeboolean nullable

Patient active status

send_intake_formboolean nullable

Frontend field - ignored

call_to_fill_intake_formboolean nullable

Frontend field - ignored

phone_number_idstring nullable

Frontend field - ignored

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

US States enum matching Prisma @map values

zipstring nullable

workflow_stage_idstring nullable

assigned_user_idstring nullable

location_idstring nullable

organization_idstring nullable

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"
        }
      ]
    }
  ]
}

Create Patient

Request

Request body

Response 201Created

Example response

Changes

Response