FHIR DSTU2 - Patient

These FHIR Patient 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 Patients

Output Parameters

Expand all
Example Code
Get a single patient
GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. 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

Output Parameters

Expand all
Example Code
Find patients by brand and chart
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient

List of Patient resources from the results of the search. 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

Output Parameters

Expand all
Example Code
Get a single patient
GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}

Returns Patient Information. 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

Output Parameters

Expand all
Example Code
Get a SMART health card for a patient
POST
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Patient/{patientid}/$health-cards-issue

BETA: Parameters resource that includes one or more verifiable credentials

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
Example Code