DiagnosticReport
These FHIR DiagnosticReport 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: these endpoints do not follow the same naming conventions as many of the other APIs offered.
Note: 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.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
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
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
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
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
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