These FHIR Observation endpoints are a partial implementation of the FHIR DSTU2 specification. We will consider expanding these and adding additional FHIR endpoints, as well as future versions, based on usage and requests from API users.
Gets a list of observations about a given patient.
GET
/v1/{practiceid}/fhir/dstu2/Observation
Returns the list of Observations. Date filtering does not apply for the social-history category.
Input Parameters
required
practiceid | integer | practiceid |
departmentid | integer | departmentid |
patient | integer | The patient ID (same as “PATIENTID” in non-FHIR calls). |
date | string | Filter results within a specific time period or date. For the laboratory category, date filtering applies to the date the lab was ordered, not the date of the lab results. Prefix: eq – specific, le – inclusive less, lt – exclusive less, ge – inclusive greater, gt – exclusive greater, separate start and end date with space. Example: ge2015-06-1 le2015-06-22 |
category | string | Observation category code. Usable codes: social-history, laboratory and vital-signs |
code | string | One or more LOINC codes (comma delimited). |
THIRDPARTYUSERNAME | string | User name of the patient in the third party application. |
PATIENTFACINGCALL | boolean | When ‘true’ is passed we will collect relevant data and store in our database. |
Output Parameters
category | object | Classification of type of observation |
coding | object | Observation Category Coding |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
text | string | Observation Category |
code | object | Type of observation (code / type) |
coding | object | Observation Coding |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
text | string | Observation Code |
component | array | Component results |
code | object | Type of component observation (code / type) |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
valuequantity | object | Actual component result |
code | string | Coded form of the unit |
system | string | System that defines coded unit form |
unit | string | Unit representation |
value | number | Numerical value (with implicit precision) |
dataabsentreason | object | Why the result is missing |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
effectivedatetime | string | Clinically relevant time/time-period for observation |
encounter | object | Healthcare event during which this observation is made |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
id | string | Logical id of this artifact |
issued | string | Date/Time this was made available |
referencerange | array | Provides guide for interpretation |
high | object | High Range, if relevant |
code | string | Coded form of the unit |
system | string | System that defines coded unit form |
unit | string | Unit representation |
value | number | Numerical value (with implicit precision) |
low | object | Low Range, if relevant |
code | string | Coded form of the unit |
system | string | System that defines coded unit form |
unit | string | Unit representation |
value | number | Numerical value (with implicit precision) |
meaning | object | Indicates the meaning/use of this range |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
related | array | Resource related to this observation |
target | object | Resource that is related to this one |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
type | string | has-member | derived-from | sequel-to | replaces | qualified-by | interfered-by |
resourcetype | string | The type of resource |
status | string | registered | preliminary | final | amended | cancelled | entered-in-error | unknown |
subject | object | Who and/or what this is about |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
valuecodeableconcept | object | Actual result |
coding | object | Observation coding |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
valuequantity | object | Actual result |
code | string | Coded form of the unit |
system | string | System that defines coded unit form |
unit | string | Unit representation |
value | number | Numerical value (with implicit precision) |
valuestring | string | Actual result |
Gets a single result observation
GET
/v1/{practiceid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}
Observation (laboratory test and result) resource from given ID
Input Parameters
required
resultobservationid | integer | resultobservationid |
practiceid | integer | practiceid |
departmentid | integer | departmentid |
patient | integer | The patient ID (same as “PATIENTID” in non-FHIR calls). |
Output Parameters
Expand all
category | object | Classification of type of observation |
code | object | Type of observation (code / type) |
effectivedatetime | string | Clinically relevant time/time-period for observation |
id | string | Logical id of this artifact |
referencerange | array | Provides guide for interpretation |
resourcetype | string | The type of resource |
status | string | registered | preliminary | final | amended | cancelled | entered-in-error | unknown |
subject | object | Who and/or what this is about |
valuecodeableconcept | object | Actual result |
valuestring | string | Actual result |
Get an social history observation by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/SocialHistory-{socialhistoryid}
Observation (social history) resource from given ID
Input Parameters
practiceid | integer | practiceid |
socialhistoryid | integer | socialhistoryid |
❙departmentid | integer | departmentid |
patient | integer | The patient ID (same as “PATIENTID” in non-FHIR calls). |
THIRDPARTYUSERNAME | string | User name of the patient in the third party application. |
PATIENTFACINGCALL | boolean | When ‘true’ is passed we will collect relevant data and store in our database. |
Output Parameters
category | object | Classification of type of observation |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
code | object | Type of observation (code / type) |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
id | string | Logical id of this artifact |
issued | string | Date/Time this was made available |
resourcetype | string | The type of resource |
status | string | registered | preliminary | final | amended | cancelled | entered-in-error | unknown |
subject | object | Who and/or what this is about |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
valuecodeableconcept | object | Actual result |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
Get an individual vital by ID
GET
/v1/{practiceid}/fhir/dstu2/Observation/Vital-{vitalid}
Observation (vital sign) resource from given ID
Input Parameters
practiceid | integer | practiceid |
departmentid | integer | departmentid |
vitalid | integer | vitalid |
patient | integer | The patient ID (same as “PATIENTID” in non-FHIR calls). |
Output Parameters
category | object | Classification of type of observation |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
code | object | Type of observation (code / type) |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
dataabsentreason | object | Why the result is missing |
coding | array | Code defined by a terminology system |
code | string | Symbol in syntax defined by the system |
display | string | Representation defined by the system |
system | string | Identity of the terminology system |
text | string | Plain text representation of the concept |
effectivedatetime | string | Clinically relevant time/time-period for observation |
encounter | object | Healthcare event during which this observation is made |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
id | string | Logical id of this artifact |
resourcetype | string | The type of resource |
status | string | registered | preliminary | final | amended | cancelled | entered-in-error | unknown |
subject | object | Who and/or what this is about |
display | string | Text alternative for the resource |
reference | string | Relative, internal or absolute URL reference |
valuequantity | object | Actual result |
code | string | Coded form of the unit |
system | string | System that defines coded unit form |
unit | string | Unit representation |
value | number | Numerical value (with implicit precision) |