Social Coordination APIs

**Social Coordination**

Social Coordination APIs
Operations
Account
POST /api/Account/Login
POST /api/Account/Register
POST /api/Account/Activate
POST /api/Account/InActivate
POST /api/Account/ChangePassword
POST /api/Account/RequestNewPassword
POST /api/Account/SSOLogin
Login API
POST /api/Account/Login

API to Authenticate the User

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

<value></value>

Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

password
string

password

userName
string

userName

ipAddress
string

ipAddress

browserName
string

browserName

browserVersion
string

browserVersion

appGUID
string

appGUID

UUID
string

UUID

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to Register new user
POST /api/Account/Register

Service to create a new user

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

<value></value>

Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

password
string

password

userName
string

userName

firstName
string

firstName

lastName
string

lastName

address
string

address

city
string

city

state
string

state

zip
string

zip

primaryPhone
string

primaryPhone

primaryEmail
string

primaryEmail

createdBy
string

createdBy

organisation
string

createdBy

Department
Array

Department

Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

TimeZone
Object
TimeZoneId
integer int64
TimeZone
string
Description
string
Role
Object
RoleName
string
RoleId
integer int64
Profiles
Array

Profiles

Object
ProfileID
integer int64
ProfileName
string
SSOReference
string

SSO Unique Reference ID

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Account_Activate
POST /api/Account/Activate

Request parameters

UpdatedBy
integer int64 required
UserId
integer int64 optional
UserReference
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Account_InActivate
POST /api/Account/InActivate

Request parameters

UpdatedBy
integer int64 required
UserId
integer int64 optional
UserReference
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Account_ChangePassword
POST /api/Account/ChangePassword

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
newPassword
string

newPassword

oldPassword
string

oldPassword

userName
string

userName

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API for New Password
POST /api/Account/RequestNewPassword

Service to Generate new password for user.

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

<value></value>

Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

primaryEmail
string

primaryEmail

userName
string

userName

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Gets the list of Hint Questions required for LoginRegistration
GET /api/Account/HintQuestions

Gets the list of Hint Questions required for Login/Registration

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Update User basic details With Roles and Profiles
PUT /api/Account/User

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

<value></value>

Object
userId
integer int64

User Id

firstName
string

First Name

middleName
string

Middle Name

lastName
string

Last Name

address
string

Address

city
string

City

state
string

State

zip
string

ZIP

primaryPhone
string

Primary Phone

primaryEmail
string

Primary Email

organisation
string

Organisation

Department
Array

Department

Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

TimeZone
Object
TimeZoneId
integer int64
TimeZone
string
Description
string
Role
Object
RoleName
string
RoleId
integer int64
Profiles
Array

Profiles

Object
ProfileID
integer int64
ProfileName
string
SSOReference
string

SSO Unique Reference ID

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
SSO Login API
POST /api/Account/SSOLogin

API to Authenticate the User

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

password
string

password

userName
string

userName

ipAddress
string

ipAddress

browserName
string

browserName

browserVersion
string

browserVersion

appGUID
string

appGUID

UUID
string

UUID

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberId
integer int64
RoleId
integer int64
FirstName
string
LastName
string
PrimaryEmail
string
PrimaryPhone
string
StatusId
integer int32
UserName
string
MemberLogId
integer int64
ExpPwd
integer int32
IsLockedOut
boolean
IsManager
integer int32
ManagerId
integer int64
RoleName
string
ModuleID
string
IsProvider
boolean
DirectEmail
string
esRowState
string
CustomCount
integer int32
MiddleName
string
CheckChangedStatus
string
Message
string
TimeZone
string
State
string
CareTransitionNotification
boolean
SensitiveApplicable
boolean
PassAttemptLeft
integer int32
IsViewOthersActivity
boolean
ClientTimeZone
string
MdPhysicianName
string
PhSensitiveApplicable
boolean
IsViewActiveOnlyMembers
boolean
ScriptFromBaseUrl
string
ScriptFormValidationConfig
Array
Object
SfValidationId
integer int64
ScriptId
integer int64
ScriptName
string
JsKey
string
HasMasterData
boolean
SpName
string
FailedLoginCount
integer int32
API to check whether app has Minimum supported version
GET /api/Account/CheckVersion

Request parameters

CurrentVersion
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
StatusId
integer int32

Status of Version - 1 is Compatible. 2 is non-compatible

StatusMessage
string

Message to Display to user.

LatestVersion
string

Additional message if required. Compatible but suggestion message for new version.

Activity
POST /api/Activity/ScriptSummary
POST /api/Activity/MessageSummary
POST /api/Activity/Add
POST /api/Activity/SyncActivities
GET /api/Activity/CareStaffs
GET /api/Activity/Departments
GET /api/Activity/Scripts
GET /api/Activity/Priorities
POST /api/Activity/SyncMessages
POST /api/Activity/RequestReceived
POST /api/Activity/AcceptOrRejectRequest
GET /api/Activity/WorkQueueDetails
Activity_ScriptSummary
POST /api/Activity/ScriptSummary

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
ScriptId
integer int64
MemberId
integer int64
FromDate
string date-time
ToDate
string date-time
LastUpdated
string date-time
CareActivityTypeId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientFollowupId
integer int64
ScheduledDate
string date-time
PerformedBy
integer int64
PerformedByName
string
PerformedDate
string date-time
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
CareActivityTypeName
string
PatientId
integer int64
ClientPatientId
string
FirstName
string
LastName
string
ActivityOutcomeId
integer int64
ActualDuration
string
PlaceOfServiceId
integer int64
ScriptRunLogId
integer int64
ScriptScore
number double
ScriptEndDatetime
string date-time
ScriptRunTypeId
integer int64
StatusId
integer int64
SfHtmlFile
string
EndDate
string date-time
DeletedOn
string date-time
This Api handle for getting General Activity Summary details
POST /api/Activity/GeneralSummary

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
ScriptId
integer int64
MemberId
integer int64
FromDate
string date-time
ToDate
string date-time
LastUpdated
string date-time
CareActivityTypeId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientFollowupId
integer int64
ScheduledDate
string date-time
PerformedBy
integer int64
PerformedByName
string
PerformedDate
string date-time
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
CareActivityTypeName
string
PatientId
integer int64
ClientPatientId
string
FirstName
string
LastName
string
ActivityOutcomeId
integer int64
ActualDuration
string
PlaceOfServiceId
integer int64
ScriptRunLogId
integer int64
ScriptScore
number double
ScriptEndDatetime
string date-time
ScriptRunTypeId
integer int64
StatusId
integer int64
SfHtmlFile
string
EndDate
string date-time
DeletedOn
string date-time
This Api handle for getting Message summary details
POST /api/Activity/MessageSummary

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
ScriptId
integer int64
MemberId
integer int64
FromDate
string date-time
ToDate
string date-time
LastUpdated
string date-time
CareActivityTypeId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
MessageId
integer int32
MessageSubject
string
MessageContent
string
SentFrom
integer int64
SentName
string
DateSent
string date-time
ClientPatientId
string
PatientId
integer int64
PatientName
string
SentToNames
string
SentType
string
This Api handle for getting ScriptResponse details by Script Id
GET /api/Activity/ScriptResponses

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
ScriptId
integer int64 required
ScriptRunlogId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberDetail
Array
Object
RowNo
integer int64
ScriptName
string
StaffName
string
ScriptStartDateTime
string date-time
ScriptEndDateTime
string date-time
Duration
string
ScriptScore
number double
ScriptEndStatus
string
ScriptId
integer int64
ScriptRunLogId
integer int64
QuestionNo
integer int64
Question
string
Option
string
SubOption
string
Score
integer int32
CareNotes
string
CreatedOn
string date-time
MemberId
string
MemberName
string
AltruistaId
string
MemberDob
string date-time
CustomCount
integer int32
QuestionId
integer int64
ScriptRunLogDetailId
integer int64
IsResponded
boolean
TotalQuestions
integer int64
TotalResponse
integer int64
ScriptScoreReceived
string
Status
boolean
ScptQuestionResponse
string
SubOptionDynamicRaw
string
SubOptionDynamicQuestions
string
TotalScriptScore
string
CompletedByName
string
CompletedOn
string date-time
IsSignature
string
DownloadedByName
string
DownloadedOn
string date-time
ProcCode
string
CodeDescription
string
ServiceFromDate
string date-time
ServiceToDate
string date-time
ScptInactivationDate
string
ScptInactivationReason
string
IsInactivate
boolean
InactivatedBy
string
TrackDlnCurrent
string
MemberIdentifierLabel
string
MemberIdentifierValue
string
ScriptStatus
string
IsQuestionDeleted
string
QuestionOptionId
integer int64
SubOptionId
integer int64
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
SubOptionValue
string
MemberScriptResponse
Array
Object
RowNo
integer int64
ScriptName
string
StaffName
string
ScriptStartDateTime
string date-time
ScriptEndDateTime
string date-time
Duration
string
ScriptScore
number double
ScriptEndStatus
string
ScriptId
integer int64
ScriptRunLogId
integer int64
QuestionNo
integer int64
Question
string
Option
string
SubOption
string
Score
integer int32
CareNotes
string
CreatedOn
string date-time
MemberId
string
MemberName
string
AltruistaId
string
MemberDob
string date-time
CustomCount
integer int32
QuestionId
integer int64
ScriptRunLogDetailId
integer int64
IsResponded
boolean
TotalQuestions
integer int64
TotalResponse
integer int64
ScriptScoreReceived
string
Status
boolean
ScptQuestionResponse
string
SubOptionDynamicRaw
string
SubOptionDynamicQuestions
string
TotalScriptScore
string
CompletedByName
string
CompletedOn
string date-time
IsSignature
string
DownloadedByName
string
DownloadedOn
string date-time
ProcCode
string
CodeDescription
string
ServiceFromDate
string date-time
ServiceToDate
string date-time
ScptInactivationDate
string
ScptInactivationReason
string
IsInactivate
boolean
InactivatedBy
string
TrackDlnCurrent
string
MemberIdentifierLabel
string
MemberIdentifierValue
string
ScriptStatus
string
IsQuestionDeleted
string
QuestionOptionId
integer int64
SubOptionId
integer int64
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
SubOptionValue
string
This Api handle for Add Activity
POST /api/Activity/Add

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
CareStaffTimeZone
string
ScheduledType
integer int32
ScheduleTypeText
string
MemberName
string
MemberId
integer int64
UserId
integer int64
CreatedBy
integer int64
AlternateCareStaffId
integer int64
CareActivityTypeId
integer int64
ScriptId
integer int64
ScriptName
string
ScriptRunTypeId
integer int64
Priority
string
VenueId
integer int64
VenueName
string
FollowupDate
string date-time
FollowupDay
string
FollowupHrs
string
FollowupMins
string
ReferTo
integer int64
Comments
string
CanPerform
boolean
AcceptFlag
boolean
IsRecurringActivity
boolean
RecurringType
string
RecurrenceValues
Object
DailyOption
integer int32
DailyForEveryNoOfDays
integer int32
WeeklySun
boolean
WeeklySat
boolean
WeeklyMon
boolean
WeeklyTue
boolean
WeeklyWed
boolean
WeeklyThu
boolean
WeeklyFri
boolean
WeeklyForEveeryNoOfWeeks
integer int32
MonthlyOption
integer int32
MonthlyOption2
boolean
MonthlyDay
integer int32
MonthlyForEveryNoOfMonths1
integer int32
MonthlyForEveryNoOfMonths2
integer int32
MonthlyPlusOrMinusDays
integer int32
MonthlyWeek
integer int32
MonthlyWeekDay
integer int32
YearlyOption
integer int32
YearlyMonth1
integer int32
YearlyMonth2
integer int32
YearlyMonthWeek
integer int32
YearlyMonthWeekDay
integer int32
YearlyMonthDay
integer int32
YearlyPlusOrMinusDays
integer int32
EndAfterNoOfOccurrences
integer int32
EndAfterDate
string date-time
EndAfterType
integer int32
IsWorkQueueActivity
boolean
WorkQueueID
integer int64
CareStaffIds
string
ActivityDuration
string
ActivityFrom
string
CarePlanId
integer int64
PerformedBy
integer int64
PerformedDate
string date-time
UpdatedOn
string date-time
ActivityOutcomeId
integer int64
ActivityOutcomeName
string
ActualFollowupHrs
string
ActualFollowupMins
string
ActualDuration
string
ServiceCode
integer int64
PlaceOfServiceId
string
OutComeComments
string
PatientFollowupId
integer int64
Comments_Reasons
string
ErrorMessage
string
SucessMessage
string
WorkFlowId
string
CareActivityTypeName
string
ReferedName
string
AppointmentId
string
FollowUpDates
Array
string date-time
FollowUpIds
Array
integer int64
RecurringFollowUpDates
string
RecurringFollowUpIds
string

Responses

200 200

OK

application/json
text/json
application/xml
text/xml
This API Obsolete after v880 Mobile app
POST /api/Activity/SyncActivities

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
MemberId
integer int64
UserId
integer int64
CreatedBy
integer int64
AlternateCareStaffId
integer int64
CareActivityTypeId
integer int64
ScriptId
integer int64
ScriptRunTypeId
integer int64
Priority
string
VenueId
integer int64
ReferTo
integer int64
Comments
string
CanPerform
boolean
AcceptFlag
boolean
IsRecurringActivity
boolean
IsWorkQueueActivity
boolean
WorkQueueID
integer int64
CareStaffIds
string
ActivityDuration
string
ActivityFrom
string
CarePlanId
integer int64
PerformedBy
integer int64
PerformedDate
string date-time
CreatedDate
string date-time
ActivityOutcomeId
integer int64
ActualDuration
string
ServiceCode
integer int64
PlaceOfServiceId
string
OutComeComments
string
Comments_Reasons
string
AppointmentId
string
FollowUpDates
string
FollowUpIds
string
CallStatus
integer int32
ReferralNotesCreatedDate
string date-time
ReferralNotesUpdatedDate
string date-time
OutcomeNotesCreatedDate
string date-time
OutcomeNotesUpdatedDate
string date-time
ActivityCommentNotesCreatedDate
string date-time
ActivityCommentNotesUpdatedDate
string date-time
PatientFollowupId
integer int64
UpdatedBy
integer int64
UpdatedDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
OriginalFollowUpId
integer int64
FollowUpId
integer int64
ActivityType
string
CommentsNotesId
integer int64
OutcomeNotesId
integer int64
RecurringId
integer int64
OriginalRecurringId
integer int64
This API for Sync Activites Its Override form SyncActivites
POST /api/Activity/Sync

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
GeneralActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
RecurringActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
WorkQueueActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
OriginalFollowUpId
integer int64
FollowUpId
integer int64
ActivityType
string
CommentsNotesId
integer int64
OutcomeNotesId
integer int64
RecurringId
integer int64
OriginalRecurringId
integer int64
This Api returns ActivityType details Based on CareStaffId key Activity Type Drop down values
GET /api/Activity/Types

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsActive
boolean
CreatedOn
string date-time
CreatedBy
integer int64
UpdatedOn
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
ActivityOutcomeIds
string
IsActivityOutcomeMandatory
boolean
IsActualDurationMandatory
boolean
ActivityOutcomeTypeIds
string
HasScript
boolean
This API bind the Care Staff drop down values
GET /api/Activity/CareStaffs

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CareStaffDetailsId
integer int64
MemberId
integer int64
RoleId
integer int64
RoleName
string
Title
string
FirstName
string
MiddleName
string
FullName
string
LastName
string
SpecialityId
integer int64
SpecialityName
string
StartDate
string date-time
Address
string
City
string
State
string
Zip
string
Country
string
PrimaryPhone
string
AlternatePhone
string
MobilePhone
string
PrimaryEmail
string
AlternateEmail
string
Fax
string
ViewSecureData
boolean
HourlyRate
number double
DeptId
string
DeptName
string
esRowState
string
CustomCount
integer int32
MemStatus
string
StatusName
string
AccStatus
string
UserName
string
Answer
string
SDate
string
FullNameRole
string
IsActive
boolean
AssignedTo
integer int64
ClinicOrganization
string
CareStaffId
integer int64
IsCreateAdmin
boolean
DirectEmail
string
IsProvider
boolean
CfgAdminConfigID
integer int64
IsPrimary
boolean
TimeZone
string
Credential
string
Specialty
string
CareTransitionNotification
boolean
CareOrganization
string
IsExceeded
integer int32
ProfileIds
string
TimeZoneId
integer int32
HintId
integer int64
HintDescription
string
HintAnswer
string
SignaturePath
string
RoleStatus
boolean
WorkQueueDeptId
string
WorkQueueDeptName
string
HasSameProfile
boolean
DepartmentIds
string
This API bind the Care Staff drop down values by Department id
GET /api/Activity/CareStaffsByDeptId

Request parameters

UserId
integer int64 required
DeptId
integer int32 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CareStaffDetailsId
integer int64
MemberId
integer int64
RoleId
integer int64
RoleName
string
Title
string
FirstName
string
MiddleName
string
FullName
string
LastName
string
SpecialityId
integer int64
SpecialityName
string
StartDate
string date-time
Address
string
City
string
State
string
Zip
string
Country
string
PrimaryPhone
string
AlternatePhone
string
MobilePhone
string
PrimaryEmail
string
AlternateEmail
string
Fax
string
ViewSecureData
boolean
HourlyRate
number double
DeptId
string
DeptName
string
esRowState
string
CustomCount
integer int32
MemStatus
string
StatusName
string
AccStatus
string
UserName
string
Answer
string
SDate
string
FullNameRole
string
IsActive
boolean
AssignedTo
integer int64
ClinicOrganization
string
CareStaffId
integer int64
IsCreateAdmin
boolean
DirectEmail
string
IsProvider
boolean
CfgAdminConfigID
integer int64
IsPrimary
boolean
TimeZone
string
Credential
string
Specialty
string
CareTransitionNotification
boolean
CareOrganization
string
IsExceeded
integer int32
ProfileIds
string
TimeZoneId
integer int32
HintId
integer int64
HintDescription
string
HintAnswer
string
SignaturePath
string
RoleStatus
boolean
WorkQueueDeptId
string
WorkQueueDeptName
string
HasSameProfile
boolean
DepartmentIds
string
This API get Department Drop down values
GET /api/Activity/Departments

Request parameters

IsWorkQueue
boolean optional
IsActive
boolean optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
DeptId
integer int64
DeptName
string
IsActive
boolean
CreatedBy
string
CreatedOn
string date-time
UpdatedBy
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
IsWorkQueue
string
esRowState
string
CustomCount
integer int32
RowNumber
integer int64
This Api get All Scripts
GET /api/Activity/Scripts

Request parameters

UserId
integer int64 required
MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
HasScriptForm
boolean
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
Duration
number double
NoOfQuestion
integer int32
IsActive
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
RequiredWorkflow
boolean
DeletedBy
integer int64
DeletedDate
string date-time
esRowState
string
CareActivityTypeName
string
CustomCount
integer int32
AdminQuestions
Array
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScriptRunTypeId
integer int64
ScriptRunType
string
CreatedByName
string
UpdatedByName
string
QuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScriptLobId
integer int64
LobName
string
ScriptLob
string
IsReviewRequired
boolean
ReviewRequiredName
string
ModuleName
string
ModuleId
integer int32
Score
number double
TotalScore
number double
SfHtmlFile
string
FormName
string
FormId
integer int64
IsForm
integer int32
SfHeaderText
string
SfFooterText
string
SfId
integer int64
PendingRunLogId
integer int64
ScriptIsSinglePage
boolean
CareActivityTypeGroup
string
PrimaryActivity
integer int64
IsPrimary
boolean
ScriptOgiLob
string
OtherCareStaffOgiLobs
string
AssessmentName
string
IsOgi
boolean
_ScriptFormHtml
string
LobId
string
CareActivityTypeIds
string
IsAttestationRequired
boolean
AttestationText
string
IsProviderReviewRequired
boolean
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
MemberReviewTypeId
integer int32
API to get the Priority Types
GET /api/Activity/Priorities

Request body

Responses

200 200

OK

application/json
text/json
application/xml
text/xml
API to get Member Internal and external CareTeam
POST /api/Activity/CareTeam

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientId
integer int64
PhysicianId
integer int64
FullName
string
CareTeamId
integer int64
Email
string
CareTeamType
string
esRowState
string
CustomCount
integer int32
MemberCareTeamId
string
DirectEmail
string
CareTeamMemberId
integer int64
StartDate
string date-time
EndDate
string date-time
PatientPhysicianId
integer int64
DeletedOn
string date-time
Activity_SyncMessages
POST /api/Activity/SyncMessages

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
@MessageId
integer int64
@UserId
integer int64
@MemberId
integer int64
@ToMember
boolean
@SentTo
string
@Subject
string
@MessageContent
string
@CreatedOn
string date-time
@IsDirect
boolean
@DateSent
string date-time
@IsOfflineCreated
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
OfflineMessageId
integer int64
OriginalMessageId
integer int64
This API for Get Request Received Activities Details
POST /api/Activity/RequestReceived

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
LastUpdatedOn
string date-time
ToDate
string date-time
FormDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ReferenceId
integer int64
ReferBy
integer int64
ReferTo
integer int64
PatientId
integer int64
ReasonForReference
string
ReferredDate
string date-time
ReasonForRejection
string
RejectionDate
string date-time
RequestStatus
string
ResolveDate
string date-time
PatientFollowupId
integer int64
RationaleByReferee
string
RationaleByCoach
string
IsConfidential
boolean
ModuleName
string
ReferType
string
ClientPatientId
string
PerformedBy
integer int64
FollowupDate
string date-time
Status
string
PatientName
string
ReferredByName
string
ReferredToName
string
Flag
string
AcceptedBy
integer int64
ReferralId
integer int64
_ReferTypeId
integer int64
_ReferralReqDate
string date-time
_ReferralComments
string
AcceptedByName
string
MemberName
string
RejectedByName
string
DeptName
string
ActionType
string
ReasonForRequest
string
Comments
string
AcceptComments
string
WorkQueue
string
CreatedDate
string date-time
ActivityTypeName
string
ScheduledDate
string date-time
WqCount
integer int64
NonWqCount
integer int64
ScriptId
integer int64
IsSensitiveDiagnosis
boolean
Priority
string
QueueId
integer int64
StatusId
integer int32
ContactType
string
ScriptName
string
ReferralNotes
string
ReferredById
integer int64
ReferredToId
integer int64
CareStaffNames
string
Activity_AcceptOrRejectReceivedRequest
POST /api/Activity/AcceptOrRejectRequest

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
WorkQueueId
integer int64
CareStaffId
integer int64
PatientFollowupId
integer int64
AcceptComments
string
ReasonForRejection
string
FollowUpDate
string date-time
UpdatedOn
string date-time
IsAccepted
boolean
IsRejected
boolean
PatientId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Status
string
StatusMessage
string
This API for Get WorkQueue Status Details
GET /api/Activity/WorkQueueDetails

Request parameters

WorkQueueId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CareStaffName
string
DepartmentNames
string
Status
integer int32
Addresses
GET /api/Addresses/Get
POST /api/Addresses/Insert
GET /api/Addresses/AddressTypes
Addresses_Get
GET /api/Addresses/Get

Request parameters

UserId
integer int64 required
MemberId
integer int64 required

Request body

Responses

200 200

List of Addresses

Body
application/json
text/json
application/xml
text/xml
Array
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean
404 404

No addresses found for Member

application/json
text/json
application/xml
text/xml
500 500

Internal Server Error

