The identity and technical contract details declared by the specification.
DrugHistoryItem
object
Represents information about a currently or previously taken drug.
1 property
1 required
Diagnosis
object
Represents a medical diagnosis with a code and description.
1 property
1 required
InsuranceDocumentInfo
object
3 properties
2 required
PriorAuthSubmissionDenialOutcome
object
4 properties
BenefitVerificationMethodInfo
object
Represents the verification method used in a benefit verification response.
4 properties
2 required
DoseForm
string
An enumeration.
PatientCoverageStatus
string
An enumeration.
CreateBenefitVerificationResponseData
object
Represents the data contained in the response for a create benefit verification request.
1 property
1 required
Gender
string
An enumeration.
DrugCoverageDeterminationDetails
object
3 properties
RouteOfAdministration
string
See: https://www.fda.gov/industry/structured-product-labeling-resources/route-administration
PriorAuthOutcomeDenialDetail
string
An enumeration.
UnqualifiedReason
object
Represents the reason why a drug is not eligible for a clinical qualification check. More structured fields will be added to this model in the future.
1 property
1 required
TriggerBenefitVerificationConfig
object
2 properties
1 required
TriggerBenefitVerificationMedication
object
2 properties
2 required
PriorAuthSubmissionOtherOutcome
object
3 properties
PriorAuthActivityLogFollowUpCall
object
4 properties
3 required
CreateClinicalQualificationResponse
object
Models the response received upon creating a clinical qualification request.
3 properties
RealTimeBenefitsCheckResponse
object
3 properties
1 required
CreatePriorAuthResponseError
object
4 properties
2 required
ProviderIdentitySchema
object
Identity fields surfaced from a registry record.
10 properties
4 required
PriorAuthSubmissionNotSubmittedOutcome
object
3 properties
ApiResponse_ProviderLookupResponse_
object
3 properties
PriorAuthOutcomeOtherDetailPublic
string
Public version of PriorAuthOutcomeOtherDetail. This is used in the API response.
Prescription
object
Represents a prescription issued by a healthcare provider. Prefer CodedPrescription when NDCs are available.
10 properties
8 required
ClientInsuranceDocumentErrorDetailCode
string
An enumeration.
ProviderInfo
object
Contains information about a healthcare provider.
7 properties
4 required
MockResult
object
2 properties
2 required
DrugCoverage
string
An enumeration.
PrescriptionTransferConfirmationAttempt
object
2 properties
2 required
ScannedContent
object
10 properties
DrugCoverageInfo
object
Represents information about a specific drug.
11 properties
3 required
Priority
integer
Represents a priority level. Lower numbers are higher priority. - CRITICAL: 0 - HIGH: 1 - MEDIUM: 2 - LOW: 3
Pharmacy
object
Represents a pharmacy. Attributes: name (str): The name of the pharmacy. address (Address): The pharmacy's postal address.
2 properties
1 required
PriorAuthFeedbackResponse
object
Response returned after feedback has been accepted.
3 properties
GetClinicalQualificationResponseData
object
12 properties
7 required
UpdateNDPSubmissionResponseData
object
Data payload returned after a successful NDP submission update.
1 property
ProviderLookupStatus
string
Outcome of a provider lookup or search.
EvidenceItem
object
Represents an item of evidence, which can include an associated digital asset.
4 properties
2 required
PracticeLocation
object
A single practice location: postal address paired with the contact methods (phone/fax) the registry reports for that address. Fax matters for prior authorizati…
3 properties
1 required
GetPriorAuthResponseData
object
29 properties
8 required
PriorAuthMockResultNotSubmitted
object
Represents a mock result where the prior authorization was NOT submitted because the eligibility check either encountered an error or revealed the patient has…
2 properties
PriorAuthOutcomeApprovalDetail
string
An enumeration.
api__schemas__platform__public_api__provider__AuthorizedProviderResponse
object
Represents an authorized provider with their authorization status. If signedat is null, the authorization is pending.
8 properties
3 required
AuthorizeProviderRequest
object
Represents a request for authorizing a provider.
7 properties
3 required
PriorAuthMockResultApproved
object
Represents a mock result for a prior authorization request.
3 properties
ApiResponse_list_api.schemas.platform.public_api.provider.AuthorizedProviderResponse__
object
3 properties
PriorAuthOutcomeNotSubmittedDetail
string
An enumeration.
CodedDrugInfo
object
Like DrugInfo, but more closely aligned with NCPDP standards. Helps reduce any confusion on the payer-side.
2 properties
2 required
FailureDetails
object
Represents status details about a failed benefit verification.
5 properties
1 required
DrugPriorAuthorizationRequirement
string
An enumeration.
AppealLetter
object
An appeal letter file to include with the appeal submission.
3 properties
3 required
ClinicalQualificationResultStatus
string
The status of a clinical qualification check.
PriorAuthRequestStatus
string
The status of a prior authorization request.
PriorAuthErrorCode
string
Public version of PriorAuthErrorCode. This is used in the API response.
PriorAuthRequestNDPSubmission
object
Configuration for processing the prescription associated with this PA request. This field should only be provided when a prescription has been sent to Develop…
5 properties
2 required
RealTimeBenefitsCheckAlternative
object
4 properties
3 required
CoverageDetailCode
string
An enumeration.
ClientOtherErrorDetailCode
string
An enumeration.
PriorAuthSubmissionPendingOutcome
object
3 properties
2 required
api__schemas__platform__public_api__insurance_document__InsuranceDocument
object
Represents an insurance document. Attributes: filecontent (str): The content of the insurance document, base64 encoded
1 property
1 required
CreateBenefitVerificationResponse
object
Models the response received upon creating a benefit verification request.
3 properties
ReviewStatus
string
An enumeration.
HTTPValidationError
object
1 property
DrugInfo
object
Represents information about a specific drug.
4 properties
3 required
ClientErrorCode
string
An enumeration.
ClinicalQualificationResult
object
3 properties
2 required
Patient
object
Represents patient information.
9 properties
6 required
CreateClinicalQualificationRequest
object
Represents a request for creating a clinical qualification check for a list of medications. This includes detailed information about the patient, their diagnos…
8 properties
5 required
UpdateNDPSubmissionRequest
object
Request to update the NDP submission details of a prior authorization. Currently only supports updating the preferred pharmacy NCPDP ID.
1 property
PlatformMessage
object
A message within a message thread.
7 properties
6 required
DrugHistory
object
Represents the history of drugs taken by a patient.
2 properties
api__schemas__platform__public_api__benefit_verification__InsuranceDocument
object
Represents an insurance document.
1 property
1 required
PatientPlanFundSource
string
The source of the patient's plan funding.
PlatformMessageThread
object
A thread of messages related to this prior authorization.
2 properties
2 required
MockResultCase
string
An enumeration.
EligibilityCheckResponseErrorItem
object
4 properties
3 required
PriorAuthSubmissionApprovalOutcome
object
5 properties
ResponseEvidenceItem
object
Represents an item of evidence, which can include an associated digital asset.
4 properties
2 required
CancelPriorAuthResponse
object
Represents the response structure for a POST /prior-authorization/:id/cancellation request. This response is returned when a prior authorization is successfull…
3 properties
PrescriptionTransferAttempt
object
2 properties
1 required
PriorAuthMockResultOther
object
Represents a mock result for a prior authorization request.
3 properties
DenialReasonAnalysis
object
Summary of why a prior authorization was denied.
4 properties
4 required
CreatePriorAuthResponseData
object
Represents the data contained in the response for a create prior authorization request.
1 property
1 required
PrescriptionTransferErrorCode
string
An enumeration.
CreatePriorAuthResponse
object
Models the response received upon creating a prior authorization request.
3 properties
GetPriorAuthResponse
object
Represents the response structure for a GET /prior-authorization/:id request. This class extends the generic ApiResponse, specifically tailored to handle respo…
3 properties
ValidationError
object
3 properties
3 required
EligibilityCheckResponseSuccessItem
object
8 properties
1 required
CreatePriorAuthRequest
object
Represents a request for creating a prior authorization for a medication. This includes detailed information about the patient, their diagnosis, prescribed med…
16 properties
3 required
BenefitVerificationStatus
string
An enumeration.
PriorAuthFeedbackRequest
object
Payload for submitting feedback related to a prior authorization request.
2 properties
2 required
ProviderLookupResponse
object
Response shape for POST /provider/lookup. The fields populated depend on status: - active: individual is set; candidates is empty. - deactivated: individual is…
3 properties
1 required
GetBenefitVerificationResponse
object
Represents the response structure for a benefit verification query in a healthcare context. This class extends the generic ApiResponse, specifically tailored t…
3 properties
OptionalAddress
object
Represents a postal address with optional fields. Used for cases where address information may not be complete at creation time.
6 properties
PriorAuthActivityLogSentFax
object
4 properties
3 required
EligibilityCheckActionCode
string
Action code indicating the action suggested by the payer in the error case
PriorAuthActivityLogReceivedFax
object
4 properties
3 required
PrescriptionTransferConfirmationAttemptOutcome
string
An enumeration.
CreateClinicalQualificationResponseData
object
Represents the data contained in the response for a create clinical qualification request.
1 property
1 required
VisitNote
object
Represents a note made during a patient visit.
3 properties
2 required
CreateBenefitVerificationRequest
object
Models a request to create a benefit verification.
12 properties
3 required
Asset
object
2 properties
CancelPriorAuthPrescriptionTransferResponse
object
Represents the response structure for a POST /prior-authorization/:id/prescription-transfer/cancel request. This response is returned when a prior authorizatio…
3 properties
PriorAuthActivityLogFollowUpCallDetails
object
3 properties
PrescriptionTransfer
object
Information about prescription transfer status and attempts
5 properties
1 required
PriorAuthMockResultDenied
object
Represents a mock result for a prior authorization request.
3 properties
Provider
object
Represents a healthcare provider.
7 properties
4 required
PlatformMessageAttachment
object
3 properties
3 required
DocType
string
An enumeration.
PatientCoverageType
string
The type of coverage the patient has.
GetClinicalQualificationResponse
object
Represents the response structure for a GET /prior-authorization/:id request. This class extends the generic ApiResponse, specifically tailored to handle respo…
3 properties
EligibilityCheckPlanType
string
An enumeration.
Drug
object
Represents a medication prescribed by a healthcare provider. Prefer CodedDrug when NDCs are available.
9 properties
7 required
ApiError
object
3 properties
3 required
Address
object
Represents a postal address.
6 properties
5 required
AppealDetails
object
Details for submitting an appeal of a previously denied prior authorization.
2 properties
1 required
PriorAuthRequestResubmissionInfo
object
Information provided when resubmitting a prior authorization request.
3 properties
PrescriptionTransferStatus
string
An enumeration.
MockResultStatus
string
An enumeration.
ApiResponse
object
3 properties
api__schemas__platform__public_api__common__PatientInfo
object
Contains information about a patient.
8 properties
6 required
PriorAuthActivityLogFaxDetails
object
1 property
1 required
CopayOption
object
2 properties
ProviderLookupRequest
object
Body for POST /provider/lookup. Either npi or a lastname must be supplied. NPI lookup branches on the registry's status value and may return active, deactivate…
4 properties
EligibilityCheckErrorCode
string
Error code indicating the specific error encountered
Question
object
Represents a single question, as part of a questionnaire.
3 properties
2 required
User
object
3 properties
1 required
GetBenefitVerificationResponseData
object
Represents the data the data contained in the response for a get benefit verification request.
23 properties
11 required
CancelPriorAuthRequest
object
Request to cancel a prior authorization.
1 property
1 required
EntityInfo
object
Contains information about a healthcare entity.
2 properties
CodedPrescription
object
Represents a prescription issued by a healthcare provider. This is an alternative to the Prescription model that is more closely aligned with NCPDP standards a…
8 properties
5 required
PartialInsuranceInfo
object
9 properties
AssetResponse
object
2 properties
2 required
Questionnaire
object
2 properties
2 required
UpdateNDPSubmissionResponse
object
Represents the response structure for a PATCH /prior-authorization/:id/ndp-submission request.
3 properties
The full machine-readable OpenAPI contract behind this narrative.