Procedure Codes

The Procedure Codes Reference allows the user to retrieve the list of procedure codes for a specified encounter. The Procedure Documentation feature allows the user to view clinical details related to the procedures performed and billed for in the office. This is Practice-specific, HTML template-driven documentation related to specific procedures. When returned via API, all HTML is stripped out, and plain text is returned. This data may be difficult to parse. The Procedure Reference feature allows the user to view the configured list of procedures in the system.

Was this information helpful? Yes | No Thank you for your feedback! What went wrong? Incomplete or incorrect information | Irrelevant Content | Others
Submit

Get procedure documentation for given encounter

GET
/v1/{practiceid}/chart/encounter/{encounterid}/proceduredocumentation
Retrieves the procedure documentation associated with a specific encounter
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
encounterid integer encounterid
showoutcomes boolean Some practices utilize encounters with procedure workflows to document additional information about the procedure, such as outcomes associated with the proceduredocumentation. If SHOWOUTCOMES is set to true, returns additional information about outcomes, if it exists. This functionality is gated behind a toggle and will be GA no later than Jan 1, 2023.
showhtml boolean Procedure documentation is stored as HTML templates filled in by the practice. By default, we strip out all HTML when returning the data back through the API. However, there are times when preserving the HTML formatting may be useful. If SHOWHTML is set to true, the original HTML from the template is preserved when returning data back through the API.
limit integer Number of entries to return (default 1000, max 10000)Please note that this endpoint has a different default and max than normal.
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
complications array If showoutcomes is passed and the encounter includes procedure workflows, a JSON array indicating the complications with the procedure
lastmodifieddatetime string The latest date/time that this form got modified in format: MM/DD/YYYY HH24::MM::SS.
lastmodifieduser string The last user who updated this form.
outcome object If showoutcomes is passed and the encounter includes procedure workflows, a JSON object indicating the result of the procedure
proceduredocumentationtext string The text of the Procedure Documentation section. Not all practices use this. Some use it extensively with HTML templates.
proceduretemplatename string The name of the template from which this document originates
Example Code

Get list of procedure codes available for given encounter

GET
/v1/{practiceid}/encounter/{encounterid}/procedurecodes
Retrieves a list of procedure codes that can be attached to the billing slip for a given encounter
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
encounterid integer encounterid
searchvalue string The name of the procedure you want to search for. This can be the code or the description.
limit integer Number of entries to return (default 1500, max 5000)
offset integer Starting point of entries; 0-indexed

Output Parameters

Expand all
description string The human readable description of the code.
procedurecode string The CPT code for the procedure.
servicetype string The type of service this procedure is associated with. Ex: DME or LAB
Example Code

Get list of procedures and surgeries

GET
/v1/{practiceid}/reference/order/procedure
Retrieve the list of surgeries and procedures
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
searchvalue string A term to search for. Must be at least 2 characters

Output Parameters

Expand all
name string The name of the order
ordertypeid integer The athena ID of the type of order
Example Code