ABN Service API

ABN Service

Server

Endpoints that evaluate Medicare ABN requirements and return estimated non-covered costs and optional ABN PDFs.


Check ABN requirement by test codes

POST
https://abn.services.{domain}
/checkAbnByTestCodes

Evaluates whether an ABN is required for the given account, tests, and diagnoses. Returns 200 when outputType is "Success" (case-insensitive). Any other outputType is returned as 500 with outputType set to "FAILURE".

Check ABN requirement by test codes › Request Body

Request payload for /checkAbnByTestCodes.
accountNumber
​string · required

Labcorp account number identifying the ordering provider.

testCodes
​string[] · required

Test codes to evaluate.

diagCodes
​string[] · required

Diagnosis codes (typically ICD-10) for the lab work.

patientName
​string · required

Patient name as it should appear on the ABN PDF.

identificationNumber
​string

Identifier printed on the ABN PDF to correlate with lab/clinic records. Truncated to 20 characters when rendered into the PDF.

sourceName
​string

Identifies the source making the request; included in logs. Truncated to 15 characters downstream.

sourceVersion
​string

Version of the calling software; included in logs. Truncated to 20 characters downstream.

includeABNContent
​boolean | null

When true, the response includes a base64-encoded ABN PDF in abnContents.

includeDetails
​boolean | null

When true, the response includes per-test detail in abnTests.

nbrOfPrintCopies
​integer · int32

Retained for backward compatibility; value is ignored by the service.

Check ABN requirement by test codes › Responses

Successful ABN evaluation. Body includes outputType = "Success", the required-or-not flag, the estimated cost, optional per-test detail, optional base64-encoded ABN PDF in abnContents, and any service messages.

Body returned on the 200 (success) path.
outputType
​string

"Success" on the 200 path. Other values are returned as 500 with outputType set to "FAILURE".

isABNRequired
​boolean | null

True when an ABN is required for this combination.

estCost
​integer · int32

Estimated cost not covered by Medicare.

abnContents
​string

Base64-encoded ABN PDF. Populated only when includeABNContent was true in the request.

contentType
​string

MIME content type of abnContents when present.

​AbnTest[]

Per-test breakdown. Populated when includeDetails was true.

nonSpecificDiagnosisCodes
​string[]

Submitted diagnosis codes that are too non-specific to support medical necessity.

invalidDiagnosisCodes
​string[]

Submitted diagnosis codes that are not recognized.

​Message[]

Informational, warning, or error messages from the service.