application/json
text/json
application/xml
text/xml
API to Update the Additional Addresses Table for the member
POST /api/Addresses/Update

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
AddressId
integer int64
PatientId
integer int64
AddressText
string
City
string
State
string
CountyId
integer int64
Country
string
Zip
string
IsPrimary
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
AddressType
string
AddressTypeId
integer int64
esRowState
string
CustomCount
integer int32
RolePageActions
Array
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Status
integer int32
AddressLine
string
IsPreferred
boolean
PhoneNumber
string
Service to insert an Additional Address
POST /api/Addresses/Insert

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
AddressId
integer int64
PatientId
integer int64
AddressText
string
City
string
State
string
CountyId
integer int64
Country
string
Zip
string
IsPrimary
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
AddressType
string
AddressTypeId
integer int64
esRowState
string
CustomCount
integer int32
RolePageActions
Array
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Status
integer int32
AddressLine
string
IsPreferred
boolean
PhoneNumber
string
API to get the Address Types for picklist
GET /api/Addresses/AddressTypes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AddressTypeId
integer int64
AddressTypeName
string
AuditLogAction
string
ColumnName
string
OldData
string
NewData
string
PerformedOn
string date-time
PerformedBy
string
esRowState
string
CustomCount
integer int32
IsType
string
RowNumber
integer int32
Appointment
POST /api/Appointments/Add
POST /api/Appointments/Create
POST /api/Appointments/Get
GET /api/Appointments/ProviderTypes
API to retrieve the Appointments for a particular careplan
GET /api/Appointments/ByCarePlanId

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
CarePlanId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AppointmentId
integer int32
AppointmentStatusName
string
ProviderName
string
FirstName
string
LastName
string
AppointmentTypeName
string
AppointmentTypeId
integer int32
AppointmentReason
string
AppointmentTime
string
AppointmentNotes
string
AppointmentStatus
integer int32
ProviderId
integer int64
ProviderType
string
City
string
WorkPhone
string
AppointmentDate
string date-time
PhysicianCode
string
Priority
string
MemberName
string
ReferDate
string date-time
ReferbyName
string
ReferBy
integer int64
ReferTo
integer int64
StatusName
string
StatusId
integer int32
PatientId
integer int64
AppointmentName
string
ProviderEmail
string
PhysicianId
integer int64
CellPhone
string
esRowState
string
CustomCount
integer int32
RescheduleStatus
boolean
CareplanId
string
AttachmentCount
integer int32
AttachmentPath
string
IsSensitiveDiagnosis
boolean
HealthifyId
integer int64
IsPreferredProvider
boolean
HasNextPage
boolean
ProviderTypeId
integer int64
API to get the picker list data for Appointment Types Dropdown
GET /api/Appointments/Types

Request parameters

UserId
integer int64 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AppointmentTypeId
integer int32
AppointmentTypeName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
RowNumber
integer int32
API to get the Appointment Statuses for the picker list
GET /api/Appointments/Statuses

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AppointmentStatusId
integer int32
AppointmentStatusName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
RowNumber
integer int32
API to get the Appointment Priorities for Picker List
GET /api/Appointments/Priorities

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PriorityId
integer int32
PriorityName
string
API to add an Appointment
POST /api/Appointments/Add

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64

UserId

MemberId
integer int64

MemberId

CarePlanId
integer int64

CarePlanId

AppointmentDate
string date-time

DateTime for AppointmentDate - should always be same or later than creation datetime

AppointmentReason
string

reason text

AppointmentNotes
string

Appointment Notes text box

AppointmentTypeId
integer int32

Appointment TypeId

AppointmentStatusId
integer int32

Appointment Status Id

AppointmentPriorityId
integer int32

Appointment Priority ID

ProviderCode
string

Provider Code

isActive
boolean

Always send true.

CanSendEmail
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to retrieve the Appointments for a particular member
GET /api/Appointments/OfMember

Request parameters

UserId
integer int64 required
MemberId
integer int64 optional
CarePlanId
integer int64 optional
PageNumber
integer int32 optional
PageSize
integer int32 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AppointmentId
integer int32
AppointmentStatusName
string
ProviderName
string
FirstName
string
LastName
string
AppointmentTypeName
string
AppointmentTypeId
integer int32
AppointmentReason
string
AppointmentTime
string
AppointmentNotes
string
AppointmentStatus
integer int32
ProviderId
integer int64
ProviderType
string
City
string
WorkPhone
string
AppointmentDate
string date-time
PhysicianCode
string
Priority
string
MemberName
string
ReferDate
string date-time
ReferbyName
string
ReferBy
integer int64
ReferTo
integer int64
StatusName
string
StatusId
integer int32
PatientId
integer int64
AppointmentName
string
ProviderEmail
string
PhysicianId
integer int64
CellPhone
string
esRowState
string
CustomCount
integer int32
RescheduleStatus
boolean
CareplanId
string
AttachmentCount
integer int32
AttachmentPath
string
IsSensitiveDiagnosis
boolean
HealthifyId
integer int64
IsPreferredProvider
boolean
HasNextPage
boolean
ProviderTypeId
integer int64
API to add an Appointment
POST /api/Appointments/Create

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64

UserId

MemberId
integer int64

MemberId

CarePlanId
integer int64

CarePlanId

AppointmentDate
string date-time

DateTime for AppointmentDate - should always be same or later than creation datetime

AppointmentReason
string

reason text

AppointmentNotes
string

Appointment Notes text box

AppointmentTypeId
integer int32

Appointment TypeId

AppointmentStatusId
integer int32

Appointment Status Id

AppointmentPriorityId
integer int32

Appointment Priority ID

ProviderCode
string

Provider Code

isActive
boolean

Always send true.

CanSendEmail
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Appointment_GetAppointments
POST /api/Appointments/Get

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
MemberId
integer int64
CarePlanId
integer int64
PageNumber
integer int32
PageSize
integer int32
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
FirstName
string
LastName
string
ProviderType
integer int32
AppointmentStatus
integer int32
AppointmentId
integer int32

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
AppointmentId
integer int32
AppointmentStatusName
string
ProviderName
string
FirstName
string
LastName
string
AppointmentTypeName
string
AppointmentTypeId
integer int32
AppointmentReason
string
AppointmentTime
string
AppointmentNotes
string
AppointmentStatus
integer int32
ProviderId
integer int64
ProviderType
string
City
string
WorkPhone
string
AppointmentDate
string date-time
PhysicianCode
string
Priority
string
MemberName
string
ReferDate
string date-time
ReferbyName
string
ReferBy
integer int64
ReferTo
integer int64
StatusName
string
StatusId
integer int32
PatientId
integer int64
AppointmentName
string
ProviderEmail
string
PhysicianId
integer int64
CellPhone
string
esRowState
string
CustomCount
integer int32
RescheduleStatus
boolean
CareplanId
string
AttachmentCount
integer int32
AttachmentPath
string
IsSensitiveDiagnosis
boolean
HealthifyId
integer int64
IsPreferredProvider
boolean
HasNextPage
boolean
ProviderTypeId
integer int64
Appointment_ProviderTypes
GET /api/Appointments/ProviderTypes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ProviderTypeId
integer int32
ProviderType
string
esRowState
string
RowNumber
integer int32
Assessments
GET /api/Assessments/Scripts
GET /api/Assessments/ScriptsByMember
POST /api/Assessments/Save
GET /api/Assessments/Details
GET /api/Assessments/OptionTypes
GET /api/Assessments/RunLogResponses
GET /api/Assessments/ScriptPlaceholders
GET /api/Assessments/MemberPlaceholders
GET /api/Assessments/MappingDetails
POST /api/Assessments/ScriptFormTemplate
POST /api/Assessments/ScriptFormValidationResponses
POST /api/Assessments/ScriptFormMasterData
POST /api/Assessments/ScriptFormFiles
Get assesment assigned to care staff
GET /api/Assessments/Scripts

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HasScriptForm
boolean
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
Duration
number double
NoOfQuestion
integer int32
IsActive
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
RequiredWorkflow
boolean
DeletedBy
integer int64
DeletedDate
string date-time
esRowState
string
CareActivityTypeName
string
CustomCount
integer int32
AdminQuestions
Array
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScriptRunTypeId
integer int64
ScriptRunType
string
CreatedByName
string
UpdatedByName
string
QuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScriptLobId
integer int64
LobName
string
ScriptLob
string
IsReviewRequired
boolean
ReviewRequiredName
string
ModuleName
string
ModuleId
integer int32
Score
number double
TotalScore
number double
SfHtmlFile
string
FormName
string
FormId
integer int64
IsForm
integer int32
SfHeaderText
string
SfFooterText
string
SfId
integer int64
PendingRunLogId
integer int64
ScriptIsSinglePage
boolean
CareActivityTypeGroup
string
PrimaryActivity
integer int64
IsPrimary
boolean
ScriptOgiLob
string
OtherCareStaffOgiLobs
string
AssessmentName
string
IsOgi
boolean
_ScriptFormHtml
string
LobId
string
CareActivityTypeIds
string
IsAttestationRequired
boolean
AttestationText
string
IsProviderReviewRequired
boolean
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
MemberReviewTypeId
integer int32
Get valid assesments to perform on the Member
GET /api/Assessments/ScriptsByMember

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
isCM
integer int32 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HasScriptForm
boolean
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
Duration
number double
NoOfQuestion
integer int32
IsActive
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
RequiredWorkflow
boolean
DeletedBy
integer int64
DeletedDate
string date-time
esRowState
string
CareActivityTypeName
string
CustomCount
integer int32
AdminQuestions
Array
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScriptRunTypeId
integer int64
ScriptRunType
string
CreatedByName
string
UpdatedByName
string
QuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScriptLobId
integer int64
LobName
string
ScriptLob
string
IsReviewRequired
boolean
ReviewRequiredName
string
ModuleName
string
ModuleId
integer int32
Score
number double
TotalScore
number double
SfHtmlFile
string
FormName
string
FormId
integer int64
IsForm
integer int32
SfHeaderText
string
SfFooterText
string
SfId
integer int64
PendingRunLogId
integer int64
ScriptIsSinglePage
boolean
CareActivityTypeGroup
string
PrimaryActivity
integer int64
IsPrimary
boolean
ScriptOgiLob
string
OtherCareStaffOgiLobs
string
AssessmentName
string
IsOgi
boolean
_ScriptFormHtml
string
LobId
string
CareActivityTypeIds
string
IsAttestationRequired
boolean
AttestationText
string
IsProviderReviewRequired
boolean
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
MemberReviewTypeId
integer int32
Save Assesment Response
POST /api/Assessments/Save

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
AppSource
string
RunTypeId
integer int32
UniqueDeviceId
string
PatientId
integer int64
ScriptId
integer int64
HealthCoachId
integer int64
CreatedOn
string date-time
EndDate
string date-time
StatusId
integer int32
CallType
integer int32
PatientFollowUpId
integer int64
ScriptRunLogId
integer int64
IsSinglePageScript
boolean
ScriptActivityOutcomeId
integer int32
ScriptActivityOutcomeNotes
string
Comments
string
PlaceOfServiceId
integer int32
ScriptActualDuration
string
VenueId
integer int32
HcpcCodeId
integer int32
IsOffline
boolean
OutcomeNotesCreatedDate
string date-time
OutcomeNotesUpdatedDate
string date-time
RunLogQuestions
Array
Object
@QUESTION_ID
integer int64
@QUESTION
string
@CARE_NOTES
string
@CREATED_ON
string
@RESPONSE_TIME_FROM
string
@RESPONSE_TIME_TO
string
@RESPONSE_TIME_TOTAL
integer int64
@IS_RESPONDED
boolean
@NOTES_CREATED_DATE
string date-time
@NOTES_UPDATED_DATE
string date-time
ScriptReponses
Array
Object
@QuestionId
integer int64
@Optionid
integer int64
@OptionValue
string
@CreatedOn
string date-time
@CreatedBy
integer int64
@Score
number double
@SubOptionid
integer int64
@SubOptionValue
string
@SubOptDynVal
string
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
ScriptDurationData
Array
Object
@StartDateTime
string date-time
@EndDateTime
string date-time
@DurationDifference
number double
ScriptAttestationData
Array
Object
@ScriptRunMode
integer int64
@AttestationDate
string date-time
ScriptFormAction
string
PatientFollowUpDate
string date-time
CareActivityTypeId
integer int64
ExternalProviderId
integer int64
IsMemberReview
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
string
New API For saving assessment response details for supporting offline feature
POST /api/Assessments/SaveAssessment

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
AppSource
string
RunTypeId
integer int32
UniqueDeviceId
string
PatientId
integer int64
ScriptId
integer int64
HealthCoachId
integer int64
CreatedOn
string date-time
EndDate
string date-time
StatusId
integer int32
CallType
integer int32
PatientFollowUpId
integer int64
ScriptRunLogId
integer int64
IsSinglePageScript
boolean
ScriptActivityOutcomeId
integer int32
ScriptActivityOutcomeNotes
string
Comments
string
PlaceOfServiceId
integer int32
ScriptActualDuration
string
VenueId
integer int32
HcpcCodeId
integer int32
IsOffline
boolean
OutcomeNotesCreatedDate
string date-time
OutcomeNotesUpdatedDate
string date-time
RunLogQuestions
Array
Object
@QUESTION_ID
integer int64
@QUESTION
string
@CARE_NOTES
string
@CREATED_ON
string
@RESPONSE_TIME_FROM
string
@RESPONSE_TIME_TO
string
@RESPONSE_TIME_TOTAL
integer int64
@IS_RESPONDED
boolean
@NOTES_CREATED_DATE
string date-time
@NOTES_UPDATED_DATE
string date-time
ScriptReponses
Array
Object
@QuestionId
integer int64
@Optionid
integer int64
@OptionValue
string
@CreatedOn
string date-time
@CreatedBy
integer int64
@Score
number double
@SubOptionid
integer int64
@SubOptionValue
string
@SubOptDynVal
string
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
ScriptDurationData
Array
Object
@StartDateTime
string date-time
@EndDateTime
string date-time
@DurationDifference
number double
ScriptAttestationData
Array
Object
@ScriptRunMode
integer int64
@AttestationDate
string date-time
ScriptFormAction
string
PatientFollowUpDate
string date-time
CareActivityTypeId
integer int64
ExternalProviderId
integer int64
IsMemberReview
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
ErrorMessage
string
ReferralNotesId
integer int64
OutcomeNotesId
integer int64
Getting Script Questions for Single Screen
GET /api/Assessments/Details

Request parameters

ScriptID
integer int64 required
MemberID
integer int64 required
StaffID
integer int64 required
ResponseMode
integer int32 optional
DecisionID
integer int64 optional
ViewForm
boolean optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HasScriptForm
boolean
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
Duration
number double
NoOfQuestion
integer int32
IsActive
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
RequiredWorkflow
boolean
DeletedBy
integer int64
DeletedDate
string date-time
esRowState
string
CareActivityTypeName
string
CustomCount
integer int32
AdminQuestions
Array
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScriptRunTypeId
integer int64
ScriptRunType
string
CreatedByName
string
UpdatedByName
string
QuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScriptLobId
integer int64
LobName
string
ScriptLob
string
IsReviewRequired
boolean
ReviewRequiredName
string
ModuleName
string
ModuleId
integer int32
Score
number double
TotalScore
number double
SfHtmlFile
string
FormName
string
FormId
integer int64
IsForm
integer int32
SfHeaderText
string
SfFooterText
string
SfId
integer int64
PendingRunLogId
integer int64
ScriptIsSinglePage
boolean
CareActivityTypeGroup
string
PrimaryActivity
integer int64
IsPrimary
boolean
ScriptOgiLob
string
OtherCareStaffOgiLobs
string
AssessmentName
string
IsOgi
boolean
_ScriptFormHtml
string
LobId
string
CareActivityTypeIds
string
IsAttestationRequired
boolean
AttestationText
string
IsProviderReviewRequired
boolean
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
MemberReviewTypeId
integer int32
API to get the Script Option types MasterData
GET /api/Assessments/OptionTypes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Gets the scpt responses based on member script it will pick latest results
GET /api/Assessments/MemberResponses

Request parameters

UserId
integer int64 required
ScriptId
integer int64 required
MemberId
integer int64 required
ResponseMode
integer int32 optional
IsOffline
boolean optional
PatientFollowUpId
integer int64 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ScptQuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScptRunLogDetails
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
PatientId
integer int64
ScriptId
integer int64
CallStatus
integer int32
StatusId
integer int64
ReceivedScore
number double
ActivityOutcomeId
integer int64
OutcomeNotes
string
ActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
StaffId
integer int64
StaffName
string
ScriptIsSinglePage
boolean
StartDate
string date-time
EndDate
string date-time
EndedBy
integer int64
DownloadedBy
integer int64
DownloadedOn
string date-time
FollowupDate
string date-time
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsOggiExist
boolean
ScriptRunMode
integer int32
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
IsMemberReview
boolean
QuestionRunLogDetails
Array
Object
Questionid
integer int64
Question
string
CareNotes
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
ResponseTimeTotal
integer int64
IsResponded
boolean
StaffId
integer int64
StaffName
string
RunTypeId
integer int64
ScriptFormValidations
Array
Object
ScriptId
integer int64
PatientId
integer int64
JsKey
string
Result
string
gets the script response based on RunlogId
GET /api/Assessments/RunLogResponses

Request parameters

UserId
integer int64 required
RunLogId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ScptQuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScptRunLogDetails
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
PatientId
integer int64
ScriptId
integer int64
CallStatus
integer int32
StatusId
integer int64
ReceivedScore
number double
ActivityOutcomeId
integer int64
OutcomeNotes
string
ActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
StaffId
integer int64
StaffName
string
ScriptIsSinglePage
boolean
StartDate
string date-time
EndDate
string date-time
EndedBy
integer int64
DownloadedBy
integer int64
DownloadedOn
string date-time
FollowupDate
string date-time
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsOggiExist
boolean
ScriptRunMode
integer int32
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
IsMemberReview
boolean
QuestionRunLogDetails
Array
Object
Questionid
integer int64
Question
string
CareNotes
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
ResponseTimeTotal
integer int64
IsResponded
boolean
StaffId
integer int64
StaffName
string
RunTypeId
integer int64
ScriptFormValidations
Array
Object
ScriptId
integer int64
PatientId
integer int64
JsKey
string
Result
string
Gets the Script Placeholders Based on ScriptId
GET /api/Assessments/ScriptPlaceholders

Request parameters

UserId
integer int64 required
ScriptId
integer int64 required
MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ScptPhId
integer int64
ScriptId
integer int64
ScptRelCtrlId
integer int32
ScptRelCtrlType
string
ScptRelType
integer int32
ScptRelId
integer int64
ScptRelKey
string
ScptRelKeyParent
string
ScptPhName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
IsDeleted
boolean
esRowState
string
Assessments_PlaceholdersByMember
GET /api/Assessments/MemberPlaceholders

Request parameters

UserId
integer int64 required
MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PlaceholderKey
string
PlaceholderValue
string
Assessments_MappingDetails
GET /api/Assessments/MappingDetails

Request parameters

UserId
integer int64 required
ScriptID
integer int64 required
LastUpdated
string date-time optional
ViewForm
boolean optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ScriptId
integer int64
CarePlanOGIS
Array
Object
TimeFrame
string
OggiLobId
integer int64
OppName
string
GoalGroupName
string
GoalName
string
InterventionName
string
ConditionName
string
LobName
string
Span
string
CustomCount
integer int32
CondStyle
string
OppStyle
string
GoalGroupStyle
string
GoalStyle
string
IntervStyle
string
LobStyle
string
OppId
integer int64
GoalId
integer int64
GoalGroupId
integer int64
InterventionId
integer int64
LobId
integer int64
TimeSpan
integer int32
SqlKey
string
LobOptionId
integer int64
LobSubOptionId
integer int64
IsChecked
integer int32
OptionId
integer int64
ConditionId
integer int64
ServiceCategoryLabel
string
SpStyle
string
RecommandedUnits
string
OggiServicePlanId
integer int64
GuidelineSource
string
SubOptionId
integer int64
InterventionAliasName
string
OppPriorityId
integer int32
Lobs
Array
Object
LobId
integer int64
LobName
string
LobDesc
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
StartDate
string date-time
EndDate
string date-time
LobLogo
string
ServicePlanOGIS
Array
Object
OggiServicePlanId
integer int64
OggiTimeFrameId
integer int64
ServiceId
integer int64
BenefitLimit
string
UnitTypeId
integer int64
TimePeriodId
integer int64
CreatedBy
integer int64
CreatedOn
string date-time
OggiLobId
integer int64
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
LobOptionId
integer int64
TimeSpan
integer int32
OptionId
integer int64
LobSubOptionId
integer int64
OptionTypeId
integer int64
UnitType
string
Description
string
Lobs
string
ServiceCodes
string
TimeFrame
string
Frequency
string
Providers
string
TimeSpanValue
string
ConditionTypeId
integer int32
ConditionTypeName
string
IdenticalMappings
Array
Object
IdenticalId
integer int64
IdenticalKey
string
IdenticalType
string
IdenticalRelId
integer int64
AllIdenticalRelIds
string
ScriptFormMappings
Array
Object
ControlId
string
Type
string
TypeId
integer int64
InterventionLanguageMappings
Array
Object
InterventionId
integer int64
LanguageId
integer int64
InterventionName
string
InterventionAliasName
string
DeletedBy
integer int64
DeletedOn
string date-time
ScriptManageActivities
Array
Object
SourceScriptId
integer int64
QuestionId
integer int64
OptionId
integer int64
SubOptionId
integer int64
CallStatus
integer int32
Duration
integer int32
DurationType
integer int32
Enumeration:
0
1
2
CareActivityTypeId
integer int64
CareActivityTypeName
string
MappedScriptId
integer int64
MappedScriptName
string
PriorityId
integer int32
Priority
string
VenueId
integer int64
MappedScriptRunTypeId
integer int64
LobIds
string
Assessments_ScriptFormTemplate
POST /api/Assessments/ScriptFormTemplate

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Assessments_ScriptFormValidationResponses
POST /api/Assessments/ScriptFormValidationResponses

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
MemberId
integer int64
ScriptId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ScriptId
integer int64
PatientId
integer int64
JsKey
string
Result
string
Assessments_GetScriptFormMasterData
POST /api/Assessments/ScriptFormMasterData

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
SfValidationId
integer int64
ScriptId
integer int64
ScriptName
string
JsKey
string
HasMasterData
boolean
SpName
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
SchemaDetails
Object
SchemaQuery
string
OperationQuery
string
TransactionLimit
integer int32
QueryData
Array
Object
Query
string
Assessments_ScriptFormFiles
POST /api/Assessments/ScriptFormFiles

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Authorization
POST /api/Authorization/Authorization
Save Authorization Request
POST /api/Authorization/Authorization

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
actualDischargeDate
string date-time
admissionType
string
alternateAuthID
string
authClass
string
lobName
string
planName
string
authNote
Array of string
authPriority
string
authReviewer
string
authServiceLines
Array
Object
approvedDaysUnits
integer int32
authLineNumber
integer int32
authorizationid
string
decisionReasonCode
string
decisionStatus
string
effectiveDate
string date-time
memberID
string
modifier
string
requestedDaysUnits
integer int32
serviceCode
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
serviceFromDate
string date-time
serviceToDate
string date-time
termDate
string date-time
treatmentType
string
units
string
decisionId
integer int64
memberNotificationType
string
memberNotificationDate
string date-time
memberNotes
string
providerNotificationType
string
providerNotificationDate
string date-time
providerNotes
string
denialType
string
denialReason
string
alternateServiceId
string
unitType
string
decisionDate
string date-time
authStatus
string
prevAuthStatus
string
authType
string
authorizationId
string
callerEmail
string
callerFax
string
callerName
string
callerPhone
string
claimType
string
closedDate
string date-time
closedReason
string
diagnosisCodes
Array
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
dischargeDiagnosis
string
dischargeStatusCode
string
effectiveDate
string date-time
facilityID
string
facilityCapacity
string
lastUpdatedDate
string date-time
memberID
string
notificationDate
string date-time
placeOfService
string
program
string
programName
string
referFromProvider
string
referFromProviderCapacity
string
referToProvider
string
referToProviderCapacity
string
termDate
string date-time
treatmentType
string
authDueDate
string date-time
serviceFromDate
string date-time
serviceToDate
string date-time
requestSentMode
string
outOfAreaIndicator
string
admissionLevel
string
admitReason
string
certificationType
string
mrn
string
transportationMode
string
determinationType
string
reviewType
string
dischargeType
string
dischargeTo
string
memberNotificationType
string
memberNotificationDate
string date-time
providerNotificationType
string
providerNotificationDate
string date-time
admittingProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
referredByProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
referredToProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
facilityProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
string
CarePlan
POST /api/CarePlan/Get
POST /api/CarePlan/GetCarePlans
POST /api/CarePlan/GetGuidingOpportunities
GET /api/CarePlan/GoalGroups
GET /api/CarePlan/Goals
GET /api/CarePlan/Conditions
GET /api/CarePlan/Opportunities
PUT /api/CarePlan/Update
GET /api/CarePlan/Interventions
GET /api/CarePlan/FilterTypes
GET /api/CarePlan/Categories
GET /api/CarePlan/Search
GET /api/CarePlan/Priorities
POST /api/CarePlan/SignOff
POST /api/CarePlan/UploadSignatures
POST /api/CarePlan/SyncEditedCarePlans
POST /api/CarePlan/CarePlanSignatureTemplate
POST /api/CarePlan/UpdateCarePlans
POST /api/CarePlan/UpdateEditedCarePlans
POST /api/CarePlan/GuidingOpportunitiesResolve
CarePlan_Get
POST /api/CarePlan/Get

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required
UserId
integer int64 required
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
CategoryIds
string
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
PriorityId
integer int32
SearchType
string
SearchText
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CarePlan_GetCarePlans
POST /api/CarePlan/GetCarePlans

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required
UserId
integer int64 required
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
CategoryIds
string
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
PriorityId
integer int32
SearchType
string
SearchText
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
New Guiding Opportunities Get service
POST /api/CarePlan/GetGuidingOpportunities

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Master Data GoalGroups
GET /api/CarePlan/GoalGroups

