Logo
Overview
Exam List
Exam WebhookExam Upload AttachmentExam Questions & AnswersExam Submit AnswersExam Invite ResendPartner Pharmacy ListPartner Pharmacy Treatment PackagesCustom Pharmacy Search

Exam Invite

POST

https://staging-api.qualiphy.me/api/exam_invite
This endpoint is used to send an exam invitation to a patient. This allows healthcare providers to schedule exams and notify patients via email, integrating the invitation process into their workflow. The endpoint accepts details about the patient, such as their name, contact information, and exam specifics, and can optionally include additional information like callback URLs and extra patient data. This endpoint streamlines the scheduling and communication process, ensuring that patients receive timely invitations and relevant information about their scheduled exams.

Note: Only 1 prescriptive exam may be completed at a time.

Parameters

  • api_key string

    Required

    API key for authentication

  • exams array

    Required

    List of exam static Ids

    You will need to pass here an array of exam ids provided on the previous screen. Therefore you may send multi-exams, which will all be linked to a single meeting. Retrieve these exam IDs using the Exam List API or by visiting the Exam List on the platform.

  • first_name string

    Required

    Patient's first name

  • last_name string

    Required

    Patient's last name

  • email string

    Required

    Patient's email address

  • dob string

    Required

    Patient's date of birth (YYYY-MM-DD)

    This is the patient's date of birth field and needs to be sent in the following format. YYYY-MM-DD ie. 1990-06-30

  • phone_number string

    Required

    Patient's phone number (10 digits or +1)

    This is the patient's phone number which will be used to text them an invite unless it is disabled via our platform. We support only the following two formats. +15552223232 or 1234567890

  • tele_state string

    Required

    Telehealth state (capital abbreviation)

    Telehealth clinic types will be required to pass in states in which they want the patient to be screened. The format will be as a two letter uppercase abbreviation of the state. Capital Abbreviation i.e NY = New York

  • webhook_url string

    Optional

    Webhook URL for callback

    This is the url to be used in which you want Qualiphy's platform to send back data upon exam completion. You will be getting a POST call to this url.

  • additional_data string

    Optional

    Additional data (stringified)

    This field allows for you to send data in a stringified format that is specific to your software, whether it be IDs or other crucial information for mapping results and generated PDFs into your own code.

  • redirect_approve string

    Optional

    Redirect URL on approve

    Redirects allow you to send patients after a call is complete to your own branded page. This URL is used when the call is successfully completed and approved.

  • redirect_reject string

    Optional

    Redirect URL on reject

    Redirects allow you to send patients after a call is complete to your own branded page. This URL is used when the call is rejected.

  • redirect_na string

    Optional

    Redirect URL on not available

    Redirects allow you to send patients after a call is complete to your own branded page. This URL is used when no providers are available, and the call cannot be completed.

  • redirect_missed string

    Optional

    Redirect URL on missed exam

    Redirects allow you to send patients after a call is complete to your own branded page. This URL is triggered after a 3-minute countdown expires when the user is waiting for someone to be available, and no providers are available (not due to providers being in a call).

  • dmv_license_number string

    Optional

    DMV license number

  • address_line_1 string

    Optional

    Address line 1

    This is the patient's home address.

  • address_line_2 string

    Optional

    Address line 2

    This is the patient's home address.

  • city string

    Optional

    City

    This is the patient's city.

  • state string

    Optional

    State (capital abbreviation)

    This is the patient's state.

  • zip_code string

    Optional

    ZIP code

    This is the patient's home address.

  • shipping_address_line_1 string

    Optional

    Shipping address line 1

    This is the patient's shipping address and will be used for sending prescriptions for RX screened exams.

  • shipping_address_line_2 string

    Optional

    Shipping address line 2

    This is the patient's shipping address and will be used for sending prescriptions for RX screened exams.

  • shipping_city string

    Optional

    Shipping city

    This is the patient's shipping address and will be used for sending prescriptions for RX screened exams.

  • shipping_state string

    Optional

    Shipping state (capital abbreviation)

    This is the patient's shipping address and will be used for sending prescriptions for RX screened exams.

  • shipping_zip_code string

    Optional

    Shipping ZIP code

    This is the patient's shipping address and will be used for sending prescriptions for RX screened exams.

  • gender integer

    Optional

    Gender (1=Male, 2=Female, 3=Prefer not to say)

    The values expected based on the patient's gender is the following: (1 = Male, 2 = Female, 3 = Prefer Not to Say)

  • pharmacy_id integer

    Optional

    Unique id for partner pharmacy when using prescription services.

    If using a partner pharmacy, leverage the Partner Pharmacy List API ( to get the pharmacy_id ). If using a local pharmacy, run the same API and check if 'Choose your pharmacy' is available. If so, grab the ID and ensure to pass additional data from the Custom Pharmacy Search API.

  • exam_pos_id string

    Optional

    Unique id for partner pharmacy treatment packages when using prescription services

    If you want to preselect a prescription with specific dosage then they need to provide this id which can be found using this Partner Pharmacy Treatment Packages API.

  • custom_pharmacy integer

    Optional

    Flag to choose between custom and partner pharmacy

    (1=Custom Pharmacy, 2=Partner Pharmacy)

  • ncpdpid string

    Optional

    Unique identifier for a custom pharmacy

  • pharmacy_name string

    Optional

    Custom pharmacy name

  • pharmacy_address_line_1 string

    Optional

    Custom pharmacy address line 1

  • pharmacy_address_line_2 string

    Optional

    Custom pharmacy address line 2

  • pharmacy_zip_code string

    Optional

    Custom pharmacy zip code

  • pharmacy_city string

    Optional

    Custom pharmacy city

  • pharmacy_state string

    Optional

    Custom pharmacy state

  • pharmacy_phone string

    Optional

    Custom pharmacy phone number

  • pharmacy_type string

    Optional

    Custom pharmacy type

  • provider_pos_selection integer

    Optional

    Provider choice for pharmacy and order set

    1=Provider does not choose pharmacy or order set, 2=Let provider choose order set only, 3=Let provider choose pharmacy and order set

  • custom_pharmacy_patient_choice integer

    Optional

    Leave custom pharmacy choice to patient

    1=Choose custom pharmacy, 2=Let patient choose their custom pharmacy

  • skip_pharmacy_confirmation integer

    Optional

    Skip pharmacy confirmation screen on the patient side (only skips it if all pharmacy information fields are in the payload)

    1=Does not skip pharmacy confirmation, 2=Skips pharmacy confirmation

  • custom_pharmacy_patient_billing integer

    Optional

    Patient or clinic should be billed by the pharmacy

    1=Clinic is billed by the pharmacy, 2=Patient is billed by the pharmacy

  • custom_pharmacy_clinic_billing string

    Optional

    Clinic Identifier for pharmacy billing

  • custom_pharmacy_delivery_method integer

    Optional

    Delivery method for custom pharmacy orders

    1=Pick up in pharmacy, 2=Ship to patient/clinic

Response

200
400
401
500

Response Fields Explanation

FieldExplanation
http_code200
meeting_urlThis is the meeting link that will be used for the exams
meeting_uuidThis is the meeting unique id
patient_exams An array of patient exams, where each object contains patient_exam_id, exam_title, and exam_id

Example Request Payload:

Response Example

{
"http_code":200
"meeting_url":"https://app.qualiphy.me/meetin..."
"meeting_uuid":"example-id"
"patient_exams":[
0:{
"patient_exam_id":4844
"exam_title":"GFE Test"
"exam_id":800
}
]
}