CreatePendingAuthorizationRequest

Payload used to start a pre-authorization request for one or more products.

beneficiary_idinteger<int64>required

Beneficiary identifier. Long integer returned by the beneficiary search.

beneficiary_emailstring

Beneficiary email address. Used for notification of authorization outcomes.

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

Beneficiary phone number, in international format.

sponsor_slugstringrequired

Sponsor slug. Lowercase alphanumeric identifier.

doctor_medical_license_numberstring

Prescribing doctor's medical license number.

doctor_country_codestring

ISO 3166-1 alpha-2 code of the country that issued the doctor's license.

doctor_specialty_namestring

Prescribing doctor's medical specialty.

doctor_namestring

Prescribing doctor's full name.

provider_notification_emailstring

Email address that will receive authorization notifications for this request.

diagnoses object[]

Diagnoses associated with the request.

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[]

Treatments prescribed as part of the request.

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[]

Additional products (labs, imaging, procedures) prescribed as part of the request.

Array [

provider_product_codestring

Provider-side SKU for the product.

product_idinteger<int64>

OSIGU catalog product identifier.

sponsor_product_idstring

product_type_slugstringrequired

quantityinteger<int32>required

Requested quantity.

]

provider_slugsstring[]

Providers allowed to redeem authorizations generated by this request.

provider_slugstring

Provider that submitted the request.

sponsor_authorization_codes object[]

Authorization codes previously issued by the sponsor for this request, when applicable.

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]

]

biometric_reading_idstring<uuid>

Identifier of a previously accepted biometric reading, when required.

illness_onsetstring<date-time>

Reported date of illness onset. ISO 8601 date-time.

provider_emailstring

Provider email address for correspondence about this request.

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])?

provider_phone_numberstring

Provider phone number for correspondence about this request.

risk_managerboolean

True when the request is submitted by a sponsor risk-manager user rather than a clinical user.