Get GoalGroup MasterData for edit/add CarePlan

Request parameters

UserId
integer int64 required
Status
integer int32 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
GoalGroupId
integer int64
GoalGroupName
string
IsActive
boolean
CreatedBy
integer int64
CareStaffCreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
CareStaffUpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
Master Data Goals
GET /api/CarePlan/Goals

Get Goals MasterData for edit/add CarePlan

Request parameters

UserId
integer int64 required
Status
integer int32 optional
GoalGroupId
integer int64 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
GoalGroupMappingId
integer int64
GoalId
integer int64
GoalName
string
GoalGroupId
integer int64
GoalGroupName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
GoalStyle
string
GoalGroupStyle
string
GoalGroupMapStyle
string
esRowState
string
CustomCount
integer int32
Get Master data of Condition
GET /api/CarePlan/Conditions

Get Condition MasterData for edit/add CarePlan

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ConditionId
integer int64
ConditionName
string
ConditionTypeId
integer int32
ConditionTypeName
string
ConditionWithCategoryName
string
Notes
string
Rank
integer int32
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CareStaffCreatedByName
string
CareStaffUpdatedByName
string
esRowState
string
CustomCount
integer int32
Master Data Opportunity
GET /api/CarePlan/Opportunities

Get Opportunity MasterData for edit/add CarePlan

Request parameters

UserId
integer int64 required
Status
integer int32 optional
ConditionId
integer int64 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
OppCondId
integer int64
ConditionId
integer int64
ConditionName
string
OpportunityId
integer int64
OppName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
UpdatedByName
string
DeletedBy
integer int64
DeletedOn
string date-time
CondStyle
string
OppStyle
string
OppCondMapStyle
string
esRowState
string
CustomCount
integer int32
Update Careplan Details
PUT /api/CarePlan/Update

Update member careplan record.

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
CarePlanId
integer int64
PatientId
integer int64
LobId
integer int64
GoalId
integer int64
InterventionId
integer int64
GoalGroupId
integer int64
GoalGroupIsActive
boolean
ConditionId
integer int64
OppId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
UserId
integer int64
UniqueId
string
InterventionTypeId
integer int32
SignOffStatus
boolean
SourceTypeId
integer int32
IsOfflineCreated
boolean
IsEdited
boolean
OggiLobId
integer int64
DeviceId
string
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string
ActualEndDate
string
CarePlanPriorityId
integer int32
MemberInvolvementId
integer int32
Description
string
IsDeleted
boolean
IsUpdated
boolean
LastUpdatedDate
string
SignOffDate
string date-time
SignOffBy
integer int64
CreatedBy
string
CreatedOn
string
UpdatedOn
string
UpdatedBy
integer int64
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
boolean
Master Data Interventions
GET /api/CarePlan/Interventions

Get Intervention Master Data of Careplan edit/add

Request parameters

UserId
integer int64 required
SearchText
string optional
Status
integer int32 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
InterventionId
integer int64
InterventionName
string
AliasName
string
CustomCount
integer int32
SearchField
string
SearchData
string
GoalId
integer int64
GoalName
string
Master Data FilterType
GET /api/CarePlan/FilterTypes

Get Filter Type Master Data of Careplan edit/add

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array of string
Master Data Category
GET /api/CarePlan/Categories

Get Category Master Data of Careplan edit/add

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CategoryId
integer int32
CategoryName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
Selected
boolean
Master Data Status remarksGet Status Master Data of Careplan editaddremarks
GET /api/CarePlan/Statuses

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
StatusId
integer int32
StatusName
string
CategoryId
integer int32
StatusOnSignOff
integer int32
IsEditable
boolean
IsActive
boolean
CreatedByName
string
CreatedOn
string date-time
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
CategoryName
string
RowNumber
integer int32
Search Careplan
GET /api/CarePlan/Search

Get Careplan records of search related

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
CategoryId
integer int32 required
PriorityId
integer int32 optional
SearchType
string optional
SearchText
string optional
PageNumber
integer int32 optional
PageSize
integer int32 optional
OrderByField
string optional
SortOrder
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CarePlanId
integer int64
PatientId
integer int64
PatientName
string
LobId
integer int64
LobName
string
GoalId
integer int64
GoalName
string
GoalAliasName
string
GoalIsActive
boolean
InterventionId
integer int64
InterventionName
string
InterventionAliasName
string
InterventionIsActive
boolean
GoalGroupId
integer int64
GoalGroupName
string
GoalGroupIsActive
boolean
ConditionId
integer int64
ConditionName
string
ConditionTypeId
integer int32
ConditionTypeName
string
ConditionIsActive
boolean
OppId
integer int64
OppName
string
OppAliasName
string
OpportuniyIsActive
boolean
OggiLobId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
CategoryName
string
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
CarePlanPriorityId
integer int32
CarePlanPriorityName
string
MemberInvolvementId
integer int32
MemberInvolvementName
string
CarePlanTerm
string
CareOpportunityId
integer int64
PatientOpportunityActive
boolean
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedByName
string
DeletedOn
string date-time
RoleId
integer int64
RoleName
string
ReferenceCpId
integer int64
CareOppMappingId
integer int64
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string date-time
ActualEndDate
string date-time
UniqueId
string
LobStyle
string
IntervStyle
string
CondStyle
string
OppStyle
string
GoalStyle
string
GoalGroupStyle
string
esRowState
string
InterventionTypeId
integer int32
InterventionTypeName
string
GuidelineSource
string
FirstName
string
LastName
string
Source
string
CareTeamCarePlanId
integer int64
SignOffStatus
boolean
Percentage
integer int32
CustomCount
integer int32
OpportunityName
string
ActlStartDate
string date-time
ActlEndDate
string date-time
CategoryNameLow
string
MemberSignOffStatus
string
SourceTypeId
integer int32
IsPrimaryCareStaff
boolean
IsSensitiveDiagnosis
boolean
Zip
string
ConditionLevel
string
InterventionNotes
string
OppPriorityId
integer int64
ScriptName
string
Question
string
QuestionOption
string
QuestionSubOption
string
MultipleInterventionName
string
MemberCareTeamId
integer int64
CplOwnerName
string
OppIds
string
OppGroup
string
LanguageId
integer int64
PrimaryLanguageId
integer int64
OpportunityResolvedDate
string date-time
IsEdited
boolean
IsActive
boolean
AssignedOwnerId
integer int64
AssignedOwnerName
string
Master Data Status
GET /api/CarePlan/Priorities

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PriorityId
integer int32
PriorityName
string
PrioritySection
string
IsActive
boolean
esRowState
string
CustomCount
integer int32
CarePlan SignOff
POST /api/CarePlan/SignOff

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
CarePlanSignOffList
Array
Object
MemberId
integer int64
CarePlanId
integer int64
SignOffStatus
boolean
SignOffDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CarePlanId
integer int64
SignOffStatus
boolean
Syncing Care plans from Mobile Local DB to ServerShouldd be removed after 890
POST /api/CarePlan/SyncCarePlans

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
CarePlanId
integer int64
PatientId
integer int64
LobId
integer int64
GoalId
integer int64
InterventionId
integer int64
GoalGroupId
integer int64
GoalGroupIsActive
boolean
ConditionId
integer int64
OppId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
UserId
integer int64
UniqueId
string
InterventionTypeId
integer int32
SignOffStatus
boolean
SourceTypeId
integer int32
IsOfflineCreated
boolean
IsEdited
boolean
OggiLobId
integer int64
DeviceId
string
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string
ActualEndDate
string
CarePlanPriorityId
integer int32
MemberInvolvementId
integer int32
Description
string
IsDeleted
boolean
IsUpdated
boolean
LastUpdatedDate
string
SignOffDate
string date-time
SignOffBy
integer int64
CreatedBy
string
CreatedOn
string
UpdatedOn
string
UpdatedBy
integer int64
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
Uploading Care plan signatures from Mobile to Server
POST /api/CarePlan/UploadSignatures

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
SID
integer int64
UserId
integer int64
MemberId
integer int64
CareStaffSignature
string
MemberSignature
string
MemberSignedEnteredDate
string date-time
CareStaffSignedEnteredDate
string date-time
CreatedDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
boolean
Shouldd be removed after 890
POST /api/CarePlan/SyncEditedCarePlans

Request parameters

UserID
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
CarePlanId
integer int64
PatientId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
AssignedOwnerId
integer int64
Notes
string
UpdatedBy
integer int64
UpdatedOn
string date-time
PriorityId
integer int64
IsSignOff
boolean
IsOfflineEdited
boolean
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
CarePlan_CarePlanSignatureTemplate
POST /api/CarePlan/CarePlanSignatureTemplate

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CarePlan_UpdateCarePlans
POST /api/CarePlan/UpdateCarePlans

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
CarePlanId
integer int64
PatientId
integer int64
LobId
integer int64
GoalId
integer int64
InterventionId
integer int64
GoalGroupId
integer int64
GoalGroupIsActive
boolean
ConditionId
integer int64
OppId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
UserId
integer int64
UniqueId
string
InterventionTypeId
integer int32
SignOffStatus
boolean
SourceTypeId
integer int32
IsOfflineCreated
boolean
IsEdited
boolean
OggiLobId
integer int64
DeviceId
string
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string
ActualEndDate
string
CarePlanPriorityId
integer int32
MemberInvolvementId
integer int32
Description
string
IsDeleted
boolean
IsUpdated
boolean
LastUpdatedDate
string
SignOffDate
string date-time
SignOffBy
integer int64
CreatedBy
string
CreatedOn
string
UpdatedOn
string
UpdatedBy
integer int64
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CarePlanResponses
Array
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
OGGIDeletionResponses
Array
Object
OggiDeletionId
integer int64
OriginalOggiDeletionId
integer int64
ScriptRunLogDetailId
integer int64
CareOpportunityId
integer int64
CarePlan_UpdateEditedCarePlans
POST /api/CarePlan/UpdateEditedCarePlans

Request parameters

UserID
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
CarePlanId
integer int64
PatientId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
AssignedOwnerId
integer int64
Notes
string
UpdatedBy
integer int64
UpdatedOn
string date-time
PriorityId
integer int64
IsSignOff
boolean
IsOfflineEdited
boolean
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CarePlanResponses
Array
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
OGGIDeletionResponses
Array
Object
OggiDeletionId
integer int64
OriginalOggiDeletionId
integer int64
ScriptRunLogDetailId
integer int64
CareOpportunityId
integer int64
GuidingOpportunitiesResolveRequest
POST /api/CarePlan/GuidingOpportunitiesResolve

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
CareOpportunityID
integer int64
ResolutionID
integer int64
StatusID
integer int64
ResolvedDate
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time

Responses

200 200

OK

application/json
text/json
application/xml
text/xml
CaseLoad
GET /api/CaseLoad/Get
CaseLoad_Get
GET /api/CaseLoad/Get

API to get the Caremembers .

Request parameters

UserId
integer int64 required
<value> {"UserId":578255 } </value>
PageNum
integer int32 optional
<value> {PageNum : 1 } </value>
PageSize
integer int32 optional
<value> { PageSize : null/100 } </value>
OrderByField
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientDetailsId
integer int64
PrimaryMedicalCondition
string
PatientId
integer int64
HealthCoachId
integer int64
HasAlert
boolean
RowColorVisibility
string
LastName
string
FirstName
string
Age
string
RiskCategoryName
string
RiskCategoryId
integer int32
CaseStatus
string
PerformedDate
string date-time
PrimaryLanguage
string
PatientDob
string
ReferBy
integer int64
ReferredDate
string date-time
AcceptedDate
string date-time
ReferredStaffName
string
ReferenceStatus
string
ActivityScriptName
string
PlanName
string
LobName
string
LatestPlanStatus
string
esRowState
string
CustomCount
integer int32
Sex
string
CellPhone
string
HomePhone
string
ClientPatientId
string
ProgramNames
string
AltruistaId
string
PrimaryBehaviouralCondition
string
AlertStatus
string
AssignedOn
string date-time
PerformedDateString
string
NextContactDate
string date-time
NextActivity
string
IsRequireActivity
boolean
CarrierMemId
string
LastVisitDate
string date-time
NextVisitDate
string date-time
PcpName
string
ErVisits
integer int64
DueDays
integer int32
LastClaim
string date-time
FullDueDays
string
MemberHealthSummary
integer int32
AppVisits
integer int64
AdtdaysCount
integer int64
ClientName
string
IsSensitiveDiagnosis
boolean
ProgramStatus
string
ReferralSource
string
PersistentSuperUtilizerFlag
string
EligibilityEndDate
string
MemberZipCode
string
RiskScore
string
MemberAddress
string
MemberCity
string
MemberCounty
string
ThlStatus
string
MedicaidNo
string
IsMyMember
boolean
Ssn
string
PsuScore
string
RiskofAdmission
string
RiskLevel
string
RiskColor
string
API to get the accessible clients for the Carestaff
GET /api/Clients/Get

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ConsentForms
GET /api/ConsentForms/Get
GET /api/ConsentForms/Content
GET /api/ConsentForms/MemberConsents
POST /api/ConsentForms/UploadConsent
API to get the Consent Forms Master List
GET /api/ConsentForms/Get

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CnstFormId
integer int64
CnstFormMappingId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
CreatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
UpdatedByName
string
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
ConsentForms_Content
GET /api/ConsentForms/Content

Request parameters

ConsentId
integer int32 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CnstFormId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
Get Member ConsentForms
GET /api/ConsentForms/MemberConsents

Request parameters

MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CnstFormId
integer int64
CnstFormMappingId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
PatientCnstId
integer int64
PatientConsentPath
string
CnstStatusId
integer int32
StatusName
string
PatientId
integer int64
CnstPatientFormValidFrom
string date-time
CnstPatientFormValidTo
string date-time
ConsentFormMasterIsActive
boolean
ConsentFormPatientIsActive
boolean
IsActiveName
string
CnstCheckListId
integer int32
CheckListName
string
CheckListActive
boolean
CareStaffSingedOffBy
integer int64
CareStaffSingedOffByName
string
CareStaffSingedOffOn
string date-time
PatientIdSingedOn
string date-time
CustomComments
string
CreatedBy
integer int64
CreatedOn
string date-time
CreatedByName
string
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
UpdatedByName
string
esRowState
string
CustomCount
integer int32
API to get the MasterData for Consent Form Status
GET /api/ConsentForms/Statuses

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CnstStatusId
integer int32
StatusName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
API to upload a new consent Form
POST /api/ConsentForms/UploadConsent

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
<value> {"FormDetails": {
"PatientId": "694104",
"CnstFormMappingId": "111",
"CnstFormOriginalName": "My Community Connect_Consent Form",
"CareStaffSignedOffBy": 693592,
"CareStaffSignedOffOn": "2016-08-08T16:00:42.5244309-04:00",
"PatientIdSignedOn": "2016-08-08T16:00:42.5244309-04:00",
"CreatedBy": 693592,
"UniqueDeviceId": "03006E250800F4A205009E52060001000400EC36040060D7040088DA0400BAFE01002EB902004ED709006252",
"StatusId": 1
},
"FormContent": "--FormHtml content--"
} </value>
Object
FormDetails
Object
CreatedBy
integer int64

Loggedin User ID

CareStaffSignedOffBy
integer int64

Lob ID

CnstFormMappingId
integer int32

Loggedin User ID

PatientId
integer int64

Lob ID

CnstFormOriginalName
string

Loggedin User ID

CareStaffSignedOffOn
string date-time

Lob ID

PatientIdSignedOn
string date-time

Lob ID

UniqueDeviceId
string

Lob ID

StatusId
integer int32

Lob ID

FormContent
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
This method used for Download the particular consentformpost method
POST /api/ConsentForms/Download

Request parameters

Path
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Document
Function to upload any Document and convert to Pdf
POST /api/Documents/Upload

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
DocumentType
string required
CreatedDate
string date-time required
Description
string optional
FileExtension
string optional

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
integer int32
LOB
GET /api/LOB/MemberLOBs
POST /api/LOB/AddMemberLOB
API to get the accessible LOBs for the carestaff
GET /api/LOB/Get

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
LobId
integer int64
LobName
string
LobDesc
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
LobidDate
string
StartDate
string date-time
EndDate
string date-time
LOB_MemberLOBs
GET /api/LOB/MemberLOBs

Request parameters

UserID
integer int64 required
MemberId
integer int64 required
IncludeInactive
boolean optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
BenefitProgramId
integer int64
ProgramName
string
StartDate
string date-time
EndDate
string date-time
LobIdString
string
IsActive
string
esRowState
string
CustomCount
integer int32
LOB_AddMemberLOB
POST /api/LOB/AddMemberLOB

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required

Patient/MemberID

LOBId
integer int32

LOB ID , you can get the List of LOB from LOB Controller

PlanId
integer int32
MemberPlanId
integer int64
MemberProgramId
integer int64
ProgramId
integer int64
DescriptionId
integer int32
ReferralSourceId
integer int32
StatusNameId
integer int32
InsertType
integer int32 required
StartDate
string date-time required
EndDate
string date-time
CreatedBy
integer int64
UpdatedBy
integer int64
IsParentInactive
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Logger
POST /api/Logger/Sync
Sync Log Exception API
POST /api/Logger/Sync

API to Authenticate the User

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

<value></value>

Array
Object
APIKey
string
LogType
string
DeviceID
string
PatientID
integer int64
UserName
string
UserID
integer int64
LogMessage
string
PlatformType
string
LogTime
string date-time
InputDataObject
string
SyncDateTime
string date-time
MessageTrace
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Master
GET /api/Master/Departments
GET /api/Master/TimeZones
GET /api/Master/Ethnicities
GET /api/Master/ProgramReferralTypes
GET /api/Master/HealthifyDetails
GET /api/Master/SocialProviderURLDetails
GET /api/Master/SecurityConfig
GET /api/Master/MasterDataCheck
GET /api/Master/LastAccessedConfig
GET /api/Master/GetGuidingOpportunitiesReasons
Gets the list of states for the picklists
GET /api/Master/States

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Get List of Departments
GET /api/Master/Departments

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

Get List of TimeZones
GET /api/Master/TimeZones

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
TimeZoneId
integer int64
TimeZone
string
Description
string
API to get the Gender Master Data for picklists
GET /api/Master/Gender

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Relationships Master Data for picklists
GET /api/Master/Relationships

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Insurance Types Master Data for picklists
GET /api/Master/Insurances

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Languages for the picklists
GET /api/Master/Languages

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Race for the Picklists
GET /api/Master/Race

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Ethnicities for picklists
GET /api/Master/Ethnicities

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Program referral types
GET /api/Master/ProgramReferralTypes

This is required when adding a program to a member. Populates the Dropdown.

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Healthify related URLstokens
GET /api/Master/HealthifyDetails

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the Social Provider related URLstokens
GET /api/Master/SocialProviderURLDetails

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
New API to get the carestaff details with dept ids and profile access
GET /api/Master/MasterCareStaffDetails

Request parameters

UserId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
CareStaffDetailsId
integer int64
MemberId
integer int64
RoleId
integer int64
RoleName
string
Title
string
FirstName
string
MiddleName
string
FullName
string
LastName
string
SpecialityId
integer int64
SpecialityName
string
StartDate
string date-time
Address
string
City
string
State
string
Zip
string
Country
string
PrimaryPhone
string
AlternatePhone
string
MobilePhone
string
PrimaryEmail
string
AlternateEmail
string
Fax
string
ViewSecureData
boolean
HourlyRate
number double
DeptId
string
DeptName
string
esRowState
string
CustomCount
integer int32
MemStatus
string
StatusName
string
AccStatus
string
UserName
string
Answer
string
SDate
string
FullNameRole
string
IsActive
boolean
AssignedTo
integer int64
ClinicOrganization
string
CareStaffId
integer int64
IsCreateAdmin
boolean
DirectEmail
string
IsProvider
boolean
CfgAdminConfigID
integer int64
IsPrimary
boolean
TimeZone
string
Credential
string
Specialty
string
CareTransitionNotification
boolean
CareOrganization
string
IsExceeded
integer int32
ProfileIds
string
TimeZoneId
integer int32
HintId
integer int64
HintDescription
string
HintAnswer
string
SignaturePath
string
RoleStatus
boolean
WorkQueueDeptId
string
WorkQueueDeptName
string
HasSameProfile
boolean
DepartmentIds
string
Master_AppSecurityMasterDetails
GET /api/Master/SecurityConfig

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PolicyConfigKey
string
PolicyConfigValue
string
Master_MasterDataCheck
GET /api/Master/MasterDataCheck

Request parameters

UserId
integer int64 required
LastUpdated
string date-time required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ApiId
integer int32
ApiKey
string
Master_LastAccessedConfig
GET /api/Master/LastAccessedConfig

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
Feature
integer int32
Enumeration:
0
1
2
3
4
5
6
7
MaxValue
integer int32
DefaultValue
integer int32
ThresholdValue
integer int32
FeatureName
string
API to get the Reasons
GET /api/Master/GetGuidingOpportunitiesReasons

This is required when Resolve the Guiding Opportunities. Populates the Dropdown.

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Member
POST /api/Member/Create
GET /api/Member/Details
POST /api/Member/Update
GET /api/Member/FamilyDetails
POST /api/Member/ActivitySummary
API to add a new member to the DB
POST /api/Member/Create

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
FirstName
string required

First Name of the member

LastName
string

Last name of the member

GenderId
string

Gender ID like “M” , “F” …

AddressTypeId
integer int32

Address Type ID - from Primary Address

AddressLine1
string

Address Line 1 - from Primary Address

AddressLine2
string

Address Line 2 - from Primary Address

State
string

State Code like “AK” - from Primary Address

City
string

City - from Primary Address

ZipCode
string

zip - from primary Address

HomePhone
string

Home Phone - xxx-xxx-xxxx format

CellPhone
string

CellPhone - xxx-xxx-xxxx format

AlternatePhone
string

AlternatePhone - xxx-xxx-xxxx format

PrimaryEmail
string

Primary Email

DateOfBirth
string date-time

Date of Birth - DateTime Object

UserId
integer int64

Care Staff user ID - created by

UpdatedBy
integer int64

User ID of careStaff updating the data

SchoolName
string

School Name

SchoolDistrict
string

School District

RaceId
integer int32

Race ID

EthnicityIds
string

Ethnicity Ids - Multi select like “1,2,3,4” / null / “2”

PrimaryLanguageId
integer int32

Primary Language ID

InsuranceTypeId
string

Insurance Type ID like “CC” - for Medicaid Choice

RelationshipType
string

Relationship type ID like “F”

RelationshipName
string
VeteranStatus
integer int32

Veteran Status = 1 for Yes, Default is 0., Status=null not avialble

LobId
integer int32

LOB Id -

ClientId
integer int32

Client Id

PlanIds
string

Plan Ids String - like “50306,30113”

StartDate
string date-time

Start Date of Insurance

EndDate
string date-time

End Date of Insurance - not mandatory

ClientPatientId
string

Client Patient ID - returned in the response

QRCodeImageData
string

QR Code Image data as Base64 string - returned in response

MemberId
integer int64

Member Id - returned in response

IsSensitiveDiagnosis
boolean

Returned in Get Details - would be used for future BusinessLogic.

ExceptionMessage
string

Exception Message sent in case of failure - returned in Response

MedicaidNo
string

MedicaidNo

PreferredPhone
string

PreferredPhone

PreferredPhoneType
string

PreferredPhoneType

PreferredPhoneTypeId
integer int32

PreferredPhoneTypeID

InsuranceType
string
ConsentStatus
integer int32

Member Consent form Status

