PATCH api/v1/{EMRSystem}/PriorAuthorizations/{PriorAuthorizationId}
Patches a Prior Authorization in a patient's chart.
Status: Beta
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| PriorAuthorizationId |
The Prior Authorization identifier. |
string |
Required |
| EMRSystem |
The emr system. |
EMRSystem |
None. |
Body Parameters
UdmPriorAuthorizationPatchRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
Identifier of the user updating the prior authorization |
string |
Required |
| PriorAuthorization |
The updated prior authorization |
PriorAuthorizationPatch |
Required |
Header Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginId |
Gets or sets the login identifier. This Login Id will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| Password |
Gets or sets the password. This Password will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if EMRSystem = Allscripts, or Athena, or Cerner, or Meditech, or Sandbox |
| EmrInstance |
Gets or sets the emr instance. This emr instance info will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| ApplicationName |
Gets or sets the requesting application name. This requesting application name will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Required if using application keys |
| ApplicationKey |
Gets or sets the requesting application key. This requesting application key will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
Data type: Password Required if using application keys |
| AuthorizationToken |
Gets or sets the custom authorization token. This requesting authorization token will be encrypted and passed in Sansoro specific Http Request Headers. |
string |
None. |
| RequestVerboseLogging |
Enables verbose logging for a single request. When "true", verbose logging will occur. When "false", the configuration setting will be respected. This value will be passed in Sansoro specific Http Request Headers. |
boolean |
None. |
Request Formats
application/json
{
"UserId": "sample string 2",
"PriorAuthorization": {
"StatusId": "sample string 1",
"AuthorizationNumber": "sample string 2",
"AuthorizationStartDate": "2025-12-12T21:02:48.2982272+00:00",
"AuthorizationEndDate": "2025-12-12T21:02:48.2983172+00:00",
"Comment": "sample string 3",
"NoteText": "sample string 4",
"AuthorizationRequiredId": "sample string 5",
"AuthorizationAgency": "sample string 6",
"TypeId": "sample string 7",
"Phone": {
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
},
"ProvidersType": [
{
"ProviderId": "sample string 1",
"ProviderType": "sample string 2",
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"TypeId": "sample string 8",
"County": "sample string 9",
"Country": "sample string 10"
},
"Email": "sample string 3",
"NPI": "sample string 4",
"LicenseNumber": "sample string 5",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
}
],
"InternalSequence": "sample string 6"
},
{
"ProviderId": "sample string 1",
"ProviderType": "sample string 2",
"Address": {
"AddressId": "sample string 1",
"Address1": "sample string 2",
"Address2": "sample string 3",
"Address3": "sample string 4",
"City": "sample string 5",
"State": "sample string 6",
"ZIP": "sample string 7",
"TypeId": "sample string 8",
"County": "sample string 9",
"Country": "sample string 10"
},
"Email": "sample string 3",
"NPI": "sample string 4",
"LicenseNumber": "sample string 5",
"Phones": [
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
},
{
"PhoneId": "sample string 1",
"Number": "sample string 2",
"TypeId": "sample string 3",
"Extension": "sample string 4",
"FormatId": "sample string 5",
"Contact": "sample string 6"
}
],
"InternalSequence": "sample string 6"
}
]
},
"LoginId": "sample string 4",
"Password": "sample string 5",
"EmrInstance": "sample string 6",
"ApplicationName": "sample string 7",
"ApplicationKey": null,
"AuthorizationToken": "sample string 9",
"RequestVerboseLogging": true,
"EMRSystem": 0
}
Response Information
None.
Response Codes
Http Status Code 204 - Indicates that the request was processed successfully.
Http Status Code 400 - Indicates that the request did not contain all the required fields or had an invalid value.
Http Status Code 401 - Indicates that authentication to the underlying EMR server using the provided LoginId and Password failed.
Http Status Code 403 - Indicates that there is an issue with the request UserId.
Http Status Code 408 - Indicates that the request to the underlying EMR server timed out.
Http Status Code 500 - Indicates that an internal server error occurred during processing of the request.
Http Status Code 502 - Indicates that a request made to the underlying EMR server could not be completed.
Response Formats
application/json
null