How does the metadata search work?
Using Metadata Search
The Attachment Status API also supports the use of descriptive information, known as metadata, to check for attachment transactions. You don't need the traceId to search for attachment transactions for a particular claim or a patient. (This search tool is used for any cases where you do not have the Trace ID.) Using metadata search, you can use a range of dates, the patient's name, the provider's name, and so on, as a combination search. Add these search criteria into the request body.
POST https://apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/transactionStatus/metadata
You use an HTTP request body to specify the metadata values to search for transaction records. The request body contains a few mandatory values, along with several optional values to improve query accuracy.
When you have more than one match for a search, the API lists all matching transaction records in one response.
Required Metadata Search Values
All metadata queries must have the following attributes in the request body:
| Field | Definition |
|---|---|
submitterId | The ID number of record for the submitter of the transaction |
transactionReceivedStartDate | The start date for which the transaction was sent |
transactionReceivedEndDate | The date on which the transaction was completed |
Dates must be formatted in YYYY-MM-DD, as in 2021-03-31.
| NOTE: The mandatory Start Date and End Date values define a range, so your request can query for the status of all attachment transactions for the submitter during that time period. You can further focus these queries using the patient's name and other optional metadata values. This query is possible only by metadata search. |
The submitterId is required; it prevents API users from searching for medical information to which they don't have legal access, whether mistakenly or deliberately.
Filtering Metadata Searches
To filter a metadata search query, add one or more of the following optional data attributes:
| Field | Definition |
|---|---|
memberId | The patient's medical ID number |
patientFirstName | The Patient's first name |
patientLastName | The Patient's last name |
providerId | The Medical Provider ID |
providerFirstName | The first name of the medical provider |
providerLastName | The last name of the medical provider |
controlNumber | The generated control number for the medical encounter |
claimEndDate | End date of the medical claim |
claimStartDate | Opening date of the claim |
payerId | Identification number of the Payer to whom the claim is submitted |
To make the search more accurate, add one or two metadata values in the request body:
POST 'https://sandbox.apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/metadata' \
{
"submitterId": "TESTSBMTR11111",
"transactionReceivedEndDate": "2005-05-14",
"transactionReceivedStartDate": "2005-05-11",
"memberId": "0000000001"
}
| NOTE: You'll never use the `traceId` value as a metadata search criteria. |
Add more attributes in the request body to narrow the search if necessary:
POST 'https://sandbox.apigw.changehealthcare.com/medicalnetwork/attachments/status/v1/metadata' \
{
"submitterId": "TESTSBMTR11111",
"transactionReceivedEndDate": "2005-05-14",
"transactionReceivedStartDate": "2005-05-11",
"memberId": "0000000001",
"providerId": "1760854442",
"payerId": "9496"
}
Metadata Search Responses
| Details and Status for a Single Attachment | Description |
|---|---|
| Most of the information that appears in a metadata search record is The
Check the topic Standard Attachment Transaction statusCode Responses for more information about status messages. |
| Status for Multiple Attachments in a Transaction | Description |
|---|---|
| If you send multiple documents for a single transaction, the |
Updated 4 months ago