Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

Administrative Functions

Jump to bottom
Karen White edited this page May 15, 2019 · 1 revision

Purpose

Administrative functions are usually part of various other APIs as places where certain data are only available to those with the proper privileges, but there are some functions which are unique to this section. All administrative functions are consolidated in this section, but they are also present in the APIs they are normally encapuslated in. When the APIs are standardized in the future, these endpoints will likely be structured differently, but it will remain obvious that they require administrative privileges.

All endpoints which are listed as hyperlinks navigate directly to that particular endpoint's documentation, which contains data models, usage examples, and response structures.

Endpoint List

  • v2/admin/clients
  • v2/admin/clients/{hospitalId}
  • v2/admin/clients/{hospitalId}/contacts
  • v2/admin/clients/{hospitalId}/contacts/{contactId}
  • v2/admin/clients/{hospitalId}/seats
  • v2/admin/clients/{hospitalId}/sites
  • v2/admin/clients/{hospitalId}/sites/{siteId}
  • v2/admin/clients/types
  • v2/admin/consultations
  • v2/admin/hospitals/{hospitalId}/locations
  • v2/admin/hospitals/{hospitalId}/organizations
  • v2/admin/hospitals/settings/{hospitalId}
  • v2/admin/integration-logs
  • v2/admin/log-messages
  • v2/admin/patient/{patientId}/dependent
  • v2/admin/patient/{patientId}/dependent/{dependentId}/relationship
  • v2/admin/patients
  • v2/admin/patients/{id}
  • v2/admin/patients/onboardEmailSetting
  • v2/admin/patients/send-onboarding-email
  • v2/admin/pendingaccounts
  • v2/admin/pendingaccounts/{id}
  • v2/admin/snapservices/logs/{id}
  • v2/admin/userstaffprofile
  • v2/clinicians/staffs/{adminUserId}/tags
  • v2/filesharing/folder/admin
  • v2.1/admin/postalcodes
  • v2.1/admin/postalcodes/{id}
  • v2.1/admin/rules
  • v2.1/admin/rules/{id}
  • v2.1/admin/rules/{id}/patient-organization-rules
  • v2.1/admin/rules/{id}/subject-address-rules
  • v2.1/admin/rules/{id}/subject-distance-rules
  • v2.1/admin/rules/patient-organization-rules
  • v2.1/admin/rules/rule-categories
  • v2.1/admin/rules/rule-sets
  • v2.1/admin/rules/rule-sets/{id}
  • v2.1/admin/rules/rule-templates
  • v2.1/admin/rules/rule-templates/{id}
  • v2.1/admin/rules/subject-address-meta-rules
  • v2.1/admin/rules/subject-address-rules
  • v2.1/admin/rules/subject-distance-rules
  • v2.1/clinicians/profile

Recipes

Accounts

  1. Use POST v2/admin/patients/send-onboarding-email to send an onboarding email.
  2. Use PUT v2/admin/pendingaccounts to update a pending account profile.
  3. Use GET v2/admin/pendingaccounts/{id} to get a pending account profile.

Checking For a Patient's Presence in the System

Use GET v2/admin/patients to determine if a user exists in the system. This endpoint requires physician or administrative permissions to run properly.

Clients

  1. Use GET or POST v2/admin/clients to get details of clients in the system, or to create new clients.
  2. Use v2/admin/clients/{hospitalId} to get, update, or deactivate client details by hospital ID. Use GET, PUT, or DELETE, not POST.
  3. Use PUT v2/admin/clients/{hospitalId}/contacts/{contactId} to edit a hospital contact entry.
  4. Use GET v2/admin/clients/{hospitalId}/seats to get the available client seats for a hospital.
  5. Use GET or POST v2/admin/clients/{hospitalId}/sites to get a list of hospital sites or create a new hospital site.
  6. Use GET or PUT v2/admin/clients/{hospitalId}/sites/{siteId} to access or edit a hospital site.
  7. Use GET v2/admin/clients/types to get a list of client types.

Creating Patients and Dependents

Use POST on the following endpoints to create a patient or dependent.

  • Create Patient:

    POST v2/admin/patients

  • Create Dependent:

    POST v2/admin/patient/{patientId}/dependent

Deactivating a Patient

Use DELETE v2/admin/patients/{id} to deactivate a patient. This does not remove the patient from the SnapMD system, but it sets its status to "Inactive." This endpoint requires administrative privileges.

Dependents

  1. Use POST v2/admin/patient/{patientId}/dependent to create a new dependent linked to a patient.
  2. Use PUT v2/admin/patient/{patientId}/dependent/{dependentId}/relationship to edit a relatinship with a dependent.

Encounters

  1. Use GET v2/admin/consultations to get all encounters for a hospital.

Hospitals

  1. Use GET v2/admin/hospitals/{hospitalId}/locations to get all hospital locations.
  2. Use GET v2/admin/hospitals/{hospitalId}/organizations to get all organizations related to a hospital.
  3. Use GET or PUT v2/admin/hospitals/settings/{hospitalId} to get or edit hospital settings.
  4. Use GET v2/admin/patients/onboardEmailSetting to get whether the current user's hospital has the ability to send onboard emails.
  5. Use GET v2/filesharing/folder/admin to get the shared folder a hospital uses.

Log Messages

  1. Use GET v2/admin/integration-logs to get integration log messages.
  2. Use GET v2/admin/log-messages to get log messages.
  3. Use GET v2/admin/snapservices/logs/{id} to get the last 100 log records for a service.

Patients

Use POST v2/admin/patients to import a patient with minimum data.

Postal Codes

  1. Use GET or PUT v2.1/admin/postalcodes to get or add postal codes.
  2. Use PUT or DELETE v2.1/admin/postalcodes/{id} to update or delete a postal code.

Rules

Use the following endpoints to handle rules.

  1. Use GET or POST v2.1/admin/rules to get all rules, or to add a new rule.
  2. Use PUT or DELETE v2.1/admin/rules/{id} to edit or delete a rule.

Use the following endpoints to handle specific rule types. The subject address rules are the only rules currently implemented on all systems.

  1. Use PUT v2.1/admin/rules/{id}/patient-organization-rules to edit a patient organization rule.
  2. Use PUT v2.1/admin/rules/{id}/subject-address-rules to edit a subject address rule.
  3. Use GET v2.1/admin/rules/subject-address-meta-rules to access rules which contain info to make subject address rules.
  4. Use PUT v2.1/admin/rules/{id}/subject-distance-rules to edit a subject distance rule.
  5. Use POST v2.1/admin/rules/patient-organization-rules to add a patient organization rule.
  6. Use POST v2.1/admin/rules/subject-address-rules to add a subject address rule.
  7. Use POST v2.1/admin/rules/subject-distance-rules to add a subject distance rule.

Use the following endpoints to handle rule categories and rule sets.

  1. Use GET v2.1/admin/rules/rule-categories to access rule categories.
  2. Use GET or POST v2.1/admin/rules/rule-sets to access or add rule sets
  3. Use PUT or DELETE v2.1/admin/rules/rule-sets/{id} to update or delete rule sets by ID.

Use the following endpoints to handle rule templates.

  1. Use GET or POST v2.1/admin/rules/rule-templates to get rule templates or to add a new rule template.
  2. Use PUT or DELETE v2.1/admin/rules/rule-templates/{id} to update or delete a rule template by its ID.

Tags

  1. Use POST v2/clinicians/staffs/{adminUserId}/tags to apply a tag to an admin user.

Users

  1. v2/admin/userstaffprofile is an alias for v2.1/clinicians/profile.

Contents

Clone this wiki locally