Submit (register) patient (WRITE)
particle_submit_patient⚠️ WRITE: register a new patient with Particle Health. Returns the patient with a system-generated particle_patient_id (use it for subsequent queries). Endpoint: POST /api/v2/patients.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ssn | No | Social Security Number (optional; improves demographic match quality). | |
| No | Patient email address. | ||
| gender | Yes | Administrative gender: MALE or FEMALE. | |
| consent | No | Consent objects, if required by your Particle data-sharing agreement. | |
| telephone | No | Patient phone number. | |
| given_name | Yes | Patient's legal first / given name. | |
| patient_id | Yes | Your own external identifier for this patient (echoed back by Particle). | |
| family_name | Yes | Patient's legal last / family name. | |
| postal_code | Yes | 5-digit ZIP / postal code. | |
| address_city | Yes | City of the patient's home address. | |
| address_lines | No | Street address lines, e.g. ["123 Main St"]. | |
| address_state | Yes | Two-letter US state code, e.g. NY. | |
| date_of_birth | Yes | Date of birth, YYYY-MM-DD. |