How Do I Create Exam From API?

If you need to create exams programmatically, Qualiphy allows you to create exams directly through the API.

Why it matters:

• Using the API to create exams gives your clinic the flexibility to automate and integrate the exam process with your existing systems, saving time and reducing manual work.

To create an exam from the API:

To send a POST request to create an exam webhook use the endpoint below:

POST {{PROVIDED_URL}}

This endpoint is a webhook used to send information back after an exam invitation has been processed. This webhook is called by the system to notify the healthcare provider or relevant service about the status and details of the exam invite. It typically includes data such as the provider's name, clinic details, the exam name, status of the exam (e.g., Approved, Deferred, N/A), and unique identifiers like exam and patient exam IDs. This endpoint ensures that the provider receives real-time updates about the exam status, allowing for efficient follow-up and record-keeping within their systems.

Refer to the specifics below:

w:

Example Request Payload:

No request payload available

Parameters:

No parameters

Request Fields:

No request fields available

Responses:

Status Code: 200 - Event: Consultation Complete

{
  "event": 1,
  "reason": "Initial consultation complete",
  "exam_id": "exam-001",
  "exam_url": "https://exam.example.com/access/123456",
  "exam_name": "General Health Check",
  "rx_status": "Pharmacy Confirmed",
  "clinic_name": "Downtown Medical Center",
  "exam_status": "Approved",
  "patient_email": "[e-mail]",
  "provider_name": "NP Liza Test",
  "additional_data": "Additional details passed in for reference.",
  "patient_exam_id": "patient-exam-789",
  "questions_answers": [
    {
      "no": 1,
      "answer": "I am feeling good.",
      "question": "How are you feeling today?"
    },
    {
      "no": 2,
      "answer": "None known.",
      "question": "Do you have any allergies?"
    }
  ],
  "patient_phone_number": "234567890"
}

Status Code: 200 - Event: Prescription Confirmed

{
  "event": 2,
  "reason": "Initial consultation complete",
  "exam_id": "exam-001",
  "exam_url": "https://exam.example.com/access/123456",
  "quantity": 30,
  "exam_name": "General Health Check",
  "rx_status": "Pharmacy Confirmed",
  "directions": "Take one tablet by mouth twice daily",
  "clinic_name": "Downtown Medical Center",
  "exam_status": "Approved",
  "drug_details": {
    "size": "medium",
    "strength": "200mg",
    "drug_name": "Ibuprofen",
    "gpi_number": "456123789",
    "ndc_number": "123456789",
    "dosage_form_type": "tablet",
    "active_ingredient": "Ibuprofen",
    "inactive_ingredient": [
      "starch",
      "lactose"
    ]
  },
  "duration_days": 15,
  "patient_email": "[e-mail]",
  "provider_name": "NP Liza Test",
  "refill_amount": 2,
  "schedule_code": "II",
  "quantity_units": "tablets",
  "additional_data": "Additional details passed in for reference.",
  "dispense_number": 1,
  "patient_exam_id": "patient-exam-789",
  "prescription_id": 12345,
  "questions_answers": [
    {
      "no": 1,
      "answer": "I am feeling good.",
      "question": "How are you feeling today?"
    },
    {
      "no": 2,
      "answer": "None known.",
      "question": "Do you have any allergies?"
    }
  ],
  "patient_phone_number": "234567890"
}

Status Code: 200 - Event: Prescription Tracking Information

{
  "event": 3,
  "prescription_tracking": [
    {
      "pharmacy_location": "Main Street Location",
      "rx_number": "RX123456",
      "tracking_number": "123ABC456DEF",
      "delivery_service": "Overnight",
      "ship_carrier": "FedEx"
    },
    {
      "pharmacy_location": "East Side Location",
      "rx_number": "RX654321",
      "tracking_number": "654XYZ321ABC",
      "delivery_service": "2-Day",
      "ship_carrier": "UPS"
    }
  ],
  "created_at": "2024-09-25T15:30:00Z"
}

Response Fields:

Field	Explanation
additional_data	This field returns the stringified data that was passed in during exam invite.
questions_answers	You will receive an array of objects that include the question, answer and the position of the question.
event	There are three potential times a webhook is called depending on the exam. Event 1 is general good faith exams. Event 2 represents exams with included prescriptions and will return back the prescription details. Event 3 will include prescription tracking information for those exams with prescriptive services.