PrimaryCareProvider
string
IsMyMember
boolean
PreferredLanguagesIds
string

Gets comma separeted Languages for the member

PrimaryMedicalConditionId
integer int64

Added for careplan signature funtionality

PrimaryMedicalConditionName
string

Added for careplan signature funtionality

PrimaryBehaviouralConditionId
integer int64

Added for careplan signature funtionality

PrimaryBehaviouralConditionName
string

Added for careplan signature funtionality

PrimaryCareStaffName
string

Added for careplan signature funtionality

MaritalStatus
string

Added for careplan signature funtionality

CarestaffPrimaryEmail
string

Added for careplan signature funtionality

RiskLevel
string

Patient Risk Level

PrivacyAddress
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Member_Details
GET /api/Member/Details

Request parameters

UserId
integer int64 required
MemberId
integer int64 required

Request body

Responses

200 200

Member Details

Body
application/json
text/json
application/xml
text/xml
Object
FirstName
string required

First Name of the member

LastName
string

Last name of the member

GenderId
string

Gender ID like “M” , “F” …

AddressTypeId
integer int32

Address Type ID - from Primary Address

AddressLine1
string

Address Line 1 - from Primary Address

AddressLine2
string

Address Line 2 - from Primary Address

State
string

State Code like “AK” - from Primary Address

City
string

City - from Primary Address

ZipCode
string

zip - from primary Address

HomePhone
string

Home Phone - xxx-xxx-xxxx format

CellPhone
string

CellPhone - xxx-xxx-xxxx format

AlternatePhone
string

AlternatePhone - xxx-xxx-xxxx format

PrimaryEmail
string

Primary Email

DateOfBirth
string date-time

Date of Birth - DateTime Object

UserId
integer int64

Care Staff user ID - created by

UpdatedBy
integer int64

User ID of careStaff updating the data

SchoolName
string

School Name

SchoolDistrict
string

School District

RaceId
integer int32

Race ID

EthnicityIds
string

Ethnicity Ids - Multi select like “1,2,3,4” / null / “2”

PrimaryLanguageId
integer int32

Primary Language ID

InsuranceTypeId
string

Insurance Type ID like “CC” - for Medicaid Choice

RelationshipType
string

Relationship type ID like “F”

RelationshipName
string
VeteranStatus
integer int32

Veteran Status = 1 for Yes, Default is 0., Status=null not avialble

LobId
integer int32

LOB Id -

ClientId
integer int32

Client Id

PlanIds
string

Plan Ids String - like “50306,30113”

StartDate
string date-time

Start Date of Insurance

EndDate
string date-time

End Date of Insurance - not mandatory

ClientPatientId
string

Client Patient ID - returned in the response

QRCodeImageData
string

QR Code Image data as Base64 string - returned in response

MemberId
integer int64

Member Id - returned in response

IsSensitiveDiagnosis
boolean

Returned in Get Details - would be used for future BusinessLogic.

ExceptionMessage
string

Exception Message sent in case of failure - returned in Response

MedicaidNo
string

MedicaidNo

PreferredPhone
string

PreferredPhone

PreferredPhoneType
string

PreferredPhoneType

PreferredPhoneTypeId
integer int32

PreferredPhoneTypeID

InsuranceType
string
ConsentStatus
integer int32

Member Consent form Status

PrimaryCareProvider
string
IsMyMember
boolean
PreferredLanguagesIds
string

Gets comma separeted Languages for the member

PrimaryMedicalConditionId
integer int64

Added for careplan signature funtionality

PrimaryMedicalConditionName
string

Added for careplan signature funtionality

PrimaryBehaviouralConditionId
integer int64

Added for careplan signature funtionality

PrimaryBehaviouralConditionName
string

Added for careplan signature funtionality

PrimaryCareStaffName
string

Added for careplan signature funtionality

MaritalStatus
string

Added for careplan signature funtionality

CarestaffPrimaryEmail
string

Added for careplan signature funtionality

RiskLevel
string

Patient Risk Level

PrivacyAddress
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean
404 404

No member details found for Member

application/json
text/json
application/xml
text/xml
500 500

Internal Server Error

application/json
text/json
application/xml
text/xml
Update Member Details
POST /api/Member/Update

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
FirstName
string required

First Name of the member

LastName
string

Last name of the member

GenderId
string

Gender ID like “M” , “F” …

AddressTypeId
integer int32

Address Type ID - from Primary Address

AddressLine1
string

Address Line 1 - from Primary Address

AddressLine2
string

Address Line 2 - from Primary Address

State
string

State Code like “AK” - from Primary Address

City
string

City - from Primary Address

ZipCode
string

zip - from primary Address

HomePhone
string

Home Phone - xxx-xxx-xxxx format

CellPhone
string

CellPhone - xxx-xxx-xxxx format

AlternatePhone
string

AlternatePhone - xxx-xxx-xxxx format

PrimaryEmail
string

Primary Email

DateOfBirth
string date-time

Date of Birth - DateTime Object

UserId
integer int64

Care Staff user ID - created by

UpdatedBy
integer int64

User ID of careStaff updating the data

SchoolName
string

School Name

SchoolDistrict
string

School District

RaceId
integer int32

Race ID

EthnicityIds
string

Ethnicity Ids - Multi select like “1,2,3,4” / null / “2”

PrimaryLanguageId
integer int32

Primary Language ID

InsuranceTypeId
string

Insurance Type ID like “CC” - for Medicaid Choice

RelationshipType
string

Relationship type ID like “F”

RelationshipName
string
VeteranStatus
integer int32

Veteran Status = 1 for Yes, Default is 0., Status=null not avialble

LobId
integer int32

LOB Id -

ClientId
integer int32

Client Id

PlanIds
string

Plan Ids String - like “50306,30113”

StartDate
string date-time

Start Date of Insurance

EndDate
string date-time

End Date of Insurance - not mandatory

ClientPatientId
string

Client Patient ID - returned in the response

QRCodeImageData
string

QR Code Image data as Base64 string - returned in response

MemberId
integer int64

Member Id - returned in response

IsSensitiveDiagnosis
boolean

Returned in Get Details - would be used for future BusinessLogic.

ExceptionMessage
string

Exception Message sent in case of failure - returned in Response

MedicaidNo
string

MedicaidNo

PreferredPhone
string

PreferredPhone

PreferredPhoneType
string

PreferredPhoneType

PreferredPhoneTypeId
integer int32

PreferredPhoneTypeID

InsuranceType
string
ConsentStatus
integer int32

Member Consent form Status

PrimaryCareProvider
string
IsMyMember
boolean
PreferredLanguagesIds
string

Gets comma separeted Languages for the member

PrimaryMedicalConditionId
integer int64

Added for careplan signature funtionality

PrimaryMedicalConditionName
string

Added for careplan signature funtionality

PrimaryBehaviouralConditionId
integer int64

Added for careplan signature funtionality

PrimaryBehaviouralConditionName
string

Added for careplan signature funtionality

PrimaryCareStaffName
string

Added for careplan signature funtionality

MaritalStatus
string

Added for careplan signature funtionality

CarestaffPrimaryEmail
string

Added for careplan signature funtionality

RiskLevel
string

Patient Risk Level

PrivacyAddress
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Member_FamilyDetails
GET /api/Member/FamilyDetails

Request parameters

MemberId
integer int64 required

Request body

Responses

200 200

List of Family Details

Body
application/json
text/json
application/xml
text/xml
Array
Object
AltruistaId
string
FirstName
string
LastName
string
Gender
string
BirthYear
string date-time
PatientDetailsId
integer int64
ClientId
integer int64
PatientId
integer int64
NamePrefix
string
MiddleName
string
NameSuffix
string
MothersName
string
EthnicityId
integer int32
Address
string
City
string
State
string
Zip
string
CountyId
integer int32
Country
string
Fax
string
PrimaryLanguageId
integer int64
HomePhone
string
CellPhone
string
AlternatePhone
string
PrimaryEmail
string
AlternateEmail
string
InsurancePolicyNumber
string
InsurancePlan
string
RelationshipType
string
MaritalStatus
string
PrimaryMedicalConditionId
integer int64
MedicalDescription
string
PrimaryBehaviouralConditionId
integer int64
BehaviouralDescription
string
PreferedTimeOfCall
string
Height
string
Income
number double
ResidenceStatusId
integer int32
IncentiveAmount
number double
Comments
string
ReferralType
integer int32
SsnSub
string
DobNormalized
string
InsuranceType
string
IncomeCriteria
string
StatusId
integer int32
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
IsDemo
boolean
RaceId
integer int64
SecondaryInsuranceType
string
SecondaryInsurancePolicyNumber
string
BoroughId
integer int64
AddressLine
string
esRowState
string
CustomCount
integer int32
BirthYearString
string
Age
integer int32
PrimaryLanguageName
string
AgeInYears
string
RelationshipValue
string
404 404

No family details found for Member

application/json
text/json
application/xml
text/xml
500 500

Internal Server Error

application/json
text/json
application/xml
text/xml
Member_ActivitySummary
POST /api/Member/ActivitySummary

Request parameters

MemberId
integer int64 required
pageNum
integer int32 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientFollowupId
integer int64
ScheduledDate
string date-time
PerformedBy
integer int64
PerformedByName
string
PerformedDate
string date-time
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
CareActivityTypeName
string
PatientId
integer int64
ClientPatientId
string
FirstName
string
LastName
string
ActivityOutcomeId
integer int64
ActualDuration
string
PlaceOfServiceId
integer int64
ScriptRunLogId
integer int64
ScriptScore
number double
ScriptEndDatetime
string date-time
ScriptRunTypeId
integer int64
StatusId
integer int64
SfHtmlFile
string
EndDate
string date-time
DeletedOn
string date-time
MemberPhone
GET /api/MemberPhone/PhoneTypes
GET /api/MemberPhone/PhoneTypesOthers
GET /api/MemberPhone/MemberPhones
POST /api/MemberPhone/Add
POST /api/MemberPhone/Update
POST /api/MemberPhone/UpdatePrefferedPhone
POST /api/MemberPhone
MemberPhone_PhoneTypes
GET /api/MemberPhone/PhoneTypes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_PhoneTypesOthers
GET /api/MemberPhone/PhoneTypesOthers

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_MemberPhones
GET /api/MemberPhone/MemberPhones

Request parameters

MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_Add
POST /api/MemberPhone/Add

Request parameters

MemberId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
PhoneType
string
PhoneNumber
string
IsPreferred
boolean
esRowState
string
CreatedOn
string date-time
UpdatedOn
string date-time
DeletedBy
string
DeletedOn
string date-time
CreatedBy
string
UpdatedBy
string
Extension
string
PhoneNotes
string
CustomCount
integer int32
PhoneTypeId
integer int32
PatientPhoneId
integer int64
RowNumber
integer int32

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_Update
POST /api/MemberPhone/Update

Request parameters

MemberId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
PhoneType
string
PhoneNumber
string
IsPreferred
boolean
esRowState
string
CreatedOn
string date-time
UpdatedOn
string date-time
DeletedBy
string
DeletedOn
string date-time
CreatedBy
string
UpdatedBy
string
Extension
string
PhoneNotes
string
CustomCount
integer int32
PhoneTypeId
integer int32
PatientPhoneId
integer int64
RowNumber
integer int32

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_UpdatePrefferedPhone
POST /api/MemberPhone/UpdatePrefferedPhone

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
PhoneType
string required

HOME_PHONE/CELL_PHONE/ALTERNATE_PHONE

PhoneNumber
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
MemberPhone_Post
POST /api/MemberPhone

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
string

Responses

204 204

No Content

MemberPlan
GET /api/MemberPlan/OfMember
POST /api/MemberPlan/Update
POST /api/MemberPlan/SyncMemberPlans
Get Member plans
GET /api/MemberPlan/OfMember

API to fetch the member plans of member. Only carestaff id and member id are required paramters. Rest are optional.

Request parameters

UserID
integer int64 required
MemberId
integer int64 required
StartDate
string date-time optional
EndDate
string date-time optional
LanguageId
integer int64 optional
PageNumber
integer int32 optional
PageSize
integer int32 optional
CategoryID
string optional
OrderByField
string optional
SortOrder
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CarePlanId
integer int64
PatientId
integer int64
PatientName
string
LobId
integer int64
LobName
string
GoalId
integer int64
GoalName
string
GoalAliasName
string
GoalIsActive
boolean
InterventionId
integer int64
InterventionName
string
InterventionAliasName
string
InterventionIsActive
boolean
GoalGroupId
integer int64
GoalGroupName
string
GoalGroupIsActive
boolean
ConditionId
integer int64
ConditionName
string
ConditionTypeId
integer int32
ConditionTypeName
string
ConditionIsActive
boolean
OppId
integer int64
OppName
string
OppAliasName
string
OpportuniyIsActive
boolean
OggiLobId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
CategoryName
string
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
CarePlanPriorityId
integer int32
CarePlanPriorityName
string
MemberInvolvementId
integer int32
MemberInvolvementName
string
CarePlanTerm
string
CareOpportunityId
integer int64
PatientOpportunityActive
boolean
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedByName
string
DeletedOn
string date-time
RoleId
integer int64
RoleName
string
ReferenceCpId
integer int64
CareOppMappingId
integer int64
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string date-time
ActualEndDate
string date-time
UniqueId
string
LobStyle
string
IntervStyle
string
CondStyle
string
OppStyle
string
GoalStyle
string
GoalGroupStyle
string
esRowState
string
InterventionTypeId
integer int32
InterventionTypeName
string
GuidelineSource
string
FirstName
string
LastName
string
Source
string
CareTeamCarePlanId
integer int64
SignOffStatus
boolean
Percentage
integer int32
CustomCount
integer int32
OpportunityName
string
ActlStartDate
string date-time
ActlEndDate
string date-time
CategoryNameLow
string
MemberSignOffStatus
string
SourceTypeId
integer int32
IsPrimaryCareStaff
boolean
IsSensitiveDiagnosis
boolean
Zip
string
ConditionLevel
string
InterventionNotes
string
OppPriorityId
integer int64
ScriptName
string
Question
string
QuestionOption
string
QuestionSubOption
string
MultipleInterventionName
string
MemberCareTeamId
integer int64
CplOwnerName
string
OppIds
string
OppGroup
string
LanguageId
integer int64
PrimaryLanguageId
integer int64
OpportunityResolvedDate
string date-time
IsEdited
boolean
IsActive
boolean
AssignedOwnerId
integer int64
AssignedOwnerName
string
MemberPlan_UpdateMemberPlan
POST /api/MemberPlan/Update

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
AliasIntervention
string
StartDate
string date-time
EndDate
string date-time
Comment
string
IsCarePlan
boolean
CarePlanId
integer int64
LanguageId
integer int32
OfflineId
integer int64
MemberId
integer int64
CreatedOn
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
string
API for Memberplan Updates
POST /api/MemberPlan/SyncMemberPlans

Request parameters

UserID
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
UserId
integer int64
AliasIntervention
string
StartDate
string date-time
EndDate
string date-time
Comment
string
IsCarePlan
boolean
CarePlanId
integer int64
LanguageId
integer int32
OfflineId
integer int64
MemberId
integer int64
CreatedOn
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
MemberPlanId
integer int64
IsUpdateSuccess
boolean
Notes
GET /api/Notes/Types
POST /api/Notes/Sync
Get Care Notes this should be deprecated
GET /api/Notes/OfMember

API to fetch the care notes for a member. Only carestaff id and member id are required paramters. Rest are optional.

Request parameters

UserID
integer int64 required
MemberId
integer int64 required
StartDate
string date-time optional
EndDate
string date-time optional
NoteType
string optional
PageNumber
integer int32 optional
PageSize
integer int32 optional
OrderByField
string optional
SortOrder
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HealthNotesId
integer int64
PatientId
integer int64
HealthNotes
string
CareStaffName
string
NoteType
string
HealthNoteTypeId
integer int32
ReferenceId
integer int64
CreatedBy
string date-time
CreatedDate
string date-time
UpdatedBy
string date-time
UpdatedOn
string date-time
CustomCount
integer int32
ScriptName
string
GoalActivityQuestionName
string
IsAlert
boolean
HealthNotesDate
string date-time
StatusName
string
OppName
string
MeasureVersion
integer int64
OppDetailId
integer int64
QualityMeasureStatusId
integer int64
QualityMeasureStatusName
string
FirstName
string
LastName
string
AltruistaId
string
CplNotesGroupId
integer int64
IsMultipleCareplan
integer int32
Type
string
ContactType
string
HasNextPage
boolean
QuestionId
integer int64
CareActivityTypeName
string
DeletedOn
string date-time
New API for fetching notes based on dates and date filters
POST /api/Notes/GetMemberNotes

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required
UserId
integer int64 required
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
NoteType
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HealthNotesId
integer int64
PatientId
integer int64
HealthNotes
string
CareStaffName
string
NoteType
string
HealthNoteTypeId
integer int32
ReferenceId
integer int64
CreatedBy
string date-time
CreatedDate
string date-time
UpdatedBy
string date-time
UpdatedOn
string date-time
CustomCount
integer int32
ScriptName
string
GoalActivityQuestionName
string
IsAlert
boolean
HealthNotesDate
string date-time
StatusName
string
OppName
string
MeasureVersion
integer int64
OppDetailId
integer int64
QualityMeasureStatusId
integer int64
QualityMeasureStatusName
string
FirstName
string
LastName
string
AltruistaId
string
CplNotesGroupId
integer int64
IsMultipleCareplan
integer int32
Type
string
ContactType
string
HasNextPage
boolean
QuestionId
integer int64
CareActivityTypeName
string
DeletedOn
string date-time
Notes_GetMasterNotesTypes
GET /api/Notes/Types

Request parameters

UserID
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
NoteTypeId
integer int64
NoteType
string
IsNoteType
boolean
NoteStatus
boolean
TableName
string
ColumnName
string
RowNumber
integer int32
HealthNoteTemplate
string
HasProfileAccess
boolean
Notes_SyncNotes
POST /api/Notes/Sync

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
UserId
integer int64
PatientId
integer int64
HealthNoteTypeId
integer int32
HealthNotes
string
HealthNotesDate
string date-time
IsAlert
boolean
IsConfidential
boolean
CreatedDate
string date-time
UpdatedOn
string date-time
HealthNotesId
integer int64
ReferenceId
integer int64
OfflineId
integer int64
AlertUpdatedBy
integer int64
AlertUpdatedOn
string date-time
QuestionId
integer int64
AlertStatusId
integer int32
IsNoteType
boolean
SyncDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
HealthNoteId
integer int64
ReferenceId
integer int64
NewReferenceId
integer int64
NewHealthNoteId
integer int64
Outcome
GET /api/Outcome/Venu
GET /api/Outcome/PlaceOfServices
GET /api/Outcome/Codes
GET /api/Outcome/ActivityOutcomes
GET /api/Outcome/ActivityOutcomeTypes
API to get VenueContact Type
GET /api/Outcome/Venu

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
VenueId
integer int64
VenueName
string
CreatedOn
string date-time
CreatedBy
integer int64
UpdatedOn
string date-time
UpdatedBy
integer int64
DeletedOn
string date-time
DeletedBy
integer int64
esRowState
string
CustomCount
integer int32
CreatedByName
string
UpdatedByName
string
IsActive
boolean
IsDefault
boolean
DefaultVenueName
string
RowNumber
integer int32
API call get Place of Services
GET /api/Outcome/PlaceOfServices

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PlaceOfServiceId
integer int64
PlaceOfService
string
IsActiveName
string
IsActive
boolean
CreatedByName
string
UpdatedByName
string
AlternatecarestaffName
string
CreatedBy
string
CreatedOn
string date-time
CfgAdminConfigId
integer int64
AdminConfigName
string
esRowState
string
Result
string
UpdatedBy
string
UpdatedOn
string date-time
CustomCount
integer int32
RowNumber
integer int32
API call get Services Codes
GET /api/Outcome/Codes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ActivityOutcomeId
integer int64
ActivityOutcome
string
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
RunLogId
integer int64
PatientFollowupId
integer int64
OutComeNotes
string
ActualDuration
string
PlaceOfService
string
PlaceOfServiceId
integer int64
VenueID
integer int64
HcpcCodeId
integer int64
HcpcCode
string
IsActivityOutcomeMandatory
integer int32
CareActivityTypeId
integer int64
API call get Activity Outcomes
GET /api/Outcome/ActivityOutcomes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ActivityOutcomeId
integer int64
ActivityOutcome
string
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
RunLogId
integer int64
PatientFollowupId
integer int64
OutComeNotes
string
ActualDuration
string
PlaceOfService
string
PlaceOfServiceId
integer int64
VenueID
integer int64
HcpcCodeId
integer int64
HcpcCode
string
IsActivityOutcomeMandatory
integer int32
CareActivityTypeId
integer int64
API to get Activity Outcome Types
GET /api/Outcome/ActivityOutcomeTypes

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ActivityOutcomesList
Array
Object
ActivityOutcomeId
integer int64
ActivityOutcome
string
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
RunLogId
integer int64
PatientFollowupId
integer int64
OutComeNotes
string
ActualDuration
string
PlaceOfService
string
PlaceOfServiceId
integer int64
VenueID
integer int64
HcpcCodeId
integer int64
HcpcCode
string
IsActivityOutcomeMandatory
integer int32
CareActivityTypeId
integer int64
ActivityOutcomeTypes
Array
Object
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
Plans
POST /api/BenefitPlan/Get
GET /api/BenefitPlan/MemberPlans
POST /api/BenefitPlan/AddMemberPlan
API to get the Plans related to LOB
POST /api/BenefitPlan/Get

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
careStaffId
integer int64

Loggedin User ID

LobId
integer int32

Lob ID

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
BenefitPlanId
integer int64
PlanName
string
PlanDesc
string
StartDate
string date-time
EndDate
string date-time
HasExpired
boolean
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
Plans_MemberPlans
GET /api/BenefitPlan/MemberPlans

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
LobId
integer int32 required
IncludeInactive
boolean optional

Default False, Pass True for Edit Plans/Programs Purpose

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
MemBenfPlanId
integer int64
MemberId
integer int64
StartDate
string date-time
EndDate
string date-time
PlanName
string
esRowState
string
CustomCount
integer int32
LobName
string
BenefitPlanId
integer int64
Plans_AddMemberPlan
POST /api/BenefitPlan/AddMemberPlan

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required

Patient/MemberID

LOBId
integer int32

LOB ID , you can get the List of LOB from LOB Controller

PlanId
integer int32
MemberPlanId
integer int64
MemberProgramId
integer int64
ProgramId
integer int64
DescriptionId
integer int32
ReferralSourceId
integer int32
StatusNameId
integer int32
InsertType
integer int32 required
StartDate
string date-time required
EndDate
string date-time
CreatedBy
integer int64
UpdatedBy
integer int64
IsParentInactive
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Profile
GET /api/Profile/Active
Profile_ActiveProfiles
GET /api/Profile/Active

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
CfgAdminConfigId
integer int64
AdminConfigName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
UpdatedByName
string
CreatedByName
string
ParentId
integer int64
ParentName
string
LevelId
integer int64
CareOrganization
string
IsExceeded
boolean
ProfileType
string
Address
string
Email
string
Phone
string
Fax
string
IsCheck
integer int32
IsEditable
boolean
IsUnassign
integer int32
Program
GET /api/Program/Get
GET /api/Program/ByPlanIds
POST /api/Program/AddMemberProgram
POST /api/Program/UpdateMemberProgram
GET /api/Program/StatusNames
GET /api/Program/StatusDescriptions
GET /api/Program/MasterProgramsList
GET /api/Program/MasterStatusList
Program_Get
GET /api/Program/Get

Request parameters

MemberId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
IsDataLoad
boolean
MemBenfProgId
integer int64
PlanName
string
ProgramName
string
MemberId
integer int64
MemBenfPlanId
integer int64
BenPlanProgId
integer int64
ClosureId
integer int32
ReferralTypeId
integer int32
IsPending
boolean
StartDate
string date-time
EndDate
string date-time
MemberStatus
string
LobId
integer int64
esRowState
string
CustomCount
integer int32
LobName
string
PlanDesc
string
LobDesc
string
ProgramDesc
string
BenefitPlanId
integer int64
IsPendingStr
string
lblPrevReason
string
trPlanNameVisible
boolean
Type
string
ErrorMessage
string
StrUpdate
string
StatusDescription
string
RecordStatus
string
ProgramStatusId
integer int64
CreatedBy
string
ProgramStatus
string
Reason
string
Operation
string
CreatedOn
string date-time
UpdatedOn
string date-time
ReferralType
string
CarrierMemId
string
UpdatedBy
string
Program_ProgramsByPlanIds
GET /api/Program/ByPlanIds

