Update a patient

curl --request PATCH \
  --url https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "preferred_name": "<string>",
  "title": "<string>",
  "suffix": "<string>",
  "date_of_birth": "2023-12-25",
  "email": "[email protected]",
  "phone": "<string>",
  "secondary_phone": "<string>",
  "country": "<string>",
  "nationality": "<string>",
  "occupation": "<string>",
  "residential_address": "<string>",
  "work_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "next_of_kin": {
    "name": "<string>",
    "phone": "<string>",
    "address": "<string>"
  },
  "national_id": "<string>",
  "preferred_language": "<string>",
  "referred_by": "<string>",
  "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employment": {
    "status": "<string>",
    "company": "<string>",
    "role": "<string>"
  },
  "is_dependent": true,
  "is_waitlist": true,
  "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing": {},
  "medical_history": "<string>",
  "family_history": "<string>",
  "smoking_status": "<string>",
  "alcohol_use": "<string>",
  "recreational_drug_use": "<string>",
  "physical_activity": "<string>",
  "living_arrangement": "<string>",
  "is_vip": true,
  "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emails": [
    {
      "email": "[email protected]",
      "type": "<string>",
      "is_primary": false
    }
  ],
  "phones": [
    {
      "phone_number": "<string>",
      "type": "<string>",
      "is_primary": false
    }
  ],
  "guardians": [
    {
      "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "is_responsible_for_billing": false,
      "is_primary": false,
      "can_access_records": false,
      "is_emergency_contact": true,
      "can_schedule_appointments": false,
      "notes": "<string>"
    }
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    last_name: '<string>',
    middle_name: '<string>',
    preferred_name: '<string>',
    title: '<string>',
    suffix: '<string>',
    date_of_birth: '2023-12-25',
    email: '[email protected]',
    phone: '<string>',
    secondary_phone: '<string>',
    country: '<string>',
    nationality: '<string>',
    occupation: '<string>',
    residential_address: '<string>',
    work_address: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    next_of_kin: {name: '<string>', phone: '<string>', address: '<string>'},
    national_id: '<string>',
    preferred_language: '<string>',
    referred_by: '<string>',
    referral_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    employment: {status: '<string>', company: '<string>', role: '<string>'},
    is_dependent: true,
    is_waitlist: true,
    sponsor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billing: {},
    medical_history: '<string>',
    family_history: '<string>',
    smoking_status: '<string>',
    alcohol_use: '<string>',
    recreational_drug_use: '<string>',
    physical_activity: '<string>',
    living_arrangement: '<string>',
    is_vip: true,
    primary_location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    emails: [{email: '[email protected]', type: '<string>', is_primary: false}],
    phones: [{phone_number: '<string>', type: '<string>', is_primary: false}],
    guardians: [
      {
        guardian_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        first_name: '<string>',
        last_name: '<string>',
        email: '<string>',
        phone: '<string>',
        is_responsible_for_billing: false,
        is_primary: false,
        can_access_records: false,
        is_emergency_contact: true,
        can_schedule_appointments: false,
        notes: '<string>'
      }
    ]
  })
};

fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id}"

