AuthorizationRequestResource
diagnoses object[]
Per-product decision inside an authorization.
APPROVED: the product is covered by the authorization.REJECTED: the product is not covered. 'reason' explains why.MANUAL_APPROVAL_REQUIRED: the product needs manual review by the sponsor before being approved or rejected.
Possible values: [APPROVED, REJECTED, MANUAL_APPROVAL_REQUIRED]
authorizations object[]
Authorization identifier. Long integer assigned by OSIGU.
Beneficiary identifier. Long integer.
OSIGU authorization code. Human-readable identifier the beneficiary uses at the point of service.
Slug of the sponsor that issued the authorization.
Authorization code assigned by the sponsor, when applicable.
Prescribing doctor's medical license number.
ISO 3166-1 alpha-2 code of the country that issued the doctor's license.
Prescribing doctor's medical specialty.
Prescribing doctor's full name.
True when the authorization requires manual review by the sponsor before it can be redeemed.
True when a sponsor operator has manually approved the authorization.
Insurance coverage type of the authorization.
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 of the authorization. One of DRUG, LABORATORY, DIAGNOSTIC_TEST, MEDICAL_PROCEDURE.
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]
Current lifecycle status of the authorization.
Overall lifecycle status of an authorization.
PENDING_REVIEW: awaiting sponsor manual review before it can be approved.CREATED: created in OSIGU but not yet processed.READY: approved and ready to be redeemed by the beneficiary.PARTIALLY_CLAIMED: partially redeemed; remaining quantities are still available.CLAIMED: fully redeemed.VOIDED: cancelled; cannot be redeemed.PAID: settlement to the provider has been confirmed by the sponsor.ERROR: processing failed. Response contains a diagnostic reason.REQUEST_IN_PROGRESS: still being processed by the authorization engine.QUALIFICATION: undergoing sponsor coverage qualification.INCOMPLETE: waiting for the provider to attach required documents or data.REJECTED: rejected by the sponsor.APPROVED: approved by the sponsor.CANCELLED: cancelled by the sponsor.USER_ERROR: request payload was invalid.CANCELLED_BY_PATIENT: cancelled at the beneficiary's request.PENDING_MEDICAL_REPORT: waiting for a medical report from the provider.COMPLETED: workflow completed.NOT_ATTENDED: the beneficiary did not attend the scheduled service.SENT_TO_SPONSOR: dispatched to the sponsor for downstream processing.PAYMENT_CONFIRMED: sponsor has confirmed payment to the provider.
Possible values: [PENDING_REVIEW, CREATED, READY, PARTIALLY_CLAIMED, CLAIMED, VOIDED, PAID, ERROR, REQUEST_IN_PROGRESS, QUALIFICATION, INCOMPLETE, REJECTED, APPROVED, CANCELLED, USER_ERROR, CANCELLED_BY_PATIENT, PENDING_MEDICAL_REPORT, COMPLETED, NOT_ATTENDED, SENT_TO_SPONSOR, PAYMENT_CONFIRMED]
Storage path to the generated authorization document.
True when all documents required by the sponsor are attached.
Timestamp from which the authorization can be redeemed. ISO 8601.
Timestamp after which the authorization can no longer be redeemed. ISO 8601.
Timestamp when the authorization was created. ISO 8601.
Timestamp of the most recent update. ISO 8601.
products object[]
Products included in the authorization.
Authorization product-line identifier.
OSIGU catalog product identifier.
Product name.
Slug of the product type.
Prescribed treatment duration in days.
Quantity requested by the doctor.
Quantity the sponsor authorized to be dispensed.
Quantity that has already been claimed against this line.
True when the product is part of a recurring treatment plan.
Current recurrence number, when 'recurrent_treatment' is true.
Total number of recurrences authorized for the treatment plan.
Current status of this product line (for example, APPROVED, REJECTED, PENDING_REVIEW).
Free-text explanation of the current status.
provider_products object[]
Provider-side SKUs mapped to this authorized product line.
Provider slug.
Provider-side product code.
non_associated_products object[]
Products submitted with the request but not associated with any authorized line.
Provider that offered the product.
Provider-side product code.
Human-readable product name.
Prescribed treatment duration in days.
Quantity submitted.
treatments object[]
frequencies object[]
Possible values: [MORNING, AFTERNOON, EVENING]