Request parameters

PlanIds
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
BenefitProgramId
integer int64
ProgramName
string
ProgramDesc
string
StartDate
string date-time
EndDate
string date-time
HasExpired
boolean
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
Handleing for Added New programs LOBPlanProgram
POST /api/Program/AddMemberProgram

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required

Patient/MemberID

LOBId
integer int32

LOB ID , you can get the List of LOB from LOB Controller

PlanId
integer int32
MemberPlanId
integer int64
MemberProgramId
integer int64
ProgramId
integer int64
DescriptionId
integer int32
ReferralSourceId
integer int32
StatusNameId
integer int32
InsertType
integer int32 required
StartDate
string date-time required
EndDate
string date-time
CreatedBy
integer int64
UpdatedBy
integer int64
IsParentInactive
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Update Memer Program Details
POST /api/Program/UpdateMemberProgram

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
MemberId
integer int64 required

Patient/MemberID

LOBId
integer int32

LOB ID , you can get the List of LOB from LOB Controller

PlanId
integer int32
MemberPlanId
integer int64
MemberProgramId
integer int64
ProgramId
integer int64
DescriptionId
integer int32
ReferralSourceId
integer int32
StatusNameId
integer int32
InsertType
integer int32 required
StartDate
string date-time required
EndDate
string date-time
CreatedBy
integer int64
UpdatedBy
integer int64
IsParentInactive
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
API to get the statusNames
GET /api/Program/StatusNames

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ProgramStatusId
integer int64
ProgramStatusName
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
API to get the Status Descriptions
GET /api/Program/StatusDescriptions

Request parameters

ProgramStatusId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ProgramReasonId
integer int32
ReasonDescription
string
ReasonType
string
CreatedOn
string date-time
CreatedBy
integer int64
IsActive
boolean
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
ProgramStatusId
integer int64
Program_ProgramsMasterDataByCareStaff
GET /api/Program/MasterProgramsList

Handle for Get Master LOB,Plan,Programs Master Data based on CareStaffID

Request parameters

UserId
integer int64 required
<value> {"UserId":578255 } </value>

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
Id
integer int64
Name
string
TypeId
integer int32
TypeName
string
ParentId
integer int64
StartDate
string date-time
EndDate
string date-time
RowNumber
integer int32
Program_BindMasterProgramStatusData
GET /api/Program/MasterStatusList

This API returns a list of status name, Status Description .

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
Id
integer int64
Name
string
TypeId
integer int32
TypeName
string
ParentId
integer int64
StartDate
string date-time
EndDate
string date-time
RowNumber
integer int32
Provider
POST /api/Provider/Add
POST /api/Provider/AddHealthify
GET /api/Provider/GetHealthify
GET /api/Provider/Filter
GET /api/Provider/Details
POST /api/Provider/SocialReferralType
POST /api/Provider/Save
GET /api/Provider
Provider_Add
POST /api/Provider/Add

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
HealthifyId
integer int64
Address
string
ProviderName
string
WorkPhone
string
City
string
State
string
Zip
string
ProviderTypeName
string
LanguageName
string
Email
string
UUID
string
IsHealthify
boolean
CareTeamId
integer int64
CreatedOn
string date-time
CarePlanId
integer int64
MemberZipCode
string
InterventionName
string
SearchURL
string
CreatedBy
integer int64
MemberId
integer int64
ReferralType
integer int32
IsPreferredProvider
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Save Healthify Details
POST /api/Provider/AddHealthify

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UUID
string
CarePlanId
integer int64
MemberZipCode
string
InterventionName
string
SearchURL
string
CreatedBy
integer int64
CreatedOn
string date-time
MemberId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Healthify Provider Details
GET /api/Provider/GetHealthify

Request parameters

UUID
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Provider_ProviderFilter
GET /api/Provider/Filter

Request parameters

UserId
integer int64 required
MemberId
integer int64 required
ProviderName
string required
IsEdit
boolean optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ProviderName
string
PhysicianCode
string
PhysicianId
integer int64
ProviderIndicator
string
ProviderType
string
ProviderTypeId
integer int32
Address
string
CellPhone
string
Email
string
IsPreferredProvider
boolean
IsSocialReferral
boolean
Provider_ProviderDetails
GET /api/Provider/Details

Request parameters

UserId
integer int64 required
PhysicianId
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientPhysicianId
integer int64
PatientId
integer int64
PhysicianId
integer int64
ProviderType
string
EffectiveFrom
string date-time
EffectiveTo
string date-time
HasAlert
boolean
IsSelfReported
boolean
CreatedOn
string date-time
UpdatedOn
string date-time
PhysicianCode
string
NamePrefix
string
FirstName
string
LastName
string
MiddleName
string
NameSuffix
string
EthnicityId
integer int32
Address
string
City
string
State
string
Country
string
Zip
string
Fax
string
SpecialityId
string
Speciality
string
ProviderTypeId
integer int32
ProviderTypeName
string
PrimaryBehavioral
boolean
PrimaryLanguage
string
HomePhone
string
CellPhone
string
AlternatePhone
string
Email
string
CreatedBy
integer int64
Status
string
WorkPhone
string
ProviderName
string
ClinicId
string
ClinicName
string
IsPcp
boolean
CareTeamId
integer int64
StartDate
string date-time
EndDate
string date-time
IsThroughLoad
boolean
PcpName
string
CareNote
string
IsActive
integer int32
ItemStyle
string
VendorID
integer int64
IndexName
string
ProviderParStat
string
VendorIndexName
string
IsPrimary
boolean
LobId
string
LanguageIds
string
SpecialityIds
string
Gender
string
BoroughId
integer int64
IsPcp1
boolean
PrimaryBehavioral1
boolean
CareTeamUnableChk
string
DirectEmail
string
esRowState
string
CustomCount
integer int32
CountyId
integer int32
Username
string
ProviderIndicator
string
ProviderNpi
string
ProviderMpin
string
ProviderTaxId
string
IndexValue
string
PcmStartDate
string date-time
PcmEndDate
string date-time
CreatedByName
string
UpdatedByName
string
HealthifyId
integer int64
EmailId
string
EmailSentDate
string date-time
IsPreferredProvider
boolean
IsSocialReferral
boolean
Provider_ReferralType
POST /api/Provider/SocialReferralType

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
HealthifyId
integer int64
Address
string
ProviderName
string
WorkPhone
string
City
string
State
string
Zip
string
ProviderTypeName
string
LanguageName
string
Email
string
UUID
string
IsHealthify
boolean
CareTeamId
integer int64
CreatedOn
string date-time
CarePlanId
integer int64
MemberZipCode
string
InterventionName
string
SearchURL
string
CreatedBy
integer int64
MemberId
integer int64
ReferralType
integer int32
IsPreferredProvider
boolean

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Provider_SocialProviderInsert
POST /api/Provider/Save

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
healthifyID
integer int64
AddressLine1
string
AddressLine2
string
City
string
ProviderName
string
ProviderTypeName
string
State
string
ZipCode
string
IsUpdate
string
CareTeamId
string
CreatedBy
Object
UUID
string
IsPreferredProvider
boolean
Email
string
Address
string
Phone
string
UserId
integer int64

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Healthify History Details
GET /api/Provider

Request parameters

MemberZipCode
string required
InterventionName
string optional
MemberId
integer int64 optional
CarePlanId
integer int64 optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Role
GET /api/Role/Active
GET /api/Role/Fields
GET /api/Role/MenuTabs
GET /api/Role/MenuLinks
GET /api/Role/ApplicationConfig
Get Active Role
GET /api/Role/Active

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ApplicationId
string uuid
Example:
00000000-0000-0000-0000-000000000000
RoleId
string uuid
Example:
00000000-0000-0000-0000-000000000000
RoleName
string
LoweredRoleName
string
Description
string
RolesGroupId
string
RolesId
integer int64
esRowState
string
CustomCount
integer int32
ModuleId
string
Role_FieldVisibility
GET /api/Role/Fields

API to get the Field level permissions for the carestaff.

Request parameters

RoleId
integer int32 required
<value> {"RoleId":"33", "PageId":"2"} </value>
PageId
integer int32 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Not used Now
GET /api/Role/MenuTabs

Request parameters

ModuleIds
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Role_MenuLinksVisibility
GET /api/Role/MenuLinks

API to get the Page level permissions for the carestaff.

Request parameters

RoleIds
string required
<value> {"RoleIds":"33"} </value>

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Getting application configure values
GET /api/Role/ApplicationConfig

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
FieldLabelId
integer int64
FieldLabelName
string
FieldLabelValue
string
FieldDescription
string
FieldValueType
string
FieldKey
string
FieldLabelValueId
string
Schedule
GET /api/Schedule/Get
POST /api/Schedule/SyncOutcome
GET /api/Schedule/SyncQueue
POST /api/Schedule/SchedulesByDuration
GET /api/Schedule/AddressGet
Schedule_Get
GET /api/Schedule/Get

API to get the Schedule Activities.

Request parameters

UserId
integer int64 required
<value> {"UserId":578255 } </value>
StartDate
string date-time optional
<value> {StartDate : 01/16/2017 00:00:00 } </value>
EndDate
string date-time optional
<value> { EndDate : 01/16/2017 23:59:59 } </value>
OrderByField
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientId
integer int64
ClientPatientId
string
FullName
string
CareActivityTypeName
string
ActivityFrom
string
FollowupDate
string date-time
Notes
string
ActivityAssignedOwner
string
Priority
string
AcceptComments
string
PatientFollowupId
integer int64
AssignedBy
string
ScriptName
string
Status
integer int32
IsRequiredActivity
boolean
ScriptId
integer int64
FormId
integer int64
FormName
string
ScriptStatusId
integer int64
ScriptStatusName
string
PerformedStaffId
integer int64
PerformedStaffName
string
PerformedOn
string
ScriptRunLogId
integer int64
FirstName
string
LastName
string
ScriptRunTypeId
integer int64
SfHtmlFile
string
HasScriptForm
boolean
ActivityOutcomeId
integer int64
OutcomeNotes
string
ScriptActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
IsSingleScreen
boolean
IsSensitiveDiagnosis
boolean
RiskLevel
string
CareActivityTypeId
integer int64
Address
string
City
string
State
string
County
string
Country
string
Zip
string
ScriptScheduledDuration
string
CanPerform
boolean
DeletedOn
string date-time
ExternalProviderStatusId
integer int32
Schedule_SyncOutcomeDetails
POST /api/Schedule/SyncOutcome

Request parameters

UserId
integer int64 required
IsLatest
boolean optional

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
SyncDate
string date-time
UserId
integer int64
PatientFollowupId
integer int64
ActivityOutcomeId
integer int64
OutcomeNotes
string
MemberId
integer int64
ScriptId
integer int64
PlaceOfServiceId
integer int64
ScriptActualDuration
string
VenueId
integer int64
HcpcCodeId
integer int64
PerformedOn
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Schedule_SyncQueue
GET /api/Schedule/SyncQueue

Request parameters

UserId
integer int64 required
AltruistaId
string optional
MemberName
string optional
FromDate
string date-time optional
ToDate
string date-time optional
Status
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientFollowupId
string
FirstName
string
LastName
string
ScriptName
string
CareActivityTypeName
string
ClientPatientId
string
PatientId
integer int64
PerformedDate
string date-time
Status
string
IsSensitiveDiagnosis
boolean
RiskLevel
string
Schedule_SchedulesByDuration
POST /api/Schedule/SchedulesByDuration

Request parameters

UserId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientId
integer int64
ClientPatientId
string
FullName
string
CareActivityTypeName
string
ActivityFrom
string
FollowupDate
string date-time
Notes
string
ActivityAssignedOwner
string
Priority
string
AcceptComments
string
PatientFollowupId
integer int64
AssignedBy
string
ScriptName
string
Status
integer int32
IsRequiredActivity
boolean
ScriptId
integer int64
FormId
integer int64
FormName
string
ScriptStatusId
integer int64
ScriptStatusName
string
PerformedStaffId
integer int64
PerformedStaffName
string
PerformedOn
string
ScriptRunLogId
integer int64
FirstName
string
LastName
string
ScriptRunTypeId
integer int64
SfHtmlFile
string
HasScriptForm
boolean
ActivityOutcomeId
integer int64
OutcomeNotes
string
ScriptActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
IsSingleScreen
boolean
IsSensitiveDiagnosis
boolean
RiskLevel
string
CareActivityTypeId
integer int64
Address
string
City
string
State
string
County
string
Country
string
Zip
string
ScriptScheduledDuration
string
CanPerform
boolean
DeletedOn
string date-time
ExternalProviderStatusId
integer int32
Schedule_AddressGet
GET /api/Schedule/AddressGet

Request parameters

UserId
integer int64 required
PatientIds
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
PatientId
integer int64
Address
string
City
string
State
string
Zip
string
Country
string
County
string
IsSensitiveDiagnosis
boolean
Search
POST /api/Search/Members
Search_Members
POST /api/Search/Members

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
<value> {"DOB": null,
"altruistaId": "",
"careStaffId": 693592,
"carrierMemberId": "",
"firstName": "test",
"lastName": ""} </value>
Object
firstName
string

First Name of the member

lastName
string

Last name of the member

careStaffId
integer int64

Logged in User ID

carrierMemberId
string

Medicaid ID

altruistaId
string

Altruista ID

DOB
string date-time

Dat Of Birth

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ServicePlan
GET /api/ServicePlan/Get
POST /api/ServicePlan/SyncServicePlans
GET /api/ServicePlan/MasterData
ServicePlan_Get
GET /api/ServicePlan/Get

Request parameters

UserID
integer int64 required
MemberId
integer int64 required
PageNumber
integer int32 optional
PageSize
integer int32 optional
OrderByField
string optional
SortOrder
string optional

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
ServiceId
integer int64
Description
string
Code
string
MemberServicePlanId
integer int64
Provider
string
UnitType
string
Frequency
string
FromDate
string date-time
ToDate
string date-time
ProviderCode
string
ProviderName
string
Lob
string
LobId
integer int64
LobName
string
RequestedUnits
integer int64
ApprovedUnits
integer int64
UsedUnits
integer int64
UpdatedBy
string
CreatedOn
string date-time
CreatedBy
string
UpdatedOn
string date-time
ApprovedDate
string date-time
LobIds
string
ServiceGuideLine
string
ServiceStatus
string
OggiServicePlanId
integer int64
CustomCount
integer int32
CarePlanId
integer int64
AuthId
string
AuthNo
integer int64
Modifier
string
Syncing Service plans from Mobile Local DB to Server
POST /api/ServicePlan/SyncServicePlans

Request parameters

MemberId
integer int64 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Array
Object
MemberServicePlanId
integer int64
CarePlanId
integer int64
MemberId
integer int64
ServiceId
integer int32
OggiServicePlanId
integer int64
FromDate
string date-time
ToDate
string date-time
LobId
integer int64
RequestedUnits
integer int32
UnitTypeId
integer int32
TimePeriodId
integer int32
ServiceStatusId
integer int32
EpisodeId
integer int32
CreatedOn
string date-time
UpdatedOn
string date-time
Description
string
DeviceId
string
CreatedByID
integer int64
BenefitLimit
string
GuidelineUsed
integer int32
StatusId
integer int32
Frequency
string
Provider
string

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Array
Object
OfflineMemberServicePlanId
integer int64
MemberServicePlanId
integer int64
ServicePlan_GetSPMasterData
GET /api/ServicePlan/MasterData

Request parameters

UserID
integer int64 required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
ServiceplanGuidelines
Array
Object
ServiceGuidelineId
integer int64
ServiceGuideline
string
ServiceplanDecisionStatus
Array
Object
DecisionStatusId
integer int64
DecisionStatus
string
IsActive
boolean
Test
GET /Get
POST /Update
POST /api/Test
PUT /api/Test/{id}
DELETE /api/Test/{id}
Test_Get
GET /Get

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Test_UpdateMemberPlan
POST /Update

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
Object
UserId
integer int64
AliasIntervention
string
StartDate
string date-time
EndDate
string date-time
Comment
string
IsCarePlan
boolean
CarePlanId
integer int64
LanguageId
integer int32
OfflineId
integer int64
MemberId
integer int64
CreatedOn
string date-time

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Test_expirepassword
POST /api/Test

Request parameters

username
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Test_Put
PUT /api/Test/{id}

Path variables

id
integer int32 required

Request body

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded
string

Responses

204 204

No Content

Test_Delete
DELETE /api/Test/{id}

Path variables

id
integer int32 required

Request body

Responses

204 204

No Content

Token
POST /api/Token/Authenticate
GET /api/Token/SecuredMethod
POST /api/Token
Token_Authenticate
POST /api/Token/Authenticate

Request parameters

username
string required
password
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
string
Token_SecuredMethod
GET /api/Token/SecuredMethod

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
Object
Token_CheckUser
POST /api/Token

Request parameters

username
string required
password
string required

Request body

Responses

200 200

OK

Body
application/json
text/json
application/xml
text/xml
boolean
Type Definitions
LoginInput
Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

password
string

password

userName
string

userName

ipAddress
string

ipAddress

browserName
string

browserName

browserVersion
string

browserVersion

appGUID
string

appGUID

UUID
string

UUID

HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

RegisterInput
Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

password
string

password

userName
string

userName

firstName
string

firstName

lastName
string

lastName

address
string

address

city
string

city

state
string

state

zip
string

zip

primaryPhone
string

primaryPhone

primaryEmail
string

primaryEmail

createdBy
string

createdBy

organisation
string

createdBy

Department
Array

Department

Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

TimeZone
Object
TimeZoneId
integer int64
TimeZone
string
Description
string
Role
Object
RoleName
string
RoleId
integer int64
Profiles
Array

Profiles

Object
ProfileID
integer int64
ProfileName
string
SSOReference
string

SSO Unique Reference ID

Department

Department Class.

Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

TimeZones

Time Zone Class

Object
TimeZoneId
integer int64
TimeZone
string
Description
string
Role
Object
RoleName
string
RoleId
integer int64
Profile
Object
ProfileID
integer int64
ProfileName
string
ChangePasswordInput
Object
newPassword
string

newPassword

oldPassword
string

oldPassword

userName
string

userName

ResetPasswordInput
Object
HintQuestion
Object
HintDescription
string

HintDescription

HintId
integer int32

HintId

hintAnswer
string

HintAnswer

primaryEmail
string

primaryEmail

userName
string

userName

EditUserInput
Object
userId
integer int64

User Id

firstName
string

First Name

middleName
string

Middle Name

lastName
string

Last Name

address
string

Address

city
string

City

state
string

State

zip
string

ZIP

primaryPhone
string

Primary Phone

primaryEmail
string

Primary Email

organisation
string

Organisation

Department
Array

Department

Object
DepartmentID
integer int64

Department Id - Long.

DepartmentName
string

Department Name - string.

TimeZone
Object
TimeZoneId
integer int64
TimeZone
string
Description
string
Role
Object
RoleName
string
RoleId
integer int64
Profiles
Array

Profiles

Object
ProfileID
integer int64
ProfileName
string
SSOReference
string

SSO Unique Reference ID

UviewAhsCmCmnGetLoggedinUserinfoProxyStub
Object
MemberId
integer int64
RoleId
integer int64
FirstName
string
LastName
string
PrimaryEmail
string
PrimaryPhone
string
StatusId
integer int32
UserName
string
MemberLogId
integer int64
ExpPwd
integer int32
IsLockedOut
boolean
IsManager
integer int32
ManagerId
integer int64
RoleName
string
ModuleID
string
IsProvider
boolean
DirectEmail
string
esRowState
string
CustomCount
integer int32
MiddleName
string
CheckChangedStatus
string
Message
string
TimeZone
string
State
string
CareTransitionNotification
boolean
SensitiveApplicable
boolean
PassAttemptLeft
integer int32
IsViewOthersActivity
boolean
ClientTimeZone
string
MdPhysicianName
string
PhSensitiveApplicable
boolean
IsViewActiveOnlyMembers
boolean
ScriptFromBaseUrl
string
ScriptFormValidationConfig
Array
Object
SfValidationId
integer int64
ScriptId
integer int64
ScriptName
string
JsKey
string
HasMasterData
boolean
SpName
string
FailedLoginCount
integer int32
ScriptformValidationConfigDetails
Object
SfValidationId
integer int64
ScriptId
integer int64
ScriptName
string
JsKey
string
HasMasterData
boolean
SpName
string
AppVersionOutput
Object
StatusId
integer int32

Status of Version - 1 is Compatible. 2 is non-compatible

StatusMessage
string

Message to Display to user.

LatestVersion
string

Additional message if required. Compatible but suggestion message for new version.

