Endpoints for preauthorization processes.
Fetches a preauthorization
Fetches an existing preauthorization linked to the consent token provided
Related documentation: Understanding Preauth Statuses, Preauths Process Overview
query Parameters
consent_tokenconsent token linked to the preauth
Fetches a preauthorization › Responses
Preauthorization retrieved successfully
accessPointanaesthesiaTypeauthorizationcarcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeisElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNamepreauthTypeproviderConsentproviderCurrencyproviderNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameCreate a preauthorization
Creates a new preauthorization using multipart form data with file uploads
Related documentation: Preauths Process Overview, Understanding Preauths
Create a preauthorization › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: consent_token, intervention_code, service_start +6 more | |
| type = object · requires: consent_token, intervention_code, service_start +13 more | |
| type = object · requires: consent_token, intervention_code, service_start +10 more | |
| type = object · requires: consent_token, intervention_code, service_start +11 more | |
| type = object · requires: consent_token, intervention_code, service_start +12 more | |
| type = object · requires: consent_token, intervention_code, service_start +7 more |
consent_tokenConsent token for authorization. This is the authorization_code received from the Create Virtual Claim endpoint.
intervention_codeIntervention code for the service offered
service_startISO timestamp for when the service started
service_endISO timestamp for when the service ended
List of billed items
List of diagnoses
List of doctors
List of attachments
provider_notification_emailEmail to notify the provider of any updates on the preauthorization request
Create a preauthorization › Responses
Preauthorization created successfully
accessPointanaesthesiaTypeauthorizationcarcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeisElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNamepreauthTypeproviderConsentproviderCurrencyproviderNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameCancel a preauthorization
Cancels an existing preauthorization identified by its consent token and intervention code. Cancellation is only valid while the preauth is in one of these statuses: DRAFT, FINALISED, PENDING_DOCTOR_APPROVAL, or the pending-clarification state.
Related documentation: Cancel Preauth, Understanding Preauth Statuses
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Cancel a preauthorization › Request Body
consent_tokenBeneficiary consent token authorizing the preauthorization to be cancelled.
intervention_codeSHA intervention (benefit package) code of the preauthorization being cancelled.
Cancel a preauthorization › Responses
Preauthorization canceled successfully
accessPointanaesthesiaTypeauthorizationcarcinomaStagingclinicalIndicationscomorbidityconditionCauseconditionEmploymentRelatedconditionOtherRelatedcostPerSessioncountdowncreatedByNamedescriptiondoctorApproveddoctorReviewStatusfinalApprovedAmountguididinterventionCodeisElectiveisEmergencyisHmisPreauthisOncologyisOpticalisRadiologyisRenalisRequestPhaseisResponsePhaseisSurgicallengthOfStaymemberIdentifiermemberIsVipmemberIsVvipmemberNamememberSchememetastasesneedsDoctorApprovalnumberOfPreauthDoctorsRequiredotherMetastasespayerIdentifierpayerInvoiceNopayerNamepreauthTypeproviderConsentproviderCurrencyproviderNameproviderNotificationEmailreasonForAcuteDialysisreasonForSelectingOtherserviceEndserviceStartsessionExpectedDatesessionTypesessionsFrequencysessionsRequiredstatussubmissionDateIn_EATtokentotalEstimatedAmountForPreauthtotalInterimApprovedAmountForPreauthupdatedByNameRemove a diagnosis from a preauthorization
Removes a diagnosis from an existing preauthorization. The ICD diagnosis code to remove (e.g. A09) is supplied in the path; the request body carries the consent token and related identifiers.
Related documentation: Remove Preauth Diagnosis
path Parameters
icd_codeICD diagnosis code to remove
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Remove a diagnosis from a preauthorization › Request Body
consent_tokenConsent token authorising the action on the beneficiary's preauthorisation.
icd_codeICD-10 diagnosis code to remove from the preauthorisation.
intervention_codeSHA intervention code the diagnosis is associated with.
Remove a diagnosis from a preauthorization › Responses
Preauth diagnosis removed successfully
Remove a doctor from a preauthorization
Removes a doctor (practitioner) from an existing preauthorization. The practitioner is identified by their PractitionerRegistrationNumber supplied in the request body.
Related documentation: Remove Preauth Doctor
Headers
X-Facility-IdFacility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.
X-Facility-Id-TypeType of identifier supplied in X-Facility-Id. Currently only fr-code is supported.
Remove a doctor from a preauthorization › Request Body
consent_tokenConsent token authorising the action on the beneficiary's preauthorisation.
intervention_codeSHA intervention code the doctor is associated with.
practitioner_registration_numberRegulatory registration number of the practitioner to remove. Example is dummy data.
Remove a doctor from a preauthorization › Responses
Preauth doctor removed successfully