- Documentation
- API Reference
- Platform Guide
- Quickstart Guide
- Changelog
- POSTRun Benefit Verification
- GETRetrieve Benefit Verification
- POSTSend Prior Authorization
- GETRetrieve Prior Authorization
- POSTCheck Clinical Qualification
- GETRetrieve Clinical Qualification
- POSTCheck Prior Authorization Status
- POSTSubmit Patient Enrollment
- Authentication
- Webhooks
API Documentation
Retrieve Prior Authorization
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
success Contains the data from your prior authorization request, or None if an error occurred.
The ID of this prior authorization
The type of object. This will always be 'prior_authorization', from this endpoint, but this can be helpful for differentiating between different types of objects when parsing webhook responses.
prior_authorization The URL where the Prior Authorization can be viewed.
The current status of the prior auth request.
processing, awaiting_review, awaiting_outcome, completed, failed Clinical diagnoses for the patient in ICD-10 format. i.e. 'E66.9'
ICD-10 code for the diagnosis. i.e. 'E66.9'
A collection of evidence items supporting the authorization request. Any other supporting evidence that doesn't fit into one of the explicitly declared fields above can be added here.
Detailed content of the evidence, which varies based on the type of evidence.
The date and time (if available) when the evidence was created. This is important for ensuring we have an accurate timeline of the patient's history.
Title of the evidence. This will be shown to users in the platform UI so it's recommended to give it a name that would be meaningful to them, such as 'Intake Form'
Demographic information for the patient
The patient's postal address
Street address of residence.
Additional street address information.
City of residence.
State or province of residence.
ZIP or postal code part of the address.
Country of residence.
The patient's date of birth
The patient's email address
The patient's first name
The patient's last name
The patient's gender
male, female, other, not_specified Your internal ID for this patient. This is used for linking all of the requests for a given patient.
The patient's phone number
Array of insurance documents.
Insurance card scanned content.
The client/employer name.
The group number on the card.
The member name on the card.
The member number on the card.
The payer name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card. i.e. 'United Healthcare', 'United', 'United Health' could all appear
The plan name on the card. This field is not normalized, so the same plan may have different names depending on the way it appears on the card
The Rx BIN number on the card.
The Rx group number on the card.
The Rx PCN number on the card.
Error message if we were unable to extract information from the card.
The Base64 encoded insurance card image you send in the request is stored on our servers. A signed URL to the image is returned here. This URL has a short expiry time, so you should download the image immediately after receiving it if you want to view the asset.
Information regarding the prescription this prior authorization is being created for.
The number of days the prescription will be expected to last.
The quantity of the medication.
Instructions on how the medication should be taken.
The name of the medication.
The strength of the medication.
The form of the medication.
tablet, capsule, suspension, cream, solution, ointment, suppository, inhaler, liquid, powder, injectable, patch, gel, lozenge, concentrate The unit of measurement for the medication.
milliliter, liter, gram, milligram, microgram, unit, tablet, capsule, patch, inhaler, applicator, pack, vial The route of administration for the medication.
oral, subcutaneous, intravenous, intramuscular, topical, inhalation, nasal, ophthalmic, otic, rectal, vaginal, transdermal, buccal, sublingual An optional dictionary containing additional information related to the drug or future prescription.
The date the prescription was issued
Details of the healthcare provider who created the prescription.
The provider's postal address.
Street address of residence.
Additional street address information.
City of residence.
State or province of residence.
ZIP or postal code part of the address.
Country of residence.
The provider's fax number.
The provider's first name.
The provider's last name.
The provider's NPI.
The provider's phone number.
Information about the pharmacy where the prescription will be filled.
The name of the pharmacy.
Represents a postal address.
Street address of residence.
Additional street address information.
City of residence.
State or province of residence.
ZIP or postal code part of the address.
Country of residence.
List of questionnaires. This is the best place to send structured Q&A format data, such as intake forms, etc.
A list of questions included in the questionnaire.
The answer to the question.
Optional list of choices for the question. If provided, the answer must be one of the choices. It's important to include this list of choices for any multiple choice question. This allows our AI to know what a user has effectively said 'no' to by picking another option. I.e. for a question 'Do you have any of the following conditions: Diabetes, Heart Disease, Cancer, None of the above' if the user answers 'None of the above' we can infer that they don't have any of those conditions. Without the choices list we would have no way of knowing that.
The question to be answered.
The date and time when the questionnaire was answered. This is important for ensuring we have an accurate timeline of the patient's history.
List of visit notes.
The title of the visit note. This is optional and can be used to give the note a meaningful name, such as 'Initial Consultation'.
The content of the visit note.
The date and time (if available) when the visit note was created. This is important for ensuring we have an accurate timeline of the patient's history.
A list of activity log items for the prior authorization request.
sent_fax A signed URL to download the fax file. Note that this URL has a short lifespan and should be used immediately to download the file.
The mock result of the prior authorization request, if one was provided in the initial request
The Prior Authorization has been approved.
Approved A code indicating the reason for the prior auth approval. The possible values are:
- prior_auth_not_required: A prior authorization is not required.
- approval: The prior authorization request has been approved.
prior_auth_not_required, approval More details regarding the prior auth request status, if the prior auth has completed and more information is available
The Prior Authorization has been approved.
Approved A code indicating the reason for the prior auth approval. The possible values are:
- prior_auth_not_required: A prior authorization is not required.
- approval: The prior authorization request has been approved.
prior_auth_not_required, approval The date when the authorization expires. This information is not always available, but it will be included where possible.