SummaryFilterRequest
Object
UserId
integer int64
ScriptId
integer int64
MemberId
integer int64
FromDate
string date-time
ToDate
string date-time
LastUpdated
string date-time
CareActivityTypeId
integer int64
UviewAhsCmActivitySummaryProxyStub
Object
PatientFollowupId
integer int64
ScheduledDate
string date-time
PerformedBy
integer int64
PerformedByName
string
PerformedDate
string date-time
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
CareActivityTypeName
string
PatientId
integer int64
ClientPatientId
string
FirstName
string
LastName
string
ActivityOutcomeId
integer int64
ActualDuration
string
PlaceOfServiceId
integer int64
ScriptRunLogId
integer int64
ScriptScore
number double
ScriptEndDatetime
string date-time
ScriptRunTypeId
integer int64
StatusId
integer int64
SfHtmlFile
string
EndDate
string date-time
DeletedOn
string date-time
UViewMesssageDetailsProxyStub
Object
MessageId
integer int32
MessageSubject
string
MessageContent
string
SentFrom
integer int64
SentName
string
DateSent
string date-time
ClientPatientId
string
PatientId
integer int64
PatientName
string
SentToNames
string
SentType
string
MemberScriptResponseHistoryCollection
Object
MemberDetail
Array
Object
RowNo
integer int64
ScriptName
string
StaffName
string
ScriptStartDateTime
string date-time
ScriptEndDateTime
string date-time
Duration
string
ScriptScore
number double
ScriptEndStatus
string
ScriptId
integer int64
ScriptRunLogId
integer int64
QuestionNo
integer int64
Question
string
Option
string
SubOption
string
Score
integer int32
CareNotes
string
CreatedOn
string date-time
MemberId
string
MemberName
string
AltruistaId
string
MemberDob
string date-time
CustomCount
integer int32
QuestionId
integer int64
ScriptRunLogDetailId
integer int64
IsResponded
boolean
TotalQuestions
integer int64
TotalResponse
integer int64
ScriptScoreReceived
string
Status
boolean
ScptQuestionResponse
string
SubOptionDynamicRaw
string
SubOptionDynamicQuestions
string
TotalScriptScore
string
CompletedByName
string
CompletedOn
string date-time
IsSignature
string
DownloadedByName
string
DownloadedOn
string date-time
ProcCode
string
CodeDescription
string
ServiceFromDate
string date-time
ServiceToDate
string date-time
ScptInactivationDate
string
ScptInactivationReason
string
IsInactivate
boolean
InactivatedBy
string
TrackDlnCurrent
string
MemberIdentifierLabel
string
MemberIdentifierValue
string
ScriptStatus
string
IsQuestionDeleted
string
QuestionOptionId
integer int64
SubOptionId
integer int64
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
SubOptionValue
string
MemberScriptResponse
Array
Object
RowNo
integer int64
ScriptName
string
StaffName
string
ScriptStartDateTime
string date-time
ScriptEndDateTime
string date-time
Duration
string
ScriptScore
number double
ScriptEndStatus
string
ScriptId
integer int64
ScriptRunLogId
integer int64
QuestionNo
integer int64
Question
string
Option
string
SubOption
string
Score
integer int32
CareNotes
string
CreatedOn
string date-time
MemberId
string
MemberName
string
AltruistaId
string
MemberDob
string date-time
CustomCount
integer int32
QuestionId
integer int64
ScriptRunLogDetailId
integer int64
IsResponded
boolean
TotalQuestions
integer int64
TotalResponse
integer int64
ScriptScoreReceived
string
Status
boolean
ScptQuestionResponse
string
SubOptionDynamicRaw
string
SubOptionDynamicQuestions
string
TotalScriptScore
string
CompletedByName
string
CompletedOn
string date-time
IsSignature
string
DownloadedByName
string
DownloadedOn
string date-time
ProcCode
string
CodeDescription
string
ServiceFromDate
string date-time
ServiceToDate
string date-time
ScptInactivationDate
string
ScptInactivationReason
string
IsInactivate
boolean
InactivatedBy
string
TrackDlnCurrent
string
MemberIdentifierLabel
string
MemberIdentifierValue
string
ScriptStatus
string
IsQuestionDeleted
string
QuestionOptionId
integer int64
SubOptionId
integer int64
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
SubOptionValue
string
MemberScriptResponseHistory
Object
RowNo
integer int64
ScriptName
string
StaffName
string
ScriptStartDateTime
string date-time
ScriptEndDateTime
string date-time
Duration
string
ScriptScore
number double
ScriptEndStatus
string
ScriptId
integer int64
ScriptRunLogId
integer int64
QuestionNo
integer int64
Question
string
Option
string
SubOption
string
Score
integer int32
CareNotes
string
CreatedOn
string date-time
MemberId
string
MemberName
string
AltruistaId
string
MemberDob
string date-time
CustomCount
integer int32
QuestionId
integer int64
ScriptRunLogDetailId
integer int64
IsResponded
boolean
TotalQuestions
integer int64
TotalResponse
integer int64
ScriptScoreReceived
string
Status
boolean
ScptQuestionResponse
string
SubOptionDynamicRaw
string
SubOptionDynamicQuestions
string
TotalScriptScore
string
CompletedByName
string
CompletedOn
string date-time
IsSignature
string
DownloadedByName
string
DownloadedOn
string date-time
ProcCode
string
CodeDescription
string
ServiceFromDate
string date-time
ServiceToDate
string date-time
ScptInactivationDate
string
ScptInactivationReason
string
IsInactivate
boolean
InactivatedBy
string
TrackDlnCurrent
string
MemberIdentifierLabel
string
MemberIdentifierValue
string
ScriptStatus
string
IsQuestionDeleted
string
QuestionOptionId
integer int64
SubOptionId
integer int64
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
SubOptionValue
string
DynamicRowItemProxy
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
DynamicSubOptionProxy
Object
Id
integer int64
Value
string
ParentId
integer int64
AddActivityInput
Object
CareStaffTimeZone
string
ScheduledType
integer int32
ScheduleTypeText
string
MemberName
string
MemberId
integer int64
UserId
integer int64
CreatedBy
integer int64
AlternateCareStaffId
integer int64
CareActivityTypeId
integer int64
ScriptId
integer int64
ScriptName
string
ScriptRunTypeId
integer int64
Priority
string
VenueId
integer int64
VenueName
string
FollowupDate
string date-time
FollowupDay
string
FollowupHrs
string
FollowupMins
string
ReferTo
integer int64
Comments
string
CanPerform
boolean
AcceptFlag
boolean
IsRecurringActivity
boolean
RecurringType
string
RecurrenceValues
Object
DailyOption
integer int32
DailyForEveryNoOfDays
integer int32
WeeklySun
boolean
WeeklySat
boolean
WeeklyMon
boolean
WeeklyTue
boolean
WeeklyWed
boolean
WeeklyThu
boolean
WeeklyFri
boolean
WeeklyForEveeryNoOfWeeks
integer int32
MonthlyOption
integer int32
MonthlyOption2
boolean
MonthlyDay
integer int32
MonthlyForEveryNoOfMonths1
integer int32
MonthlyForEveryNoOfMonths2
integer int32
MonthlyPlusOrMinusDays
integer int32
MonthlyWeek
integer int32
MonthlyWeekDay
integer int32
YearlyOption
integer int32
YearlyMonth1
integer int32
YearlyMonth2
integer int32
YearlyMonthWeek
integer int32
YearlyMonthWeekDay
integer int32
YearlyMonthDay
integer int32
YearlyPlusOrMinusDays
integer int32
EndAfterNoOfOccurrences
integer int32
EndAfterDate
string date-time
EndAfterType
integer int32
IsWorkQueueActivity
boolean
WorkQueueID
integer int64
CareStaffIds
string
ActivityDuration
string
ActivityFrom
string
CarePlanId
integer int64
PerformedBy
integer int64
PerformedDate
string date-time
UpdatedOn
string date-time
ActivityOutcomeId
integer int64
ActivityOutcomeName
string
ActualFollowupHrs
string
ActualFollowupMins
string
ActualDuration
string
ServiceCode
integer int64
PlaceOfServiceId
string
OutComeComments
string
PatientFollowupId
integer int64
Comments_Reasons
string
ErrorMessage
string
SucessMessage
string
WorkFlowId
string
CareActivityTypeName
string
ReferedName
string
AppointmentId
string
FollowUpDates
Array
string date-time
FollowUpIds
Array
integer int64
RecurringFollowUpDates
string
RecurringFollowUpIds
string
ActivityRecurrenceInput
Object
DailyOption
integer int32
DailyForEveryNoOfDays
integer int32
WeeklySun
boolean
WeeklySat
boolean
WeeklyMon
boolean
WeeklyTue
boolean
WeeklyWed
boolean
WeeklyThu
boolean
WeeklyFri
boolean
WeeklyForEveeryNoOfWeeks
integer int32
MonthlyOption
integer int32
MonthlyOption2
boolean
MonthlyDay
integer int32
MonthlyForEveryNoOfMonths1
integer int32
MonthlyForEveryNoOfMonths2
integer int32
MonthlyPlusOrMinusDays
integer int32
MonthlyWeek
integer int32
MonthlyWeekDay
integer int32
YearlyOption
integer int32
YearlyMonth1
integer int32
YearlyMonth2
integer int32
YearlyMonthWeek
integer int32
YearlyMonthWeekDay
integer int32
YearlyMonthDay
integer int32
YearlyPlusOrMinusDays
integer int32
EndAfterNoOfOccurrences
integer int32
EndAfterDate
string date-time
EndAfterType
integer int32
SyncActivity
Object
MemberId
integer int64
UserId
integer int64
CreatedBy
integer int64
AlternateCareStaffId
integer int64
CareActivityTypeId
integer int64
ScriptId
integer int64
ScriptRunTypeId
integer int64
Priority
string
VenueId
integer int64
ReferTo
integer int64
Comments
string
CanPerform
boolean
AcceptFlag
boolean
IsRecurringActivity
boolean
IsWorkQueueActivity
boolean
WorkQueueID
integer int64
CareStaffIds
string
ActivityDuration
string
ActivityFrom
string
CarePlanId
integer int64
PerformedBy
integer int64
PerformedDate
string date-time
CreatedDate
string date-time
ActivityOutcomeId
integer int64
ActualDuration
string
ServiceCode
integer int64
PlaceOfServiceId
string
OutComeComments
string
Comments_Reasons
string
AppointmentId
string
FollowUpDates
string
FollowUpIds
string
CallStatus
integer int32
ReferralNotesCreatedDate
string date-time
ReferralNotesUpdatedDate
string date-time
OutcomeNotesCreatedDate
string date-time
OutcomeNotesUpdatedDate
string date-time
ActivityCommentNotesCreatedDate
string date-time
ActivityCommentNotesUpdatedDate
string date-time
PatientFollowupId
integer int64
UpdatedBy
integer int64
UpdatedDate
string date-time
SyncActivityResponse
Object
OriginalFollowUpId
integer int64
FollowUpId
integer int64
ActivityType
string
CommentsNotesId
integer int64
OutcomeNotesId
integer int64
RecurringId
integer int64
OriginalRecurringId
integer int64
SyncActivitiesInput
Object
GeneralActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
RecurringActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
WorkQueueActivities
Array
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
SyncActivityInput
Object
@MemberId
integer int64
@UserId
integer int64
@CreatedBy
integer int64
@AlternateCareStaffId
integer int64
@CareActivityTypeId
integer int64
@ScriptId
integer int64
@ScriptRunTypeId
integer int64
@Priority
string
@VenueId
integer int64
@ReferTo
integer int64
@Comments
string
@CanPerform
boolean
@AcceptFlag
boolean
@IsRecurringActivity
boolean
@IsWorkQueueActivity
boolean
@WorkQueueID
integer int64
@CareStaffIds
string
@ActivityDuration
string
@ActivityFrom
string
@CarePlanId
integer int64
@PerformedBy
integer int64
@PerformedDate
string date-time
@CreatedDate
string date-time
@Comments_Reasons
string
@CallStatus
integer int32
@ReferralNotesCreatedDate
string date-time
@ReferralNotesUpdatedDate
string date-time
@OutcomeNotesCreatedDate
string date-time
@OutcomeNotesUpdatedDate
string date-time
@ActivityCommentNotesCreatedDate
string date-time
@ActivityCommentNotesUpdatedDate
string date-time
@PatientFollowupId
integer int64
@UpdatedBy
integer int64
@UpdatedDate
string date-time
@ActivityOutcomeId
integer int64
@ActivityOutcomeName
string
@ActualFollowupHrs
string
@ActualFollowupMins
string
@ActualDuration
string
@ServiceCode
integer int64
@PlaceOfServiceId
string
@OutComeComments
string
@RecurringId
integer int64
@IsOfflineCreated
boolean
@OfflinePatientFollowUpId
integer int64
@FollowupDate
string date-time
@FollowupTime
string date-time
@FollowupDay
string
@FollowupHrs
string
@FollowupMins
string
@SyncDate
string date-time
@UpdatedOn
string date-time
UviewAhsCmnCareActivityTypeDetailsProxyStub
Object
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsActive
boolean
CreatedOn
string date-time
CreatedBy
integer int64
UpdatedOn
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
ActivityOutcomeIds
string
IsActivityOutcomeMandatory
boolean
IsActualDurationMandatory
boolean
ActivityOutcomeTypeIds
string
HasScript
boolean
UviewAhsCmCmnCareStaffDetailViewProxyStub
Object
CareStaffDetailsId
integer int64
MemberId
integer int64
RoleId
integer int64
RoleName
string
Title
string
FirstName
string
MiddleName
string
FullName
string
LastName
string
SpecialityId
integer int64
SpecialityName
string
StartDate
string date-time
Address
string
City
string
State
string
Zip
string
Country
string
PrimaryPhone
string
AlternatePhone
string
MobilePhone
string
PrimaryEmail
string
AlternateEmail
string
Fax
string
ViewSecureData
boolean
HourlyRate
number double
DeptId
string
DeptName
string
esRowState
string
CustomCount
integer int32
MemStatus
string
StatusName
string
AccStatus
string
UserName
string
Answer
string
SDate
string
FullNameRole
string
IsActive
boolean
AssignedTo
integer int64
ClinicOrganization
string
CareStaffId
integer int64
IsCreateAdmin
boolean
DirectEmail
string
IsProvider
boolean
CfgAdminConfigID
integer int64
IsPrimary
boolean
TimeZone
string
Credential
string
Specialty
string
CareTransitionNotification
boolean
CareOrganization
string
IsExceeded
integer int32
ProfileIds
string
TimeZoneId
integer int32
HintId
integer int64
HintDescription
string
HintAnswer
string
SignaturePath
string
RoleStatus
boolean
WorkQueueDeptId
string
WorkQueueDeptName
string
HasSameProfile
boolean
DepartmentIds
string
DepartmentProxyStub
Object
DeptId
integer int64
DeptName
string
IsActive
boolean
CreatedBy
string
CreatedOn
string date-time
UpdatedBy
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
IsWorkQueue
string
esRowState
string
CustomCount
integer int32
RowNumber
integer int64
ScptAdminScriptProxyStub
Object
HasScriptForm
boolean
ScriptId
integer int64
ScriptName
string
CareActivityTypeId
integer int64
Duration
number double
NoOfQuestion
integer int32
IsActive
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
RequiredWorkflow
boolean
DeletedBy
integer int64
DeletedDate
string date-time
esRowState
string
CareActivityTypeName
string
CustomCount
integer int32
AdminQuestions
Array
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScriptRunTypeId
integer int64
ScriptRunType
string
CreatedByName
string
UpdatedByName
string
QuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScriptLobId
integer int64
LobName
string
ScriptLob
string
IsReviewRequired
boolean
ReviewRequiredName
string
ModuleName
string
ModuleId
integer int32
Score
number double
TotalScore
number double
SfHtmlFile
string
FormName
string
FormId
integer int64
IsForm
integer int32
SfHeaderText
string
SfFooterText
string
SfId
integer int64
PendingRunLogId
integer int64
ScriptIsSinglePage
boolean
CareActivityTypeGroup
string
PrimaryActivity
integer int64
IsPrimary
boolean
ScriptOgiLob
string
OtherCareStaffOgiLobs
string
AssessmentName
string
IsOgi
boolean
_ScriptFormHtml
string
LobId
string
CareActivityTypeIds
string
IsAttestationRequired
boolean
AttestationText
string
IsProviderReviewRequired
boolean
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
MemberReviewTypeId
integer int32
ScptAdminQuestionProxyStub
Object
QuestionId
integer int64
Question
string
ScriptId
integer int64
OptionTypeId
integer int64
QuestionNo
integer int64
RequiredAnswer
boolean
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
CareActivityTypeName
string
ScriptName
string
Options
integer int32
QuestionOptions
Array
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
RunLogRefference
string
QuestionIdenticalId
integer int32
IsOgi
boolean
ScptQuestionResponseProxyStub
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScptAdminQuestionOptionProxyStub
Object
QuestionOptionId
integer int64
QuestionOption
string
OptionTypeId
integer int64
QuestionId
integer int64
QuestionNext
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
esRowState
string
CustomCount
integer int32
Score
number double
SubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
MultipleSubOptions
Array
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
SubOptionType
string
Ogi
string
OptionNo
integer int32
VariableId
integer int64
VariableType
integer int32
OutputVariableIds
string
VariableName
string
IsSubOptionDynamic
boolean
IsOptionRequired
boolean
Formula
string
IsOgi
boolean
ScptAdminQuestionSuboptionProxyStub
Object
QuestionSuboptionId
integer int64
QuestionSuboptionText
string
QuestionOptionId
integer int64
OptionTypeId
integer int64
FieldId
integer int64
Notes
string
Score
number double
ParentId
integer int64
CreatedDate
string date-time
CreatedBy
integer int64
UpdatedDate
string date-time
UpdatedBy
integer int64
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
SubOptionValues
integer int32
SubOptionType
string
Ogi
string
VariableId
integer int64
MultipleSubOptions
Array
Object
IsSubOptionRequired
boolean
SubOptionScore
number double
IsOgi
boolean
CareTeamFilter
Object
MemberId
integer int64
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
UviewAhsCmPatientCareTeamGetProxyStub
Object
PatientId
integer int64
PhysicianId
integer int64
FullName
string
CareTeamId
integer int64
Email
string
CareTeamType
string
esRowState
string
CustomCount
integer int32
MemberCareTeamId
string
DirectEmail
string
CareTeamMemberId
integer int64
StartDate
string date-time
EndDate
string date-time
PatientPhysicianId
integer int64
DeletedOn
string date-time
SyncMessageInput
Object
@MessageId
integer int64
@UserId
integer int64
@MemberId
integer int64
@ToMember
boolean
@SentTo
string
@Subject
string
@MessageContent
string
@CreatedOn
string date-time
@IsDirect
boolean
@DateSent
string date-time
@IsOfflineCreated
boolean
SyncMessagesResponse
Object
OfflineMessageId
integer int64
OriginalMessageId
integer int64
RequestReceivedInput
Object
UserId
integer int64
LastUpdatedOn
string date-time
ToDate
string date-time
FormDate
string date-time
UviewAhsCmMyActivityLogCustomSubprocProxyStub
Object
ReferenceId
integer int64
ReferBy
integer int64
ReferTo
integer int64
PatientId
integer int64
ReasonForReference
string
ReferredDate
string date-time
ReasonForRejection
string
RejectionDate
string date-time
RequestStatus
string
ResolveDate
string date-time
PatientFollowupId
integer int64
RationaleByReferee
string
RationaleByCoach
string
IsConfidential
boolean
ModuleName
string
ReferType
string
ClientPatientId
string
PerformedBy
integer int64
FollowupDate
string date-time
Status
string
PatientName
string
ReferredByName
string
ReferredToName
string
Flag
string
AcceptedBy
integer int64
ReferralId
integer int64
_ReferTypeId
integer int64
_ReferralReqDate
string date-time
_ReferralComments
string
AcceptedByName
string
MemberName
string
RejectedByName
string
DeptName
string
ActionType
string
ReasonForRequest
string
Comments
string
AcceptComments
string
WorkQueue
string
CreatedDate
string date-time
ActivityTypeName
string
ScheduledDate
string date-time
WqCount
integer int64
NonWqCount
integer int64
ScriptId
integer int64
IsSensitiveDiagnosis
boolean
Priority
string
QueueId
integer int64
StatusId
integer int32
ContactType
string
ScriptName
string
ReferralNotes
string
ReferredById
integer int64
ReferredToId
integer int64
CareStaffNames
string
AcceptOrRejectActivityInput
Object
WorkQueueId
integer int64
CareStaffId
integer int64
PatientFollowupId
integer int64
AcceptComments
string
ReasonForRejection
string
FollowUpDate
string date-time
UpdatedOn
string date-time
IsAccepted
boolean
IsRejected
boolean
PatientId
integer int64
ResponseProxy
Object
Status
string
StatusMessage
string
WorkQueueDeatilsResponse
Object
CareStaffName
string
DepartmentNames
string
Status
integer int32
Address

Address Model for Member’s Addresses

Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean
PatientAdditionalAddressProxyStub
Object
AddressId
integer int64
PatientId
integer int64
AddressText
string
City
string
State
string
CountyId
integer int64
Country
string
Zip
string
IsPrimary
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
AddressType
string
AddressTypeId
integer int64
esRowState
string
CustomCount
integer int32
RolePageActions
Array
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
Status
integer int32
AddressLine
string
IsPreferred
boolean
PhoneNumber
string
UviewAhsCmnRolePageConfigurationGetProxyStub
Object
RolePageConfigId
integer int64
ActionType
string
PageActionId
integer int64
RoleId
integer int64
IsAdd
boolean
IsEdit
boolean
IsDelete
boolean
IsPrint
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
IsView
boolean
IndexId
integer int64
CstFldIdxId
integer int64
Type
integer int32
AddressTypeProxyStub
Object
AddressTypeId
integer int64
AddressTypeName
string
AuditLogAction
string
ColumnName
string
OldData
string
NewData
string
PerformedOn
string date-time
PerformedBy
string
esRowState
string
CustomCount
integer int32
IsType
string
RowNumber
integer int32
UviewAhsGcCmAppointmentDetailsProxyStub
Object
AppointmentId
integer int32
AppointmentStatusName
string
ProviderName
string
FirstName
string
LastName
string
AppointmentTypeName
string
AppointmentTypeId
integer int32
AppointmentReason
string
AppointmentTime
string
AppointmentNotes
string
AppointmentStatus
integer int32
ProviderId
integer int64
ProviderType
string
City
string
WorkPhone
string
AppointmentDate
string date-time
PhysicianCode
string
Priority
string
MemberName
string
ReferDate
string date-time
ReferbyName
string
ReferBy
integer int64
ReferTo
integer int64
StatusName
string
StatusId
integer int32
PatientId
integer int64
AppointmentName
string
ProviderEmail
string
PhysicianId
integer int64
CellPhone
string
esRowState
string
CustomCount
integer int32
RescheduleStatus
boolean
CareplanId
string
AttachmentCount
integer int32
AttachmentPath
string
IsSensitiveDiagnosis
boolean
HealthifyId
integer int64
IsPreferredProvider
boolean
HasNextPage
boolean
ProviderTypeId
integer int64
AppointmentTypeProxyStub
Object
AppointmentTypeId
integer int32
AppointmentTypeName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
RowNumber
integer int32
AppointmentStatusProxyStub
Object
AppointmentStatusId
integer int32
AppointmentStatusName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
RowNumber
integer int32
AppointmentPriority
Object
PriorityId
integer int32
PriorityName
string
AddAppointment

Add Appointment data model

Object
UserId
integer int64

UserId

MemberId
integer int64

MemberId

CarePlanId
integer int64

CarePlanId

AppointmentDate
string date-time

DateTime for AppointmentDate - should always be same or later than creation datetime

AppointmentReason
string

reason text

AppointmentNotes
string

Appointment Notes text box

AppointmentTypeId
integer int32

Appointment TypeId

AppointmentStatusId
integer int32

Appointment Status Id

AppointmentPriorityId
integer int32

Appointment Priority ID

ProviderCode
string

Provider Code

isActive
boolean

Always send true.

