Procedure

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

Gets a list of procedures for a given patient.

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure
List of Procedure 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
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).
date string Filter results within a specific time period or date. Prefix: eq - specific, le - inclusive less, lt - exclusive less, ge - inclusive greater, gt - exclusive greater, separate start and end date with space. Example: ge2015-06-1 le2015-06-22
_lastupdated string Last updated filter
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
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code

Get a specific procedure by ID

GET
/v1/{practiceid}/{departmentid}/fhir/dstu2/Procedure/{procedureid}
Procedure 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
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
departmentid integer departmentid
procedureid integer procedureid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code

Gets a list of procedures for a given patient.

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure
List of Procedure 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
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
chartsharinggroupid integer chartsharinggroupid
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
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code

Get a specific procedure by ID

GET
/v1/{practiceid}/{brandid}/{chartsharinggroupid}/fhir/dstu2/Procedure/{procedureid}
Procedure 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
Try in Postman

Input Parameters

Expand all

required

practiceid integer practiceid
brandid integer brandid
procedureid integer procedureid
chartsharinggroupid integer chartsharinggroupid
patient integer The patient ID (same as "PATIENTID" in non-FHIR calls).

Output Parameters

Expand all
code object Identification of the procedure
id string Logical id of this artifact
performeddatetime string Date/Period the procedure was performed
resourcetype string The type of resource
status string in-progress | aborted | completed | entered-in-error
subject object Who the procedure was performed on
Example Code