GET v1/patient/observations?chartID={chartID}&obsCodes={obsCodes}&lastOnly={lastOnly}&startDate={startDate}&endDate={endDate}&patientFieldList={patientFieldList}
Get Observations: Retrieve result observation values for a given patient.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
chartID |
The EMR-Link patient chart ID. |
string |
Required |
obsCodes |
One or more observation codes (comma-separated) identifying the observations to retrieve. |
string |
Required |
lastOnly |
If supplied and set to true, only the most recent observation value for each observation will be returned. |
boolean |
Default value is False |
startDate |
If supplied, only observation values on or after the start date will be returned. |
date |
None. |
endDate |
If supplied, only observation values before the end date will be returned. |
date |
None. |
patientFieldList |
If supplied, only the patient model fields identified in this list will be assigned in the returned Patient object. Separate multiple with a comma. |
string |
None. |
Body Parameters
None.
Response Information
Resource Description
GetObservationsResponseName | Description | Type | Additional information |
---|---|---|---|
ChartID | string |
None. |
|
Patient | Patient |
None. |
|
Observations | Collection of ResultObservation |
None. |
|
Error |
Will be set to True if any errors occur during the processing of the API method. |
boolean |
None. |
ErrorMessage |
Will contain an error message string if Error is True. |
string |
None. |
Response Formats
application/json, text/json
{ "ChartID": "sample string 1", "Patient": { "PatientID": "sample string 1", "MRN": "sample string 2", "ExtID": "sample string 3", "AltID": "sample string 4", "MedicareNumber": "sample string 5", "LastName": "sample string 6", "FirstName": "sample string 7", "MiddleName": "sample string 8", "Suffix": "sample string 9", "DateOfBirth": "sample string 10", "Gender": "sample string 11", "SSN": "sample string 12", "Race": "sample string 13", "Ethnicity": "sample string 14", "GenderIdentityCode": "sample string 15", "GenderIdentityDescription": "sample string 16", "SexualOrientationCode": "sample string 17", "SexualOrientationDescription": "sample string 18", "Address1": "sample string 19", "Address2": "sample string 20", "City": "sample string 21", "State": "sample string 22", "Country": "sample string 23", "ZipCode": "sample string 24", "Phone": "sample string 25", "WorkPhone": "sample string 26", "CellPhone": "sample string 27", "Email": "sample string 28", "MaritalStatus": "sample string 29", "Unit": "sample string 30", "Room": "sample string 31", "Bed": "sample string 32", "CareStatus": "sample string 33" }, "Observations": [ { "Name": "sample string 1", "Value": "sample string 2", "Date": "2025-08-24T22:52:22.7843346-05:00", "Unit": "sample string 4" }, { "Name": "sample string 1", "Value": "sample string 2", "Date": "2025-08-24T22:52:22.7843346-05:00", "Unit": "sample string 4" } ], "Error": true, "ErrorMessage": "sample string 3" }
application/xml, text/xml
<GetObservationsResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <Error>true</Error> <ErrorMessage>sample string 3</ErrorMessage> <ChartID>sample string 1</ChartID> <Patient> <PatientID>sample string 1</PatientID> <MRN>sample string 2</MRN> <ExtID>sample string 3</ExtID> <AltID>sample string 4</AltID> <MedicareNumber>sample string 5</MedicareNumber> <LastName>sample string 6</LastName> <FirstName>sample string 7</FirstName> <MiddleName>sample string 8</MiddleName> <Suffix>sample string 9</Suffix> <DateOfBirth>sample string 10</DateOfBirth> <Gender>sample string 11</Gender> <SSN>sample string 12</SSN> <Race>sample string 13</Race> <Ethnicity>sample string 14</Ethnicity> <GenderIdentityCode>sample string 15</GenderIdentityCode> <GenderIdentityDescription>sample string 16</GenderIdentityDescription> <SexualOrientationCode>sample string 17</SexualOrientationCode> <SexualOrientationDescription>sample string 18</SexualOrientationDescription> <Address1>sample string 19</Address1> <Address2>sample string 20</Address2> <City>sample string 21</City> <State>sample string 22</State> <Country>sample string 23</Country> <ZipCode>sample string 24</ZipCode> <Phone>sample string 25</Phone> <WorkPhone>sample string 26</WorkPhone> <CellPhone>sample string 27</CellPhone> <Email>sample string 28</Email> <MaritalStatus>sample string 29</MaritalStatus> <Unit>sample string 30</Unit> <Room>sample string 31</Room> <Bed>sample string 32</Bed> <CareStatus>sample string 33</CareStatus> </Patient> <Observations> <ResultObservation> <Name>sample string 1</Name> <Value>sample string 2</Value> <Date>2025-08-24T22:52:22.7843346-05:00</Date> <Unit>sample string 4</Unit> </ResultObservation> <ResultObservation> <Name>sample string 1</Name> <Value>sample string 2</Value> <Date>2025-08-24T22:52:22.7843346-05:00</Date> <Unit>sample string 4</Unit> </ResultObservation> </Observations> </GetObservationsResponse>