CanSendEmail
boolean
AppoinmentsFilterRequest
Object
UserId
integer int64
MemberId
integer int64
CarePlanId
integer int64
PageNumber
integer int32
PageSize
integer int32
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
FirstName
string
LastName
string
ProviderType
integer int32
AppointmentStatus
integer int32
AppointmentId
integer int32
ProviderTypes
Object
ProviderTypeId
integer int32
ProviderType
string
esRowState
string
RowNumber
integer int32
AssesmentResponse
Object
AppSource
string
RunTypeId
integer int32
UniqueDeviceId
string
PatientId
integer int64
ScriptId
integer int64
HealthCoachId
integer int64
CreatedOn
string date-time
EndDate
string date-time
StatusId
integer int32
CallType
integer int32
PatientFollowUpId
integer int64
ScriptRunLogId
integer int64
IsSinglePageScript
boolean
ScriptActivityOutcomeId
integer int32
ScriptActivityOutcomeNotes
string
Comments
string
PlaceOfServiceId
integer int32
ScriptActualDuration
string
VenueId
integer int32
HcpcCodeId
integer int32
IsOffline
boolean
OutcomeNotesCreatedDate
string date-time
OutcomeNotesUpdatedDate
string date-time
RunLogQuestions
Array
Object
@QUESTION_ID
integer int64
@QUESTION
string
@CARE_NOTES
string
@CREATED_ON
string
@RESPONSE_TIME_FROM
string
@RESPONSE_TIME_TO
string
@RESPONSE_TIME_TOTAL
integer int64
@IS_RESPONDED
boolean
@NOTES_CREATED_DATE
string date-time
@NOTES_UPDATED_DATE
string date-time
ScriptReponses
Array
Object
@QuestionId
integer int64
@Optionid
integer int64
@OptionValue
string
@CreatedOn
string date-time
@CreatedBy
integer int64
@Score
number double
@SubOptionid
integer int64
@SubOptionValue
string
@SubOptDynVal
string
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
ScriptDurationData
Array
Object
@StartDateTime
string date-time
@EndDateTime
string date-time
@DurationDifference
number double
ScriptAttestationData
Array
Object
@ScriptRunMode
integer int64
@AttestationDate
string date-time
ScriptFormAction
string
PatientFollowUpDate
string date-time
CareActivityTypeId
integer int64
ExternalProviderId
integer int64
IsMemberReview
boolean
RunLogQuestion
Object
@QUESTION_ID
integer int64
@QUESTION
string
@CARE_NOTES
string
@CREATED_ON
string
@RESPONSE_TIME_FROM
string
@RESPONSE_TIME_TO
string
@RESPONSE_TIME_TOTAL
integer int64
@IS_RESPONDED
boolean
@NOTES_CREATED_DATE
string date-time
@NOTES_UPDATED_DATE
string date-time
RunLogScptResponse
Object
@QuestionId
integer int64
@Optionid
integer int64
@OptionValue
string
@CreatedOn
string date-time
@CreatedBy
integer int64
@Score
number double
@SubOptionid
integer int64
@SubOptionValue
string
@SubOptDynVal
string
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
RunLogScptDuration
Object
@StartDateTime
string date-time
@EndDateTime
string date-time
@DurationDifference
number double
RunLogScptAttestation
Object
@ScriptRunMode
integer int64
@AttestationDate
string date-time
DynamicRowItem
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
DynamicSubOption
Object
Id
integer int64
Value
string
ParentId
integer int64
SaveAssessmentOutput
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
ErrorMessage
string
ReferralNotesId
integer int64
OutcomeNotesId
integer int64
ScriptResponsesProxyStub
Object
ScptQuestionResponses
Array
Object
QuestionResponseId
integer int64
ScriptRunLogDetailId
integer int64
QuestionOptionId
integer int64
OptionValue
string
SubOptionId
integer int64
SubOptionValue
string
ScriptScore
number double
CreatedBy
integer int64
CeratedOn
string date-time
IsActive
boolean
esRowState
string
CustomCount
integer int32
QuestionId
integer int64
CareNotes
string
OptionTypeId
integer int64
ScriptRunLogId
integer int64
CoachId
integer int64
PatientFollowupId
integer int64
IsReviewed
boolean
SubOptionDynamicXml
string
SubOptionDynamicJson
string
SubOptionDynamicRaw
string
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
DynamicRows
Array
Object
RowNo
integer int32
IsChecked
boolean
OptionId
integer int64
DynamicSubOptions
Array
Object
Id
integer int64
Value
string
ParentId
integer int64
CareActivityTypeName
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
ScptRunLogDetails
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
PatientId
integer int64
ScriptId
integer int64
CallStatus
integer int32
StatusId
integer int64
ReceivedScore
number double
ActivityOutcomeId
integer int64
OutcomeNotes
string
ActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
StaffId
integer int64
StaffName
string
ScriptIsSinglePage
boolean
StartDate
string date-time
EndDate
string date-time
EndedBy
integer int64
DownloadedBy
integer int64
DownloadedOn
string date-time
FollowupDate
string date-time
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsOggiExist
boolean
ScriptRunMode
integer int32
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
IsMemberReview
boolean
QuestionRunLogDetails
Array
Object
Questionid
integer int64
Question
string
CareNotes
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
ResponseTimeTotal
integer int64
IsResponded
boolean
StaffId
integer int64
StaffName
string
RunTypeId
integer int64
ScriptFormValidations
Array
Object
ScriptId
integer int64
PatientId
integer int64
JsKey
string
Result
string
RunLogDetails
Object
ScriptRunLogId
integer int64
PatientFollowupId
integer int64
PatientId
integer int64
ScriptId
integer int64
CallStatus
integer int32
StatusId
integer int64
ReceivedScore
number double
ActivityOutcomeId
integer int64
OutcomeNotes
string
ActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
StaffId
integer int64
StaffName
string
ScriptIsSinglePage
boolean
StartDate
string date-time
EndDate
string date-time
EndedBy
integer int64
DownloadedBy
integer int64
DownloadedOn
string date-time
FollowupDate
string date-time
CareActivityTypeId
integer int64
CareActivityTypeName
string
IsOggiExist
boolean
ScriptRunMode
integer int32
ExternalProviderId
integer int64
ExternalProviderStatusId
integer int32
IsMemberReview
boolean
QuestionRunLogDetails
Object
Questionid
integer int64
Question
string
CareNotes
string
NotesCreatedDate
string date-time
NotesUpdatedDate
string date-time
CreatedOn
string date-time
ResponseTimeFrom
string date-time
ResponseTimeTo
string date-time
ResponseTimeTotal
integer int64
IsResponded
boolean
StaffId
integer int64
StaffName
string
RunTypeId
integer int64
ScriptformValidationDetails
Object
ScriptId
integer int64
PatientId
integer int64
JsKey
string
Result
string
ScptPlaceHolderProxyStub
Object
ScptPhId
integer int64
ScriptId
integer int64
ScptRelCtrlId
integer int32
ScptRelCtrlType
string
ScptRelType
integer int32
ScptRelId
integer int64
ScptRelKey
string
ScptRelKeyParent
string
ScptPhName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
IsDeleted
boolean
esRowState
string
MemberPlaceholderProxy
Object
PlaceholderKey
string
PlaceholderValue
string
ScriptMappingDetailsProxyStub
Object
ScriptId
integer int64
CarePlanOGIS
Array
Object
TimeFrame
string
OggiLobId
integer int64
OppName
string
GoalGroupName
string
GoalName
string
InterventionName
string
ConditionName
string
LobName
string
Span
string
CustomCount
integer int32
CondStyle
string
OppStyle
string
GoalGroupStyle
string
GoalStyle
string
IntervStyle
string
LobStyle
string
OppId
integer int64
GoalId
integer int64
GoalGroupId
integer int64
InterventionId
integer int64
LobId
integer int64
TimeSpan
integer int32
SqlKey
string
LobOptionId
integer int64
LobSubOptionId
integer int64
IsChecked
integer int32
OptionId
integer int64
ConditionId
integer int64
ServiceCategoryLabel
string
SpStyle
string
RecommandedUnits
string
OggiServicePlanId
integer int64
GuidelineSource
string
SubOptionId
integer int64
InterventionAliasName
string
OppPriorityId
integer int32
Lobs
Array
Object
LobId
integer int64
LobName
string
LobDesc
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
StartDate
string date-time
EndDate
string date-time
LobLogo
string
ServicePlanOGIS
Array
Object
OggiServicePlanId
integer int64
OggiTimeFrameId
integer int64
ServiceId
integer int64
BenefitLimit
string
UnitTypeId
integer int64
TimePeriodId
integer int64
CreatedBy
integer int64
CreatedOn
string date-time
OggiLobId
integer int64
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
LobOptionId
integer int64
TimeSpan
integer int32
OptionId
integer int64
LobSubOptionId
integer int64
OptionTypeId
integer int64
UnitType
string
Description
string
Lobs
string
ServiceCodes
string
TimeFrame
string
Frequency
string
Providers
string
TimeSpanValue
string
ConditionTypeId
integer int32
ConditionTypeName
string
IdenticalMappings
Array
Object
IdenticalId
integer int64
IdenticalKey
string
IdenticalType
string
IdenticalRelId
integer int64
AllIdenticalRelIds
string
ScriptFormMappings
Array
Object
ControlId
string
Type
string
TypeId
integer int64
InterventionLanguageMappings
Array
Object
InterventionId
integer int64
LanguageId
integer int64
InterventionName
string
InterventionAliasName
string
DeletedBy
integer int64
DeletedOn
string date-time
ScriptManageActivities
Array
Object
SourceScriptId
integer int64
QuestionId
integer int64
OptionId
integer int64
SubOptionId
integer int64
CallStatus
integer int32
Duration
integer int32
DurationType
integer int32
Enumeration:
0
1
2
CareActivityTypeId
integer int64
CareActivityTypeName
string
MappedScriptId
integer int64
MappedScriptName
string
PriorityId
integer int32
Priority
string
VenueId
integer int64
MappedScriptRunTypeId
integer int64
LobIds
string
ScriptOGIProxyStub
Object
TimeFrame
string
OggiLobId
integer int64
OppName
string
GoalGroupName
string
GoalName
string
InterventionName
string
ConditionName
string
LobName
string
Span
string
CustomCount
integer int32
CondStyle
string
OppStyle
string
GoalGroupStyle
string
GoalStyle
string
IntervStyle
string
LobStyle
string
OppId
integer int64
GoalId
integer int64
GoalGroupId
integer int64
InterventionId
integer int64
LobId
integer int64
TimeSpan
integer int32
SqlKey
string
LobOptionId
integer int64
LobSubOptionId
integer int64
IsChecked
integer int32
OptionId
integer int64
ConditionId
integer int64
ServiceCategoryLabel
string
SpStyle
string
RecommandedUnits
string
OggiServicePlanId
integer int64
GuidelineSource
string
SubOptionId
integer int64
InterventionAliasName
string
OppPriorityId
integer int32
LobProxyStub
Object
LobId
integer int64
LobName
string
LobDesc
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
StartDate
string date-time
EndDate
string date-time
LobLogo
string
CplOggiServicePlanProxyStub
Object
OggiServicePlanId
integer int64
OggiTimeFrameId
integer int64
ServiceId
integer int64
BenefitLimit
string
UnitTypeId
integer int64
TimePeriodId
integer int64
CreatedBy
integer int64
CreatedOn
string date-time
OggiLobId
integer int64
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
LobOptionId
integer int64
TimeSpan
integer int32
OptionId
integer int64
LobSubOptionId
integer int64
OptionTypeId
integer int64
UnitType
string
Description
string
Lobs
string
ServiceCodes
string
TimeFrame
string
Frequency
string
Providers
string
TimeSpanValue
string
ConditionTypeId
integer int32
ConditionTypeName
string
ScriptIdenticalPrepopulationProxyStub
Object
IdenticalId
integer int64
IdenticalKey
string
IdenticalType
string
IdenticalRelId
integer int64
AllIdenticalRelIds
string
ScriptFormMappingDetailProxyStub
Object
ControlId
string
Type
string
TypeId
integer int64
CarePlanInterventionConfigProxyStub
Object
InterventionId
integer int64
LanguageId
integer int64
InterventionName
string
InterventionAliasName
string
DeletedBy
integer int64
DeletedOn
string date-time
ScriptManageActivityProxyStub
Object
SourceScriptId
integer int64
QuestionId
integer int64
OptionId
integer int64
SubOptionId
integer int64
CallStatus
integer int32
Duration
integer int32
DurationType
integer int32
Enumeration:
0
1
2
CareActivityTypeId
integer int64
CareActivityTypeName
string
MappedScriptId
integer int64
MappedScriptName
string
PriorityId
integer int32
Priority
string
VenueId
integer int64
MappedScriptRunTypeId
integer int64
LobIds
string
SFValidationInputRequest
Object
MemberId
integer int64
ScriptId
integer int64
ScriptFormMasterDataDetails
Object
SchemaDetails
Object
SchemaQuery
string
OperationQuery
string
TransactionLimit
integer int32
QueryData
Array
Object
Query
string
ScriptFormMasterSchemaDetails
Object
SchemaQuery
string
OperationQuery
string
TransactionLimit
integer int32
ScriptFormQueryData
Object
Query
string
AuthRequest
Object
actualDischargeDate
string date-time
admissionType
string
alternateAuthID
string
authClass
string
lobName
string
planName
string
authNote
Array of string
authPriority
string
authReviewer
string
authServiceLines
Array
Object
approvedDaysUnits
integer int32
authLineNumber
integer int32
authorizationid
string
decisionReasonCode
string
decisionStatus
string
effectiveDate
string date-time
memberID
string
modifier
string
requestedDaysUnits
integer int32
serviceCode
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
serviceFromDate
string date-time
serviceToDate
string date-time
termDate
string date-time
treatmentType
string
units
string
decisionId
integer int64
memberNotificationType
string
memberNotificationDate
string date-time
memberNotes
string
providerNotificationType
string
providerNotificationDate
string date-time
providerNotes
string
denialType
string
denialReason
string
alternateServiceId
string
unitType
string
decisionDate
string date-time
authStatus
string
prevAuthStatus
string
authType
string
authorizationId
string
callerEmail
string
callerFax
string
callerName
string
callerPhone
string
claimType
string
closedDate
string date-time
closedReason
string
diagnosisCodes
Array
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
dischargeDiagnosis
string
dischargeStatusCode
string
effectiveDate
string date-time
facilityID
string
facilityCapacity
string
lastUpdatedDate
string date-time
memberID
string
notificationDate
string date-time
placeOfService
string
program
string
programName
string
referFromProvider
string
referFromProviderCapacity
string
referToProvider
string
referToProviderCapacity
string
termDate
string date-time
treatmentType
string
authDueDate
string date-time
serviceFromDate
string date-time
serviceToDate
string date-time
requestSentMode
string
outOfAreaIndicator
string
admissionLevel
string
admitReason
string
certificationType
string
mrn
string
transportationMode
string
determinationType
string
reviewType
string
dischargeType
string
dischargeTo
string
memberNotificationType
string
memberNotificationDate
string date-time
providerNotificationType
string
providerNotificationDate
string date-time
admittingProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
referredByProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
referredToProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
facilityProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
AuthServiceLine
Object
approvedDaysUnits
integer int32
authLineNumber
integer int32
authorizationid
string
decisionReasonCode
string
decisionStatus
string
effectiveDate
string date-time
memberID
string
modifier
string
requestedDaysUnits
integer int32
serviceCode
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
serviceFromDate
string date-time
serviceToDate
string date-time
termDate
string date-time
treatmentType
string
units
string
decisionId
integer int64
memberNotificationType
string
memberNotificationDate
string date-time
memberNotes
string
providerNotificationType
string
providerNotificationDate
string date-time
providerNotes
string
denialType
string
denialReason
string
alternateServiceId
string
unitType
string
decisionDate
string date-time
Code
Object
codeType
integer int32
Enumeration:
0
1
2
3
codeValue
string
codeDescription
string
AuthProvider
Object
providerTypeSpecified
boolean
providerCode
string
capacity
Array
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
address
string
callerEmail
string
callerName
string
callerPhone
string
ProviderCapacity
Object
capacityCode
string
effectiveFrom
string date-time
effectiveTo
string date-time
LOB
string
taxId
string
CarePlanFilter
Object
MemberId
integer int64 required
UserId
integer int64 required
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
CategoryIds
string
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
PriorityId
integer int32
SearchType
string
SearchText
string
GuidingOpportunitiesRequest
Object
MemberId
integer int64
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdated
string date-time
UviewAhsCmnCplGoalGroupDetailsProxyStub
Object
GoalGroupId
integer int64
GoalGroupName
string
IsActive
boolean
CreatedBy
integer int64
CareStaffCreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
CareStaffUpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
UviewAhsCmnCplGoalGroupMappingDetailsProxyStub
Object
GoalGroupMappingId
integer int64
GoalId
integer int64
GoalName
string
GoalGroupId
integer int64
GoalGroupName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
GoalStyle
string
GoalGroupStyle
string
GoalGroupMapStyle
string
esRowState
string
CustomCount
integer int32
UviewAhsCmnCplManageConditionDetailsProxyStub
Object
ConditionId
integer int64
ConditionName
string
ConditionTypeId
integer int32
ConditionTypeName
string
ConditionWithCategoryName
string
Notes
string
Rank
integer int32
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CareStaffCreatedByName
string
CareStaffUpdatedByName
string
esRowState
string
CustomCount
integer int32
UviewAhsCmnCplConditionOpportunityDetailsProxyStub
Object
OppCondId
integer int64
ConditionId
integer int64
ConditionName
string
OpportunityId
integer int64
OppName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
UpdatedByName
string
DeletedBy
integer int64
DeletedOn
string date-time
CondStyle
string
OppStyle
string
OppCondMapStyle
string
esRowState
string
CustomCount
integer int32
CareplanInput
Object
CarePlanId
integer int64
PatientId
integer int64
LobId
integer int64
GoalId
integer int64
InterventionId
integer int64
GoalGroupId
integer int64
GoalGroupIsActive
boolean
ConditionId
integer int64
OppId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
UserId
integer int64
UniqueId
string
InterventionTypeId
integer int32
SignOffStatus
boolean
SourceTypeId
integer int32
IsOfflineCreated
boolean
IsEdited
boolean
OggiLobId
integer int64
DeviceId
string
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string
ActualEndDate
string
CarePlanPriorityId
integer int32
MemberInvolvementId
integer int32
Description
string
IsDeleted
boolean
IsUpdated
boolean
LastUpdatedDate
string
SignOffDate
string date-time
SignOffBy
integer int64
CreatedBy
string
CreatedOn
string
UpdatedOn
string
UpdatedBy
integer int64
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean
ListScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean
ScriptCancelOGGIDeletionProxyStub
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean
AutoCompleteInterventionProxy
Object
InterventionId
integer int64
InterventionName
string
AliasName
string
CustomCount
integer int32
SearchField
string
SearchData
string
GoalId
integer int64
GoalName
string
CplCategoryProxyStub
Object
CategoryId
integer int32
CategoryName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
Selected
boolean
CplStatusProxyStub
Object
StatusId
integer int32
StatusName
string
CategoryId
integer int32
StatusOnSignOff
integer int32
IsEditable
boolean
IsActive
boolean
CreatedByName
string
CreatedOn
string date-time
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
CategoryName
string
RowNumber
integer int32
UviewAhsCmCarePlanDetailsProxyStub
Object
CarePlanId
integer int64
PatientId
integer int64
PatientName
string
LobId
integer int64
LobName
string
GoalId
integer int64
GoalName
string
GoalAliasName
string
GoalIsActive
boolean
InterventionId
integer int64
InterventionName
string
InterventionAliasName
string
InterventionIsActive
boolean
GoalGroupId
integer int64
GoalGroupName
string
GoalGroupIsActive
boolean
ConditionId
integer int64
ConditionName
string
ConditionTypeId
integer int32
ConditionTypeName
string
ConditionIsActive
boolean
OppId
integer int64
OppName
string
OppAliasName
string
OpportuniyIsActive
boolean
OggiLobId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
StatusName
string
CategoryId
integer int32
CategoryName
string
IsSignOff
boolean
SignOffName
string
CarePlanNotes
string
CarePlanPriorityId
integer int32
CarePlanPriorityName
string
MemberInvolvementId
integer int32
MemberInvolvementName
string
CarePlanTerm
string
CareOpportunityId
integer int64
PatientOpportunityActive
boolean
CreatedBy
integer int64
CreatedByName
string
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedByName
string
DeletedOn
string date-time
RoleId
integer int64
RoleName
string
ReferenceCpId
integer int64
CareOppMappingId
integer int64
ModifiedAliasIntervention
string
MemberVoiceComment
string
ActualStartDate
string date-time
ActualEndDate
string date-time
UniqueId
string
LobStyle
string
IntervStyle
string
CondStyle
string
OppStyle
string
GoalStyle
string
GoalGroupStyle
string
esRowState
string
InterventionTypeId
integer int32
InterventionTypeName
string
GuidelineSource
string
FirstName
string
LastName
string
Source
string
CareTeamCarePlanId
integer int64
SignOffStatus
boolean
Percentage
integer int32
CustomCount
integer int32
OpportunityName
string
ActlStartDate
string date-time
ActlEndDate
string date-time
CategoryNameLow
string
MemberSignOffStatus
string
SourceTypeId
integer int32
IsPrimaryCareStaff
boolean
IsSensitiveDiagnosis
boolean
Zip
string
ConditionLevel
string
InterventionNotes
string
OppPriorityId
integer int64
ScriptName
string
Question
string
QuestionOption
string
QuestionSubOption
string
MultipleInterventionName
string
MemberCareTeamId
integer int64
CplOwnerName
string
OppIds
string
OppGroup
string
LanguageId
integer int64
PrimaryLanguageId
integer int64
OpportunityResolvedDate
string date-time
IsEdited
boolean
IsActive
boolean
AssignedOwnerId
integer int64
AssignedOwnerName
string
CplPriorityProxyStub
Object
PriorityId
integer int32
PriorityName
string
PrioritySection
string
IsActive
boolean
esRowState
string
CustomCount
integer int32
CareplanSignOffInput
Object
CarePlanSignOffList
Array
Object
MemberId
integer int64
CarePlanId
integer int64
SignOffStatus
boolean
SignOffDate
string date-time
CareplanSignOffList
Object
MemberId
integer int64
CarePlanId
integer int64
SignOffStatus
boolean
SignOffDate
string date-time
CarePlanSignOffOutput
Object
CarePlanId
integer int64
SignOffStatus
boolean
SyncCarePlanResponse
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
CarePlanSignatureLogProxy
Object
SID
integer int64
UserId
integer int64
MemberId
integer int64
CareStaffSignature
string
MemberSignature
string
MemberSignedEnteredDate
string date-time
CareStaffSignedEnteredDate
string date-time
CreatedDate
string date-time
EditCarePlanRequest
Object
CarePlanId
integer int64
PatientId
integer int64
StartDate
string date-time
EndDate
string date-time
StatusId
integer int32
AssignedOwnerId
integer int64
Notes
string
UpdatedBy
integer int64
UpdatedOn
string date-time
PriorityId
integer int64
IsSignOff
boolean
IsOfflineEdited
boolean
IsScptCncL
boolean
ScriptCancelOggiDeletions
Object
ScriptCancelOGGIDeletions
Array
Object
OggiDeletionId
integer int64
CarePlanId
integer int64
OpportunityId
integer int64
ScriptRunLogId
integer int64
ScriptRunLogDetailId
integer int64
QuestionId
integer int64
IsDelete
boolean
SyncCarePlansResponeProxy
Object
CarePlanResponses
Array
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
OGGIDeletionResponses
Array
Object
OggiDeletionId
integer int64
OriginalOggiDeletionId
integer int64
ScriptRunLogDetailId
integer int64
CareOpportunityId
integer int64
CarePlanResponseProxy
Object
CarePlanId
integer int64
OrginalCarePlanId
integer int64
IsOffline
boolean
IsDeleted
boolean
IsUpdateSuccess
boolean
OGGIDeletenionResponseProxy
Object
OggiDeletionId
integer int64
OriginalOggiDeletionId
integer int64
ScriptRunLogDetailId
integer int64
CareOpportunityId
integer int64
GOResloveRequest

GuidingOpportunitiesResolveRequest

Object
CareOpportunityID
integer int64
ResolutionID
integer int64
StatusID
integer int64
ResolvedDate
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
UviewAhsMyCareMemberListProxyStub
Object
PatientDetailsId
integer int64
PrimaryMedicalCondition
string
PatientId
integer int64
HealthCoachId
integer int64
HasAlert
boolean
RowColorVisibility
string
LastName
string
FirstName
string
Age
string
RiskCategoryName
string
RiskCategoryId
integer int32
CaseStatus
string
PerformedDate
string date-time
PrimaryLanguage
string
PatientDob
string
ReferBy
integer int64
ReferredDate
string date-time
AcceptedDate
string date-time
ReferredStaffName
string
ReferenceStatus
string
ActivityScriptName
string
PlanName
string
LobName
string
LatestPlanStatus
string
esRowState
string
CustomCount
integer int32
Sex
string
CellPhone
string
HomePhone
string
ClientPatientId
string
ProgramNames
string
AltruistaId
string
PrimaryBehaviouralCondition
string
AlertStatus
string
AssignedOn
string date-time
PerformedDateString
string
NextContactDate
string date-time
NextActivity
string
IsRequireActivity
boolean
CarrierMemId
string
LastVisitDate
string date-time
NextVisitDate
string date-time
PcpName
string
ErVisits
integer int64
DueDays
integer int32
LastClaim
string date-time
FullDueDays
string
MemberHealthSummary
integer int32
AppVisits
integer int64
AdtdaysCount
integer int64
ClientName
string
IsSensitiveDiagnosis
boolean
ProgramStatus
string
ReferralSource
string
PersistentSuperUtilizerFlag
string
EligibilityEndDate
string
MemberZipCode
string
RiskScore
string
MemberAddress
string
MemberCity
string
MemberCounty
string
ThlStatus
string
MedicaidNo
string
IsMyMember
boolean
Ssn
string
PsuScore
string
RiskofAdmission
string
RiskLevel
string
RiskColor
string
UviewAhsCmnCnstFormMasterDetailsProxyStub
Object
CnstFormId
integer int64
CnstFormMappingId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
IsActive
boolean
IsActiveName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
CreatedByName
string
UpdatedOn
string date-time
DeletedBy
integer int64
UpdatedByName
string
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
CnstFormProxyStub
Object
CnstFormId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
UviewAhsCmnCnstFormPatientMasterDetailsProxyStub
Object
CnstFormId
integer int64
CnstFormMappingId
integer int64
FormTitle
string
FormContent
string byte
FormActualFileName
string
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
PatientCnstId
integer int64
PatientConsentPath
string
CnstStatusId
integer int32
StatusName
string
PatientId
integer int64
CnstPatientFormValidFrom
string date-time
CnstPatientFormValidTo
string date-time
ConsentFormMasterIsActive
boolean
ConsentFormPatientIsActive
boolean
IsActiveName
string
CnstCheckListId
integer int32
CheckListName
string
CheckListActive
boolean
CareStaffSingedOffBy
integer int64
CareStaffSingedOffByName
string
CareStaffSingedOffOn
string date-time
PatientIdSingedOn
string date-time
CustomComments
string
CreatedBy
integer int64
CreatedOn
string date-time
CreatedByName
string
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
UpdatedByName
string
esRowState
string
CustomCount
integer int32
CnstStatusProxyStub
Object
CnstStatusId
integer int32
StatusName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
ConsentUploadInput
Object
FormDetails
Object
CreatedBy
integer int64

Loggedin User ID

CareStaffSignedOffBy
integer int64

Lob ID

CnstFormMappingId
integer int32

Loggedin User ID

PatientId
integer int64

Lob ID

CnstFormOriginalName
string

Loggedin User ID

CareStaffSignedOffOn
string date-time

Lob ID

PatientIdSignedOn
string date-time

Lob ID

UniqueDeviceId
string

Lob ID

StatusId
integer int32

Lob ID

FormContent
string
MemberConsetDetails
Object
CreatedBy
integer int64