payload = {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "preferred_name": "<string>",
    "title": "<string>",
    "suffix": "<string>",
    "date_of_birth": "2023-12-25",
    "email": "[email protected]",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "country": "<string>",
    "nationality": "<string>",
    "occupation": "<string>",
    "residential_address": "<string>",
    "work_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "next_of_kin": {
        "name": "<string>",
        "phone": "<string>",
        "address": "<string>"
    },
    "national_id": "<string>",
    "preferred_language": "<string>",
    "referred_by": "<string>",
    "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employment": {
        "status": "<string>",
        "company": "<string>",
        "role": "<string>"
    },
    "is_dependent": True,
    "is_waitlist": True,
    "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing": {},
    "medical_history": "<string>",
    "family_history": "<string>",
    "smoking_status": "<string>",
    "alcohol_use": "<string>",
    "recreational_drug_use": "<string>",
    "physical_activity": "<string>",
    "living_arrangement": "<string>",
    "is_vip": True,
    "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "emails": [
        {
            "email": "[email protected]",
            "type": "<string>",
            "is_primary": False
        }
    ],
    "phones": [
        {
            "phone_number": "<string>",
            "type": "<string>",
            "is_primary": False
        }
    ],
    "guardians": [
        {
            "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "first_name": "<string>",
            "last_name": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "is_responsible_for_billing": False,
            "is_primary": False,
            "can_access_records": False,
            "is_emergency_contact": True,
            "can_schedule_appointments": False,
            "notes": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "mrn": "<string>",
    "middle_name": "<string>",
    "preferred_name": "<string>",
    "title": "<string>",
    "suffix": "<string>",
    "date_of_birth": "2023-12-25",
    "gender": "male",
    "marital_status": "single",
    "client_type": "adult",
    "client_status": "<string>",
    "is_dependent": true,
    "email": "<string>",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "country": "<string>",
    "nationality": "<string>",
    "occupation": "<string>",
    "residential_address": "<string>",
    "work_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "next_of_kin": {
      "name": "<string>",
      "phone": "<string>",
      "address": "<string>"
    },
    "national_id": "<string>",
    "preferred_language": "<string>",
    "referred_by": "<string>",
    "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employment": {
      "status": "<string>",
      "company": "<string>",
      "role": "<string>"
    },
    "is_waitlist": true,
    "billing": {
      "individual_type": "self_pay",
      "group_type": "self_pay"
    },
    "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "allergies": [
      "<string>"
    ],
    "medical_history": "<string>",
    "current_medications": [
      "<string>"
    ],
    "chronic_conditions": [
      "<string>"
    ],
    "blood_type": "O+",
    "genotype": "AA",
    "family_history": "<string>",
    "smoking_status": "<string>",
    "alcohol_use": "<string>",
    "recreational_drug_use": "<string>",
    "physical_activity": "<string>",
    "living_arrangement": "<string>",
    "has_profile_image": true,
    "profile_image_path": "<string>",
    "status": "active",
    "is_vip": true,
    "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portal_access_enabled": true,
    "admission_status": "<string>",
    "couple": {
      "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "responsible_for_billing": true,
      "relationship_status": "<string>"
    },
    "emails": [
      {
        "email": "[email protected]",
        "type": "<string>",
        "permission": "email_ok",
        "is_primary": false
      }
    ],
    "phones": [
      {
        "phone_number": "<string>",
        "type": "<string>",
        "permission": "text_voicemail_ok",
        "is_primary": false
      }
    ],
    "guardians": [
      {
        "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "relationship": "parent",
        "is_responsible_for_billing": false,
        "is_primary": false,
        "can_access_records": false,
        "is_emergency_contact": true,
        "can_schedule_appointments": false,
        "notes": "<string>"
      }
    ],
    "insurance": [
      {}
    ],
    "pharmacies": [
      {}
    ],
    "care_providers": [
      {}
    ],
    "notification_settings": {
      "upcoming_appointments_enabled": true,
      "upcoming_appointments_email_option": "<string>",
      "upcoming_appointments_phone_option": "<string>",
      "incomplete_documents_enabled": true,
      "incomplete_documents_email_option": "<string>",
      "incomplete_documents_phone_option": "<string>",
      "cancellations_enabled": true,
      "cancellations_email_option": "<string>",
      "cancellations_phone_option": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

PATCH

clinics

{clinic_id}

patients

{patient_id}

Update a patient

curl --request PATCH \
  --url https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "preferred_name": "<string>",
  "title": "<string>",
  "suffix": "<string>",
  "date_of_birth": "2023-12-25",
  "email": "[email protected]",
  "phone": "<string>",
  "secondary_phone": "<string>",
  "country": "<string>",
  "nationality": "<string>",
  "occupation": "<string>",
  "residential_address": "<string>",
  "work_address": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "next_of_kin": {
    "name": "<string>",
    "phone": "<string>",
    "address": "<string>"
  },
  "national_id": "<string>",
  "preferred_language": "<string>",
  "referred_by": "<string>",
  "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "employment": {
    "status": "<string>",
    "company": "<string>",
    "role": "<string>"
  },
  "is_dependent": true,
  "is_waitlist": true,
  "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "billing": {},
  "medical_history": "<string>",
  "family_history": "<string>",
  "smoking_status": "<string>",
  "alcohol_use": "<string>",
  "recreational_drug_use": "<string>",
  "physical_activity": "<string>",
  "living_arrangement": "<string>",
  "is_vip": true,
  "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "emails": [
    {
      "email": "[email protected]",
      "type": "<string>",
      "is_primary": false
    }
  ],
  "phones": [
    {
      "phone_number": "<string>",
      "type": "<string>",
      "is_primary": false
    }
  ],
  "guardians": [
    {
      "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "is_responsible_for_billing": false,
      "is_primary": false,
      "can_access_records": false,
      "is_emergency_contact": true,
      "can_schedule_appointments": false,
      "notes": "<string>"
    }
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    last_name: '<string>',
    middle_name: '<string>',
    preferred_name: '<string>',
    title: '<string>',
    suffix: '<string>',
    date_of_birth: '2023-12-25',
    email: '[email protected]',
    phone: '<string>',
    secondary_phone: '<string>',
    country: '<string>',
    nationality: '<string>',
    occupation: '<string>',
    residential_address: '<string>',
    work_address: '<string>',
    city: '<string>',
    state: '<string>',
    zip: '<string>',
    next_of_kin: {name: '<string>', phone: '<string>', address: '<string>'},
    national_id: '<string>',
    preferred_language: '<string>',
    referred_by: '<string>',
    referral_source_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    employment: {status: '<string>', company: '<string>', role: '<string>'},
    is_dependent: true,
    is_waitlist: true,
    sponsor_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    billing: {},
    medical_history: '<string>',
    family_history: '<string>',
    smoking_status: '<string>',
    alcohol_use: '<string>',
    recreational_drug_use: '<string>',
    physical_activity: '<string>',
    living_arrangement: '<string>',
    is_vip: true,
    primary_location_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    emails: [{email: '[email protected]', type: '<string>', is_primary: false}],
    phones: [{phone_number: '<string>', type: '<string>', is_primary: false}],
    guardians: [
      {
        guardian_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        first_name: '<string>',
        last_name: '<string>',
        email: '<string>',
        phone: '<string>',
        is_responsible_for_billing: false,
        is_primary: false,
        can_access_records: false,
        is_emergency_contact: true,
        can_schedule_appointments: false,
        notes: '<string>'
      }
    ]
  })
};

