API Reference

Create Patient

post
https://customer-api-sandbox.greenlighthealth.com/v1/customers//patients

Creates a new patient and returns the Greenlight provided identifier for this patient.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Greenlight provided identifier

Body Params

Create Patient Payload

string
required
length ≤ 50

The Patient's First Name.

  • maxLength: 50
string | null

The Patient's Middle Name.

  • maxLength: 50
string
required
length ≤ 50

The Patient's Last Name.

  • maxLength: 50
date
required

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

string
enum
required

The Patient's Sex as assigned at birth.

Allowed:
string | null

The first line of the Patient's Street Address.

string | null

The second line of the Patient's Street Address.

string | null

The city that the patient resides in.

  • maxLength: 100
string | null

The state abbreviation of the Patient's Street Address.

  • maxLength: 2
string
required
length between 5 and 10

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.

string | null

The county the Patient lives in.

  • maxLength: 50
string | null

The country the Patient lives in.

  • maxLength: 50
string
required
length ≤ 256

The Patient's Email Address.

Must conform to email address pattern, [email protected]

  • maxLength: 256
string | null

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

string | null

Email Address of the Patient's assistant.

Must conform to email address pattern, [email protected]

  • maxLength: 256
string | null

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

string | null
enum

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

Allowed:
string | null
enum

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

Allowed:
Responses

Updated 8 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago