{"openapi":"3.0.0","info":{"title":"NexHealth API v3.1.0 (Beta)","version":"v3.1.0","description":"Endpoints that exist only in v3.1.0, the edge version of the Synchronizer API. Send `Nex-Api-Version: v3.1.0` to use them. Where an endpoint is not redefined here, v3.1.0 behaves exactly like the stable v3.0.0 reference. Access is limited to approved partner institutions; contact NexHealth before you build on these endpoints."},"security":[{"Authorization":[]}],"tags":[{"name":"Communication Logs","description":"Operations about Communication Logs"},{"name":"Form Responses","description":"Operations about Form Responses"},{"name":"Form Schemas","description":"Patient intake form schemas configured for a location"},{"name":"Insurance","description":"An insurance resource"},{"name":"Medical History","description":"A medical history resource"},{"name":"Patients","description":"A patients resource"},{"name":"Procedure Code Categories","description":"Categories grouping the procedure codes of the data source"},{"name":"Procedure Codes","description":"Catalog of billable procedure codes available on the data source"}],"paths":{"/insurance_plans":{"post":{"summary":"Create insurance plan","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Eaglesoft, Open Dental.\n\nThis endpoint creates a new insurance plan for the institution scoped to the specified location's data source.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postInsurancePlans"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"postInsurancePlans"}},"/medical_history/items":{"get":{"summary":"View medical history items","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Denticon, Dentrix, Dentrix Ascend, Dentrix Enterprise, Eaglesoft, eClinicalWorks, Open Dental.\n\nReturns a list of medical history items (allergies, conditions, or medications) for the given location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"category","description":"Category of medical history items to return (allergies, conditions, medications)","required":true,"schema":{"type":"string","enum":["allergies","conditions","medications"]}},{"in":"query","name":"search_term","description":"Filter items whose name matches the search string","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"getMedicalHistoryItems"}},"/medical_history/patient_items":{"get":{"summary":"View patient medical history items","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Dentrix Enterprise, Eaglesoft, Open Dental.\n\nReturns a list of patient-specific medical history items (allergies, conditions, or medications) for the given patient.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Patient ID to return items for","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"category","description":"Category of patient items to return (allergies, conditions, medications)","required":true,"schema":{"type":"string","enum":["allergies","conditions","medications"]}},{"in":"query","name":"active","description":"Filter active or inactive items","required":false,"schema":{"type":"boolean","default":true}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"getMedicalHistoryPatientItems"},"post":{"summary":"Create or update patient medical history items","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Open Dental.\n\nBatch creates, updates, or deactivates patient-specific medical history items...","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postMedicalHistoryPatientItems"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem_Collection_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Medical History"],"operationId":"postMedicalHistoryPatientItems"}},"/patients/{id}":{"patch":{"summary":"Update patient","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Denticon, Dentrix, Eaglesoft (partial on Open Dental).\n\nUpdates a patient record and enqueues a patients.update sync command. All fields are optional — only provided fields are updated. Phone number fields cannot be blanked: provide a non-empty value or omit the field. Returns 422 if the patient has not been synced to the EHR (no foreign_id). 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.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/patchPatientsId"}}},"required":true},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Patients"],"operationId":"patchPatientsId"}},"/insurance_coverages":{"post":{"summary":"Create insurance coverage","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postInsuranceCoverages"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"postInsuranceCoverages","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Eaglesoft, Open Dental.\n\n"}},"/insurance_coverages/{id}":{"delete":{"summary":"Delete insurance coverage","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"Insurance coverage ID","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Insurance"],"operationId":"deleteInsuranceCoveragesId","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Eaglesoft, Open Dental.\n\n"}},"/communication_logs":{"get":{"summary":"View communication logs","description":"> 🚧 Beta\n>\n> 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.\n\nThis endpoint lists the communication log requests made through this API at the given location, each with the status of its write-back to the EHR (`pending`, `succeeded` or `failed`). Filter by `patient_id`, `status` or `created_since`. Only requests registered in the last 30 days are listed unless `created_since` reaches further back, up to 90 days. Entries recorded directly in the EHR are not available. Communication logs exist only for Open Dental locations, the only EHR the write-back currently supports.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter by patient","required":false,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"status","description":"Filter by write-back status","required":false,"schema":{"type":"string","enum":["pending","succeeded","failed"]}},{"in":"query","name":"created_since","description":"Requests registered after the specified time (UTC). Defaults to 30 days ago and cannot be more than 90 days ago","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"sort","description":"Optional comma-separated string of fields to sort on.\nInclude a leading dash for descending order.\n\nAvailable fields:\n  * created_at\n  * -created_at\n","required":false,"schema":{"type":"string"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_CommunicationLogCreateDirective_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Communication Logs"],"operationId":"getCommunicationLogs"},"post":{"summary":"Create communication log","description":"> 🚧 Beta\n>\n> 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.\n\nSupported for Open Dental locations only. Requests for a location on any other EHR are rejected with 422. This endpoint registers a request to append an entry to the patient's communication log in the connected EHR, for example a summary of a phone call or the transcript of a text conversation, and returns 202 Accepted with the request in `pending` status. The entry is written to the EHR asynchronously: poll this request to learn whether the write-back `succeeded` or `failed`. Entries are append-only and cannot be updated or deleted through the API. A request that `succeeded` wrote one entry, so do not resend it; a request that `failed` wrote nothing and is retried by submitting a new one.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postCommunicationLogs"}}},"required":true},"responses":{"202":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_CommunicationLogCreateDirective_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Communication Logs"],"operationId":"postCommunicationLogs","x-nex":{"supported_ehrs":["opendental"]}}},"/communication_logs/{id}":{"get":{"summary":"View communication log","description":"> 🚧 Beta\n>\n> 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.\n\nThis endpoint returns a communication log request made through this API, with the status of its write-back to the EHR. Entries recorded directly in the EHR are not available. Communication logs exist only for Open Dental locations, the only EHR the write-back currently supports.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","required":true,"schema":{"type":"string"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_CommunicationLogCreateDirective_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Communication Logs"],"operationId":"getCommunicationLogsId"}},"/form_responses":{"get":{"summary":"View form responses","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"patient_id","description":"Filter responses by patient ID.","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponse_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"getFormResponses","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with all 15 supported health record systems.\n\n"},"post":{"summary":"Create a form response","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postFormResponses"}}},"required":true},"responses":{"201":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"postFormResponses","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with all 15 supported health record systems.\n\n"}},"/form_responses/{id}":{"get":{"summary":"View a form response","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Responses"],"operationId":"getFormResponsesId","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with all 15 supported health record systems.\n\n"}},"/form_schemas":{"get":{"summary":"List form schemas for a location","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormSchema_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Schemas"],"operationId":"getFormSchemas","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with all 15 supported health record systems.\n\n"}},"/form_schemas/{uuid}":{"get":{"summary":"View a specific form schema","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"uuid","required":true,"schema":{"type":"string"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_FormSchemaDetail_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Form Schemas"],"operationId":"getFormSchemasUuid","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with all 15 supported health record systems.\n\n"}},"/procedure_code_categories":{"get":{"summary":"View procedure code categories","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Eaglesoft, Open Dental.\n\nReturns a list of procedure code categories for the location.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Code Categories"],"operationId":"getProcedureCodeCategories"}},"/procedure_code_categories/{id}":{"get":{"summary":"View procedure code category","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Eaglesoft, Open Dental.\n\nReturns a single procedure code category.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"path","name":"id","description":"The NexHealth id of the procedure code category","required":true,"schema":{"type":"integer","format":"int64"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_NotFound"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Code Categories"],"operationId":"getProcedureCodeCategoriesId"}},"/procedure_codes":{"get":{"summary":"View procedure codes","description":"> 🚧 Beta\n>\n> 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.\n>\n> **Health record systems:** Works with Dentrix, Dentrix Ascend, Dentrix Enterprise, Eaglesoft, Open Dental.\n\nReturns a list of procedure codes for the location. Optionally filter by updated_since.","parameters":[{"in":"header","name":"Nex-Api-Version","description":"The NexHealth API version","required":true,"schema":{"type":"string","default":"v3.1.0"}},{"in":"query","name":"subdomain","description":"Used to scope the request to the specified institution","required":true,"schema":{"type":"string"}},{"in":"query","name":"location_id","description":"Used to scope the request to the specified location","required":true,"schema":{"type":"integer","format":"int32"}},{"in":"query","name":"updated_since","description":"Procedure codes updated after the specified time (UTC)","required":false,"schema":{"type":"string","format":"date-time"}},{"in":"query","name":"start_cursor","description":"First item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"end_cursor","description":"Last item of the current page. Starts empty","required":false,"schema":{"type":"string"}},{"in":"query","name":"per_page","description":"Number of results to return per page. Maximum allowed amount is 1000.","required":false,"schema":{"type":"integer","format":"int32","default":5}}],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCode_Collection_Response_WithCursor"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_BadRequest"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Unauthorized"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_Forbidden"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_Errors_InternalServerError"}}}}},"tags":["Procedure Codes"],"operationId":"getProcedureCodes"}}},"servers":[{"url":"https://nexhealth.info"}],"components":{"securitySchemes":{"Authorization":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"postInsurancePlans":{"type":"object","properties":{"insurance_plan":{"type":"object","properties":{"name":{"type":"string","description":"Plan name"},"employer_name":{"type":"string","description":"Employer name"},"payer_id":{"type":"string","description":"Payer ID"},"address":{"type":"string","description":"Street address"},"address2":{"type":"string","description":"Street address 2"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"2 letter state code"},"zip_code":{"type":"string","description":"Zip code"},"country_code":{"type":"string","description":"2 letter country code"},"group_num":{"type":"string","description":"Group number"}},"required":["name","employer_name"]}},"required":["insurance_plan"],"description":"Create insurance plan"},"API_V31_Entities_Insurance_EhrPlan_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_EhrPlan"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Insurance_EhrPlan_Response model"},"API_V31_Entities_Insurance_EhrPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true","nullable":true},"patient_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverage"},"description":"List of patient coverages"},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"},"description":"List of individuals who hold subscriptions to this plan."},"fee_schedule":{"$ref":"#/components/schemas/API_Entities_FeeSchedule"},"annual_max_individual":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"benefit_year_renewal_month":{"type":"integer","format":"int32","example":1,"description":"Month (1-12) when the benefit year resets. Null if not provided by the EHR."}}},"API_V2_Entities_Insurance_PatientCoverage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true}}},"API_V2_Entities_Insurance_Subscriber":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"The subscriber's id"},"name":{"type":"string","example":"John Smith","description":"The subscriber's full name"},"date_of_birth":{"type":"string","example":"1990-06-05","description":"The subscriber's date of birth in YYYY-MM-DD format","nullable":true}}},"API_Entities_FeeSchedule":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Fee schedule id"},"name":{"type":"string","example":"Cash","description":"The name of the fee schedule"},"active":{"type":"boolean","example":true,"description":"Indicates if the fee schedule is active","nullable":true},"location_id":{"type":"integer","format":"int32","example":21,"description":"The id of the location this fee schedule belongs to","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Fee Schedule update date in UTC"}}},"API_V2_Entities_Price":{"type":"object","properties":{"amount":{"type":"string","example":"62.00","description":"The currency value, in whole units (e.g. dollars)"},"currency":{"type":"string","example":"USD","description":"The ISO currency code"}}},"API_Errors_BadRequest":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_BadRequest model"},"API_Errors_Unauthorized":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_Unauthorized model"},"API_Errors_Forbidden":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_Forbidden model"},"API_Errors_InternalServerError":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_InternalServerError model"},"API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_Item"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_MedicalHistory_Item_Collection_Response_WithCursor model"},"API_V31_Entities_MedicalHistory_Item":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":415,"description":"Medical history item id"},"name":{"type":"string","example":"Aspirin","description":"Medical history item name"}}},"API_Errors_NotFound":{"type":"object","properties":{"code":{"type":"boolean","description":"Indicates the success or failure of the request."},"description":{"type":"string","description":"Additional context about the request to help with debugging."},"data":{"type":"object"},"error":{"type":"array","items":{"type":"string"},"description":"Any errors that occured during the execution of the request."}},"description":"API_Errors_NotFound model"},"API_V31_Entities_MedicalHistory_PatientItem_Collection_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_MedicalHistory_PatientItem"}},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_MedicalHistory_PatientItem_Collection_Response model"},"API_V31_Entities_MedicalHistory_PatientItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":101,"description":"Patient medical history item id"},"item_id":{"type":"integer","format":"int64","example":55,"description":"ID of the referenced medical history item"},"item_name":{"type":"string","example":"Aspirin","description":"Medical history item name"},"note":{"type":"string","example":"Severe reaction","description":"Optional note about the patient item"},"active":{"type":"boolean","example":true,"description":"Whether the item is active"}}},"postMedicalHistoryPatientItems":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"Patient ID"},"allergies":{"type":"array","description":"Allergy items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history allergy item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}},"conditions":{"type":"array","description":"Condition items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history condition item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}},"medications":{"type":"array","description":"Medication items to create or update","items":{"type":"object","properties":{"item_id":{"type":"integer","format":"int32","description":"Medical history medication item ID"},"note":{"type":"string","description":"Optional note"},"active":{"type":"boolean","description":"Whether the item is active","default":true}},"required":["item_id"]}}},"required":["patient_id"],"description":"Create or update patient medical history items"},"patchPatientsId":{"type":"object","properties":{"patient":{"type":"object","properties":{"first_name":{"type":"string","description":"Patient first name"},"last_name":{"type":"string","description":"Patient last name"},"email":{"type":"string","description":"Patient email id. Must match regular expression /\\A([^@\\s]+)@((?:[-a-z0-9]\\.)[a-z]{2,})\\Z/"},"date_of_birth":{"type":"string","format":"date","description":"Patient date of birth. Must be a parseable date string, recommended format is YYYY-MM-DD"},"middle_name":{"type":"string","description":"Patient middle name"},"gender":{"type":"string","description":"Patient gender.","enum":["Male","Female","Other"]},"cell_phone_number":{"type":"string","description":"Patient cell phone number, written to the integrated system's cell/mobile phone field. Some integrated systems report the number back as an untyped primary number; the cell_phone_number response field falls back to that number, so the value stays visible after the write syncs."},"home_phone_number":{"type":"string","description":"Patient home phone number"},"work_phone_number":{"type":"string","description":"Patient work place phone number"},"work_phone_extension":{"type":"string","description":"Patient work phone extension"},"ssn":{"type":"string","description":"Patient social security number"},"address":{"type":"object","description":"Patient address","properties":{"line_1":{"type":"string","description":"Address line 1"},"line_2":{"type":"string","description":"Address line 2"},"city":{"type":"string","description":"City"},"region":{"type":"string","description":"State"},"postal_code":{"type":"string","description":"Zip code"}}}}}},"required":["patient"],"description":"Update patient"},"API_V31_Entities_PatientDetailed_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_PatientDetailed"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_PatientDetailed_Response model"},"API_V31_Entities_PatientDetailed":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"},"hipaa":{"$ref":"#/components/schemas/API_V2_Entities_PrivacyAuthorization"},"ehr_unsubscribe_sms":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from SMS in the EHR"},"ehr_unsubscribe_emails":{"type":"boolean","example":false,"description":"Whether the patient is unsubscribed from emails in the EHR"},"preferred_location_id":{"type":"integer","format":"int32","description":"Patient's preferred location from the EHR"},"children":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"description":"Patient children"},"guarantor":{"$ref":"#/components/schemas/API_V31_Entities_PatientBasic"},"provider":{"$ref":"#/components/schemas/API_V31_Entities_Provider"},"last_visited_appointment":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"upcoming_appts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Scheduled appointments for one year. Not included by default"},"procedures":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Procedure"},"description":"Procedures assigned to the patient. Not included by default"},"insurance_coverages":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_PatientCoverageForIndividual"},"description":"Insurance coverages"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Adjustment"},"description":"Payment ledger adjustments"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_ChargeBasicWithDelete"},"description":"Payment ledger charges"},"payments":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_Ledger_Payment"},"description":"Payment ledger payments"},"patient_alerts":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_PatientAlert"},"description":"Patient Alerts"},"appointments":{"type":"array","items":{"$ref":"#/components/schemas/API_V2_Entities_AppointmentBasic"},"description":"Appointments for patient within date range"},"location_ids":{"type":"array","items":{"type":"integer","format":"int32"},"example":[101,102,103],"description":"Array of location ids associated with the user"},"ssn":{"type":"string","description":"Patient social security number. Returned only when fetching a single patient; omitted from patient lists and from patient objects embedded in other resources."}}},"API_V2_Entities_PatientAddress":{"type":"object","properties":{"line_1":{"type":"string","example":"333 Bush Street","description":"Address line 1","nullable":true},"line_2":{"type":"string","example":"Apt 4B","description":"Address line 2","nullable":true},"postal_code":{"type":"string","example":"20814","description":"Zip code","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"region":{"type":"string","example":"NY","description":"State","nullable":true}}},"API_V2_Entities_PrivacyAuthorization":{"type":"object","properties":{"authorization":{"type":"boolean","example":true,"description":"Whether the patient has provided HIPAA authorization"},"authorization_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient provided HIPAA authorization"},"privacy":{"type":"boolean","example":true,"description":"Whether the patient has acknowledged HIPAA privacy notice"},"privacy_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient acknowledged HIPAA privacy notice"},"consent":{"type":"boolean","example":true,"description":"Whether the patient has provided HIPAA consent"},"consent_date":{"type":"string","format":"date","example":"2023-03-22","description":"Date the patient provided HIPAA consent"}}},"API_V31_Entities_PatientBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"cell_phone_number":{"type":"string","example":"5163042196","description":"Cell phone number. When the integrated system reports the patient's main number as an untyped primary number instead of a typed cell number — which is how most systems report it back after a write — this field falls back to that primary number. The fallback is usually the cell number, but the integrated system does not guarantee the primary number is a cell number."},"preferred_phone_number":{"type":"string","example":"5163042196","description":"The best-known phone number for reaching the patient: the first available of the integrated system's untyped primary number, cell phone number, home phone number, and work phone number. Read-only — write one of the typed phone number fields to change it."},"guarantor_id":{"type":"integer","format":"int32","description":"User id of this patient's responsible party"},"billing_type":{"type":"string","example":"Standard Billing - finance charges","description":"Used by practices in some integrated systems to categorize and filter patients when creating reports, requesting payments, and performing other related office tasks. Some integrated systems call this an account type rather than a billing type"},"chart_id":{"type":"string","example":"017407","description":"User-facing ID for referencing patient data, used in some integrated systems. Depending on the system, the chart ID supplements or replaces the foreign_id as the ID visible to EHR users"},"preferred_language":{"type":"string","example":"es","description":"Patient's preferred language as an ISO 639-1 code, if specified in the integrated system"},"provider_id":{"type":"integer","format":"int32","description":"User id of this patient's primary provider"},"gender":{"type":"string","example":"Female","description":"Gender from biographical data"},"new_patient":{"type":"boolean","example":false,"description":"Whether the patient is new"},"non_patient":{"type":"boolean","example":true,"description":"Whether this is a non-patient user record"},"date_of_birth":{"type":"string","example":"1964-05-03","description":"Date of birth in YYYY-MM-DD format"},"premedication":{"type":"string","description":"Premedication notes"},"address":{"$ref":"#/components/schemas/API_V2_Entities_PatientAddress"}}},"API_V31_Entities_Provider":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"User id"},"email":{"type":"string","example":"anthony.smith@nexhealth.com","description":"User email"},"first_name":{"type":"string","example":"John","description":"First name"},"middle_name":{"type":"string","example":"Anthony","description":"Middle name"},"last_name":{"type":"string","example":"Smith","description":"Last name"},"name":{"type":"string","example":"John Smith","description":"Full name"},"created_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User creation date in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"User last update date in UTC"},"institution_id":{"type":"integer","format":"int32","example":1,"description":"The institution this user belongs to"},"foreign_id":{"type":"string","example":"532e7f8c","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"foreign_id_type":{"type":"string","example":"--DataSource-","description":"Foreign Id type is a unique string identifier for the integrated system"},"inactive":{"type":"boolean","example":false,"description":"Is the user inactivated?"},"phone_number":{"type":"string","example":"5163042196","description":"Primary phone number"},"cell_phone_number":{"type":"string","example":"","description":"Cell phone number"},"home_phone_number":{"type":"string","example":"","description":"Home phone number"},"work_phone_number":{"type":"string","example":"","description":"Work phone number"},"work_phone_extension":{"type":"string","example":"","description":"Work phone extension"},"display_name":{"type":"string","example":"John Smith","description":"Display name"},"npi":{"type":"string","example":"1912507500","description":"National Provider Identifier as registered in NPPES. May be null if the practice did not enter it into the integrated system."},"tin":{"type":"string","example":"078051120","description":"Taxpayer Identification Number (SSN or ITIN). May be null if the practice did not enter it into the integrated system."},"state_license":{"type":"string","example":"R219935","description":"State license number. May be null if the practice did not enter it into the integrated system."},"specialty_code":{"type":"string","example":"363L00000X","description":"Specialty code corresponding to the provider's state license and NPI. May be null if the practice did not enter it into the integrated system."}}},"API_V2_Entities_AppointmentBasic":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1822,"description":"Appointment id"},"provider_id":{"type":"integer","format":"int32","example":102,"description":"Provider id"},"provider_name":{"type":"string","example":"Dr. John Smith","description":"Provider name"},"start_time":{"type":"string","format":"date-time","example":"2021-12-06T09:45:00.000Z","description":"Start time of the appointment in UTC"},"end_time":{"type":"string","format":"date-time","example":"2021-12-06T10:00:00.000Z","description":"End time of the appointment in UTC"},"location_id":{"type":"integer","format":"int32","example":1,"description":"Location id"},"confirmed":{"type":"boolean","example":true,"description":"Is this appointment confirmed?"}}},"API_V31_Entities_Procedure":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":11,"description":"Procedure id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id"},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id"},"provider_id":{"type":"integer","format":"int32","example":84,"description":"Provider id"},"appointment_id":{"type":"integer","format":"int64","example":283,"description":"Appointment id"},"code":{"type":"string","example":"D6100","description":"Procedure code"},"name":{"type":"string","example":"Implant Removal","description":"Procedure name"},"status":{"type":"string","enum":["planned","scheduled","completed","inactive","referred","existing"],"example":"completed","description":"Procedure status"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure update date in UTC"},"body_site":{"$ref":"#/components/schemas/API_V2_Entities_ProcedureBodySite"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"start_date":{"type":"string","format":"date","example":"2022-06-24","description":"Start date for procedure"},"end_date":{"type":"string","format":"date","example":"2022-06-24","description":"End date for procedure"},"treatment_plan_ids":{"type":"array","items":{"type":"integer","format":"int64"},"example":[42,57],"description":"Treatment plan ids"}}},"API_V2_Entities_ProcedureBodySite":{"type":"object","properties":{"tooth":{"type":"array","items":{"type":"string"},"example":["3","14"],"description":"Tooth identifier strings, typically tooth numbers"},"surface":{"type":"string","example":"MOD","description":"Tooth surface codes"}}},"API_V2_Entities_Insurance_PatientCoverageForIndividual":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient","nullable":true},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies","nullable":true},"plan_id":{"type":"integer","format":"int64","example":18,"description":"The ID of the insurance plan this coverage subscribes to","nullable":true},"subscriber_num":{"type":"string","example":"123456789","description":"The subscriber's identification number for the plan","nullable":true},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"The date the coverage takes effect","nullable":true},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"The date the coverage expires","nullable":true},"plan":{"$ref":"#/components/schemas/API_Entities_Insurance_EhrPlan"},"subscriber":{"$ref":"#/components/schemas/API_V2_Entities_Insurance_Subscriber"}}},"API_Entities_Insurance_EhrPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"payer_id":{"type":"string","example":"87726","description":"A unique ID number that is assigned to an insurance company for the purpose of transmitting provider claims electronically","nullable":true},"name":{"type":"string","example":"United Healthcare","description":"Plan name","nullable":true},"address":{"type":"string","example":"123 Law St","description":"Street address","nullable":true},"address2":{"type":"string","example":"85335, North East","description":"Street address 2","nullable":true},"city":{"type":"string","example":"New York","description":"City","nullable":true},"state":{"type":"string","example":"NY","description":"2 letter state code","nullable":true},"zip_code":{"type":"string","example":"54700","description":"Zip code","nullable":true},"country_code":{"type":"string","example":"US","description":"2 letter country code","nullable":true},"group_num":{"type":"string","example":"12345","description":"Group number","nullable":true},"employer_name":{"type":"string","example":"Walmart","description":"Employer name","nullable":true},"foreign_id":{"type":"string","example":"1","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Plan update date in UTC"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"The UTC date and time the insurance plan was deleted. Null unless the plan is soft-deleted; deleted plans are only returned when include_deleted is true","nullable":true}}},"API_V31_Entities_Ledger_Adjustment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"adjustment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"adjusted_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date adjustment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"adjustment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the adjustment type for this payment"}}},"API_V31_Entities_Ledger_ChargeBasicWithDelete":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"procedure_id":{"type":"integer","format":"int64","example":34,"description":"The ID of the procedure associated with this charge"},"procedure_code":{"type":"string","example":"D0120","description":"The procedure code associated with this charge"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the charge"},"fee":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"charged_at":{"type":"string","format":"date","example":"2024-10-05","description":"The UTC date charge was made"},"deleted_at":{"type":"string","format":"date-time","example":"2022-01-01T00:00:00Z","description":"The UTC datetime the charge was deleted"}}},"API_V31_Entities_Ledger_Payment":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":113,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it."},"location_id":{"type":"integer","format":"int32","example":10,"description":"The ID of the location that this item is for"},"patient_id":{"type":"integer","format":"int32","example":3,"description":"The ID of the patient that this item is for"},"guarantor_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the guarantor that this item is for"},"provider_id":{"type":"integer","format":"int32","example":15,"description":"The ID of the provider that this item is for"},"updated_at":{"type":"string","format":"date-time","example":"2024-09-05T20:31:17.007Z","description":"Last updated time for item in UTC"},"description":{"type":"string","example":"This is a description","description":"A description of the item"},"deleted_at":{"type":"string","format":"date-time","example":"2024-09-15T11:21:26.003Z","description":"Deleted time for item in UTC"},"payment_amount":{"$ref":"#/components/schemas/API_V2_Entities_Price"},"paid_at":{"type":"string","format":"date","example":"2024-10-01","description":"The UTC date payment was made"},"transaction_id":{"type":"string","example":"NHP:JXZEQ1234","description":"The ID of the transaction for this payment"},"charge_id":{"type":"integer","format":"int64","example":1111,"description":"The ID of the charge for this payment"},"claim_id":{"type":"integer","format":"int64","example":2222,"description":"The ID of the insurance claim for this payment"},"payment_plan_id":{"type":"integer","format":"int64","example":3,"description":"The ID of the payment plan associated with this payment"},"insurance_plan_id":{"type":"integer","format":"int64","example":4,"description":"The ID of the insurance plan associated with this payment"},"payment_type_id":{"type":"integer","format":"int64","example":5,"description":"The ID of the payment type for this payment"}}},"API_V2_Entities_PatientAlert":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":10,"description":"Patient Alert id"},"patient_id":{"type":"integer","format":"int32","example":101,"description":"Id of the associated patient"},"note":{"type":"string","example":"Patient is late on payment","description":"The note for the patient alert"},"disabled_at":{"type":"string","format":"date-time","example":"2024-02-05T20:16:57.007Z","description":"The time that the alert was disabled in UTC"},"created_at":{"type":"string","format":"date-time","example":"2023-11-11T10:11:01.007Z","description":"The time that the alert was created in UTC"},"updated_at":{"type":"string","format":"date-time","example":"2024-01-14T14:11:01.007Z","description":"The time that the alert was last updated in UTC"}}},"postInsuranceCoverages":{"type":"object","properties":{"insurance_plan_id":{"type":"integer","format":"int32","description":"ID of the insurance plan to enroll the patient in"},"patient_id":{"type":"integer","format":"int32","description":"ID of the patient receiving the insurance coverage"},"subscriber_id":{"type":"integer","format":"int32","description":"ID of the patient who holds the insurance policy. Exactly one of subscriber_id or insurance_subscription is required. Use this when the subscriber already has an active coverage for the same plan."},"subscription_relation":{"type":"string","description":"Relationship of the patient to the insurance subscriber (e.g. self, spouse, child)","enum":["self","spouse","child","employee","handicap_dep","signif_other","injured_plaintiff","life_partner","dependent","other"],"default":"self"},"priority":{"type":"string","description":"Priority of this coverage when the patient has multiple plans (e.g. primary, secondary)","enum":["primary","secondary","supplemental"],"default":"primary"},"insurance_subscription":{"type":"object","description":"Subscription details for a new insurance subscription. Exactly one of subscriber_id or insurance_subscription is required. Use this when no existing subscription is on file and one needs to be created.","properties":{"subscriber_num":{"type":"string","description":"Subscriber member ID as it appears on the insurance card"},"effective_date":{"type":"string","format":"date","description":"Date the insurance coverage becomes effective (YYYY-MM-DD)"},"expiration_date":{"type":"string","format":"date","description":"Date the insurance coverage expires (YYYY-MM-DD)"}},"required":["subscriber_num"]}},"required":["insurance_plan_id","patient_id"],"description":"Create insurance coverage"},"API_V31_Entities_Insurance_PatientCoverage_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_PatientCoverage"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_Insurance_PatientCoverage_Response model"},"API_V31_Entities_Insurance_PatientCoverage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":18,"description":"Coverage id"},"subscription_relation":{"type":"string","example":"self","description":"The relationship of this patient to the subscriber"},"patient_id":{"type":"integer","format":"int32","example":25,"description":"The ID of the covered patient"},"priority":{"type":"integer","format":"int32","example":2,"description":"The relative priority of this insurance coverage where the lowest value is the patient's primary insurance\nand higher values represent secondary and tertiary policies"},"plan_id":{"type":"integer","format":"int64","example":18,"description":"Plan id"},"subscriber_num":{"type":"string","example":"123456789","description":"Subscriber number"},"effective_date":{"type":"string","format":"date","example":"2022-01-01","description":"Effective date"},"expiration_date":{"type":"string","format":"date","example":"2022-12-31","description":"Expiration date"},"insurance_type":{"type":"string","enum":["dental","medical","vision"],"example":"dental","description":"The type of the insurance plan"},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Insurance Coverage update date in UTC"},"active":{"type":"boolean","example":true,"description":"Whether the insurance coverage is currently active"},"subscriber":{"$ref":"#/components/schemas/API_V31_Entities_Insurance_Subscriber"},"benefits_remaining":{"$ref":"#/components/schemas/API_V2_Entities_Price"}}},"API_V31_Entities_Insurance_Subscriber":{"type":"object","properties":{"id":{"type":"integer","format":"int32","example":415,"description":"The subscriber's id"},"name":{"type":"string","example":"John Smith","description":"The subscriber's full name"},"date_of_birth":{"type":"string","example":"1990-06-05","description":"The subscriber's date of birth in YYYY-MM-DD format","nullable":true},"postal_code":{"type":"string","example":"20814","description":"The subscriber's postal code","nullable":true}}},"API_V31_Entities_CommunicationLogCreateDirective_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_CommunicationLogCreateDirective"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_CommunicationLogCreateDirective_Collection_Response_WithCursor model"},"API_V31_Entities_CommunicationLogCreateDirective":{"type":"object","properties":{"id":{"type":"string","example":"019965f2-4d1e-7a3c-9b0e-3f0c2a7d9e11","description":"Id of the communication log request (UUID)"},"patient_id":{"type":"integer","format":"int32","example":162,"description":"Patient id"},"location_id":{"type":"integer","format":"int32","example":21,"description":"Location id"},"mode":{"type":"string","enum":["phone","text","email","mail","in_person"],"example":"phone","description":"How the practice and the patient communicated"},"direction":{"type":"string","enum":["sent","received"],"example":"received","description":"Whether the practice sent or received the communication. Null when the exchange had no single direction, such as a two-way text conversation"},"note":{"type":"string","example":"AI receptionist call summary: patient confirmed the cleaning on Tuesday at 10am.","description":"Body of the log entry, written to the EHR verbatim"},"occurred_at":{"type":"string","format":"date-time","example":"2026-09-01T14:30:00.000Z","description":"When the communication happened, in UTC"},"status":{"type":"string","enum":["pending","succeeded","failed"],"example":"succeeded","description":"Status of the write-back to the EHR: `pending` until the EHR integration reports back, then `succeeded` or `failed`"},"completed_at":{"type":"string","format":"date-time","example":"2026-09-01T14:31:07.000Z","description":"When the write-back reached its final status. Null while pending"},"created_at":{"type":"string","format":"date-time","example":"2026-09-01T14:30:05.000Z","description":"When the request was registered, in UTC"}}},"postCommunicationLogs":{"type":"object","properties":{"communication_log":{"type":"object","description":"Communication log details","properties":{"patient_id":{"type":"integer","format":"int32","description":"Patient the communication was with"},"mode":{"type":"string","description":"How the practice and the patient communicated","enum":["phone","text","email","mail","in_person"]},"direction":{"type":"string","description":"Whether the practice sent or received the communication. Omit when the exchange had no single direction, such as a two-way text conversation","enum":["sent","received"]},"note":{"type":"string","description":"Body of the log entry, written to the EHR verbatim"},"occurred_at":{"type":"string","format":"date-time","description":"When the communication happened (UTC). Defaults to the time of the request"}},"required":["patient_id","mode","note"]}},"required":["communication_log"],"description":"Create communication log"},"API_V31_Entities_CommunicationLogCreateDirective_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_CommunicationLogCreateDirective"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_CommunicationLogCreateDirective_Response model"},"API_V31_Entities_FormResponse_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FormResponse"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FormResponse_Collection_Response_WithCursor model"},"API_V31_Entities_FormResponse":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"The form response ID"},"location_id":{"type":"integer","format":"int64","example":1,"description":"The ID of the location where the form was submitted"},"patient_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the patient who submitted the form"},"created_at":{"type":"string","example":"2024-04-12T00:00:00Z","description":"Timestamp when the form response was created"}}},"postFormResponses":{"type":"object","properties":{"patient_id":{"type":"integer","format":"int32","description":"ID of the patient submitting the form.","example":42},"form_schema_id":{"type":"string","description":"UUID of the form schema (PDFWS::Document) used for this submission.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"},"patient_submitted_data":{"type":"object","description":"Raw Form.io submission data keyed by field name.","example":{"firstName":"Jane","lastName":"Doe"}}},"required":["patient_id","form_schema_id","patient_submitted_data"],"description":"Create a form response"},"API_V31_Entities_FormResponseDetail_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_FormResponseDetail"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_FormResponseDetail_Response model"},"API_V31_Entities_FormResponseDetail":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":1,"description":"The form response ID"},"location_id":{"type":"integer","format":"int64","example":1,"description":"The ID of the location where the form was submitted"},"patient_id":{"type":"integer","format":"int64","example":42,"description":"The ID of the patient who submitted the form"},"created_at":{"type":"string","example":"2024-04-12T00:00:00Z","description":"Timestamp when the form response was created"},"form_schema_id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"UUID of the form schema used for this response"}}},"API_V31_Entities_FormSchema_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_FormSchema"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_FormSchema_Collection_Response_WithCursor model"},"API_V31_Entities_FormSchema":{"type":"object","properties":{"id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"The form schema ID"},"title":{"type":"string","example":"Patient Health History","description":"The title of the form"},"form_slug":{"type":"string","example":"patient-health-history","description":"Stable identifier for this form across versions, derived from the filename"},"deleted_at":{"type":"string","format":"date-time","example":"2026-05-12T20:16:57.007Z","description":"Form schema deletion date in UTC; null for active forms"},"foreign_id":{"type":"string","example":"1","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true}}},"API_V31_Entities_FormSchemaDetail_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_FormSchemaDetail"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_FormSchemaDetail_Response model"},"API_V31_Entities_FormSchemaDetail":{"type":"object","properties":{"id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"The form schema ID"},"title":{"type":"string","example":"Patient Health History","description":"The title of the form"},"form_slug":{"type":"string","example":"patient-health-history","description":"Stable identifier for this form across versions, derived from the filename"},"deleted_at":{"type":"string","format":"date-time","example":"2026-05-12T20:16:57.007Z","description":"Form schema deletion date in UTC; null for active forms"},"foreign_id":{"type":"string","example":"1","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"formio_schema":{"type":"object","example":{"display":"form","components":[]},"description":"The full Form.io JSON schema for the form"},"newest_version_id":{"type":"string","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","description":"UUID of the newest version of this form"}}},"API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_ProcedureCodeCategory_Collection_Response_WithCursor model"},"API_V31_Entities_ProcedureCodeCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":7,"description":"Resource id"},"foreign_id":{"type":"string","example":"19","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"name":{"type":"string","example":"Diagnostic","description":"The procedure code category name"}}},"API_V31_Entities_ProcedureCodeCategory_Response":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCodeCategory"},"count":{"type":"integer","format":"int32","example":2,"description":"Number of total objects, in case of collection."}},"description":"API_V31_Entities_ProcedureCodeCategory_Response model"},"API_V31_Entities_ProcedureCode_Collection_Response_WithCursor":{"type":"object","properties":{"code":{"type":"boolean","example":false,"description":"Indicates the success or failure of the request"},"description":{"type":"string","example":"Description","description":"Additional context on the request to help with debugging."},"error":{"type":"array","items":{"type":"string"},"example":["Error message"],"description":"Any errors that occur during the execution of the request."},"data":{"type":"array","items":{"$ref":"#/components/schemas/API_V31_Entities_ProcedureCode"}},"page_info":{"type":"object","example":{"has_previous_page":false,"has_next_page":false,"start_cursor":"AAAAA","end_cursor":"BBBBBB"},"description":"Pagination information that can be used for fetching previous and next pages."}},"description":"API_V31_Entities_ProcedureCode_Collection_Response_WithCursor model"},"API_V31_Entities_ProcedureCode":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":423,"description":"Resource id"},"foreign_id":{"type":"string","example":"1234-5678","description":"Identifier NexHealth uses to uniquely match this record to its counterpart in the integrated EHR. How it is derived differs between EHRs and may change; treat it as an opaque string and do not parse it.","nullable":true},"code":{"type":"string","example":"D0150","description":"The procedure code abbreviation"},"description":{"type":"string","example":"Comprehensive Oral Evaluation","description":"The procedure code description"},"location_id":{"type":"integer","format":"int32","example":123,"description":"The location this procedure code belongs to. Null indicates an institution-wide procedure code."},"ada_code":{"type":"string","example":"D0120","description":"ADA CDT code for the procedure (e.g. D0120). Null if not set."},"abbreviation":{"type":"string","example":"EXAM","description":"Short display name used in scheduling views. Null if not set."},"procedure_code_category_id":{"type":"integer","format":"int64","example":7,"description":"ID of the associated procedure code category. Null if uncategorized."},"procedure_code_category_name":{"type":"string","example":"Diagnostic","description":"Name of the associated procedure code category. Null if uncategorized."},"updated_at":{"type":"string","format":"date-time","example":"2020-06-05T20:16:57.007Z","description":"Procedure code last updated date in UTC"}}}}}}