Member Care Alerts

Create MemberCareAlert

Creates a new MemberCareAlert

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberCareAlert_Key
required
integer <int32>

Unique identifier for each Member Care Alert record. Note: This field is marked as NOT NULL in the database and therefore required by the API.

alert_Details
string or null <= 1024 characters

A description area used to provide more detail about the care alert.

care_Alert_Status
string or null <= 32 characters

Status of the care alert that will be sent to the Member based upon the alert criteria. The status can be set to either 'Due Soon', 'Past Due', or 'Completed'.

diagnostic_Code
string or null <= 8 characters

Diagnostic code tied to the care alert.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

frequency
integer or null <int32>

Identifies the frequency of the care alert by specifying the number of the associated frequency type that should be used.

frequency_Type
string or null <= 16 characters

Identifies the frequency at which the care alerts should be sent. This can be based upon a certain number of months, an annual basis, or a certain number of years.

last_Service_Date
string or null <date-time>

Identifies the last date that the Member received the service associated with the care alert.

member_Seq
required
string [ 1 .. 2 ] characters

References Members.Member_Seq value on the parent record.

next_Service_Date
string or null <date-time>

Idenfities the next date that the Member is to receive the service associated with the care alert.

procedure_Code
string or null <= 8 characters

Procedure code tied the care alert.

subscriber_ID
required
string [ 1 .. 9 ] characters

References Members.Subscriber_ID value on the parent record.

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/subscribers/{subscriberID}/members/{memberSeq}/care-alerts
Request samples
{
  • "memberCareAlert_Key": 0,
  • "alert_Details": "string",
  • "care_Alert_Status": "string",
  • "diagnostic_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "frequency": 0,
  • "frequency_Type": "string",
  • "last_Service_Date": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "next_Service_Date": "2019-08-24T14:15:22Z",
  • "procedure_Code": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberCareAlert

Lists all MemberCareAlert for the given subscriberID and memberSeq

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

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/subscribers/{subscriberID}/members/{memberSeq}/care-alerts
Request samples 
Response samples 
No sample
Get MemberCareAlert
Gets MemberCareAlert


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCareAlertKey
required
integer <int32> 
MemberCareAlert Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/care-alerts/{memberCareAlertKey}
Request samples 
Response samples 
No sample
Update MemberCareAlert
Updates a specific MemberCareAlert.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCareAlertKey
required
integer <int32> 
MemberCareAlert Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberCareAlert_Key
required
integer <int32> 
Unique identifier for each Member Care Alert record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
alert_Details
string or null  <= 1024 characters 
A description area used to provide more detail about the care alert.


 
care_Alert_Status
string or null  <= 32 characters 
Status of the care alert that will be sent to the Member based upon the alert criteria. The status can be set to either 'Due Soon', 'Past Due', or 'Completed'.


 
diagnostic_Code
string or null  <= 8 characters 
Diagnostic code tied to the care alert.


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


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


 
frequency
integer or null <int32> 
Identifies the frequency of the care alert by specifying the number of the associated frequency type that should be used.


 
frequency_Type
string or null  <= 16 characters 
Identifies the frequency at which the care alerts should be sent. This can be based upon a certain number of months, an annual basis, or a certain number of years.


 
last_Service_Date
string or null <date-time> 
Identifies the last date that the Member received the service associated with the care alert.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
next_Service_Date
string or null <date-time> 
Idenfities the next date that the Member is to receive the service associated with the care alert.


 
procedure_Code
string or null  <= 8 characters 
Procedure code tied the care alert.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/members/{memberSeq}/care-alerts/{memberCareAlertKey}
Request samples 
{
  • "memberCareAlert_Key": 0,
  • "alert_Details": "string",
  • "care_Alert_Status": "string",
  • "diagnostic_Code": "string",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "frequency": 0,
  • "frequency_Type": "string",
  • "last_Service_Date": "2019-08-24T14:15:22Z",
  • "member_Seq": "st",
  • "next_Service_Date": "2019-08-24T14:15:22Z",
  • "procedure_Code": "string",
  • "subscriber_ID": "string",
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string"
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberCareAlert
Deletes an MemberCareAlert


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberCareAlertKey
required
integer <int32> 
MemberCareAlert Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/care-alerts/{memberCareAlertKey}
Request samples 
Create or Update Batch MemberCareAlert
Create or Update multiple MemberCareAlert 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
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberCareAlert_Key
required
integer <int32> 
Unique identifier for each Member Care Alert record. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
alert_Details
string or null  <= 1024 characters 
A description area used to provide more detail about the care alert.


 
care_Alert_Status
string or null  <= 32 characters 
Status of the care alert that will be sent to the Member based upon the alert criteria. The status can be set to either 'Due Soon', 'Past Due', or 'Completed'.


 
diagnostic_Code
string or null  <= 8 characters 
Diagnostic code tied to the care alert.


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


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


 
frequency
integer or null <int32> 
Identifies the frequency of the care alert by specifying the number of the associated frequency type that should be used.


 
frequency_Type
string or null  <= 16 characters 
Identifies the frequency at which the care alerts should be sent. This can be based upon a certain number of months, an annual basis, or a certain number of years.


 
last_Service_Date
string or null <date-time> 
Identifies the last date that the Member received the service associated with the care alert.


 
member_Seq
required
string  [ 1 .. 2 ] characters 
References Members.Member_Seq value on the parent record.


 
next_Service_Date
string or null <date-time> 
Idenfities the next date that the Member is to receive the service associated with the care alert.


 
procedure_Code
string or null  <= 8 characters 
Procedure code tied the care alert.


 
subscriber_ID
required
string  [ 1 .. 9 ] characters 
References Members.Subscriber_ID value on the parent record.


 
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/subscribers/{subscriberID}/members/{memberSeq}/care-alerts-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}