DocumentReference
These FHIR DocumentReference 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
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
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
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