Submit Patient

post

https://sandbox.particlehealth.com/api/v2/patients

Registers a patient's demographics in Particle's system and generates a unique Particle Patient ID (PPID) for use in subsequent API operations.

Body Params

Patient

address_city

string

required

The patient's home city.

address_lines

array of strings

The patient's home street address. This should not include the patient's city, state, or zip code.

address_lines

address_state

string

required

The patient's home state.

consent

array of objects

The patient's consent information.

consent

date_of_birth

string

required

The patient's date of birth, this field is required and must be of the format YYYY-MM-DD.

string

The patient's email, must be a valid email address.

family_name

string

required

The patient's family name (last name), this field is required.

gender

string

required

The patient's gender, must be either FEMALE or MALE.

given_name

string

required

The patient's given name (first name), this field is required.

particle_patient_id

string

The Particle Assigned Patient ID. Output only.

patient_id

string

required

The unique patient id in an external system.

postal_code

string

required

The patient's home postal (zip) code.

ssn

string

The patient's social security number, must be a valid US social security number.

telephone

string

The patient's telephone number.

Responses

Language

Credentials

Header

Response

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

application/json

200OK

400Bad Request

401Unauthorized

406Not Acceptable

500Internal Server Error