Patients
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.
post/patients
Request
- Base URLhttps://nexhealth.info
- URLhttps://nexhealth.info/patients
- AuthAPI key in header Authorization
Query parameters
subdomainstring required
Used to scope the request to the specified institution
location_idinteger required
Used to scope the request to the specified location
Headers
Nex-Api-Versionstring required
The NexHealth API version
Request body
Example request
{
"provider": {
"provider_id": 12
}
}Response
Successful
Example response
{
"description": "Description",
"error": [
"Error message"
],
"data": {
"id": 415,
"email": "anthony.smith@nexhealth.com",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": 1,
"foreign_id": "532e7f8c",
"foreign_id_type": "--DataSource-",
"cell_phone_number": "5163042196",
"preferred_phone_number": "5163042196",
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"gender": "Female",
"non_patient": true,
"date_of_birth": "1964-05-03",
"address": {
"line_1": "333 Bush Street",
"line_2": "Apt 4B",
"postal_code": "20814",
"city": "New York",
"region": "NY"
},
"hipaa": {
"authorization": true,
"authorization_date": "2023-03-22",
"privacy": true,
"privacy_date": "2023-03-22",
"consent": true,
"consent_date": "2023-03-22"
},
"children": [
{
"id": 415,
"email": "anthony.smith@nexhealth.com",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": 1,
"foreign_id": "532e7f8c",
"foreign_id_type": "--DataSource-",
"cell_phone_number": "5163042196",
"preferred_phone_number": "5163042196",
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"gender": "Female",
"non_patient": true,
"date_of_birth": "1964-05-03",
"address": {
"line_1": "333 Bush Street",
"line_2": "Apt 4B",
"postal_code": "20814",
"city": "New York",
"region": "NY"
}
}
],
"guarantor": {
"id": 415,
"email": "anthony.smith@nexhealth.com",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": 1,
"foreign_id": "532e7f8c",
"foreign_id_type": "--DataSource-",
"cell_phone_number": "5163042196",
"preferred_phone_number": "5163042196",
"billing_type": "Standard Billing - finance charges",
"chart_id": "017407",
"preferred_language": "es",
"gender": "Female",
"non_patient": true,
"date_of_birth": "1964-05-03",
"address": {
"line_1": "333 Bush Street",
"line_2": "Apt 4B",
"postal_code": "20814",
"city": "New York",
"region": "NY"
}
},
"provider": {
"id": 415,
"email": "anthony.smith@nexhealth.com",
"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"name": "John Smith",
"created_at": "2020-06-05T20:16:57.007Z",
"updated_at": "2020-06-05T20:16:57.007Z",
"institution_id": 1,
"foreign_id": "532e7f8c",
"foreign_id_type": "--DataSource-",
"phone_number": "5163042196",
"display_name": "John Smith",
"npi": "1912507500",
"tin": "078051120",
"state_license": "R219935",
"specialty_code": "363L00000X"
},
"last_visited_appointment": {
"id": 1822,
"provider_id": 102,
"provider_name": "Dr. John Smith",
"start_time": "2021-12-06T09:45:00.000Z",
"end_time": "2021-12-06T10:00:00.000Z",
"location_id": 1,
"confirmed": true
},
"upcoming_appts": [
{
"id": 1822,
"provider_id": 102,
"provider_name": "Dr. John Smith",
"start_time": "2021-12-06T09:45:00.000Z",
"end_time": "2021-12-06T10:00:00.000Z",
"location_id": 1,
"confirmed": true
}
],
"procedures": [
{
"id": 11,
"foreign_id": "1234-5678",
"location_id": 21,
"patient_id": 162,
"provider_id": 84,
"appointment_id": 283,
"code": "D6100",
"name": "Implant Removal",
"status": "completed",
"updated_at": "2020-06-05T20:16:57.007Z",
"body_site": {
"tooth": [
"3",
"14"
],
"surface": "MOD"
},
"fee": {
"amount": "62.00",
"currency": "USD"
},
"start_date": "2022-06-24",
"end_date": "2022-06-24",
"treatment_plan_ids": [
42,
57
]
}
],
"insurance_coverages": [
{
"id": 18,
"subscription_relation": "self",
"patient_id": 25,
"priority": 2,
"plan_id": 18,
"subscriber_num": "123456789",
"effective_date": "2022-01-01",
"expiration_date": "2022-12-31",
"plan": {
"id": 18,
"payer_id": "87726",
"name": "United Healthcare",
"address": "123 Law St",
"address2": "85335, North East",
"city": "New York",
"state": "NY",
"zip_code": "54700",
"country_code": "US",
"group_num": "12345",
"employer_name": "Walmart",
"foreign_id": "1",
"updated_at": "2020-06-05T20:16:57.007Z",
"deleted_at": "2024-09-15T11:21:26.003Z"
},
"subscriber": {
"id": 415,
"name": "John Smith",
"date_of_birth": "1990-06-05"
}
}
],
"adjustments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"adjustment_amount": {
"amount": "62.00",
"currency": "USD"
},
"adjusted_at": "2024-10-01",
"transaction_id": "NHP:JXZEQ1234",
"charge_id": 1111,
"claim_id": 2222,
"adjustment_type_id": 5
}
],
"charges": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"procedure_id": 34,
"procedure_code": "D0120",
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"fee": {
"amount": "62.00",
"currency": "USD"
},
"charged_at": "2024-10-05",
"deleted_at": "2022-01-01T00:00:00Z"
}
],
"payments": [
{
"id": 113,
"foreign_id": "1234-5678",
"location_id": 10,
"patient_id": 3,
"guarantor_id": 5,
"provider_id": 15,
"updated_at": "2024-09-05T20:31:17.007Z",
"description": "This is a description",
"deleted_at": "2024-09-15T11:21:26.003Z",
"payment_amount": {
"amount": "62.00",
"currency": "USD"
},
"paid_at": "2024-10-01",
"transaction_id": "NHP:JXZEQ1234",
"charge_id": 1111,
"claim_id": 2222,
"payment_plan_id": 3,
"insurance_plan_id": 4,
"payment_type_id": 5
}
],
"patient_alerts": [
{
"id": 10,
"patient_id": 101,
"note": "Patient is late on payment",
"disabled_at": "2024-02-05T20:16:57.007Z",
"created_at": "2023-11-11T10:11:01.007Z",
"updated_at": "2024-01-14T14:11:01.007Z"
}
],
"appointments": [
{
"id": 1822,
"provider_id": 102,
"provider_name": "Dr. John Smith",
"start_time": "2021-12-06T09:45:00.000Z",
"end_time": "2021-12-06T10:00:00.000Z",
"location_id": 1,
"confirmed": true
}
],
"location_ids": [
101,
102,
103
]
},
"count": 2
}Changes
No recorded changes to this operation across all 1 revision of this API.