Skip to main content

Endpoint

Request Body

string
Patient’s full name
string
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
Array of medical conditions as strings (e.g., ["Hypertension", "Diabetes"])
array
Array of current medications
string
Known allergies (comma-separated or as a single string)
array
Array of note objects for additional patient information
boolean
Whether medication reminders are enabled for this patient (default: false)
object
Prescription refill information
string
How the patient joined the system (e.g., “WEB”, “WHATSAPP”, “API”)

Response

boolean
Indicates if the patient was created successfully
object
The created patient object with generated ID and timestamps
string
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.
All these formats are accepted and normalized to 15551234567:
  • +15551234567
  • 15551234567
  • 5551234567
  • (555) 123-4567
  • 555-123-4567
  • 555.123.4567
The system will:
  1. Remove all non-digit characters
  2. Add country code 1 if missing (for 10-digit numbers)
  3. 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
This works even if phone numbers are in different formats:
  • Creating with 5551234567 after +15551234567 → Duplicate detected
  • Creating with (555) 123-4567 after 15551234567 → Duplicate detected

Use Cases

Create patient records during onboarding or registration:
Create patients as part of a larger integration workflow:

Best Practices

  • Only collect necessary patient information
  • Implement proper consent mechanisms
  • Follow healthcare data compliance requirements (HIPAA, etc.)
  • Use secure transmission (HTTPS)
  • 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
  • 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