Goal
These FHIR Care Plan 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 goals for a given patient.
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Goal
List of Goal 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.
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
description
string
What's the desired outcome
id
string
Logical id of this artifact
resourcetype
string
The type of resource
status
string
proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
subject
object
Who this goal is intended for
text
object
Text summary of the resource, for human interpretation
Example Code
Get a specific goal by ID
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Goal/{goalid}
Goal 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
goalid
integer
goalid
practiceid
integer
practiceid
departmentid
integer
departmentid
patient
integer
The patient ID (same as "PATIENTID" in non-FHIR calls).
Output Parameters
Expand all
description
string
What's the desired outcome
id
string
Logical id of this artifact
resourcetype
string
The type of resource
status
string
proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled
subject
object
Who this goal is intended for
text
object
Text summary of the resource, for human interpretation
Example Code