2.1 Patient Onboarding for SSO

Patient Onboarding for SSO-only Providers

Document version 1.3

For reference, here is a list of APIs which may be useful to clients who wish to use their own patient portals and import them to SnapMD Virtual Care Management for telemedicine encounters.

Check if the patient exists

A patient's email address operates as his or her unique ID in SnapMD's VCM database. Before attempting to import a patient, it is helpful to know whether the patient is already in the system.

GET v2/admin/patients?email={email}

API Reference

Create patients

POST v2/admin/patients

{
  "firstName": "sample string 1",
  "lastName": "sample string 2",
  "email": "sample string 3",
  "dob": "2015-11-05T17:58:58.378672Z",
  "address": "sample string 4",
  "countryId": 1,
  "timeZoneId": 1,
  "mobileNumberWithCountryCode": "sample string 5",
  "gender": "sample string 6"
}

API Reference SSO Procedures

Schedule an encounter

In order for a clinician to create an appointment, he or she must have Schedule Consultations permissions.

POST v2/admin/schedule/consultations

{
  "id": 1,
  "consultationId": 1,
  "assignedDoctorUsername": "sample string 2",
  "patientUsername": "sample string 3",
  "patient": {
    "$id": "2",
    "id": 1,
    "primaryPhysician": "sample string 2",
    "name": "sample string 3",
    "address": "sample string 4",
    "city": "sample string 5",
    "zipCode": "sample string 6",
    "gender": "sample string 7",
    "dob": "2015-11-05T18:06:09.4561213Z"
  },
  "isNoCharge": true,
  "primaryConsern": "sample string 5",
  "secondaryConsern": "sample string 6",
  "note": "sample string 7",
  "scheduledTime": "2015-11-05T18:06:09.4571214Z",
  "doctorName": "sample string 8",
  "profileImagePath": "sample string 9",
  "schedulingReasonType": 1,
  "prevConsultationID": 1,
  "scheduledFrom": "sample string 10"
}

API Reference

List a patient's upcoming consultations

GET v2/patients/scheduledconsultations

API Reference

Deactivate a patient

DELETE v2/admin/patients/{id}

API Reference