Update Patient

patch

https://customer-api-sandbox.greenlighthealth.com/v1/customers/{customerId}/patients/{patientId}

Updates the existing patient with the new provided data. Only fields provided in the request body, will be updated for the patient. If a field is not needed for updating, it should be removed from the request body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

customerId

uuid

required

Greenlight provided identifier

patientId

uuid

required

Greenlight provided identifier for this patient

Body Params

Update Patient Payload

firstName

string

length ≤ 50

The Patient's First Name.

maxLength: 50

middleName

string | null

The Patient's Middle Name.

maxLength: 50

lastName

string

length ≤ 50

The Patient's Last Name

maxLength: 50

dateOfBirth

date

The Patient's Date of Birth in YYYY-MM-DD format

streetAddr

string | null

The first line of the Patient's Street Address.

streetAddr2

string | null

The second line of the Patient's Street Address.

city

string | null

The city that the patient resides in.

maxLength: 100

state

string | null

The state abbreviation of the Patient's Street Address.

maxLength: 2

zipCode

string

length between 5 and 10

^\d{5}(?:[-\s]\d{4})?$

The Patient's 5 or 9 digit Zip Code in ##### or #####-#### format.

While 9 digits are accepted, only the first 5 digits will be used.

county

string | null

The county the Patient lives in.

maxLength: 50

country

string | null

The country the Patient lives in.

maxLength: 50

string

length ≤ 256

The Patient's Email Address.

Must conform to email address pattern, [email protected]

maxLength: 256

mobilePhone

string | null

^[0-9]{3}-[0-9]{3}-[0-9]{4}$

The Patient's mobile phone number in ###-###-#### format. Area Code and Exchange must be valid for US.

ccEmail

string | null

Email Address of the Patient's assistant.

Must conform to email address pattern, [email protected]

maxLength: 256

ccMobilePhone

string | null

^[0-9]{3}-[0-9]{3}-[0-9]{4}$

The mobile phone number of the Patient's assistant in ###-###-#### format. Area Code and Exchange must be valid for US.

patientPreferredCommunication

string | null

enum

The preferred line of communication. Expected values: 'NO PREFERENCE', 'SMS', or 'EMAIL'

Allowed:

ccPreferredCommunication

string | null

enum

The preferred line of communication. Expected values: 'NO PREFERENCE', 'SMS', or 'EMAIL'

Allowed:

sex

string

enum

The Patient's Sex as assigned at birth.

Allowed:

Responses

200Empty response

400The malformed input error. Indicates that the server does not understand this request. Field invalidFields contains the field name and the error description.

401The unauthorized error. Indicates the client is unauthorized to perform this action. Check to ensure your x-api-key is correct and the token is still valid.

404The not found error. Indicates the requested entity was not found

422The invalid input error. Indicates the server could decode the request but the request was semantically invalid. Field invalidFields contains the fieldname and the error description.

429The TooManyRequests error. Indicates the rate limit was hit for this call or customer. Implement an incremental backoff to avoid this error.

500The internal server error. An unexpected error condition occurred, contact support if the issue persists. Include the returned requestId when contacting support.