Troubleshoot APIs with Metadata

Metadata for troubleshooting

Optum Medical Network APIs support a troubleshooting feature called metadata.

📘
NOTE
API users need not enable this capability; it is automatic and has no effect on information in any medical transaction. The meta object obtains its data from the request headers and the transaction token. If you encounter any issues with a transaction and need to work with the Optum technical support team, give the values provided in the meta object to the Optum representative.

JSON Response Object Description

{ "meta": { "submitterId": "999898", "senderId": "Xxxx.Xxxxxx", "billerId": "009998", "traceId": "900773a9-c0ba-6aa2- 0f61-cfcc30a0200f", "outboundTraceId": "7894445309", "applicationMode": "prod" }, Upon request, give this entire object to Optum support for troubleshooting. All values listed in the meta object are automatically taken from the API request header or from the secure token, with the exception of the outboundTraceId, which is taken from the request header at the beginning of the transaction set (BHT segment, BHT03 element), as the submitterTransactionIdentifier header field.

In the meta object, we use OutboundTraceId for point-to-point tracing and the clearinghouse returns it to the submitter for their use whenever needed.

When they appear, consider the IDs in the metadata object as a hierarchy from less specific to most specific:
submitterId as least specific
senderId denoting the API customer
billerId as the customer medical department that is responsible for the billing ApplicationMode describes the operating environment, which for API customers will either be production ("prod") or sandbox.

JSON Response Object	Description
`{ "meta": { "submitterId": "999898", "senderId": "Xxxx.Xxxxxx", "billerId": "009998", "traceId": "900773a9-c0ba-6aa2- 0f61-cfcc30a0200f", "outboundTraceId": "7894445309", "applicationMode": "prod" },`	Upon request, give this entire object to Optum support for troubleshooting. All values listed in the meta object are automatically taken from the API request header or from the secure token, with the exception of the `outboundTraceId`, which is taken from the request header at the beginning of the transaction set (BHT segment, BHT03 element), as the `submitterTransactionIdentifier` header field. In the `meta` object, we use `OutboundTraceId` for point-to-point tracing and the clearinghouse returns it to the submitter for their use whenever needed. When they appear, consider the IDs in the metadata object as a hierarchy from less specific to most specific: `submitterId` as least specific `senderId` denoting the API customer `billerId` as the customer medical department that is responsible for the billing `ApplicationMode` describes the operating environment, which for API customers will either be production ("prod") or sandbox.

Here are some general troubleshooting tips:

Check the headers for any typos or unexpected values.
Validate your JSON to make sure it is properly formatted.
Try the healthcheck endpoint to make sure the API is up and running.
Check out our pre-formatted Postman collections in the documentation to compare values and troubleshoot differences.

If you still experience issues, send over the headers and body of the request, and we will troubleshoot in depth.

Related Topics

Updated 2 months ago

Metadata for troubleshooting

📘NOTE

📘
NOTE