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

Encounters

Jump to bottom
Karen White edited this page May 15, 2019 · 3 revisions

Encounters

Purpose

The Encounters API handles interactions between patients and medical staff. Medical staff can be doctors, nurses, or a number of other hospital positions. The Encounters API refers to encounters in multiple terms, and their functionality can be found under a variety of resources. All endpoints listed here are part of the Encounters API. Some duplications exist among the v2 and v2.1 endpoints, where the same functionality exists under renamed endpoints.

Endpoint List

  • v2/admin/consultations
  • v2/clinicians/consultations/{consultation}
  • v2/clinicians/dashboard/consultations/{startDate}/{endDate}
  • v2/consultations/{consultationId}/snapshots
  • v2/consultations/{consultationId}/snapshots/{shapshotFileId}
  • v2/patients/{patientId}/consultations
  • v2/patients/{patientId}/consultations/status/{statusId}
  • v2/patients/activeconsultations/{consultationId}
  • v2/patients/activeconsultations/{consultationId}/alive-timestamp
  • v2/patients/availableconsultations
  • v2/patients/consultations
  • v2/patients/consultations/{consultationId}/connection-status
  • v2/patients/consultations/{consultationId}/intake
  • v2/patients/consultations/{consultationId}/participants
  • v2/patients/consultations/{consultationId}/participants/tokens
  • v2/patients/consultations/activeconsultations
  • v2/patients/consultations/participants
  • v2/patients/consultations/participants/{participantId}
  • v2/patients/consultations/participants/{participantId}/invitation
  • v2/patients/consultations/participants/{participantId}/tokens
  • v2/physicians/appointments/{id}
  • v2/physicians/appointments/{id}/all
  • v2/physicians/appointments/{id}/videokey
  • v2/schedule/concern/primary
  • v2/schedule/concern/primary/other
  • v2/schedule/concern/secondary
  • v2/schedule/concern/secondary/other
  • v2/schedule/consultations/{id}
  • v2.1/clinicians/consultations/{id}
  • v2.1/clinicians/consultations/{id}/markasfullfill
  • v2.1/clinicians/consultations/{id}/participant-video-key
  • v2.1/clinicians/consultations/{id}/verbose
  • v2.1/patients/{personId}/encounters
  • v2.1/patients/consultations/{consultationid}/markasfullfill
  • v2.1/patients/consultations/on-demand
  • v3/admin/consultations/{{consultationId}}

Deprecated Endpoints

  • v2/patients/consultations/{consultationId}/all

Recipes

Any endpoints that handle administrative functions are listed under the "Administrative Functions" page.

Active Encounters

  1. Use PUT v2/patients/activeconsultations/{consultationId}/alive-timestamp to update an active encounter's timestamp.
  2. Use DELETE v2/patients/activeconsultations/{consultationId} to end an active encounter.

Creating Encounters

Use POST v2.1/patients/{personId}/encounters to create an encounter based on a user's global person ID.

Completing Encounters

Use one of the following endpoints to mark an encounter as complete:

  1. POST v2.1/clinicians/consultations/{id}/markasfullfill
  2. POST v2.1/patients/consultations/{consultationid}/markasfullfill

Getting Encounter Data

Use GET on one of the following endpoints to retrieve information about an encounter by the encounter's ID. This information includes data about what happened in the encounter, and does not include information about the participants.

  1. v2/physicians/appointments/{id}
  2. v2.1/clinicians/consultations/{id}

Use GET on one of the following endpoints to retrieve information as described above, but including data about the participants involved in the encounter.

  1. v2/physicians/appointments/{id}/all
  2. v2.1/clinicians/consultations/{id}/verbose

The two endpoints above are aliases for the same information. There are also a number of other endpoints which get encounter information, as follows:

  1. GET v2/patients/availableconsultations: Get current user's available encounters
  2. GET v2/patients/consultations/activeconsultations: Get current user's active encounters
  3. GET v2/schedule/consultations/{id}: Get scheduled encounters
  4. GET v2/clinicians/consultations/{consultation}: Get encounter by ID and status
  5. GET v2/patients/{patientId}/consultations: Get encounters by patient ID
  6. GET v2/patients/{patientId}/consultations/status/{statusId}: Get encounters by patient ID and specific status

Each of these endpoints returns information in a different format; please refer to specific endpoint documentation for more details.

Handling Encounter Concerns

The "concern" andpoints do not return the concerns of specific encounters, but return lists of possible concerns which clinicians and schedulers may use to flag encounters. These endpoints are:

  1. v2/schedule/concern/primary
  2. v2/schedule/concern/primary/other
  3. v2/schedule/concern/secondary
  4. v2/schedule/concern/secondary/other

To update primary and secondary concerns, use PUT v2/patients/consultations/{consultationId}/intake.

The concerns of individual patients are listed in the data returned by other endpoints in this section.

On-Demand Encounters

Use POST on the following two endpoints to create an on-demand encounter:

  1. v2/patients/consultations
  2. v2.1/patients/consultations/on-demand

Patient Information

Use GET on one of the following endpoints to retrieve information about patients who were involved in the encounters.

  1. v3/admin/consultations/{{consultationId}}: Get all available information about encounter patients
  2. v2/clinicians/dashboard/consultations/{startDate}/{endDate}: Get patient information from encounters between the specified dates

Participants in Encounters

  1. Use POST on one of the following endpoints to create tokens for participants:
    • v2/patients/consultations/{consultationId}/participants/tokens: Create token using encounter ID
    • v2/patients/consultations/participants/{participantId}/tokens: Create token using participant ID
  2. Use POST on one of the following endpoints to modify participants:
    • v2/patients/consultations/{consultationId}/participants: Add a participant to an encounter
    • v2/patients/consultations/participants/{participantId}: Update a participant in an encounter
  3. Use GET v2/patients/consultations/participants to get information about an encounter's participants.
  4. Use DELETE v2/patients/consultations/participants/{participantId}/invitation to decline an invitation to be a particpant in an encounter.

Remote Conferences

Use GET on one of the following endpoints to retrieve video keys for remote conferences.

  1. v2/physicians/appointments/{id}/videokey
  2. v2.1/clinicians/consultations/{id}/participant-video-key

Use GET v2/patients/consultations/{consultationId}/connection-status to check the connection status of these remote conferences.

Snapshots

  1. Use GET or POST v2/consultations/{consultationId}/snapshots to get or update an encounter snapshot by encounter ID.
  2. Use GET or DELETE v2/consultations/{consultationId}/snapshots/{shapshotFileId} to get or delete an encounter snapshot by encounter ID and snapshot file ID.

Contents

Clone this wiki locally