Plan Diagnosis Age Restrictions

Create PlanDiagnosisAge

Creates a new PlanDiagnosisAge

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
planDiagnosisAge_Key
required
integer <int32>

Unique identifier for each Diagnosis Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.

age_Range_Type
string or null <= 1 characters

Specifies whether the associated age range is in days, months, or years.

age_Type
string or null <= 16 characters

Adjudication will apply the rule if the Patient falls outside of the specified range based upon the designated criteria: 1. Birth Date - age is specified by looking at the Patient's day of birth. 2. End of Birth Month - age is specified based upon the full birth month. For example, if the Patient is turning 18 on September 12th, adjudication won't consider the Patient to be 18 until October 1st. 3. Ignore Age - defauls the rule to only being based upon the diagnosis code.

diagnostic_Code_Type
required
string [ 1 .. 16 ] characters

Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.

entry_Date
string <date-time>

Date when the record was added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

ex_Code
string or null <= 6 characters

Specifies the Ex Code that will be applied based upon the designated criteria.

from_Age
integer or null <int32>

Start of the range of Ages.

from_Diag
required
string [ 1 .. 8 ] characters

Start of the range of Diagnosis Codes.

plan_ID
required
string [ 1 .. 20 ] characters

References the Plans.Plan_ID value in parent table.

thru_Age
integer or null <int32>

End of the range of Ages.

thru_Diag
required
string [ 1 .. 8 ] characters

End of the range of Diagnosis Codes.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

Responses
200

Success

401

Unauthorized

post/plans/{planID}/diagnosis-age-restrictions
Request samples
{
  • "planDiagnosisAge_Key": 0,
  • "age_Range_Type": "s",
  • "age_Type": "string",
  • "diagnostic_Code_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "from_Diag": "string",
  • "plan_ID": "string",
  • "thru_Age": 0,
  • "thru_Diag": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List PlanDiagnosisAge

Lists all PlanDiagnosisAge for the given planID

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
planID
required
string

Plan ID

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/plans/{planID}/diagnosis-age-restrictions
Request samples 
Response samples 
No sample
Get PlanDiagnosisAge
Gets PlanDiagnosisAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDiagnosisAgeKey
required
integer <int32> 
PlanDiagnosisAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/plans/{planID}/diagnosis-age-restrictions/{planDiagnosisAgeKey}
Request samples 
Response samples 
No sample
Update PlanDiagnosisAge
Updates a specific PlanDiagnosisAge.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDiagnosisAgeKey
required
integer <int32> 
PlanDiagnosisAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
planDiagnosisAge_Key
required
integer <int32> 
Unique identifier for each Diagnosis Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Range_Type
string or null  <= 1 characters 
Specifies whether the associated age range is in days, months, or years.


 
age_Type
string or null  <= 16 characters 
Adjudication will apply the rule if the Patient falls outside of the specified range based upon the designated criteria: 1. Birth Date - age is specified by looking at the Patient's day of birth. 2. End of Birth Month - age is specified based upon the full birth month. For example, if the Patient is turning 18 on September 12th, adjudication won't consider the Patient to be 18 until October 1st. 3. Ignore Age - defauls the rule to only being based upon the diagnosis code.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that will be applied based upon the designated criteria.


 
from_Age
integer or null <int32> 
Start of the range of Ages.


 
from_Diag
required
string  [ 1 .. 8 ] characters 
Start of the range of Diagnosis Codes.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
thru_Age
integer or null <int32> 
End of the range of Ages.


 
thru_Diag
required
string  [ 1 .. 8 ] characters 
End of the range of Diagnosis Codes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
200
Success


401
Unauthorized


put/plans/{planID}/diagnosis-age-restrictions/{planDiagnosisAgeKey}
Request samples 
{
  • "planDiagnosisAge_Key": 0,
  • "age_Range_Type": "s",
  • "age_Type": "string",
  • "diagnostic_Code_Type": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "ex_Code": "string",
  • "from_Age": 0,
  • "from_Diag": "string",
  • "plan_ID": "string",
  • "thru_Age": 0,
  • "thru_Diag": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete PlanDiagnosisAge
Deletes an PlanDiagnosisAge


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
planID
required
string
Plan ID


 
planDiagnosisAgeKey
required
integer <int32> 
PlanDiagnosisAge Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/plans/{planID}/diagnosis-age-restrictions/{planDiagnosisAgeKey}
Request samples 
Create or Update Batch PlanDiagnosisAge
Create or Update multiple PlanDiagnosisAge 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
planID
required
string
Plan ID


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
planDiagnosisAge_Key
required
integer <int32> 
Unique identifier for each Diagnosis Age rule. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
age_Range_Type
string or null  <= 1 characters 
Specifies whether the associated age range is in days, months, or years.


 
age_Type
string or null  <= 16 characters 
Adjudication will apply the rule if the Patient falls outside of the specified range based upon the designated criteria: 1. Birth Date - age is specified by looking at the Patient's day of birth. 2. End of Birth Month - age is specified based upon the full birth month. For example, if the Patient is turning 18 on September 12th, adjudication won't consider the Patient to be 18 until October 1st. 3. Ignore Age - defauls the rule to only being based upon the diagnosis code.


 
diagnostic_Code_Type
required
string  [ 1 .. 16 ] characters 
Specifies the numbering system used for the selected Diagnosis Codes. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
entry_Date
string <date-time> 
Date when the record was added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
ex_Code
string or null  <= 6 characters 
Specifies the Ex Code that will be applied based upon the designated criteria.


 
from_Age
integer or null <int32> 
Start of the range of Ages.


 
from_Diag
required
string  [ 1 .. 8 ] characters 
Start of the range of Diagnosis Codes.


 
plan_ID
required
string  [ 1 .. 20 ] characters 
References the Plans.Plan_ID value in parent table.


 
thru_Age
integer or null <int32> 
End of the range of Ages.


 
thru_Diag
required
string  [ 1 .. 8 ] characters 
End of the range of Diagnosis Codes.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
Responses 
207
Success


401
Unauthorized


put/plans/{planID}/diagnosis-age-restrictions-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}