Skip to main content

Start a consultation with an existing patient

 

  1. Request an iframe url to Start a consultation using the POST /embed/consultation/create endpoint with patient data. This endpoint will:
    • Create or update the patient automatically
    • Generate a presigned iframe URL for creating a consultation
    • Success: The API returns the iframe URL and patient details (including patient identifiers in the key array).
    • Failure: An error code is set accordingly.
  2. Use the iframe url to create a consultation with the prefilled patient in the Empego App.
  3. Patient receives and completes the consultation.
  4. Upon completion of the consultation:
    • A browser event is fired through the Embedded Iframe Events API
    • Server-side event messages are created and queued for retrieval (polling endpoint implementation following v1 event patterns will be available in a future update)
  5. With the id (consultationKey) provided in the browser Embedded Iframe Events or retrieved from the server-side event messages, an employee can request an iframe url to view the consultation details using the GET /embed/consultation/view endpoint.