FHIR DSTU2 - Appointment

These FHIR Appointment 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
Find appointments within a practice
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment
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
_id integer The appointment ID. Per the FHIR spec, this is "_id", not "appointmentid" as with other API calls.
date string Filter results within a specific time period.
practitioner integer Filter results to appointments with the given practitioner ID

Output Parameters

Expand all
Example Code
Get a single appointment
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Appointment/{appointmentid}
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
appointmentid integer appointmentid

Output Parameters

Expand all
Example Code