Update Patient

put

https://api.joinplanbase.com/api/v1/patients/{id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The ID of the patient to update

Body Params

external_id

The patient's external identifier (e.g. EHR ID)

first_name

The patient's first name

last_name

The patient's last name

birth_date

The patient's date of birth

The patient's email

phone

The patient's phone number

language

The patient's language

address_line1

Address line 1

address_line2

Address line 2

address_city

City

address_district

District / county

address_state

State or region

address_postal_code

Postal / ZIP code

address_country

Country

activity_ids

array | null

List of activity IDs associated with this patient

client_ids

array | null

List of client IDs associated with this patient

primary_provider_id

The provider (person) ID that is this patient's primary provider

payor_enrollments_in

array | null

List of payor enrollments that this patient has

custom_option_ids

array | null

List of custom option IDs associated with the patient

custom_fields

object | null

Custom fields for this patient (reference/joined-table fields not supported)

The patient's primary ID

time_created

The time when the patient was created

time_updated

The time when the patient was last updated

archived

Whether the patient is archived

payor_provider_enrollments

array | null

The patient's payor enrollments

primary_provider

PersonRead | null

The patient's primary provider

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

422Validation Error