Create Authorization

Create a new authorization record with associated lines and access records.

The authorization data is specified in the body of the request. The data is a JSON object conforming to the DI file specification for authorizations, authorization lines, and authorization accesses accordingly.  All field names must be lowercase.

If there is an existing data match for the new authorization record, the record is not created. When the call is accepted it returns an operations URL that the requesting client uses to track the status of the request.

Sample Request Format

POST [base URL]/authorization

{
    "authnumber": "",
    "authtype": "",
    "authdecision": "",
    "access":
    [
        {
            "idtype": "",
            "providerid": "",
            "role": ""
        }
    ],

    lines:
    [
        {

            "authlinenumber": "",
            "dosstart": "",
            "dosend": "",
            "hcpcs": "",
            "access":
            [
                {
                    "idtype": "",
                    "providerid": "",
                    "role": ""
                }
            ]
        }
    ]
}

Sample Response Format

HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]
 

Update Authorization

Update an authorization record with associated lines and access records.

This is a sparse update; only fields being changed need to be included.  

The lookup keys for the authorization record to update are included in the query parameters, authnumber.

Any child records being updated (lines, accesses, etc) must include a "record_action" field with the action being taken on them (n - new, m - modify, d - delete).

Child records must also include the appropriate necessary keys.

Sample Request Format
Required key fields are highlighted.
PATCH [base URL]/authorization?authnumber=[authnumber]
{
    "authtype": "",
    "authdecision": "",
    "access":
    [
        {
            "idtype": "",
            "providerid": "",
            "role": "",
            "record_action": "n"
        }
    ],
    lines:
    [
        {
            "authlinenumber": "",
            "dosstart": "",
            "dosend": "",
            "hcpcs": "",
                      "record_action": "m"
            "access":
            [
                {
                    "idtype": "",
                    "providerid": "",
                    "role": "",
                    "action_record": "n"
                }
            ]
        }
    ]
}


Sample Response Format

HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]

Delete Authorization
Delete an authorization record and all associated child records (lines, accesses, etc).
The lookup keys for the authorization record to delete are included in the query parameters, authnumber.
Sample Request Format

DELETE [base URL]/authorization?authnumber=[authnumber]

Sample Response Format

HTTP/1.1 202 Accepted
Operation-Location: [base URL]/operation/[operationId]