Create patient (beta)

🚧

Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds request fields patient.address, patient.address.city, patient.address.line_1, patient.address.line_2 (+10 more); removes request fields patient.bio, patient.bio.address_line_1, patient.bio.address_line_2, patient.bio.cell_phone_number (+16 more); and other schema changes.

This endpoint creates a new patient (201 Created), or returns the existing patient (200 OK) when one with a matching name and date of birth already exists. At least one non-blank phone number (cell_phone_number, home_phone_number, or work_phone_number) is required. Phone numbers are written to typed fields in the integrated system, but many systems report the main number back as an untyped primary number — see the cell_phone_number and preferred_phone_number response fields for how that is surfaced.

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

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

Body Params

Create patient

provider
object
required
patient
object
required
Headers
string
required
Defaults to v3.1.0

The NexHealth API version

Responses

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