Endpoint
Request Body
Patient’s full name
Patient’s phone number in ANY format. Supports:
+15551234567(E.164 format)15551234567(11-digit)5551234567(10-digit)(555) 123-4567(formatted)- Any other format - will be automatically normalized to 11-digit format
Array of medical conditions as strings (e.g.,
["Hypertension", "Diabetes"])Array of current medications
Known allergies (comma-separated or as a single string)
Array of note objects for additional patient information
Whether medication reminders are enabled for this patient (default:
false)Prescription refill information
How the patient joined the system (e.g., “WEB”, “WHATSAPP”, “API”)
Response
Indicates if the patient was created successfully
The created patient object with generated ID and timestamps
Error message if the request failed (only present when success is false)
Examples
Basic Patient Creation
Comprehensive Patient Creation
Response Examples
Success Response
Duplicate Patient Error (409)
Phone Number Handling
Phone Number Flexibility: The API accepts phone numbers in ANY format and automatically normalizes them.
15551234567:
+15551234567155512345675551234567(555) 123-4567555-123-4567555.123.4567
- Remove all non-digit characters
- Add country code
1if missing (for 10-digit numbers) - Store in normalized 11-digit format
Duplicate Prevention
The API automatically prevents duplicate patients based on phone number. If you attempt to create a patient with a phone number that already exists (in any format), the API will:- Return HTTP status code
409 Conflict - Include the existing patient data in the response
- Not create a new record
- Creating with
5551234567after+15551234567→ Duplicate detected - Creating with
(555) 123-4567after15551234567→ Duplicate detected
Use Cases
New Patient Registration
New Patient Registration
Create patient records during onboarding or registration:
Integration Workflow
Integration Workflow
Create patients as part of a larger integration workflow:
Best Practices
Data Privacy
Data Privacy
- Only collect necessary patient information
- Implement proper consent mechanisms
- Follow healthcare data compliance requirements (HIPAA, etc.)
- Use secure transmission (HTTPS)
Data Quality
Data Quality
- Validate data on the client side before submission
- Phone numbers can be in any format - the API will normalize them
- Provide clear error messages for validation failures
- Handle 409 duplicate responses gracefully
Integration
Integration
- Store the returned patient ID for future API calls
- Handle duplicate patient scenarios gracefully (409 status)
- Implement retry logic for network failures
- The API will mark patients created via API with
join_status: "API"
Error Codes
| Status Code | Error Message | Description |
|---|---|---|
| 400 | ”Failed to create patient” | Required fields are missing or invalid |
| 401 | ”Unauthorized - Invalid API key” | The provided API key is invalid |
| 409 | ”Patient with this phone number already exists” | Patient with same phone (any format) exists |
| 500 | ”Failed to create patient” | An unexpected error occurred |

