Encounter

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

Endpoints

Find encounters for a given patient.

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

Output Parameters

Expand all
Example Code

Get details of a given encounter

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

Output Parameters

Expand all
Example Code