Appointment Third Party Coding Status

The thirdpartycodingstatus call allows third party coding partners to indicate that they have started work on coding a claim for a given appointment ID. Currently, the only status allowed is "STARTED". The status is shown on the claim. It should be deleted when coding is finished. The third party external data call can be used to store arbitrary data (such as a foreign system appointment ID), up to 4000 characters. Both calls are specific to a particular API key and an appointment ID, so one API user's change in status is not seen by other user's. The third party external data, however, is not displayed to the user in athenaNet; it is just for the API user to store data. Please note that PUT and POST are actually interchangeable for these endpoints.

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

Endpoints

Add appointment third party coding status

POST
/v1/{practiceid}/appointments/{appointmentid}/thirdpartycodingstatus
Add the third party coding status for a specific appointment
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
appointmentid integer appointmentid
Content-Type string Content type of the payload

❙ Request Body

Expand all
status string The status to set this appointment's third party coding status to.

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 appointment third party coding status

GET
/v1/{practiceid}/appointments/{appointmentid}/thirdpartycodingstatus
Retrieves the third party coding status for a specific appointment
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
appointmentid integer appointmentid

Output Parameters

Expand all
status string The current coding status
statuslastmodifieddatetime string The ISO8601 timestamp of when the status was last changed
Example Code

Update appointment third party coding status

PUT
/v1/{practiceid}/appointments/{appointmentid}/thirdpartycodingstatus
Modifies the third party coding status for a specific appointment
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
appointmentid integer appointmentid
Content-Type string Content type of the payload

❙ Request Body

Expand all
status string The status to set this appointment's third party coding status to.

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

Remove appointment third party coding status

DELETE
/v1/{practiceid}/appointments/{appointmentid}/thirdpartycodingstatus
Deletes the record for a specific appointment coding status
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
appointmentid integer appointmentid

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