Avatar CWS 2022 Update 17

Last updated
Save as PDF

Product Requirements / Recommendations

Avatar CWS required
RADplus required

Product Update Form Description

The Treatment Plan web service is updated to support Signature fields.

Included Updates

None

Required Updates

None

Details

NEW1 CHANGED0 FIXED0

New (1)

AV-76200 Details \| User Acceptance Tests 'Treatment Plan' web service The 'Treatment Plan' web service is updated to support signature fields. Value Added: Support for signature fields when using the 'Treatment Plan' web service	Topics • Signatures • Treatment Plan • Web Services

Acceptance Tests

AV-76200 Summary | Details

'Treatment Plan' web service

Note - These testing guidelines assume the user is skilled in the use of, at a minimum, the following:

SoapUI - Add Treatment Plan
Treatment Plan
SoapUI - Edit Treatment Plan
SoapUI - Get Treatment Plan

Scenario 1: Treatment Plan Web Service - Add Treatment Plan

Specific Setup:

A client is enrolled in an existing episode (Client A).
The following signature fields must be added to the 'Treatment Plan' form via 'Site Specific Section Modeling:
SS Treatment Plan Client Sign 1 (Field #52143 - This can be found in the 'Form and Table Documentation' form).
SS Treatment Plan Part Sign 1 (Field #57020 - This can be found in the 'Form and Table Documentation' form).
A console widget must be configured for the 'Treatment Plan' form ('Treatment Plan' widget).
A view must be configured to have the 'Treatment Plans' widget and the 'Console Widget Viewer' (View A).

Steps

Access SoapUI for the 'TreatmentPlan' - 'AddTreatmentPlan' web service.
Enter the system code that will be used to log into Avatar in the 'SystemCode' field.
Enter the user name that will be used to log into Avatar in the 'UserName' field.
Enter the password that will be used to log into Avatar in the 'Password' field.
Enter the desired date in the 'PlanDate' field.
Enter the desired value in the 'PlanName' field.
Enter the desired value in the 'PlanType' field.
Enter the desired value in the 'TreatmentPlanStatus' field.
Enter a valid problem code in the 'SNOMEDCode' field.
Enter the corresponding problem description in the 'SNOMEDDesc' field.
Enter the desired value in the 'ProblemCodeStatus' field.
Enter the desired date in the 'DateOfOnset' field.
Enter the desired staff ID in the 'StaffResponsible' field.
Enter the desired date in the 'DateOpened' field.
Enter the desired value in the 'Problem' field.
Enter the desired value in the 'Status' field.
Populate any other desired fields.
Enter "STAFF" in the 'Role' field.
Enter the desired staff ID in the 'StaffMember' field.
Enter "57020" in the 'TreatmentPlanParticipants' - 'SSSignature' - 'FieldNumber' field.
Enter a base64 encoded signature value in the 'TreatmentPlanParticipants' - 'SSSignature' - 'FieldValue' field.
Enter "52143" in the 'SSSignature' - 'FieldNumber' field.
Enter a base64 encoded signature value in the 'SSSignature' - 'FieldValue' field.
Enter "Client A" in the 'ClientID' field.
Enter "1" in the 'EpisodeNumber' field.
Enter "CWS60000" in the 'OptionID' field.
Click [Run].
Validate the 'Confirmation' field contains the unique ID for the treatment plan filed.
Validate the 'Message' field contains: "Treatment Plan web service has been filed successfully".
Select "Client A" and access "View A".
Validate the 'Treatment Plan' widget contains the record added in the previous steps.
Click [View].
Validate the 'Console Widget Viewer' displays all treatment plan data filed in the previous steps.
Validate the 'SS Treatment Plan Client Sign 1' field contains the signature added in the previous steps.
Validate the 'SS Treatment Plan Part Sign 1' field contains the signature added in the previous steps.
Click [Close All].

Scenario 2: Treatment Plan Web Service - Edit Treatment Plan

Specific Setup:

A client is enrolled in an existing episode and has a draft 'Treatment Plan' on file (Client A).
The following signature fields must be added to the 'Treatment Plan' form via 'Site Specific Section Modeling:
SS Treatment Plan Client Sign 1 (Field #52143 - This can be found in the 'Form and Table Documentation' form).
SS Treatment Plan Part Sign 1 (Field #57020 - This can be found in the 'Form and Table Documentation' form).
A console widget must be configured for the 'Treatment Plan' form ('Treatment Plan' widget).
A view must be configured to have the 'Treatment Plans' widget and the 'Console Widget Viewer' (View A).

Steps

Access SoapUI for the 'TreatmentPlan' - 'EditTreatmentPlan' web service.
Enter the system code that will be used to log into Avatar in the 'SystemCode' field.
Enter the user name that will be used to log into Avatar in the 'UserName' field.
Enter the password that will be used to log into Avatar in the 'Password' field.
Enter the original date on file in the 'PlanDate' field.
Enter the desired value in the 'PlanName' field.
Enter the desired value in the 'PlanType' field.
Enter the desired value in the 'TreatmentPlanStatus' field.
Enter a valid problem code in the 'SNOMEDCode' field.
Enter the corresponding problem description in the 'SNOMEDDesc' field.
Enter the desired value in the 'ProblemCodeStatus' field.
Enter the desired date in the 'DateOfOnset' field.
Enter the desired staff ID in the 'StaffResponsible' field.
Enter the desired date in the 'DateOpened' field.
Enter the desired value in the 'Problem' field.
Enter the desired value in the 'Status' field.
Populate any other desired fields.
Enter "STAFF" in the 'Role' field.
Enter the desired staff ID in the 'StaffMember' field.
Enter "57020" in the 'TreatmentPlanParticipants' - 'SSSignature' - 'FieldNumber' field.
Enter a base64 encoded signature value in the 'TreatmentPlanParticipants' - 'SSSignature' - 'FieldValue' field.
Enter "52143" in the 'SSSignature' - 'FieldNumber' field.
Enter a base64 encoded signature value in the 'SSSignature' - 'FieldValue' field.
Enter "Client A" in the 'ClientID' field.
Enter "1" in the 'EpisodeNumber' field.
Enter the unique ID for the existing 'Treatment Plan' record in the 'TPUniqueID' field.
Click [Run].
Validate the 'Confirmation' field contains the unique ID for the treatment plan filed.
Validate the 'Message' field contains: "Treatment Plan web service has been filed successfully".
Select "Client A" and access "View A".
Validate the 'Treatment Plan' widget contains the record updated in the previous steps.
Click [View].
Validate the 'Console Widget Viewer' displays all treatment plan data updated in the previous steps.
Validate the 'SS Treatment Plan Client Sign 1' field contains the signature updated in the previous steps.
Validate the 'SS Treatment Plan Part Sign 1' field contains the signature updated in the previous steps.
Click [Close All].

Scenario 3: Treatment Plan Web Service- Get Treatment Plan

Specific Setup:

A client is enrolled in an existing episode and has a 'Treatment Plan' on file (Client A).
The following signature fields must be added to the 'Treatment Plan' form via 'Site Specific Section Modeling':
SS Treatment Plan Client Sign 1 (Field #52143 - This can be found in the 'Form and Table Documentation' form).
SS Treatment Plan Part Sign 1 (Field #57020 - This can be found in the 'Form and Table Documentation' form).

Steps

Access SoapUI for the 'TreatmentPlan' - 'GetTreatmentPlan' web service.
Enter the system code that will be used to log into Avatar in the 'SystemCode' field.
Enter the user name that will be used to log into Avatar in the 'UserName' field.
Enter the password that will be used to log into Avatar in the 'Password' field.
Enter "Client A" in the 'ClientID' field.
Enter the unique ID for the existing 'Treatment Plan' record in the 'TPUniqueID' field.
Click [Run].
Validate the 'GetTreatmentPlanResponse' field contains the 'Treatment Plan' data on file.
Validate the signatures on file are returned in a base64 encoded format. Please note: you can use any online decoder to confirm the base64 value matches the signature on file.

Topics

• Signatures • Treatment Plan • Web Services