xCaliber healthCare Data Mesh

Encounter-GET

Description

Retrieves detailed information on patient encounters, such as visit details, diagnoses, and treatments for streamlined tracking and analysis within clinical workflows.

Use Cases

Retrieve Encounter Details: Obtain information about a specific encounter
Access Patient Visits: Retrieve details of patient visits
Query Encounter Diagnoses: Obtain diagnoses for an encounter
Review Encounter Notes: Access notes from a specific encounter
Examine Encounter Procedures: Retrieve details of procedures in an encounter

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/chart/${patient}/encounters`	patient departmentId	start-date include appointment end-date author-reference _count _offset
Elation	`${url}/visit_notes`
Canvas	`${url}/Encounter`		type start_date end_date

Filters

FilterName	Description	Default Value	Allowed Values
_count	Pagination params
_offset	Pagination params. Athena: Starting point of entries; 0-indexed
appointment	Find the encounter for this appointment.
ccda-output-format	This parameter will place quotes around HTML tag qualifier values.
departmentId	Identifier for the department
end-date	Omit any encounters after than this date
include	List of fields which needed to be shown in result
participant	The ID of the provider for this encounter
patient	Patient reference for any fhir resource
practitioner	Practitioner reference for the any fhir resource
quorum	sets sync/async mode	true
start-date	Omit any encounters earlier than this date
template-ids	If templateids is passed in, it will return only the template data for the array of ids passed in. The showstructured flag must be true to use this. Please note: this will cause the results to return the physical exam template, and not the data selected for the current encounter.
well-child-template-ids	If wellchildtemplateids are passed in, this will return only the template data for the ids passed in, and not the data selected for the current encounter. The showstructured flag must be true to use this. This can be used in conjunction with templateids.

Encounter Export-POST

Encounter ID-DELETE