FHIR DSTU2 - Documents and Forms

These FHIR Documents and forms 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.

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

Gets a list of document references for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference
List of DocumentReference 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).

Output Parameters

Expand all
authenticator object Which person or organization authenticates that this document is valid
content array Document referenced
description string Human-readable description of the source document
docstatus object The status of the underlying document
id string Logical id of this artifact
indexed string When this document reference created
meta object Metadata about the resource
resourcetype string The type of resource
securitylabel array A set of Security-Tag codes specifying the level of privacy/security of the Document
status string current | superseded | entered-in-error
subject object Who/what is the subject of the document
type object Kind of document (LOINC if possible)
Example Code

Get a specific document reference by ID

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/DocumentReference/AmbulatorySummary-{patientid}
DocumentReference 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
patientid integer patientid

Output Parameters

Expand all
authenticator object Which person or organization authenticates that this document is valid
content array Document referenced
description string Human-readable description of the source document
docstatus object The status of the underlying document
id string Logical id of this artifact
indexed string When this document reference created
meta object Metadata about the resource
resourcetype string The type of resource
securitylabel array A set of Security-Tag codes specifying the level of privacy/security of the Document
status string current | superseded | entered-in-error
subject object Who/what is the subject of the document
type object Kind of document (LOINC if possible)
Example Code

Gets a list of devices for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Device
Returns the list of Devices. Date filtering does not apply.
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).
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
id string Logical id of this artifact
manufacturer string Device Manufacturer
model string Device Model
patient object If the resource is affixed to a person
resourcetype string The type of resource
type object What kind of device this is
udi string FDA mandated Unique Device Identifier
Example Code

Get a specific device by ID

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Device/{deviceid}
Device 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
deviceid integer deviceid
departmentid integer departmentid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
id string Logical id of this artifact
patient object If the resource is affixed to a person
resourcetype string The type of resource
type object What kind of device this is
udi string FDA mandated Unique Device Identifier
Example Code