The Avatar CWS WEBSVC.TreatmentPlan web service is used to manage client treatment plans in myAvatar.
Points to note about treatment plans:
- A treatment plan cannot be filed with a status of ‘Final’ when document routing is enabled.
- Only treatment plans that are in 'Draft' status can be deleted.
The ProblemList web service (SearchProblem call) is expected to be used to gather the necessary problem information to include in the treatment plan payload.
SQL queries can be executed against the database to identify the client treatment plan(s) on file, if any.
Operations
This web service supports the following operations:
Object classes
This web service has the following object classes:
AddTreatmentPlan call
return to Operations list
Used to file a client treatment plan.
The following tables list the AddTreatmentPlan parameters, properties, and accepted values.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: UAT, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| EpisodeNumber |
N/A |
Avatar Episode Number |
|
| OptionID |
N/A |
Treatment Plan Option ID |
Examples: CWS60000 - Treatment Plan, CWS60001 - Treatment Plan Copy 1
|
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| TreatmentPlanInfo |
WEBSVC. TreatmentPlanObject |
WEBSVC. TreatmentPlanObject |
This property is itself an Object – details regarding provided here |
EditTreatmentPlan call
return to Operations list
Used to edit an already existing client treatment plan. Treatment plans that have already been marked as ‘Final’ cannot be edited.
The following tables list the EditTreatmentPlan parameters, properties, and accepted values.
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: UAT, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| EpisodeNumber |
N/A |
Avatar Episode Number |
Required for episode-specific treatment plans. |
| TPUniqueID |
N/A |
Treatment Plan unique id (unique to client record only) |
Example: TXC66475.00001 |
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| TreatmentPlanInfo |
WEBSVC. TreatmentPlanObject |
WEBSVC. TreatmentPlanObject |
This property is itself an Object – details regarding provided here |
DeleteTreatmentPlan call
return to Operations list
Used to delete an already existing client treatment plan. Treatment plans that have been marked as ‘Final’ cannot be deleted.
The following tables list the DeleteTreatmentPlan parameters, properties, and accepted values.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: UAT, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| TPUniqueID |
N/A |
Treatment Plan unique id (unique to client record only) |
Example: TXC66475.00001 |
| DeleteReason |
N/A |
|
Dictionary |
| DeleteComment |
N/A |
|
|
GetTreatmentPlan call
return to Operations list
Used to retrieve the details regarding the specified client treatment plan.
The following table lists the GetTreatmentPlan parameters, properties, and accepted values.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: UAT, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| ClientID |
N/A |
Avatar Client ID |
|
| TPUniqueID |
N/A |
Treatment Plan unique id (unique to client record only) |
Example: TXC66475.00001 |
GetDictionaryItems call
return to Operations list
Used to retrieve the dictionary code sets associated with the specified option.
The following table lists the GetDictionaryItems parameters, properties, accepted values, and associated dictionaries.
Parameters with no properties
| Parameter |
Property |
Value Accepted |
Notes |
| SystemCode |
N/A |
Avatar System Code |
Examples: UAT, LIVE, etc. |
| UserName |
N/A |
Avatar User ID |
|
| Password |
N/A |
Avatar Password |
|
| OptionID |
N/A |
Treatment Plan Option ID |
|
| TPUniqueID |
N/A |
Treatment Plan unique id (unique to client record only) |
Examples: CWS60000 - Treatment Plan, CWS60001 - Treatment Plan Copy 1
|
Object class: WEBSVC.TreatmentPlanGoalObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanGoalObject |
DateClosed |
Date |
|
| |
DateDue |
Date |
|
| |
DateOpened |
Date |
|
| |
Goal |
Free Text |
|
| |
Interventions |
TreatmentPlanInterventionObject |
This property is itself an Object – details regarding provided here |
| |
Objectives |
TreatmentPlanObjectiveObject |
This property is itself an Object – details regarding provided here |
| |
Predefined |
Dictionary Code |
This property is itself an Object – details regarding provided here |
| |
SSDate |
WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText40 |
WEBSVC.SiteSpecific.FreeText40 |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
WEBSVC.SiteSpecific.FreeText80 |
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling
|
WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSNumeric |
WEBSVC.SiteSpecific.Numeric |
This property is itself an Object – details regarding provided here |
| |
SSService |
WEBSVC.SiteSpecific.Service |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSTime |
WEBSVC.SiteSpecific.Time |
This property is itself an Object – details regarding provided here |
| |
StaffAssigning |
Avatar Staff ID |
|
| |
StaffResponsible |
Avatar Staff ID |
|
| |
Status |
Dictionary Code |
|
| |
UniqueID |
Free Text |
Example: TXG.00001 |
Object class: WEBSVC.TreatmentPlanInterventionObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanInterventionObject |
DateClosed |
Date |
|
| |
DateDue |
Date |
|
| |
DateOpened |
Date |
|
| |
Intervention |
Free Text |
|
| |
InterventionType |
Dictionary Code |
|
| |
Predefined |
Dictionary Code |
|
| |
SSDate |
WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText40 |
WEBSVC.SiteSpecific.FreeText40 |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
WEBSVC.SiteSpecific.FreeText80 |
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling |
WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSNumeric |
WEBSVC.SiteSpecific.Numeric |
This property is itself an Object – details regarding provided here |
| |
SSService |
WEBSVC.SiteSpecific.Service |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSTime |
WEBSVC.SiteSpecific.Time |
This property is itself an Object – details regarding provided here |
| |
StaffAssigning |
Avatar Staff ID |
|
| |
StaffResponsible |
Avatar Staff ID |
|
| |
Status |
Dictionary Code |
|
| |
UniqueID |
Free Text |
Example(s): TXI.00001 |
Object class: WEBSVC.TreatmentPlanObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanObject |
AuthorizedLevelOfCare |
Dictionary Code |
|
| |
DeviatedLevelOfCare |
Dictionary Code |
|
| |
DischargePlanning |
Free Text |
|
| |
NextReviewDate |
Date |
|
| |
PlanDate |
Date |
|
| |
PlanEndDate |
Date |
|
| |
PlanName |
Free Text |
|
| |
PlanType |
Dictionary Code |
|
| |
RecommendedLevelOfCare |
Dictionary Code |
|
| |
SSDate |
Array of WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
Array of WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
Array of WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
Array of WEBSVC.SiteSpecific.FreeText80 |
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling |
Array of WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSNumeric |
Array of WEBSVC.SiteSpecific.Numeric |
This property is itself an Object – details regarding provided here |
| |
SSService |
Array of WEBSVC.SiteSpecific.Service |
This property is itself an Object – details regarding provided here |
| |
SSSignature |
Array of WEBSVC.SiteSpecific.Signature |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
Array of WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSTime |
Array of WEBSVC.SiteSpecific.Time |
This property is itself an Object – details regarding provided here |
| |
ServiceProgram |
Dictionary Code |
|
| |
Strengths |
Free Text |
|
| |
TeamMemberToNotify |
Dictionary Code
|
|
| |
TreatmentPlanParticipants |
Array of WEBSVC.TreatmentPlanParticipantObject |
This property is itself an Object – details regarding provided here |
| |
TreatmentPlanProblems |
Array of TreatmentPlanProblemObject |
This property is itself an Object – details regarding provided here |
| |
TreatmentPlanStatus |
Dictionary Code |
|
| |
UniqueID |
Free Text |
Example: TXC66435.00001 |
| |
Weaknesses |
Free Text |
|
| |
AuthorizedLevelOfCare |
Dictionary Code |
|
| |
DeviatedLevelOfCare |
Dictionary Code |
|
| |
DischargePlanning |
Free Text |
|
| |
NextReviewDate |
Date |
|
Object class: WEBSVC.TreatmentPlanObjectiveObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanObjectiveObject |
DateClosed |
Date |
|
| |
DateDue |
Date |
|
| |
DateOpened |
Date |
|
| |
Interventions |
TreatmentPlanInterventionObject |
This property is itself an Object – details regarding provided here |
| |
Objective |
Free Text |
|
| |
Predefined |
Dictionary Code |
|
| |
SSDate |
WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText40 |
WEBSVC.SiteSpecific.FreeText40 |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
WEBSVC.SiteSpecific.FreeText80
|
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling |
WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSNumeric |
WEBSVC.SiteSpecific.Numeric |
This property is itself an Object – details regarding provided here |
| |
SSService |
WEBSVC.SiteSpecific.Service |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSTime |
WEBSVC.SiteSpecific.Time |
This property is itself an Object – details regarding provided here |
| |
StaffAssigning |
Avatar Staff ID |
|
| |
StaffResponsible |
Avatar Staff ID |
|
| |
Status |
Dictionary Code |
|
| |
UniqueID |
Free Text |
Example: TXO.00001 |
Object class: WEBSVC.TreatmentPlanParticipantObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanParticipantObject |
Notification |
Dictionary Code |
|
| |
ParticipantName |
Free Text |
|
| |
PlanAuthor |
Dictionary Code |
|
| |
Role |
Dictionary Code |
|
| |
SSDate |
WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
WEBSVC.SiteSpecific.FreeText80 |
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling |
WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSSignature |
WEBSVC.SiteSpecific.Signature |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSState |
WEBSVC.SiteSpecific.State |
This property is itself an Object – details regarding provided here |
| |
SSZip |
WEBSVC.SiteSpecific.Zip |
This property is itself an Object – details regarding provided here |
| |
StaffMember |
Avatar Staff ID |
|
| |
UniqueID |
Free Text |
Example: TXO.00001 |
Object class: WEBSVC.TreatmentPlanProblemObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.TreatmentPlanProblemObject |
DateClosed |
Date |
|
| |
DateDue |
Date |
|
| |
DateOfOnset |
Date |
|
| |
DateOpened |
Date |
|
| |
Goals |
TreatmentPlanGoalObject |
This property is itself an Object – details regarding provided here |
| |
Interventions |
TreatmentPlanInterventionObject |
This property is itself an Object – details regarding provided here |
| |
Objectives |
TreatmentPlanObjectiveObject |
This property is itself an Object – details regarding provided here |
| |
Other |
Free Text |
|
| |
Predefined |
Dictionary Code |
|
| |
Problem |
Free Text |
|
| |
ProblemCode |
WEBSVC.ProblemCodeObject |
This property is itself an Object – details regarding provided here |
| |
ProblemCodeStatus |
Dictionary Code |
|
| |
SSDate |
WEBSVC.SiteSpecific.Date |
This property is itself an Object – details regarding provided here |
| |
SSDictionaryMultiple |
WEBSVC.SiteSpecific.DictionaryMultiple |
This property is itself an Object – details regarding provided here |
| |
SSDictionarySingle |
WEBSVC.SiteSpecific.DictionarySingle |
This property is itself an Object – details regarding provided here |
| |
SSFreeText40 |
WEBSVC.SiteSpecific.FreeText40 |
This property is itself an Object – details regarding provided here |
| |
SSFreeText80 |
WEBSVC.SiteSpecific.FreeText80 |
This property is itself an Object – details regarding provided here |
| |
SSFreeTextScrolling |
WEBSVC.SiteSpecific.FreeTextScrolling |
This property is itself an Object – details regarding provided here |
| |
SSNumeric |
WEBSVC.SiteSpecific.Numeric |
This property is itself an Object – details regarding provided here |
| |
SSService |
WEBSVC.SiteSpecific.Service |
This property is itself an Object – details regarding provided here |
| |
SSStaff |
WEBSVC.SiteSpecific.Staff |
This property is itself an Object – details regarding provided here |
| |
SSTime |
WEBSVC.SiteSpecific.Time |
This property is itself an Object – details regarding provided here |
| |
StaffAssigning |
Avatar Staff ID |
|
| |
StaffResponsible |
Avatar Staff ID |
|
| |
Status |
Dictionary Code |
|
| |
UniqueID |
Free Text |
Example: TXP.00001 |
Object class: WEBSVC.ProblemCodeObject
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.ProblemCodeObject |
IMOCacheCode |
Avatar IMO Results ID |
|
| |
InternalHash |
Free Text |
|
| |
IMOCode |
Free Text |
|
| |
IMODesc |
Free Text |
|
| |
LastUpdated |
Date |
|
| |
SNOMEDCode |
Free Text |
|
| |
SNOMEDDesc |
Free Text |
|
| |
ICD10Code |
Free Text |
|
| |
ICD10Desc |
Free Text |
|
| |
ICD9Code |
Free Text |
|
| |
ICD9Desc |
Free Text |
|
| |
DSM4Code |
Free Text |
|
| |
DSM4Desc |
Free Text |
|
| |
DSM5Code |
Free Text |
|
| |
DSM5Desc |
Free Text |
|
| |
NTSTTableId |
Free Text |
|
Object class: WEBSVC.SiteSpecific.Date
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Date |
FieldNumber |
Free Text |
|
| |
FieldValue |
Date |
|
Object class: WEBSVC.SiteSpecific.DictionaryMultiple
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.DictionaryMultiple |
FieldNumber |
Free Text |
|
| |
FieldValue |
Dictionary Code(s) |
Ampersand delimited |
Object class: WEBSVC.SiteSpecific.DictionarySingle
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.DictionarySingle |
FieldNumber |
Free Text |
|
| |
FieldValue |
Dictionary Code |
|
Object class: WEBSVC.SiteSpecific.FreeText40
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.FreeText40 |
FieldNumber |
Free Text |
|
| |
FieldValue |
Free Text |
|
Object class: WEBSVC.SiteSpecific.FreeText80
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.FreeText80 |
FieldNumber |
Free Text |
|
| |
FieldValue |
Free Text |
|
Object class: WEBSVC.SiteSpecific.FreeTextScrolling
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.FreeTextScrolling |
FieldNumber |
Free Text |
|
| |
FieldValue |
Free Text |
|
Object class: WEBSVC.SiteSpecific.Numeric
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Numeric |
FieldNumber |
Free Text |
|
| |
FieldValue |
Free Text |
|
Object class: WEBSVC.SiteSpecific.Service
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Service |
FieldNumber |
Free Text |
|
| |
FieldValue |
Avatar Service Code |
|
Object class: WEBSVC.SiteSpecific.Signature
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Signature |
FieldNumber |
Free Text |
|
| |
FieldValue |
Binary Stream |
|
Object class: WEBSVC.SiteSpecific.Staff
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Staff |
FieldNumber |
Free Text |
|
| |
FieldValue |
Avatar Staff ID |
|
Object class: WEBSVC.SiteSpecific.State
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.State |
FieldNumber |
Free Text |
|
| |
FieldValue |
Dictionary Code |
|
Object class: WEBSVC.SiteSpecific.Time
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Time |
FieldNumber |
Free Text |
|
| |
FieldValue |
Format check |
|
Object class: WEBSVC.SiteSpecific.Zip
return to Object class list
| Parameter |
Property |
Value Accepted |
Notes |
| WEBSVC.SiteSpecific.Zip |
FieldNumber |
Free Text |
|
| |
FieldValue |
Format check |
|
