API InsSubs

See API Specification

Links an InsPlan to a Subscriber (patient.PatNum). Also, see PatPlans to indicate coverage.

InsSubs POST (create)

Version Added: 21.1

This does not create a new insurance plan or change benefits.

PlanNum: Required. The PlanNum of the InsPlan.
Subscriber: Required. The PatNum of the patient who is subscribed to this plan.
SubscriberID: Required.

DateEffective: Optional. The date this InsPlan became effective.
DateTerm: Optional. Not usually used. The date this InsPlan was terminated.
BenefitNotes: Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
ReleaseInfo: Added in 21.4. Optional. This is set to either "true" or "false". Default "true". This authorizes the release of information based on if there is a signature on file.
AssignBen: Added in 21.4. Optional. Either "true" or "false". Default is according to global preference within Open Dental. This authorizes the assignment of benefits based on if there is a signature on file.

Example Request:
POST /inssubs
{
"PlanNum": 15,
"Subscriber": 1,
"DateEffective":"2019-01-01",
"DateTerm": "2019-12-31",
"SubscriberID":"8645332",
"BenefitNotes":"Waiting period on crowns.",
"ReleaseInfo":"true",
"AssignBen":"true"
}

Example Response:
{
"InsSubNum":43,
"PlanNum": 15,
"Subscriber": 1,
"DateEffective":"2019-01-01",
"DateTerm": "2019-12-31",
"SubscriberID":"8645332",
"BenefitNotes":"Add these notes",
"ReleaseInfo":"true",
"AssignBen":"true"
}
201 Created
(no "location" Header is returned because there is no GET method yet)
400 (Missing or invalid fields)

InsSubs PUT (update)

Version Added: 21.1

This can be used to assign a different PlanNum or Subscriber to this InsSub. None of these changes affect the InsSubNum, so all the PatPlans (coverage) for family members will continue to point to this InsSub and will be untouched. You can obtain the InsSubNum from FamilyModules GET Insurance.

PlanNum: Optional. The PlanNum of the InsPlan.
Subscriber: Added in 21.4. Optional. The PatNum of the patient who is subscribed to this plan.
SubscriberID: Added in 21.4. Optional.
DateEffective: Added in 21.4. Optional. The date this InsPlan became effective.
DateTerm: Added in 21.4. Optional. The date this InsPlan was terminated.
BenefitNotes: Optional. BenefitNotes are specifically designed to store automated notes. For example, when automatically requesting benefits through Trojan. Benefits are stored here in text form for later reference. Not at plan level because might be specific to subscriber. If blank, it may display a benefitNote for another subscriber to the plan.
ReleaseInfo: Added in 21.4. Optional. This is set to either "true" or "false". This authorizes the release of information based on if there is a signature on file.
AssignBen: Added in 21.4. Optional. Either "true" or "false". This authorizes the assignment of benefits based on if there is a signature on file.

Example Request:
PUT /inssubs/82
{
"PlanNum": 15,
"Subscriber": 1,
"DateEffective":"2019-01-01",
"DateTerm": "2019-12-31",
"SubscriberID":"8645332",
"BenefitNotes":"Waiting period on crowns.",
"ReleaseInfo":"true",
"AssignBen":"true"
}

Example Response:
200 OK

InsSubs DELETE

Version Added: 21.1

Will fail if any PatPlans exist. You can obtain the InsSubNum from FamilyModules GET Insurance.

Example Request:
DELETE /inssubs/82

Example Response:
200 OK
400 Bad Request, "Can't delete InsSub because PatPlans are still attached."