Observation-GET

Description

Retrieves a list of all observation records containing patient details, observation codes, values, interpretation, and other measured data points.

Use Cases

Retrieve Observation Data: Obtain details of a specific observation
Access Patient Metrics: Retrieve details of patient metrics
Query Vital Signs: Obtain specific vital sign details
Review Lab Results: Access details of laboratory results
Examine Imaging Observations: Retrieve information on imaging observations

Request Sample

Athena

Elation

Canvas

cURL

JavaScript

Java

Python

Source Specific Details

EHR	APIs	mandatory filters	optional filters
Athena	`${url}/v1/${practiceId}/chart/encounter/${encounter}/physicalexam` `${url}/v1/${practiceId}/chart/${patient}/analytes` `${url}/v1/${practiceId}/chart/${patient}/vitals?departmentid=${departmentId}`	patient category departmentId encounter	include ccda-output-format template-ids end-date start-date _count _offset third-party-user-name patient-facing-call date all-results-by-encounter-id super-seded-document-id exact-duplicate-document-id lab-result-status hide-duplicate analyte-result-status
Elation	`${url}/vitals`	category patient	encounter _offset non-visit-note visit-note _count
Canvas	`${url}/Encounter/${encounterId}` `${url}/Observation`	patient category encounter visitType

Filters

FilterName	Description	Default Value
_count	Pagination params
_offset	Pagination params. Athena: Starting point of entries; 0-indexed
asserter	Source of the information about the allergy
category	food \| medication \| environment \| biologic
ccda-output-format	This parameter will place quotes around HTML tag qualifier values.
clinical-status	active \| inactive \| resolved
code	Multiple Resources: * [Observation](Observation.html): Code that identifies the allergy or intolerance * [Condition](condition.html): Code for the condition * [DeviceRequest](devicerequest.html): Code for what is being requested/ordered * [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result * [FamilyMemberHistory](familymemberhistory.html): A search by a condition code * [List](list.html): What the purpose of this list is * [Medication](medication.html): Returns medications for a specific code * [MedicationAdministration](medicationadministration.html): Return administrations of this medication code * [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code * [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code * [MedicationStatement](medicationstatement.html): Return statements of this medication code * [Observation](observation.html): The code of the observation type * [Procedure](procedure.html): A code to identify a procedure * [ServiceRequest](servicerequest.html): What is being requested/ordered
criticality	low \| high \| unable-to-assess
departmentId	Identifier for the department
encounter	Encounter created as part of
end-date	Only retrieve vitals that were taking on or before this date
identifier	Multiple Resources: * [Observation](Observation.html): External ids for this item * [CarePlan](careplan.html): External Ids for this plan * [CareTeam](careteam.html): External Ids for this team * [Composition](composition.html): Version-independent identifier for the Composition * [Condition](condition.html): A unique identifier of the condition record * [Consent](consent.html): Identifier for this record (external references) * [DetectedIssue](detectedissue.html): Unique id for the detected issue * [DeviceRequest](devicerequest.html): Business identifier for request/order * [DiagnosticReport](diagnosticreport.html): An identifier for the report * [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents * [DocumentReference](documentreference.html): Master Version Specific Identifier * [Encounter](encounter.html): Identifier(s) by which this encounter is known * [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare * [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier * [Goal](goal.html): External Ids for this goal * [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number * [Immunization](immunization.html): Business identifier * [List](list.html): Business identifier * [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier * [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier * [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier * [MedicationStatement](medicationstatement.html): Return statements with this external identifier * [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier * [Observation](observation.html): The unique id for a particular observation * [Procedure](procedure.html): A unique identifier for a procedure * [RiskAssessment](riskassessment.html): Unique identifier for the assessment * [ServiceRequest](servicerequest.html): Identifiers assigned to this order * [SupplyDelivery](supplydelivery.html): External identifier * [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest * [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
include	List of fields which needed to be shown in result
last-date	Date(/time) of last known occurrence of a reaction
manifestation	Clinical symptoms/signs associated with the Event
onset	Date(/time) when manifestations showed
patient	Patient reference for any fhir resource
patient-facing-call	When 'true' is passed source will collect relevant data and store in their database.	false
practitioner	Practitioner reference for the any fhir resource
quorum	sets sync/async mode	true
recorder	Who recorded the sensitivity
route	How the subject was exposed to the substance
severity	mild \| moderate \| severe (of event as a whole)
start-date	Only retrieve vitals that were taking on or after this date
template-ids	If templateids is passed in, it will return only the template data for the array of ids passed in
third-party-user-name	User name of the patient in the third party application.
type	Multiple Resources: * [Observation](Observation.html): allergy \| intolerance - Underlying mechanism (if known) * [Composition](composition.html): Kind of composition (LOINC if possible) * [DocumentManifest](documentmanifest.html): Kind of document set * [DocumentReference](documentreference.html): Kind of document (LOINC if possible) * [Encounter](encounter.html): Specific type of encounter * [EpisodeOfCare](episodeofcare.html): Type/class - e.g. specialist referral, disease management
verification-status	unconfirmed \| confirmed \| refuted \| entered-in-error
visit_note	visit note specific to vitals

Observation Export-POST

Observation ID-DELETE