Encounter Services

The Encounter Services feature allows the user to view the list of services associated with an encounter. The facility references features is configured in the Practice. It is used to search for facilities (pharmacies, labs, imaging centers, and durable medical equipment suppliers) supporting different orders. Each practice may define local facilities. The search is based on distance to the practice department, unless a patientID is specified then it is based on distance to the patient's home address.

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

Get list of all services for given encounter

GET
/v1/{practiceid}/encounter/{encounterid}/services
Retrieves a list of services associated with the 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

Output Parameters

Expand all
count integer The amount of services performed
note string Notes related to services.
procedures array The services attached to the billing slip of an encounter.
Example Code

Create a new service attacted to the billing slip of an encounter.

POST
/v1/{practiceid}/encounter/{encounterid}/services
Generic success/error response
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
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code

Get encounter's service information

GET
/v1/{practiceid}/encounter/{encounterid}/services/{serviceid}
Retrieves information of a specific service of the 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
serviceid integer serviceid

Output Parameters

Expand all
procedures array The services attached to the billing slip of an encounter.
Example Code

Update service information of given encounter

PUT
/v1/{practiceid}/encounter/{encounterid}/services/{serviceid}
Modifies information of a specific service of the 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
serviceid integer serviceid
Content-Type string Content type of the payload

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code

Delete specific service for given encounter

DELETE
/v1/{practiceid}/encounter/{encounterid}/services/{serviceid}
Deletes the preexisting record of the service of the 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
serviceid integer serviceid

Output Parameters

Expand all
errormessage string If the operation failed, this will contain any error messages.
success string Whether the operation was successful.
Example Code

Get list of facilities

GET
/v1/{practiceid}/chart/configuration/facilities
Retrieve a list of facilities based on the search criteria provided.
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 Used to help determine both whether to include which practice-configured facilities as well as help sort the results.
name string The facility to search for. This can include the name or address of the facility, in space delimited form
patientid integer Used to help determine which matches to return based on distance to patient and practice.
ordertype string The type of facility to search for.

Output Parameters

Expand all
address string The physical address of the facility
city string The city of the facility
distance string How far the facility is from the department or patient (if patientid is given), in miles.
facilityid integer The athena ID of this facility, to be used when adding orders
faxnumber string The fax number of the facility
name string The name of the facility
ncpdpid integer The NCPDP ID of the given facility, if applicable.
pharmacytype string For pharmacies, whether this is a RETAIL or MAILORDER pharmacy.
phonenumber string The phone number of the facility
state string The state of the facility
zipcode string The zip code of the facility
Example Code