Get a list of Claims
GET {{baseUrl}}/api/v2/Claim?patient=<integer>&practiceId=<integer>&created-start-date=<dateTime>&procedure-codes=<string>&procedure-codes=<string>&appointment=<integer>&service-end-date=<dateTime>&providerId=<integer>&departmentId=<integer>&created-end-date=<dateTime>&service-start-date=<dateTime>&include=<string>&_count=<integer>&_offset=<integer>
Overview:
Retrieves detailed information on claims, enabling healthcare developers to access and display real-time data regarding the status and details of medical claims for streamlined financial management within clinical workflows.
This is only supported in ATHENA.
Use Cases:
Patient Billing Review: Surface historical billing
Revenue Cycle Monitoring: Download status snapshots
Fraud, Waste Abuse Screening: Access details requiring investigation
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
patient | string | (Required) The patient identifier associated with the claim. | |
practiceId | string | (Required) The practice identifier | |
created-start-date | string | Start date of when the record was created (inclusive) | |
procedure-codes | string | List of procedure codes to filter | |
procedure-codes | string | List of procedure codes to filter | |
appointment | string | The appointment identifier | |
service-end-date | string | End date of the service (inclusive) | |
providerId | string | The provider's identifier | |
departmentId | string | The department's identifier | |
created-end-date | string | End date of when the record was created (inclusive) | |
service-start-date | string | Start date of the service (inclusive) | |
include | string | Fields to include in the response | |
_count | string | Number of results to return | |
_offset | string | Offset for paginated results |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
x-source-id | string | (Required) The source id provided for connecting to the data source | |
Authorization | string |
RESPONSES
status: OK
[{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","billablePeriod":{"end":"\u003cdateTime\u003e"},"use":"\u003cstring\u003e","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"}]},"provider":{"reference":"\u003cstring\u003e"},"insurance":[{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}},{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}}],"procedure":[{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"diagnosis":[{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","billablePeriod":{"end":"\u003cdateTime\u003e"},"use":"\u003cstring\u003e","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"}]},"provider":{"reference":"\u003cstring\u003e"},"insurance":[{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}},{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}}],"procedure":[{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"diagnosis":[{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}]}}]}},{"context":{"requestId":"\u003cstring\u003e","source":"\u003cstring\u003e","quorum":"\u003cboolean\u003e","notify":"\u003cboolean\u003e"},"data":{"resourceType":"\u003cstring\u003e","type":"\u003cstring\u003e","total":"\u003cinteger\u003e","entry":[{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","billablePeriod":{"end":"\u003cdateTime\u003e"},"use":"\u003cstring\u003e","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"}]},"provider":{"reference":"\u003cstring\u003e"},"insurance":[{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}},{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}}],"procedure":[{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"diagnosis":[{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}]}},{"resource":{"resourceType":"\u003cstring\u003e","id":"\u003cstring\u003e","patient":{"reference":"\u003cstring\u003e"},"status":"\u003cstring\u003e","created":"\u003cdateTime\u003e","billablePeriod":{"end":"\u003cdateTime\u003e"},"use":"\u003cstring\u003e","type":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e"}]},"provider":{"reference":"\u003cstring\u003e"},"insurance":[{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}},{"coverage":{"reference":"\u003cinteger\u003e","extension":[{"valueString":"\u003cstring\u003e"},{"valueString":"\u003cstring\u003e"}]}}],"procedure":[{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"procedureCodeableConcept":{"coding":[{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"diagnosis":[{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"id":"\u003cstring\u003e","diagnosisCodeableConcept":{"coding":[{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"},{"system":"\u003cstring\u003e","code":"\u003cstring\u003e","display":"\u003cstring\u003e"}]},"type":[{"text":"\u003cstring\u003e"},{"text":"\u003cstring\u003e"}],"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}],"extension":[{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueInteger":"\u003cinteger\u003e","valueString":"\u003cstring\u003e"}],"contained":[{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]},{"resourceType":"\u003cstring\u003e","id":"\u003cinteger\u003e","code":{"coding":[{"code":"\u003cstring\u003e"},{"code":"\u003cstring\u003e"}]},"extension":[{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"},{"url":"\u003cstring\u003e","valueString":"\u003cstring\u003e"}]}]}}]}}]