Intake Link

The GET intake link method allows for an external vendor to retrieve the Intelligent Intake link associated with a specific patient's appointment. Given an appointmentId, the service will return a URL that is intended to be used by the patient in order to complete the assigned Intelligent Intake, typically prior to the scheduled appointment.

Prerequisites

Given the nature of Intelligent Intake and the Intake Link functionality, there are configuration prerequisites in order to ensure Intake Links are being generated for appointments:

• Vendor/Practice has received an apiKey from iSalus (see Access to RESTful Webservices)
• Practice is signed up for Intelligent Intake
• The practice has enabled Intelligent Intake Links
• Intelligent Intakes are automatically assigned based on the scheduled appointment type

Authentication & Headers

See Access to RESTful Webservices
Header =  'X-Api-Key: {apiKey}'

Endpoint Information

HTTP Method: GET
URL: https://api.isalushealthcare.com/api/intakelink/appointment/{appointmentId}

Parameter(s)

Sample Request

curl -X 'GET' \
  'https://api.isalushealthcare.com/api/intakelink/appointment/{appointmentId}' \
  -H 'accept: text/plain' \
  -H 'X-Api-Key: {apiKey}'

Sample Response Body

{
  "success": true,
  "data": {
    "intakeLinkUrl": "https://www.mymedicallocker.com/mml/intakelink.html?T=REDACTED"
  } }