> ## Documentation Index
> Fetch the complete documentation index at: https://docs.develophealth.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve a Prior Authorization Status Check
> Returns the current state of an asynchronous PA status check.
Only the effective processing method is returned. The requested
`processing_method` from POST is not echoed. If an
`instant_preferred` request falls back, the effective method changes
from `instant` to `standard`.
**Coming soon.** This API may change before launch, including breaking changes.
Retrieve the current state and results of an asynchronous prior authorization
status check.
## Reading the response
The operation `status` is one of:
* `pending`: processing is still underway.
* `completed`: processing finished successfully.
* `failed`: processing stopped and `failure_reason` explains why.
`effective_processing_method` is either `instant` or `standard`. For an
`instant_preferred` request, a change from `instant` to `standard` indicates
that fallback occurred.
`prior_authorizations` is `null` while processing is pending or after it fails.
When processing completes, it is an array of matching prior authorizations. An
empty array means the check completed successfully and no prior authorizations
were found; it is not an error or an inconclusive result.
Each result exposes a normalized `status` of `approved`, `denied`,
`in_progress`, or `other`, along with any available dates and decision notes.
Vendor case IDs, source statuses, PBM names, and medication details are not
returned.
## OpenAPI
````yaml get /pa-status/{id}
openapi: 3.1.0
info:
title: Develop Health Public API
description: Develop Health Public API
version: '1.0'
servers:
- url: https://api.develophealth.ai
security: []
paths:
/pa-status/{id}:
get:
tags:
- public-api
summary: Get a PA status check
description: |-
Get the current state of an asynchronous PA status check.
Only the effective processing method is returned. If an
`instant_preferred` request falls back, it changes from `instant` to
`standard`.
This contract-only stub currently returns 501.
operationId: get_pa_status
parameters:
- name: id
in: path
required: true
schema:
type: string
minLength: 1
description: PA status check ID.
title: Id
description: PA status check ID.
responses:
'200':
description: Current PA status check state.
content:
application/json:
schema:
$ref: '#/components/schemas/GetPaStatusSuccessResponse'
'404':
description: No PA status check exists with the supplied ID.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
'501':
description: PA status checking is not yet implemented.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiErrorResponseV2'
security:
- FronteggJWTAuthentication: []
components:
schemas:
GetPaStatusSuccessResponse:
properties:
status:
type: string
const: success
title: Status
default: success
error:
type: 'null'
title: Error
data:
$ref: '#/components/schemas/GetPaStatusResponseData'
type: object
required:
- data
title: GetPaStatusSuccessResponse
description: Successful response to GET /pa-status/{id}.
ApiErrorResponseV2:
properties:
status:
type: string
const: error
title: Status
default: error
error:
$ref: '#/components/schemas/ApiErrorV2'
data:
type: 'null'
title: Data
type: object
required:
- error
title: ApiErrorResponseV2
description: V2 version of ApiErrorResponse using Pydantic v2.
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
GetPaStatusResponseData:
properties:
id:
type: string
minLength: 1
title: Id
description: Identifier used to poll the PA status GET endpoint.
object:
type: string
const: pa_status
title: Object
effective_processing_method:
type: string
enum:
- instant
- standard
title: Effective Processing Method
description: >-
Method currently running, that completed the operation, or that was
most recently attempted before failure.
status:
type: string
enum:
- pending
- completed
- failed
title: Status
failure_reason:
anyOf:
- $ref: '#/components/schemas/PaStatusFailureReason'
- type: 'null'
description: >-
Failure details when status is failed; otherwise null. The failure
code corresponds to the effective processing method.
prior_authorizations:
anyOf:
- items:
$ref: '#/components/schemas/PaStatusPriorAuthorization'
type: array
- type: 'null'
title: Prior Authorizations
description: >-
Null while the operation is pending or failed. When the operation is
completed, this is always an array. An empty array means the check
completed successfully and no prior authorizations were found for
the requested patient, NDC, and insurance information.
additionalProperties: false
type: object
required:
- id
- object
- effective_processing_method
- status
- failure_reason
- prior_authorizations
title: GetPaStatusResponseData
description: Response data returned when polling a PA status check.
ApiErrorV2:
properties:
title:
type: string
title: Title
description:
type: string
title: Description
code:
type: string
title: Code
type: object
required:
- title
- description
- code
title: ApiErrorV2
description: V2 version of ApiError using Pydantic v2.
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
type: object
required:
- loc
- msg
- type
title: ValidationError
PaStatusFailureReason:
properties:
code:
type: string
enum:
- instant_pa_status_ineligible
- instant_pa_status_failed
- standard_pa_status_failed
title: Code
message:
type: string
minLength: 1
title: Message
additionalProperties: false
type: object
required:
- code
- message
title: PaStatusFailureReason
PaStatusPriorAuthorization:
properties:
status:
type: string
enum:
- approved
- denied
- in_progress
- other
title: Status
description: >-
Normalized PA status. New, pending, and in-review source statuses
map to in_progress. Other source statuses map to other.
request_date:
anyOf:
- type: string
format: date
- type: 'null'
title: Request Date
decision_date:
anyOf:
- type: string
format: date
- type: 'null'
title: Decision Date
effective_date:
anyOf:
- type: string
format: date
- type: 'null'
title: Effective Date
termination_date:
anyOf:
- type: string
format: date
- type: 'null'
title: Termination Date
expiration_date:
anyOf:
- type: string
format: date
- type: 'null'
title: Expiration Date
decision_notes:
anyOf:
- type: string
- type: 'null'
title: Decision Notes
additionalProperties: false
type: object
required:
- status
title: PaStatusPriorAuthorization
description: Prior authorization found for the requested NDC.
securitySchemes:
FronteggJWTAuthentication:
type: http
scheme: bearer
bearerFormat: JWT
description: >-
Bearer authentication header of the form `Bearer `, where
`` is your auth token.
````