Care Case Authorizations

Create CareCaseAuth

Creates a new CareCaseAuth

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
caseKey
required
integer <int32>

Case Key

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
careCaseAuth_Key
required
integer <int32>
approved
string or null
authorization_Number
string or null <= 50 characters
careSite_ID
integer or null <int32>
case_Key
integer or null <int32>
comment
string or null
disclaimer_Given
boolean or null
end_Date
string or null <date-time>
entry_Date
string <date-time>
entry_User
string or null <= 20 characters
medical_Concordance_Level
string or null <= 32 characters
notConcordant
string or null
notification
string or null
provider_Info
string or null <= 256 characters
referred_By
string or null <= 256 characters
requested
string or null
start_Date
string or null <date-time>
update_Date
string <date-time>
update_User
string or null <= 20 characters
Responses
200

Success

401

Unauthorized

post/cases/{caseKey}/authorizations
Request samples
{
  • "careCaseAuth_Key": 0,
  • "approved": "string",
  • "authorization_Number": "string",
  • "careSite_ID": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "disclaimer_Given": true,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "medical_Concordance_Level": "string",
  • "notConcordant": "string",
  • "notification": "string",
  • "provider_Info": "string",
  • "referred_By": "string",
  • "requested": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List CareCaseAuth

Lists all CareCaseAuth for the given caseKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
caseKey
required
integer <int32>

Case Key

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/cases/{caseKey}/authorizations
Request samples 
Response samples 
No sample
Get CareCaseAuth
Gets CareCaseAuth


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseAuthKey
required
integer <int32> 
CareCaseAuth Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/cases/{caseKey}/authorizations/{careCaseAuthKey}
Request samples 
Response samples 
No sample
Update CareCaseAuth
Updates a specific CareCaseAuth.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseAuthKey
required
integer <int32> 
CareCaseAuth Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
careCaseAuth_Key
required
integer <int32> 
 
approved
string or null
 
authorization_Number
string or null  <= 50 characters 
 
careSite_ID
integer or null <int32> 
 
case_Key
integer or null <int32> 
 
comment
string or null
 
disclaimer_Given
boolean or null
 
end_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
medical_Concordance_Level
string or null  <= 32 characters 
 
notConcordant
string or null
 
notification
string or null
 
provider_Info
string or null  <= 256 characters 
 
referred_By
string or null  <= 256 characters 
 
requested
string or null
 
start_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
200
Success


401
Unauthorized


put/cases/{caseKey}/authorizations/{careCaseAuthKey}
Request samples 
{
  • "careCaseAuth_Key": 0,
  • "approved": "string",
  • "authorization_Number": "string",
  • "careSite_ID": 0,
  • "case_Key": 0,
  • "comment": "string",
  • "disclaimer_Given": true,
  • "end_Date": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "medical_Concordance_Level": "string",
  • "notConcordant": "string",
  • "notification": "string",
  • "provider_Info": "string",
  • "referred_By": "string",
  • "requested": "string",
  • "start_Date": "2019-08-24T14:15:22Z",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete CareCaseAuth
Deletes an CareCaseAuth


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
careCaseAuthKey
required
integer <int32> 
CareCaseAuth Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/cases/{caseKey}/authorizations/{careCaseAuthKey}
Request samples 
Create or Update Batch CareCaseAuth
Create or Update multiple CareCaseAuth at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
caseKey
required
integer <int32> 
Case Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
careCaseAuth_Key
required
integer <int32> 
 
approved
string or null
 
authorization_Number
string or null  <= 50 characters 
 
careSite_ID
integer or null <int32> 
 
case_Key
integer or null <int32> 
 
comment
string or null
 
disclaimer_Given
boolean or null
 
end_Date
string or null <date-time> 
 
entry_Date
string <date-time> 
 
entry_User
string or null  <= 20 characters 
 
medical_Concordance_Level
string or null  <= 32 characters 
 
notConcordant
string or null
 
notification
string or null
 
provider_Info
string or null  <= 256 characters 
 
referred_By
string or null  <= 256 characters 
 
requested
string or null
 
start_Date
string or null <date-time> 
 
update_Date
string <date-time> 
 
update_User
string or null  <= 20 characters 
 
Responses 
207
Success


401
Unauthorized


put/cases/{caseKey}/authorizations-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}