PATCH api/groups/{groupid}/priorauths/{id}
Patches an existing prior auth
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| groupid |
Group identifier |
integer |
Required |
| id |
PriorAuth identifier |
integer |
Required |
Body Parameters
The json formatted patch document (https://tools.ietf.org/html/rfc6902) containing operations to apply to the target prior auth
JsonPatchDocument| Name | Description | Type | Additional information |
|---|---|---|---|
| Operations | Collection of Operation |
None. |
Request Formats
application/json
Sample not available.
text/json
Sample not available.
application/json-patch+json
Sample not available.
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A patched prior auth resource
PriorAuthorizationModel| Name | Description | Type | Additional information |
|---|---|---|---|
| GroupNo |
Gets or sets Group identifier |
integer |
None. |
| FacilityBranchNo |
Gets or sets the Facility Branch identifier |
integer |
None. |
| FacilityUrl |
Gets or sets the Facility Url |
string |
None. |
| TransactionCode |
Gets or sets the Transaction code |
string |
None. |
| MemberSeqNo |
Gets or sets the Member sequence identifier |
integer |
None. |
| Member |
Gets or sets the Member |
MemberModel |
None. |
| PrescriptionReferenceNumber |
Gets or sets the Prescription reference number |
string |
None. |
| FillNumber |
Gets or sets the Fill number |
integer |
None. |
| ProductID |
Gets or sets the Product identifier |
string |
None. |
| DateOfService |
Gets or sets the Date of Service |
date |
None. |
| SubmittedClaimNumber |
Gets or sets the Submitted Claim number |
string |
None. |
| ResubmittedClaimNumber |
Gets or sets the Resubmitted Claim number |
string |
None. |
| Approved |
Gets or sets the Approved indicator |
boolean |
None. |
| Notes |
Gets or sets the Notes |
string |
None. |
| PriorAuthPersistentNo |
Gets or sets the Prior Auth Presistent identifier |
integer |
None. |
| PriorAuthPersistentUrl |
Gets or sets the Prior Auth Persistent Url |
string |
None. |
| QuantityDispensed |
Gets or sets the Quantity Dispensed |
decimal number |
None. |
| DaysSupply |
Gets or sets the Days supply |
integer |
None. |
| CopayOverride |
Gets or sets the Copay override |
decimal number |
None. |
| CoinsuranceOverride |
Gets or sets the Coinsurance override (Enter the percentage in decimal form (e.g., 0.25 for 25%)) |
decimal number |
None. |
| OverrideTypeNo |
Gets or sets the Override type identifier |
integer |
None. |
| OverrideTypeUrl |
Gets or sets the Override Type Url |
string |
None. |
| VariableCopayAmount |
Gets or sets the Variable Copay Amount |
decimal number |
None. |
| OOPCopayOverride |
Gets or sets the out of pocket Copay Override |
decimal number |
None. |
| OOPCoinsuranceOverride |
Gets or sets the out of pocket Coinsurance Override (Enter the percentage in decimal form (e.g., 0.25 for 25%)) |
decimal number |
None. |
| CopayCardAmount |
Gets or sets the Copay Card Amount |
decimal number |
None. |
| ExemptFromDeductible |
Gets or sets Exempty From Deductible indicator |
boolean |
None. |
| ExemptFromOutOfPocketLimit |
Gets or sets Exempt From Out of Pocket Limit indicator |
boolean |
None. |
| Url |
Gets or sets the link representing a link back to the resource |
string |
None. |
| ID |
Gets or sets the identifier for the resource |
integer |
None. |
Response Formats
application/json, text/json, application/json-patch+json
{
"url": "sample string 11",
"id": 12,
"groupNo": 1,
"facilityBranchNo": 1,
"facilityUrl": "sample string 1",
"transactionCode": "sample string 2",
"memberSeqNo": 1,
"member": {
"url": "sample string 36",
"id": 37,
"salutation": "sample string 1",
"firstName": "sample string 2",
"middleName": "sample string 3",
"lastName": "sample string 4",
"suffix": "sample string 5",
"emailAddress": "sample string 6",
"gender": "sample string 7",
"heightInches": 1,
"ssn": "sample string 8",
"doNotEmail": true,
"doNotPhone": true,
"alternateID": "sample string 11",
"dateOfBirth": "2025-12-09T20:14:31.4072374-06:00",
"comment": "sample string 12",
"birthPlace": "sample string 13",
"occupation": "sample string 14",
"usCitizen": true,
"military": true,
"active": 15,
"memberComment": "sample string 16",
"hasMedicare": true,
"medicareID": "sample string 18",
"medicarePlan": "sample string 19",
"medicareEffectiveDate": "2025-12-09T20:14:31.4072374-06:00",
"locationName": "sample string 20",
"dependantIndicator": "sample string 21",
"criticalComment": "sample string 22",
"identifier": "sample string 23",
"diabetic": true,
"isHospice": true,
"nonCodedAllergies": "sample string 25",
"sentToPharmacy": true,
"cardholderID": "sample string 26",
"secondaryCoverageOnly": true,
"locked": true,
"coverageLevelCode": "CHD - Children Only",
"yearlyHouseholdIncome": 1.0,
"isMDCaresPatient": true,
"personCode": "sample string 27",
"cobra": true,
"isTestMember": true,
"ignoreMemberInfoInClaims": true,
"setMemberInfoNextClaim": true,
"roomNumber": "sample string 31",
"bedNumber": "sample string 32",
"admittedDate": "2025-12-09T20:14:31.4072374-06:00",
"dischargeDate": "2025-12-09T20:14:31.4072374-06:00",
"cardHolderMemberID": 33,
"currentPatientPlan": {
"planContractNo": 1,
"contractCode": "sample string 1",
"contractName": "sample string 2",
"groupID": 1,
"groupPlanNo": 1,
"planName": "sample string 3",
"facilityARTypeNo": 1,
"arShortCode": "sample string 4",
"effectiveStartDate": "2025-12-09T20:14:31.4072374-06:00",
"effectiveEndDate": "2025-12-09T20:14:31.4072374-06:00",
"patientPlanID": 5
},
"homeAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"mailingAddress": {
"addressType": "Business",
"address": "sample string 1",
"addressLineTwo": "sample string 2",
"city": "sample string 3",
"stateCode": "sample string 4",
"zipCode": "sample string 5",
"country": "sample string 6"
},
"clientID": "sample string 34",
"externalID": "sample string 35",
"currentFormulary": {
"url": "sample string 2",
"id": 3,
"name": "sample string 1"
},
"nextFuturePlan": {
"planContractNo": 1,
"contractCode": "sample string 1",
"contractName": "sample string 2",
"groupID": 1,
"groupPlanNo": 1,
"planName": "sample string 3",
"facilityARTypeNo": 1,
"arShortCode": "sample string 4",
"effectiveStartDate": "2025-12-09T20:14:31.4072374-06:00",
"effectiveEndDate": "2025-12-09T20:14:31.4072374-06:00",
"patientPlanID": 5
}
},
"prescriptionReferenceNumber": "sample string 3",
"fillNumber": 4,
"productID": "sample string 5",
"dateOfService": "2025-12-09T20:14:31.4072374-06:00",
"submittedClaimNumber": "sample string 6",
"resubmittedClaimNumber": "sample string 7",
"approved": true,
"notes": "sample string 8",
"priorAuthPersistentNo": 1,
"priorAuthPersistentUrl": "sample string 9",
"quantityDispensed": 1.0,
"daysSupply": 1,
"copayOverride": 1.0,
"coinsuranceOverride": 1.0,
"overrideTypeNo": 1,
"overrideTypeUrl": "sample string 10",
"oopCopayOverride": 1.0,
"oopCoinsuranceOverride": 1.0,
"copayCardAmount": 1.0,
"exemptFromDeductible": true,
"exemptFromOutOfPocketLimit": true
}