Loggedin User ID

CareStaffSignedOffBy
integer int64

Lob ID

CnstFormMappingId
integer int32

Loggedin User ID

PatientId
integer int64

Lob ID

CnstFormOriginalName
string

Loggedin User ID

CareStaffSignedOffOn
string date-time

Lob ID

PatientIdSignedOn
string date-time

Lob ID

UniqueDeviceId
string

Lob ID

StatusId
integer int32

Lob ID

UviewAhsCmnLobDetailsProxyStub
Object
LobId
integer int64
LobName
string
LobDesc
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
LobidDate
string
StartDate
string date-time
EndDate
string date-time
UviewAhsCmPatientLobPlanProgramsProxyStub
Object
LobId
integer int64
LobName
string
BenefitPlanId
integer int64
PlanName
string
BenefitProgramId
integer int64
ProgramName
string
StartDate
string date-time
EndDate
string date-time
LobIdString
string
IsActive
string
esRowState
string
CustomCount
integer int32
MemberProgram
Object
MemberId
integer int64 required

Patient/MemberID

LOBId
integer int32

LOB ID , you can get the List of LOB from LOB Controller

PlanId
integer int32
MemberPlanId
integer int64
MemberProgramId
integer int64
ProgramId
integer int64
DescriptionId
integer int32
ReferralSourceId
integer int32
StatusNameId
integer int32
InsertType
integer int32 required
StartDate
string date-time required
EndDate
string date-time
CreatedBy
integer int64
UpdatedBy
integer int64
IsParentInactive
boolean
LoggerModel
Object
APIKey
string
LogType
string
DeviceID
string
PatientID
integer int64
UserName
string
UserID
integer int64
LogMessage
string
PlatformType
string
LogTime
string date-time
InputDataObject
string
SyncDateTime
string date-time
MessageTrace
string
AppSecurityMasterData
Object
PolicyConfigKey
string
PolicyConfigValue
string
MasterDataCashingKeyModel
Object
ApiId
integer int32
ApiKey
string
LastAccessedConfigProxy
Object
Feature
integer int32
Enumeration:
0
1
2
3
4
5
6
7
MaxValue
integer int32
DefaultValue
integer int32
ThresholdValue
integer int32
FeatureName
string
Member

Model class to send the data necessary for Member creation

Object
FirstName
string required

First Name of the member

LastName
string

Last name of the member

GenderId
string

Gender ID like “M” , “F” …

AddressTypeId
integer int32

Address Type ID - from Primary Address

AddressLine1
string

Address Line 1 - from Primary Address

AddressLine2
string

Address Line 2 - from Primary Address

State
string

State Code like “AK” - from Primary Address

City
string

City - from Primary Address

ZipCode
string

zip - from primary Address

HomePhone
string

Home Phone - xxx-xxx-xxxx format

CellPhone
string

CellPhone - xxx-xxx-xxxx format

AlternatePhone
string

AlternatePhone - xxx-xxx-xxxx format

PrimaryEmail
string

Primary Email

DateOfBirth
string date-time

Date of Birth - DateTime Object

UserId
integer int64

Care Staff user ID - created by

UpdatedBy
integer int64

User ID of careStaff updating the data

SchoolName
string

School Name

SchoolDistrict
string

School District

RaceId
integer int32

Race ID

EthnicityIds
string

Ethnicity Ids - Multi select like “1,2,3,4” / null / “2”

PrimaryLanguageId
integer int32

Primary Language ID

InsuranceTypeId
string

Insurance Type ID like “CC” - for Medicaid Choice

RelationshipType
string

Relationship type ID like “F”

RelationshipName
string
VeteranStatus
integer int32

Veteran Status = 1 for Yes, Default is 0., Status=null not avialble

LobId
integer int32

LOB Id -

ClientId
integer int32

Client Id

PlanIds
string

Plan Ids String - like “50306,30113”

StartDate
string date-time

Start Date of Insurance

EndDate
string date-time

End Date of Insurance - not mandatory

ClientPatientId
string

Client Patient ID - returned in the response

QRCodeImageData
string

QR Code Image data as Base64 string - returned in response

MemberId
integer int64

Member Id - returned in response

IsSensitiveDiagnosis
boolean

Returned in Get Details - would be used for future BusinessLogic.

ExceptionMessage
string

Exception Message sent in case of failure - returned in Response

MedicaidNo
string

MedicaidNo

PreferredPhone
string

PreferredPhone

PreferredPhoneType
string

PreferredPhoneType

PreferredPhoneTypeId
integer int32

PreferredPhoneTypeID

InsuranceType
string
ConsentStatus
integer int32

Member Consent form Status

PrimaryCareProvider
string
IsMyMember
boolean
PreferredLanguagesIds
string

Gets comma separeted Languages for the member

PrimaryMedicalConditionId
integer int64

Added for careplan signature funtionality

PrimaryMedicalConditionName
string

Added for careplan signature funtionality

PrimaryBehaviouralConditionId
integer int64

Added for careplan signature funtionality

PrimaryBehaviouralConditionName
string

Added for careplan signature funtionality

PrimaryCareStaffName
string

Added for careplan signature funtionality

MaritalStatus
string

Added for careplan signature funtionality

CarestaffPrimaryEmail
string

Added for careplan signature funtionality

RiskLevel
string

Patient Risk Level

PrivacyAddress
Object
AddressId
integer int64

Address ID- In Update, send exisiting ID or send -1 for new records to be added.

MemberId
integer int64 required

Member ID for which the Address is being updated.

AddressTypeId
integer int32

ID of the AddressType selected in the UI.

AddressLine1
string

AddressLine1

AddressLine2
string

Address Line 2

City
string

City name

State
string

State - two letter code that is sent in the Master Data like “AK”, “AZ”, etc

ZipCode
string

zip code

IsPrimary
boolean

Primary Address flag - true for primary

CreatedBy
integer int64

Carestaff ID - for updating, leave it as it is (as received). For new insert addresses, put in carestaff ID.

UpdatedBy
integer int64

CareStaff ID for Updating a record. Send this as null for Insert operation or ignore

PhoneNumber
string
IsPrivacyAddress
boolean
IsPreferred
boolean
UviewAhsCmPatientFamilyDetailsProxyStub
Object
AltruistaId
string
FirstName
string
LastName
string
Gender
string
BirthYear
string date-time
PatientDetailsId
integer int64
ClientId
integer int64
PatientId
integer int64
NamePrefix
string
MiddleName
string
NameSuffix
string
MothersName
string
EthnicityId
integer int32
Address
string
City
string
State
string
Zip
string
CountyId
integer int32
Country
string
Fax
string
PrimaryLanguageId
integer int64
HomePhone
string
CellPhone
string
AlternatePhone
string
PrimaryEmail
string
AlternateEmail
string
InsurancePolicyNumber
string
InsurancePlan
string
RelationshipType
string
MaritalStatus
string
PrimaryMedicalConditionId
integer int64
MedicalDescription
string
PrimaryBehaviouralConditionId
integer int64
BehaviouralDescription
string
PreferedTimeOfCall
string
Height
string
Income
number double
ResidenceStatusId
integer int32
IncentiveAmount
number double
Comments
string
ReferralType
integer int32
SsnSub
string
DobNormalized
string
InsuranceType
string
IncomeCriteria
string
StatusId
integer int32
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
IsDemo
boolean
RaceId
integer int64
SecondaryInsuranceType
string
SecondaryInsurancePolicyNumber
string
BoroughId
integer int64
AddressLine
string
esRowState
string
CustomCount
integer int32
BirthYearString
string
Age
integer int32
PrimaryLanguageName
string
AgeInYears
string
RelationshipValue
string
UviewAhsCmPatientPhoneNumberDetailsProxyStub
Object
PhoneType
string
PhoneNumber
string
IsPreferred
boolean
esRowState
string
CreatedOn
string date-time
UpdatedOn
string date-time
DeletedBy
string
DeletedOn
string date-time
CreatedBy
string
UpdatedBy
string
Extension
string
PhoneNotes
string
CustomCount
integer int32
PhoneTypeId
integer int32
PatientPhoneId
integer int64
RowNumber
integer int32
MemberPlanInput
Object
UserId
integer int64
AliasIntervention
string
StartDate
string date-time
EndDate
string date-time
Comment
string
IsCarePlan
boolean
CarePlanId
integer int64
LanguageId
integer int32
OfflineId
integer int64
MemberId
integer int64
CreatedOn
string date-time
SyncMemberPlanResponse
Object
MemberPlanId
integer int64
IsUpdateSuccess
boolean
HealthNotesProxyStub
Object
HealthNotesId
integer int64
PatientId
integer int64
HealthNotes
string
CareStaffName
string
NoteType
string
HealthNoteTypeId
integer int32
ReferenceId
integer int64
CreatedBy
string date-time
CreatedDate
string date-time
UpdatedBy
string date-time
UpdatedOn
string date-time
CustomCount
integer int32
ScriptName
string
GoalActivityQuestionName
string
IsAlert
boolean
HealthNotesDate
string date-time
StatusName
string
OppName
string
MeasureVersion
integer int64
OppDetailId
integer int64
QualityMeasureStatusId
integer int64
QualityMeasureStatusName
string
FirstName
string
LastName
string
AltruistaId
string
CplNotesGroupId
integer int64
IsMultipleCareplan
integer int32
Type
string
ContactType
string
HasNextPage
boolean
QuestionId
integer int64
CareActivityTypeName
string
DeletedOn
string date-time
NotesFilter
Object
MemberId
integer int64 required
UserId
integer int64 required
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time
OrderByField
string
SortOrder
string
PageNumber
integer int32
PageSize
integer int32
NoteType
string
HealthNoteTypeProxyStub
Object
NoteTypeId
integer int64
NoteType
string
IsNoteType
boolean
NoteStatus
boolean
TableName
string
ColumnName
string
RowNumber
integer int32
HealthNoteTemplate
string
HasProfileAccess
boolean
HealthNotesInput
Object
UserId
integer int64
PatientId
integer int64
HealthNoteTypeId
integer int32
HealthNotes
string
HealthNotesDate
string date-time
IsAlert
boolean
IsConfidential
boolean
CreatedDate
string date-time
UpdatedOn
string date-time
HealthNotesId
integer int64
ReferenceId
integer int64
OfflineId
integer int64
AlertUpdatedBy
integer int64
AlertUpdatedOn
string date-time
QuestionId
integer int64
AlertStatusId
integer int32
IsNoteType
boolean
SyncDate
string date-time
HealthNotesResponse
Object
HealthNoteId
integer int64
ReferenceId
integer int64
NewReferenceId
integer int64
NewHealthNoteId
integer int64
VenueProxyStub
Object
VenueId
integer int64
VenueName
string
CreatedOn
string date-time
CreatedBy
integer int64
UpdatedOn
string date-time
UpdatedBy
integer int64
DeletedOn
string date-time
DeletedBy
integer int64
esRowState
string
CustomCount
integer int32
CreatedByName
string
UpdatedByName
string
IsActive
boolean
IsDefault
boolean
DefaultVenueName
string
RowNumber
integer int32
PlaceOfServiceProxyStub
Object
PlaceOfServiceId
integer int64
PlaceOfService
string
IsActiveName
string
IsActive
boolean
CreatedByName
string
UpdatedByName
string
AlternatecarestaffName
string
CreatedBy
string
CreatedOn
string date-time
CfgAdminConfigId
integer int64
AdminConfigName
string
esRowState
string
Result
string
UpdatedBy
string
UpdatedOn
string date-time
CustomCount
integer int32
RowNumber
integer int32
ActivityOutcomeProxyStub
Object
ActivityOutcomeId
integer int64
ActivityOutcome
string
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
RunLogId
integer int64
PatientFollowupId
integer int64
OutComeNotes
string
ActualDuration
string
PlaceOfService
string
PlaceOfServiceId
integer int64
VenueID
integer int64
HcpcCodeId
integer int64
HcpcCode
string
IsActivityOutcomeMandatory
integer int32
CareActivityTypeId
integer int64
ActivityOutcomesProxyStub
Object
ActivityOutcomesList
Array
Object
ActivityOutcomeId
integer int64
ActivityOutcome
string
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
RunLogId
integer int64
PatientFollowupId
integer int64
OutComeNotes
string
ActualDuration
string
PlaceOfService
string
PlaceOfServiceId
integer int64
VenueID
integer int64
HcpcCodeId
integer int64
HcpcCode
string
IsActivityOutcomeMandatory
integer int32
CareActivityTypeId
integer int64
ActivityOutcomeTypes
Array
Object
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
ActivityOutcomeTypeProxyStub
Object
ActivityOutcomeTypeId
integer int64
ActivityOutcomeType
string
CareStaffLOBInput
Object
careStaffId
integer int64

Loggedin User ID

LobId
integer int32

Lob ID

BenefitPlanProxyStub
Object
BenefitPlanId
integer int64
PlanName
string
PlanDesc
string
StartDate
string date-time
EndDate
string date-time
HasExpired
boolean
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
UviewAhsCmCmnMemBenPlansGetDmyProxyStub
Object
MemBenfPlanId
integer int64
MemberId
integer int64
StartDate
string date-time
EndDate
string date-time
PlanName
string
esRowState
string
CustomCount
integer int32
LobName
string
BenefitPlanId
integer int64
CfgAdminConfigProxyStub
Object
CfgAdminConfigId
integer int64
AdminConfigName
string
IsActive
boolean
CreatedBy
integer int64
CreatedOn
string date-time
UpdatedBy
integer int64
UpdatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
UpdatedByName
string
CreatedByName
string
ParentId
integer int64
ParentName
string
LevelId
integer int64
CareOrganization
string
IsExceeded
boolean
ProfileType
string
Address
string
Email
string
Phone
string
Fax
string
IsCheck
integer int32
IsEditable
boolean
IsUnassign
integer int32
UviewAhsCmCmnMemBenProgramsGetDmyProxyStub
Object
IsDataLoad
boolean
MemBenfProgId
integer int64
PlanName
string
ProgramName
string
MemberId
integer int64
MemBenfPlanId
integer int64
BenPlanProgId
integer int64
ClosureId
integer int32
ReferralTypeId
integer int32
IsPending
boolean
StartDate
string date-time
EndDate
string date-time
MemberStatus
string
LobId
integer int64
esRowState
string
CustomCount
integer int32
LobName
string
PlanDesc
string
LobDesc
string
ProgramDesc
string
BenefitPlanId
integer int64
IsPendingStr
string
lblPrevReason
string
trPlanNameVisible
boolean
Type
string
ErrorMessage
string
StrUpdate
string
StatusDescription
string
RecordStatus
string
ProgramStatusId
integer int64
CreatedBy
string
ProgramStatus
string
Reason
string
Operation
string
CreatedOn
string date-time
UpdatedOn
string date-time
ReferralType
string
CarrierMemId
string
UpdatedBy
string
BenefitProgramProxyStub
Object
BenefitProgramId
integer int64
ProgramName
string
ProgramDesc
string
StartDate
string date-time
EndDate
string date-time
HasExpired
boolean
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
ProgramStatusProxyStub
Object
ProgramStatusId
integer int64
ProgramStatusName
string
IsActive
boolean
CreatedOn
string date-time
DeletedBy
integer int64
DeletedOn
string date-time
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
esRowState
string
CustomCount
integer int32
InternalProgramReasonProxyStub
Object
ProgramReasonId
integer int32
ReasonDescription
string
ReasonType
string
CreatedOn
string date-time
CreatedBy
integer int64
IsActive
boolean
DeletedBy
integer int64
DeletedOn
string date-time
esRowState
string
CustomCount
integer int32
CreatedByName
string
UpdatedByName
string
UpdatedOn
string date-time
ProgramStatusId
integer int64
PJCCareStaffProgramsMasterDataProxy
Object
Id
integer int64
Name
string
TypeId
integer int32
TypeName
string
ParentId
integer int64
StartDate
string date-time
EndDate
string date-time
RowNumber
integer int32
Provider
Object
HealthifyId
integer int64
Address
string
ProviderName
string
WorkPhone
string
City
string
State
string
Zip
string
ProviderTypeName
string
LanguageName
string
Email
string
UUID
string
IsHealthify
boolean
CareTeamId
integer int64
CreatedOn
string date-time
CarePlanId
integer int64
MemberZipCode
string
InterventionName
string
SearchURL
string
CreatedBy
integer int64
MemberId
integer int64
ReferralType
integer int32
IsPreferredProvider
boolean
HealthifyProvider
Object
UUID
string
CarePlanId
integer int64
MemberZipCode
string
InterventionName
string
SearchURL
string
CreatedBy
integer int64
CreatedOn
string date-time
MemberId
integer int64
ProviderSearchOutput
Object
ProviderName
string
PhysicianCode
string
PhysicianId
integer int64
ProviderIndicator
string
ProviderType
string
ProviderTypeId
integer int32
Address
string
CellPhone
string
Email
string
IsPreferredProvider
boolean
IsSocialReferral
boolean
UviewAhsCmCmnPhysiciandemographyPatientphysicianProxyStub
Object
PatientPhysicianId
integer int64
PatientId
integer int64
PhysicianId
integer int64
ProviderType
string
EffectiveFrom
string date-time
EffectiveTo
string date-time
HasAlert
boolean
IsSelfReported
boolean
CreatedOn
string date-time
UpdatedOn
string date-time
PhysicianCode
string
NamePrefix
string
FirstName
string
LastName
string
MiddleName
string
NameSuffix
string
EthnicityId
integer int32
Address
string
City
string
State
string
Country
string
Zip
string
Fax
string
SpecialityId
string
Speciality
string
ProviderTypeId
integer int32
ProviderTypeName
string
PrimaryBehavioral
boolean
PrimaryLanguage
string
HomePhone
string
CellPhone
string
AlternatePhone
string
Email
string
CreatedBy
integer int64
Status
string
WorkPhone
string
ProviderName
string
ClinicId
string
ClinicName
string
IsPcp
boolean
CareTeamId
integer int64
StartDate
string date-time
EndDate
string date-time
IsThroughLoad
boolean
PcpName
string
CareNote
string
IsActive
integer int32
ItemStyle
string
VendorID
integer int64
IndexName
string
ProviderParStat
string
VendorIndexName
string
IsPrimary
boolean
LobId
string
LanguageIds
string
SpecialityIds
string
Gender
string
BoroughId
integer int64
IsPcp1
boolean
PrimaryBehavioral1
boolean
CareTeamUnableChk
string
DirectEmail
string
esRowState
string
CustomCount
integer int32
CountyId
integer int32
Username
string
ProviderIndicator
string
ProviderNpi
string
ProviderMpin
string
ProviderTaxId
string
IndexValue
string
PcmStartDate
string date-time
PcmEndDate
string date-time
CreatedByName
string
UpdatedByName
string
HealthifyId
integer int64
EmailId
string
EmailSentDate
string date-time
IsPreferredProvider
boolean
IsSocialReferral
boolean
ProviderDetailsInput
Object
healthifyID
integer int64
AddressLine1
string
AddressLine2
string
City
string
ProviderName
string
ProviderTypeName
string
State
string
ZipCode
string
IsUpdate
string
CareTeamId
string
CreatedBy
Object
UUID
string
IsPreferredProvider
boolean
Email
string
Address
string
Phone
string
UserId
integer int64
VwAspnetRolesProxyStub
Object
ApplicationId
string uuid
Example:
00000000-0000-0000-0000-000000000000
RoleId
string uuid
Example:
00000000-0000-0000-0000-000000000000
RoleName
string
LoweredRoleName
string
Description
string
RolesGroupId
string
RolesId
integer int64
esRowState
string
CustomCount
integer int32
ModuleId
string
ManageFieldLabelProxyStub
Object
FieldLabelId
integer int64
FieldLabelName
string
FieldLabelValue
string
FieldDescription
string
FieldValueType
string
FieldKey
string
FieldLabelValueId
string
ScheduleActivityOutput
Object
PatientId
integer int64
ClientPatientId
string
FullName
string
CareActivityTypeName
string
ActivityFrom
string
FollowupDate
string date-time
Notes
string
ActivityAssignedOwner
string
Priority
string
AcceptComments
string
PatientFollowupId
integer int64
AssignedBy
string
ScriptName
string
Status
integer int32
IsRequiredActivity
boolean
ScriptId
integer int64
FormId
integer int64
FormName
string
ScriptStatusId
integer int64
ScriptStatusName
string
PerformedStaffId
integer int64
PerformedStaffName
string
PerformedOn
string
ScriptRunLogId
integer int64
FirstName
string
LastName
string
ScriptRunTypeId
integer int64
SfHtmlFile
string
HasScriptForm
boolean
ActivityOutcomeId
integer int64
OutcomeNotes
string
ScriptActualDuration
string
PlaceOfServiceId
integer int64
HcpcCodeId
integer int64
VenueId
integer int64
IsSingleScreen
boolean
IsSensitiveDiagnosis
boolean
RiskLevel
string
CareActivityTypeId
integer int64
Address
string
City
string
State
string
County
string
Country
string
Zip
string
ScriptScheduledDuration
string
CanPerform
boolean
DeletedOn
string date-time
ExternalProviderStatusId
integer int32
ScheduleOutcomeInput
Object
SyncDate
string date-time
UserId
integer int64
PatientFollowupId
integer int64
ActivityOutcomeId
integer int64
OutcomeNotes
string
MemberId
integer int64
ScriptId
integer int64
PlaceOfServiceId
integer int64
ScriptActualDuration
string
VenueId
integer int64
HcpcCodeId
integer int64
PerformedOn
string date-time
AssessmentSyncQueueOutput
Object
PatientFollowupId
string
FirstName
string
LastName
string
ScriptName
string
CareActivityTypeName
string
ClientPatientId
string
PatientId
integer int64
PerformedDate
string date-time
Status
string
IsSensitiveDiagnosis
boolean
RiskLevel
string
SchedulesDurationInput
Object
UserId
integer int64
StartDate
string date-time
EndDate
string date-time
LastUpdatedDate
string date-time
AddressResponseForMySchedule
Object
PatientId
integer int64
Address
string
City
string
State
string
Zip
string
Country
string
County
string
IsSensitiveDiagnosis
boolean
MemberSearchInput
Object
firstName
string

First Name of the member

lastName
string

Last name of the member

careStaffId
integer int64

Logged in User ID

carrierMemberId
string

Medicaid ID

altruistaId
string

Altruista ID

DOB
string date-time

Dat Of Birth

ServicePlanOutput
Object
ServiceId
integer int64
Description
string
Code
string
MemberServicePlanId
integer int64
Provider
string
UnitType
string
Frequency
string
FromDate
string date-time
ToDate
string date-time
ProviderCode
string
ProviderName
string
Lob
string
LobId
integer int64
LobName
string
RequestedUnits
integer int64
ApprovedUnits
integer int64
UsedUnits
integer int64
UpdatedBy
string
CreatedOn
string date-time
CreatedBy
string
UpdatedOn
string date-time
ApprovedDate
string date-time
LobIds
string
ServiceGuideLine
string
ServiceStatus
string
OggiServicePlanId
integer int64
CustomCount
integer int32
CarePlanId
integer int64
AuthId
string
AuthNo
integer int64
Modifier
string
ServicePlanInput
Object
MemberServicePlanId
integer int64
CarePlanId
integer int64
MemberId
integer int64
ServiceId
integer int32
OggiServicePlanId
integer int64
FromDate
string date-time
ToDate
string date-time
LobId
integer int64
RequestedUnits
integer int32
UnitTypeId
integer int32
TimePeriodId
integer int32
ServiceStatusId
integer int32
EpisodeId
integer int32
CreatedOn
string date-time
UpdatedOn
string date-time
Description
string
DeviceId
string
CreatedByID
integer int64
BenefitLimit
string
GuidelineUsed
integer int32
StatusId
integer int32
Frequency
string
Provider
string
SyncServicePlanResponse
Object
OfflineMemberServicePlanId
integer int64
MemberServicePlanId
integer int64
ServiceplanMasterData
Object
ServiceplanGuidelines
Array
Object
ServiceGuidelineId
integer int64
ServiceGuideline
string
ServiceplanDecisionStatus
Array
Object
DecisionStatusId
integer int64
DecisionStatus
string
IsActive
boolean
CplServiceGuidelineProxyStub
Object
ServiceGuidelineId
integer int64
ServiceGuideline
string
UmMaDecisionStatusProxyStub
Object
DecisionStatusId
integer int64
DecisionStatus
string
IsActive
boolean