API Documentation
Dental
Mental Health
{
"id": "<string>",
"status": "SUCCESS",
"creation_ts": "2023-11-07T05:31:56Z",
"request": {
"type": "BENEFITS",
"desired_completion_date": "<string>",
"patient_name": "<string>",
"dob": "<string>",
"member_id": "<string>",
"npi": "<string>",
"tax_id": "<string>",
"insurance": "UNITED_HEALTHCARE",
"group_id": "<string>",
"insurance_in_network": true,
"billing_npi": "<string>",
"rendering_npi": "<string>",
"external_id": "<string>",
"practice_billing_address": "<string>",
"diagnosis_codes": [
"<string>"
],
"claims_date_of_service": "<string>",
"claim_number": "<string>",
"additional_info": "<string>",
"benefits_query": [
"DEDUCTIBLES_AND_MAXIMUMS"
],
"benefits_codes": [
"<string>"
],
"benefits_form_name": "<string>",
"is_specialist": true,
"place_of_service": "<string>",
"billed_amount": 123,
"insurance_payor_id": "<string>"
},
"summary": "<string>",
"results": {
"call_details": [
{
"representative_name": "<string>",
"reference_number": "<string>",
"call_end_time": "2023-11-07T05:31:56Z",
"call_recording_url": "<string>",
"call_transcript": "<string>"
}
],
"plan_information": {
"is_active": true,
"plan_type": "PPO",
"effective_date": "10-01-2020",
"termination_date": "10-31-2021",
"is_calendar_year_plan": true,
"is_provider_in_network": true,
"is_primary_insurance": true
},
"maximums": {
"individual_deductible": "100",
"individual_deductible_used": "80",
"individual_out_of_pocket_maximum": "1000",
"individual_out_of_pocket_maximum_used": "800",
"family_deductible": "200",
"family_deductible_used": "100",
"family_out_of_pocket_maximum": "2000",
"family_out_of_pocket_maximum_used": "1000"
},
"procedure_codes": [
[
"<unknown>"
]
]
}
}Get Mental Health Inquiry
{
"id": "<string>",
"status": "SUCCESS",
"creation_ts": "2023-11-07T05:31:56Z",
"request": {
"type": "BENEFITS",
"desired_completion_date": "<string>",
"patient_name": "<string>",
"dob": "<string>",
"member_id": "<string>",
"npi": "<string>",
"tax_id": "<string>",
"insurance": "UNITED_HEALTHCARE",
"group_id": "<string>",
"insurance_in_network": true,
"billing_npi": "<string>",
"rendering_npi": "<string>",
"external_id": "<string>",
"practice_billing_address": "<string>",
"diagnosis_codes": [
"<string>"
],
"claims_date_of_service": "<string>",
"claim_number": "<string>",
"additional_info": "<string>",
"benefits_query": [
"DEDUCTIBLES_AND_MAXIMUMS"
],
"benefits_codes": [
"<string>"
],
"benefits_form_name": "<string>",
"is_specialist": true,
"place_of_service": "<string>",
"billed_amount": 123,
"insurance_payor_id": "<string>"
},
"summary": "<string>",
"results": {
"call_details": [
{
"representative_name": "<string>",
"reference_number": "<string>",
"call_end_time": "2023-11-07T05:31:56Z",
"call_recording_url": "<string>",
"call_transcript": "<string>"
}
],
"plan_information": {
"is_active": true,
"plan_type": "PPO",
"effective_date": "10-01-2020",
"termination_date": "10-31-2021",
"is_calendar_year_plan": true,
"is_provider_in_network": true,
"is_primary_insurance": true
},
"maximums": {
"individual_deductible": "100",
"individual_deductible_used": "80",
"individual_out_of_pocket_maximum": "1000",
"individual_out_of_pocket_maximum_used": "800",
"family_deductible": "200",
"family_deductible_used": "100",
"family_out_of_pocket_maximum": "2000",
"family_out_of_pocket_maximum_used": "1000"
},
"procedure_codes": [
[
"<unknown>"
]
]
}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
Response
Successful Response
unique generated (uuid4) id for the inquiry
status of the inquiry
SCHEDULED, IN_PROGRESS, SUCCESS, UNSUCCESSFUL, CANCELLED, UNKNOWN "SUCCESS"
timestamp of when the inquiry was created
The request that was used to create the inquiry.
Show child attributes
Show child attributes
type of the inquiry
CLAIMS_STATUS, BENEFITS, UNKNOWN "BENEFITS"
The requested completion date of the inquiry in MM-DD-YYYY format. Calls will typically be completed by the morning of the requested completion date, but in some cases may be completed earlier.
name of the patient
date of birth of the patient in MM-DD-YYYY format
member id of the patient
(deprecated, use billing_npi and rendering_npi instead) Ten digit NPI of the provider
Nine digit tax id of the provider
The insurance provider for the patient.
AETNA, HUMANA, OPTUM, OXFORD, UNITED_HEALTHCARE, UNKNOWN "UNITED_HEALTHCARE"
group id of the patient
whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined.
Ten digit NPI of the billing provider
Ten digit NPI of the rendering provider
An identifier which you can define and pass in with your creation request. This is useful for tracking a specific subgroup of inquiries. For instance, you can assign a unique external id to all inquiries for a specific provider on your platform.
The billing address of the practice. If omitted, the address will be determined from the NPI.
Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.
The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.
The claim number for the inquiry if provided by the user. Only used for claims inquiries.
Any additional information about the inquiry that is not covered by the other fields. This can be used to pass in any additional information for the request. Please check with the Health Harbor team before using this field as it may not be incorporated into the inquiry unless we are already aware of it.
The specific set of benefits to query. These are customized for each customer. Contact [email protected] for details.
An enumeration.
DEDUCTIBLES_AND_MAXIMUMS, PLAN_INFO, NETWORK_STATUS, CODE_LOOKUP_PRIOR_AUTH, CODE_LOOKUP_BENEFITS, OFFICE_VISIT_NEW_PATIENT, OFFICE_VISIT_RETURNING_PATIENT, PSYCHOTHERAPY, FAMILY_PSYCHOTHERAPY, GROUP_PSYCHOTHERAPY, ABA_COVERAGE, SPEECH_THERAPY, OCCUPATIONAL_THERAPY, PHYSICAL_THERAPY, NEURO_PSYCH, TRIAL, UNKNOWN Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH benefits inquiry.
The name of a custom form for your providers. Contact [email protected] for details.
The type of provider making the inquiry. If the provider is a specialist, set this to True. If the provider is a general PCP, set this to False.
Where the service will be performed. This is typically one of a few places: the doctors office, telehealth or an ambulatory surgical center. See this page for the full list: https://www.cms.gov/medicare/coding-billing/place-of-service-codes/code-sets
The billed amount for the claim. Value should be a float with 2 decimal places. Only used for claims inquiries.
The payor id for the insurance. Usually five characters. For example, one payor id for Aetna is 60054.
summary of the call results
The output from the call containing the benefits results..
Show child attributes
Show child attributes
The details of the placed calls including the call time in iso format, representative name, reference number, and transcript.
The plan information for the patient including the plan type and effective date. Dates will be provided in MM-DD-YYYY format. Fields will only be included if applicable, for example, when the plan is not active, no other information will be provided.
Show child attributes
Show child attributes
An enumeration.
HMO, PPO, POS, EPO, OAP, MEDICAID, HMO_POS, OTHER {
"is_active": true,
"plan_type": "PPO",
"effective_date": "10-01-2020",
"termination_date": "10-31-2021",
"is_calendar_year_plan": true,
"is_provider_in_network": true,
"is_primary_insurance": true
}The maximums for the patient including the individual and family deductible and out of pocket maximums. Fields will only be included if applicable, for example, on individual plans, family information will not be available.
Show child attributes
Show child attributes
The amount of deductible remaining for the patient. Calculated as the minimum of the individual and family deductible remaining.
x >= 0The amount of out of pocket maximum remaining for the patient. Calculated as the minimum of the individual and family out of pocket maximum remaining.
x >= 0{
"individual_deductible": "100",
"individual_deductible_used": "80",
"individual_out_of_pocket_maximum": "1000",
"individual_out_of_pocket_maximum_used": "800",
"family_deductible": "200",
"family_deductible_used": "100",
"family_out_of_pocket_maximum": "2000",
"family_out_of_pocket_maximum_used": "1000"
}A list that contains a tuple of procedure code information and their benefits. For mental health, procedure codes, if covered, will contain deductible information, copays, coinsurance, frequency limitations and whether or not prior authorization is needed. Coinsurance refers to the patient's portion of the payment.
2 elements