Claim Note
Claim note feature allows the user to view, add, and modify notes documented in the claim for a patient.
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Endpoints
- Primary
Create new claim notes
POST
/v1/{practiceid}/claims/{claimid}/note
Creates a new note for a specific claim
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
claimid
integer
claimid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
errormessage
string
If the operation failed, this will contain any error messages.
success
string
Whether the operation was successful.
Example Code
View all notes for a claim
GET
/v1/{practiceid}/claims/{claimid}/claimnotes
Retrieves the list of notes for a specific clinical document
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
claimid
integer
claimid
showholdonly
boolean
Return only claimnotes that currently have a HOLD or HOLD-like status. Defaults to 'false'.
pendingflags
string
Select claimnotes based on pendingflag values. 'All' selects claimnotes with any pendingflag ('Y', 'O', 'N', or null); pending claimnotes have a pendingflag of 'Y'; overridden claimntoes have a pendingflag of 'O'. Default is 'All'.
Output Parameters
Expand all
athenakickcode
string
The athena-internal kick code used to bin biller-submitted kick codes into like groups
athenakickcodename
string
The name for the athena-internal kick code on this claim
claimnote
string
A user-entered value associated with this claim note
claimnoteid
integer
The athena-internal ID given to this claimnote
fixtext
string
A description of why the claim note is active
and preventing the claim from dropping. Sometimes also includes
instructions for fixing the problem causing the hold.
globalclaimruleid
integer
The athena-internal ID for a global rule on this claim note
globalclaimrulename
string
The athena-internal name for a global rule on this claim note
kickcode
integer
The kick code returned from the biller
kickcodename
string
The athena-internal name for a kick code on this claim
kickcodenextsteps
string
The next steps associated with this kick code
localclaimruleid
integer
The athena-internal ID for a local rule on this claim note
localclaimrulename
string
The athena-internal name for a local rule on this claim note
networkclaimruleid
integer
The athena-internal ID for a network rule on this claim note
networkclaimrulename
string
The athena-internal name for a network rule on this claim note
overrideable
string
Whether the claim is overridable. Either 'Y' or null
pendingflag
string
The status of whether this claim is pending. One of 'Y', 'N', 'O' or null
status
string
The claim status as a result of this claim note. Can be different across claim notes
Example Code
Update/Override existing note for a claim
PUT
/v1/{practiceid}/claims/{claimid}/claimnotes/override
Modifies an existing note for a specific claim
Was this information helpful?
Yes | No
Thank you for your feedback!
What went wrong?
Incomplete or incorrect information |
Irrelevant Content
| Others
Submit
Input Parameters
Expand all❙ required
practiceid
integer
practiceid
claimid
integer
claimid
Content-Type
string
Content type of the payload
❙ Request Body
Expand allOutput Parameters
Expand all
overrides
string
Number of claimnotes overridden
success
string
Whether the operation was successful.
Example Code