fetch('https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.clinikehr.com/v1/clinics/{clinic_id}/patients/{patient_id}"

payload = {
    "first_name": "<string>",
    "last_name": "<string>",
    "middle_name": "<string>",
    "preferred_name": "<string>",
    "title": "<string>",
    "suffix": "<string>",
    "date_of_birth": "2023-12-25",
    "email": "[email protected]",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "country": "<string>",
    "nationality": "<string>",
    "occupation": "<string>",
    "residential_address": "<string>",
    "work_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "next_of_kin": {
        "name": "<string>",
        "phone": "<string>",
        "address": "<string>"
    },
    "national_id": "<string>",
    "preferred_language": "<string>",
    "referred_by": "<string>",
    "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employment": {
        "status": "<string>",
        "company": "<string>",
        "role": "<string>"
    },
    "is_dependent": True,
    "is_waitlist": True,
    "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "billing": {},
    "medical_history": "<string>",
    "family_history": "<string>",
    "smoking_status": "<string>",
    "alcohol_use": "<string>",
    "recreational_drug_use": "<string>",
    "physical_activity": "<string>",
    "living_arrangement": "<string>",
    "is_vip": True,
    "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "emails": [
        {
            "email": "[email protected]",
            "type": "<string>",
            "is_primary": False
        }
    ],
    "phones": [
        {
            "phone_number": "<string>",
            "type": "<string>",
            "is_primary": False
        }
    ],
    "guardians": [
        {
            "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "first_name": "<string>",
            "last_name": "<string>",
            "email": "<string>",
            "phone": "<string>",
            "is_responsible_for_billing": False,
            "is_primary": False,
            "can_access_records": False,
            "is_emergency_contact": True,
            "can_schedule_appointments": False,
            "notes": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "mrn": "<string>",
    "middle_name": "<string>",
    "preferred_name": "<string>",
    "title": "<string>",
    "suffix": "<string>",
    "date_of_birth": "2023-12-25",
    "gender": "male",
    "marital_status": "single",
    "client_type": "adult",
    "client_status": "<string>",
    "is_dependent": true,
    "email": "<string>",
    "phone": "<string>",
    "secondary_phone": "<string>",
    "country": "<string>",
    "nationality": "<string>",
    "occupation": "<string>",
    "residential_address": "<string>",
    "work_address": "<string>",
    "city": "<string>",
    "state": "<string>",
    "zip": "<string>",
    "next_of_kin": {
      "name": "<string>",
      "phone": "<string>",
      "address": "<string>"
    },
    "national_id": "<string>",
    "preferred_language": "<string>",
    "referred_by": "<string>",
    "referral_source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "employment": {
      "status": "<string>",
      "company": "<string>",
      "role": "<string>"
    },
    "is_waitlist": true,
    "billing": {
      "individual_type": "self_pay",
      "group_type": "self_pay"
    },
    "sponsor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "allergies": [
      "<string>"
    ],
    "medical_history": "<string>",
    "current_medications": [
      "<string>"
    ],
    "chronic_conditions": [
      "<string>"
    ],
    "blood_type": "O+",
    "genotype": "AA",
    "family_history": "<string>",
    "smoking_status": "<string>",
    "alcohol_use": "<string>",
    "recreational_drug_use": "<string>",
    "physical_activity": "<string>",
    "living_arrangement": "<string>",
    "has_profile_image": true,
    "profile_image_path": "<string>",
    "status": "active",
    "is_vip": true,
    "primary_location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "portal_access_enabled": true,
    "admission_status": "<string>",
    "couple": {
      "partner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "responsible_for_billing": true,
      "relationship_status": "<string>"
    },
    "emails": [
      {
        "email": "[email protected]",
        "type": "<string>",
        "permission": "email_ok",
        "is_primary": false
      }
    ],
    "phones": [
      {
        "phone_number": "<string>",
        "type": "<string>",
        "permission": "text_voicemail_ok",
        "is_primary": false
      }
    ],
    "guardians": [
      {
        "guardian_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "relationship": "parent",
        "is_responsible_for_billing": false,
        "is_primary": false,
        "can_access_records": false,
        "is_emergency_contact": true,
        "can_schedule_appointments": false,
        "notes": "<string>"
      }
    ],
    "insurance": [
      {}
    ],
    "pharmacies": [
      {}
    ],
    "care_providers": [
      {}
    ],
    "notification_settings": {
      "upcoming_appointments_enabled": true,
      "upcoming_appointments_email_option": "<string>",
      "upcoming_appointments_phone_option": "<string>",
      "incomplete_documents_enabled": true,
      "incomplete_documents_email_option": "<string>",
      "incomplete_documents_phone_option": "<string>",
      "cancellations_enabled": true,
      "cancellations_email_option": "<string>",
      "cancellations_phone_option": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "code": "<string>",
  "request_id": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "pointer": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

clinic_id

string<uuid>

required

patient_id

string<uuid>

required

Body

application/json

A key ABSENT from the body leaves that field unchanged; a key present with JSON null clears it where the column allows null, refused (naming the field) where it does not (first_name/last_name can never be cleared). Nested objects (next_of_kin/employment/billing) replace as a whole when present. Arrays (emails/phones/guardians) replace the set when present. allergies, current_medications and chronic_conditions cannot be changed here: they are refused by name. Use createAllergy / updateAllergy and createCondition / updateCondition, which a clinician confirms. They are still returned when you read a patient.

first_name

string

Minimum string length: 1

last_name

string

Minimum string length: 1

middle_name

string | null

preferred_name

string | null

title

string | null

suffix

string | null

client_type

enum<string>

Never couple.

Available options:

adult,

minor

date_of_birth

string<date> | null

gender

enum<string> | null

Available options:

male,

female,

other,

null

marital_status

enum<string> | null

Available options:

single,

married,

divorced,

widowed,

separated,

null

string<email> | null

phone

string | null

secondary_phone

string | null

country

string | null

nationality

string | null

occupation

string | null

residential_address

string | null

work_address

string | null

city

string | null

state

string | null

zip

string | null

next_of_kin

object | null

Show child attributes

national_id

string | null

preferred_language

string | null

referred_by

string | null

referral_source_id

string<uuid> | null

employment

object | null

Show child attributes

is_dependent

boolean

is_waitlist

boolean

billing

object | null

Show child attributes

medical_history

string | null

blood_type

enum<string> | null

Available options:

O+,

O-,

A+,

A-,

B+,

B-,

AB+,

AB-,

null

genotype

enum<string> | null

Available options:

AA,

AS,

SS,

AC,

SC,

null

family_history

string | null

smoking_status

string | null

alcohol_use

string | null

recreational_drug_use

string | null

physical_activity

string | null

living_arrangement

string | null

status

enum<string> | null

Available options:

active,

prospect,

inactive,

blocked,

null

is_vip

boolean

primary_location_id

string<uuid> | null

emails

object[]

Show child attributes

phones

object[]

Show child attributes

guardians

object[]

Show child attributes

Response

OK.

data

object

required

Show child attributes

Overview

Your key

Connections

Patients

Appointments

Encounters

Notes

Conditions

Allergies

Medications

Referrals

Submissions

Providers

Care providers

Insurance payers

Insurance coverage

Inventory

Dispensing

Drug requests

Pharmacy listings

CRM

Events

FHIR

Update a patient

Authorizations

Path Parameters

Body

Response