DocumentReference-GET

Description

Retrieves detailed information on documents linked to patient care, allowing healthcare developers to access and display real-time data regarding diverse clinical documents for streamlined information retrieval within clinical workflows.

Use Cases

Assemble Health History: Retrieve document catalog
Check Consent Details: Get consent document references
Review Care Plan Instructions: Obtain care plan document details
Share Referral Recommendations: Access recommendation document specifics
Evaluate Document Usage: Retrieve documents for analysis

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/patients/${patient}/documents/clinicaldocument` `${url}/v1/${practiceId}/patients/${patient}/documents/medicalrecord` `${url}/v1/${practiceId}/patients/${patient}/documents/patientcase` `${url}/v1/${practiceId}/patients/${patient}/documents/prescription` `${url}/v1/${practiceId}/patients/${patient}/documents/interpretation` `${url}/v1/${practiceId}/patients/${patient}/documents/order` `${url}/v1/${practiceId}/patients/${patient}/documents/encounterdocument` `${url}/v1/${practiceId}/patients/${patient}/documents/html` `${url}/v1/${practiceId}/patients/${patient}/documents/patientrecord` `${url}/v1/${practiceId}/patients/${patient}/documents/vaccine` `${url}/v1/${practiceId}/patients/${patient}/documents/surgicalresult` `${url}/v1/${practiceId}/patients/${patient}/documents/surgery` `${url}/v1/${practiceId}/patients/${patient}/documents/letter` `${url}/v1/${practiceId}/patients/${patient}/documents/admin` `${url}/v1/${practiceId}/documents/admin` `${url}/v1/${practiceId}/patients/${patient}/documents/physicianauth` `${url}/v1/${practiceId}/patients/${patient}/documents/phonemessage` `${url}/v1/${practiceId}/documents/phonemessage` `${url}/v1/${practiceId}/patients/${patient}/documents/appointmentrequest` `${url}/v1/${practiceId}/patients/${patient}/documents/unknown` `${url}/v1/${practiceId}/chart/${patient}/encounters` `${url}/v1/${practiceId}/chart/encounters/${encounter}/summary` `${url}/v1/${practiceId}/chart/encounters/${encounterid}/summary`	patient departmentId category	service-type-code date-of-service encounter document-subclass status _count _offset get-entity-info exclude-xml exclude-html patient date document-class providerId
Elation	`${url}/visit_notes` `${url}/non_visit_notes`	patient 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.
category	Type of notes		Athena: clinical-document,medical-record,patient-case,prescription,interpretation,order,encounter-document,html,patient-record,vaccine,surgical-result,surgery,letter,admin,physician-auth,phone-message,appointment-request,unknown Elation: visit_notes,non_visit_notes
class	The class(es) of document(s) comma separated.
departmentId	Identifier for the department
encounter	Source of the information about encounter id for a visit note
encounterId	Source of the information about the encounter of a patient
include	List of fields which needed to be shown in result
mobile	Flag to skip many details to make the html smaller
modified-date	Last modified date for a visit note
patient	Patient reference for any fhir resource
practitioner	Practitioner reference for the any fhir resource
quorum	sets sync/async mode	true
show-ccda-xml
skip-amendments	Flag to skip encounter amendments
status	The status of the task to filter document results.
subclass	The document subclass to filter document results.
unsigned	Visit notes that doesn't have signed date

DocumentReference Export-POST

DiagnosticReport ID-DELETE