POST
/
api
/
v0
/
dental
/
batch_inquiries
[
  {
    "success": true,
    "inquiry_id": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json · object[]
​
type
enum<string>
required

type of the inquiry

Available options:
CLAIMS_STATUS,
BENEFITS,
UNKNOWN
Example:

"BENEFITS"

​
desired_completion_date
string
required

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.

Example:

"03-19-2024"

​
patient_name
string
required

name of the patient

Example:

"Alex Martin"

​
dob
string
required

date of birth of the patient in MM-DD-YYYY format

Example:

"01-31-2020"

​
member_id
string
required

member id of the patient

Example:

"123456789"

​
npi
string
required

Ten digit NPI of the provider

Example:

"1234567890"

​
tax_id
string
required

Nine digit tax id of the provider

Example:

"123456789"

​
insurance
enum<string>
required

The insurance provider for the patient.

Available options:
AETNA,
HEALTHPLEX,
HUMANA,
METLIFE,
UNITED_HEALTHCARE,
UNKNOWN
Example:

"CIGNA"

​
group_id
string

group id of the patient

Example:

"123456"

​
insurance_in_network
boolean

whether or not the provider is in-network. If it is not known, leave this field blank and it will be determined.

​
external_id
string

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.

​
practice_billing_address
string

The billing address of the practice. If omitted, the address will be determined from the NPI.

Example:

"123 Main St, New York, NY 10001"

​
diagnosis_codes
string[]

Any diagnosis codes for the patient. If omitted, a general diagnosis code will be used.

Example:
["F41.1", "F42.23"]
​
claims_date_of_service
string

The date of service for the claim in MM-DD-YYYY format. Only used for claims inquiries.

Example:

"01-31-2020"

​
claim_number
string

The claim number for the inquiry if provided by the user. Only used for claims inquiries.

Example:

"1234567890"

​
additional_info
string

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.

Example:

"The patient is on a Medicare plan and we need to know their secondary insurance benefits."

​
benefits_query
enum<string>[]

The benefits queries for the inquiry if provided by the user. Can be either a pre-defined set of questions (e.g. STANDARD for returning patients) or an ad-hoc defined set of codes.

An enumeration.

Available options:
STANDARD,
CODE_LOOKUP_BENEFITS,
CODE_LOOKUP_FREQUENCIES,
TREATMENT_HISTORY,
DEDUCTIBLES_AND_MAXIMUMS,
UNKNOWN
Example:
["CODE_LOOKUP_BENEFITS"]
​
benefits_codes
string[]

Codes processed for a CODE_LOOKUP_BENEFITS or a CODE_LOOKUP_PRIOR_AUTH benefits inquiry. The first character in the CDT codes (D) can be optionally omitted.

Example:
["D1110", "D1120", "1130"]
​
is_specialist
boolean

The type of provider making the inquiry. If the provider is a specialist (e.g. periodontist, oral surgeon), set this to True. If the provider is a dentist, set this to False. Defaults to False if not provided.

Example:

true

Response

200
application/json
Successful Response
​
success
boolean
required
​
inquiry_id
string
required