API Reference
Status

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.

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

Accepts patient demographics in JSON or FHIR® R4 format and returns the patient record with an assigned particle_patient_id
that serves as the primary identifier for querying healthcare data, setting up monitoring, and accessing all patient-related
services.

This is the V2 version of the patient registration endpoint with enhanced capabilities for the new patient-centric API workflow.

Body Params

Patient

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
string
required

The patient's home state.

consent
array of objects

The patient's consent information.

consent
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.

string
required

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

string
required

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

string
required

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

string

The Particle Assigned Patient ID. Output only.

string
required

The unique patient id in an external system.

string
required

The patient's home postal (zip) code.

string

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

string

The patient's telephone number.

Responses

Updated 3 months ago

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

Updated 3 months ago