FHIR DSTU2 - Chart - Orders & Results, Vitals

These FHIR Orders & Results, Vitals (Charts) 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.

Note-1: that these endpoints do not follow the same naming conventions as many of the other APIs offered.

Note-2: If you are accessing a practice without Communicator Brands and are using one of the endpoints that require BRANDID in the path, you can use any positive integer for BRANDID.

Note-3: GET /v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid} only returns results that have been published to the Patient Portal.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Endpoints

Gets a list of procedures for a given patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure

List of Procedure resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ 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. 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
_lastupdated string Last updated filter
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

Expand all
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code
Gets a list of procedures for a given patient.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure

List of Procedure resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
date string Filter results within a specific time period.
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

Expand all
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code
Gets a list of observations about a given patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Observation

Returns the list of Observations. Date filtering does not apply for the social-history category.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ 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

Expand all
category object Classification of type of observation
code object Type of observation (code / type)
component array Component results
dataabsentreason object Why the result is missing
effectivedatetime string Clinically relevant time/time-period for observation
encounter object Healthcare event during which this observation is made
id string Logical id of this artifact
issued string Date/Time this was made available
referencerange array Provides guide for interpretation
related array Resource related to this observation
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
valuequantity object Actual result
valuestring string Actual result
Example Code
Gets a single result observation
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

Observation (laboratory test and result) resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ 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
Example Code
Get an social history observation by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/SocialHistory-{socialhistoryid}

Observation (social history) resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

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

Expand all
category object Classification of type of observation
code object Type of observation (code / type)
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
valuecodeableconcept object Actual result
Example Code
Get an individual vital by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Observation/Vital-{vitalid}

Observation (vital sign) resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
departmentid integer departmentid
vitalid integer vitalid
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)
dataabsentreason object Why the result is missing
effectivedatetime string Clinically relevant time/time-period for observation
encounter object Healthcare event during which this observation is made
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
valuequantity object Actual result
Example Code
Gets a list of observations about a given patient.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation

Returns the list of Observations. Date filtering does not apply for the social-history category.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
date string Filter results within a specific time period.
category string Observation category code.
code string One or more LOINC codes (comma delimited).

Output Parameters

Expand all
category object Classification of type of observation
code object Type of observation (code / type)
component array Component results
dataabsentreason object Why the result is missing
effectivedatetime string Clinically relevant time/time-period for observation
encounter object Healthcare event during which this observation is made
id string Logical id of this artifact
issued string Date/Time this was made available
referencerange array Provides guide for interpretation
related array Resource related to this observation
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
valuequantity object Actual result
valuestring string Actual result
Example Code
Get an individual result observation by ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/ResultObservation-{resultobservationid}

Observation (laboratory test and result) resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

resultobservationid integer resultobservationid
practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
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
Example Code
Get an individual vital by ID
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Observation/Vital-{vitalid}

Observation (vital sign) resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
brandid integer brandid
vitalid integer vitalid
chartsharinggroupid integer chartsharinggroupid
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)
dataabsentreason object Why the result is missing
effectivedatetime string Clinically relevant time/time-period for observation
encounter object Healthcare event during which this observation is made
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
valuequantity object Actual result
Example Code
Find diagnostic reports.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport

List of DiagnosticReport resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ 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.
category string Observation category code.
code string One or more LOINC codes (comma delimited).

Output Parameters

Expand all
category object Service category
code object Name/Code for this diagnostic report
effectivedatetime string Clinically Relevant time/time-period for report
id string Logical id of this artifact
issued string DateTime this version was released
performer object Responsible Diagnostic Service
resourcetype string The type of resource
result array Observations - simple, or complex nested groups
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
subject object The subject of the report, usually, but not always, the patient
Example Code
Get a single diagnostic report by lab result ID.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/DiagnosticReport/{labresultid}

DiagnosticReport resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
departmentid integer departmentid
labresultid integer labresultid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
category object Service category
code object Name/Code for this diagnostic report
effectivedatetime string Clinically Relevant time/time-period for report
id string Logical id of this artifact
issued string DateTime this version was released
performer object Responsible Diagnostic Service
resourcetype string The type of resource
result array Observations - simple, or complex nested groups
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
subject object The subject of the report, usually, but not always, the patient
Example Code
Find diagnostic reports.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport

List of DiagnosticReport resources from the results of the search

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
date string Filter results within a specific time period.
category string Observation category code.
code string One or more LOINC codes (comma delimited).

Output Parameters

Expand all
category object Service category
code object Name/Code for this diagnostic report
effectivedatetime string Clinically Relevant time/time-period for report
id string Logical id of this artifact
issued string DateTime this version was released
performer object Responsible Diagnostic Service
resourcetype string The type of resource
result array Observations - simple, or complex nested groups
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
subject object The subject of the report, usually, but not always, the patient
Example Code
Get a single diagnostic report by lab result ID.
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/DiagnosticReport/{labresultid}

DiagnosticReport resource from given ID

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
labresultid integer labresultid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
category object Service category
code object Name/Code for this diagnostic report
effectivedatetime string Clinically Relevant time/time-period for report
id string Logical id of this artifact
issued string DateTime this version was released
performer object Responsible Diagnostic Service
resourcetype string The type of resource
result array Observations - simple, or complex nested groups
status string registered | partial | final | corrected | appended | cancelled | entered-in-error
subject object The subject of the report, usually, but not always, the patient
Example Code
Find clinical impresssions for a given patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/ClinicalImpression

No description

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit
Try in Postman

Input Parameters

Expand all

❙ required

practiceid integer practiceid
departmentid integer departmentid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).
_lastupdated string Last updated filter
mostrecent integer If true, only retrieve the most recent clinical impression.

Output Parameters

Expand all
Example Code