API InsVerifies

See API Specification

InsVerifies GET (single)

Version Added: 23.2.23

Gets a single insurance verification.

InsVerifyNum: Required in the URL.

Example Requests:
GET /insverifies/12

Example Response:
{
"InsVerifyNum": 12,
"DateLastVerified": "2022-11-07",
"VerifyType": "InsuranceBenefit",
"FKey": 45,
"DefNum": 789,
"SecDateTEdit": "2022-12-02 09:39:54"
}

200 OK
404 BadRequest (with explanation)

InsVerifies GET (multiple)

Version Added: 23.2.23

Gets insurance verifications.

Parameters: All optional.

VerifyType: Can be either "PatientEnrollment" to verify a patient's insurance eligibility, or "InsuranceBenefit" to verify an insurance plan's benefits.
SecDateTEdit: Only include InsVerifies with a SecDateTEdit altered after the specified date and time. String in "yyyy-MM-dd HH:mm:ss" format.

Example Requests:
GET /insverifies
GET /insverifies?VerifyType=InsuranceBenefit&SecDateTEdit=2022-07-01%2005%3A30%3A00

Example Response:
[
{
"InsVerifyNum": 12,
"DateLastVerified": "2022-11-07",
"VerifyType": "InsuranceBenefit",
"FKey": 45,
"DefNum": 789,
"SecDateTEdit": "2022-12-02 09:39:54"
},
{
"InsVerifyNum": 13,
"DateLastVerified": "2022-09-27",
"VerifyType": "PatientEnrollment",
"FKey": 325,
"DefNum": 721,
"SecDateTEdit": "2022-09-29 11:09:13"
},
etc...
]

200 OK
400 NotFound (with explanation)

InsVerifies PUT

Version Added: 21.1

Updates an insurance verification. Sets the date that either a patient's insurance eligibility or an insurance plan's benefits were last verified. As with all insverify entries in our database, historical entries are always retained in the insverifyhist table. See Insurance Verification List for more information on insurance verification.

DateLastVerified: Required. String in "yyyy-MM-dd" format.
VerifyType: Required. Can be either "PatientEnrollment" to verify a patient's insurance eligibility, or "InsuranceBenefit" to verify an insurance plan's benefits.
FKey: Required. If "PatientEnrollment" was passed in for VerifyType, then FKey must be a valid patplan.PatPlanNum. If "InsuranceBenefit" was passed in for VerifyType, FKey must be a valid insplan.PlanNum.
DefNum: Optional. Must be a valid DefNum where definition.Category=38.

Example Request:
PUT /insverifies

{
"DateLastVerified": "2022-09-27",
"VerifyType": "PatientEnrollment",
"FKey": 325,
"DefNum": 721
}

Example Response:
200 OK
400 BadRequest (with explanation)