CreateAuthorizationRequest

beneficiary_idinteger<int64>required

beneficiary_emailstring

Possible values: Value must match regular expression [a-zA-Z0-9!#$%&'*+/=?^_{|}~-]+(?:.[a-zA-Z0-9!#$%&'*+/=?^_{|}~-]+)*@(?:[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z0-9](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?

beneficiary_phone_numberstring

sponsor_slugstringrequired

doctor_medical_license_numberstringrequired

doctor_country_codestringrequired

doctor_specialty_namestringrequired

doctor_namestringrequired

provider_email_addressstring

provider_phone_numberstring

illness_onsetstring<date-time>

diagnoses object[]required

Array [

coding_systemstringrequired

Coding system used for the diagnosis (for example, ICD-10).

codestringrequired

Diagnosis code within the coding system.

typestring

Diagnosis type. One of CHIEF_COMPLAINT, DIFFERENTIAL_DIAGNOSIS, MEDICAL_DIAGNOSIS.

]

treatments object[]

Array [

brandstring

Commercial or generic drug name.

drug_form_slugstringrequired

Drug presentation slug (for example, 'tablet', 'capsule').

dosage_measurement_unit_slugstringrequired

Unit of measure slug for the dosage.

treatment_duration_daysinteger<int32>required

Total treatment duration in days.

product_idsinteger<int64>[]

Catalog product identifiers for equivalent products.

compositionstring

product_idinteger<int64>

quantityinteger<int32>

additional_notesstring

file_pathstring

number_of_refillsinteger<int32>

refill_numberinteger<int32>

refill_form_datestring<date>

treatment_indicationsstring[]

frequencies object[]required

Administration frequencies.

Array [

single_dosebooleanrequired

True when the treatment is administered as a single dose.

frequency_in_hoursinteger<int32>

Number of hours between successive doses.

frequency_in_hour_slugstring

frequency_by_day_timestring

Time of day for insulin administration. One of MORNING, AFTERNOON, EVENING.

specific_administration_time object

hourinteger<int32>

minuteinteger<int32>

secondinteger<int32>

nanointeger<int32>

dosagenumber

Amount administered per dose.

dosage_rightnumber

Dosage to apply to the right side (for eye, ear, or nasal drops).

dosage_leftnumber

Dosage to apply to the left side (for eye, ear, or nasal drops).

]

compositions object[]

Array [

ingredient_idinteger<int64>required

composition_measurement_unit_slugstringrequired

quantitynumberrequired

]

]

products object[]

Array [

indexinteger<int32>

Position of the product within the request. Used to correlate response entries with request entries.

product_idstring

Provider-side product identifier. Free-form string.

pricenumberrequired

Unit price of the product. Decimal number.

quantityinteger<int32>required

Number of units being dispensed or invoiced.

substitute_product_idstring

Provider-side identifier of the substitute product used, when the original was not dispensed.

substitute_quantityinteger<int32>

Quantity of the substitute product dispensed.

authorization_product_idinteger<int64>required

Identifier of the pre-authorization product line this claim item corresponds to.

]

provider_slugsstring[]

provider_slugstring

sponsor_authorization_codes object[]

Array [

codestringrequired

Authorization code as issued by the sponsor.

coverage_typestring

product_type_slugstring

coverage_type_enumstring

Insurance coverage type.

• OUTPATIENT_CARE: ambulatory medical care.
• PRESCRIPTION_DRUGS: pharmacy drug coverage.
• DIAGNOSTIC_TESTS: imaging and diagnostic studies.
• EDUCATION, SPORTS, WELLNESS: non-medical benefits.
• CREDIT_CARD_BALANCE, PERMANENT_DISABILITY, UNEMPLOYMENT, FUNERAL_ASSISTANCE, PPI, TEMPORARY_DISABILITY: non-medical insurance benefits handled through OSIGU.
• MEDICAL_PROCEDURES: stand-alone medical procedures.
• SECOND_ASSESSMENT: second-opinion consultations.
• CANCER_DIAGNOSIS, DAILY_HOSPITALIZATION_INCOME, ACCIDENT_MEDICAL_REIMBURSEMENT, DIABETES_ACCIDENTAL_DEATH, DIABETES, CELL_PROTECTION, CASH_ROBBERY: specialized coverage lines.
• HOSPITAL_CARE, HOSPITALIZATION: inpatient care coverage.

Possible values: [OUTPATIENT_CARE, PRESCRIPTION_DRUGS, DIAGNOSTIC_TESTS, EDUCATION, SPORTS, WELLNESS, CREDIT_CARD_BALANCE, PERMANENT_DISABILITY, UNEMPLOYMENT, FUNERAL_ASSISTANCE, PPI, TEMPORARY_DISABILITY, MEDICAL_PROCEDURES, SECOND_ASSESSMENT, CANCER_DIAGNOSIS, DAILY_HOSPITALIZATION_INCOME, ACCIDENT_MEDICAL_REIMBURSEMENT, DIABETES_ACCIDENTAL_DEATH, DIABETES, CELL_PROTECTION, CASH_ROBBERY, HOSPITAL_CARE, HOSPITALIZATION]

product_type_slug_enumstring

Kind of product covered by an authorization line.

• DRUG: pharmacy medication.
• LABORATORY: laboratory test.
• DIAGNOSTIC_TEST: imaging or other diagnostic study.
• MEDICAL_PROCEDURE: in-clinic medical procedure.

Possible values: [DRUG, LABORATORY, DIAGNOSTIC_TEST, MEDICAL_PROCEDURE]

]