PHQ9 - Avatar CWS Web Service

Operations

The web service supports the following operations:

AddPHQ9
DeletePHQ9
EditPHQ9
GetDictionaryItems

Object classes

The web service has the following object classes:

WEBSVC.PHQ9Object

AddPHQ9 call

return to Operations list

Used to file a PHQ9 assessment.

Parameters with no properties

Parameter	Properties	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

Parameters with properties

Parameter	Properties	Value Accepted	Notes
PHQ9Info	WEBSVC.PHQ9Object	WEBSVC.PHQ9Object	The property is itself an object - details provided below.

DeletePHQ9 call

return to Operations list

Used to delete a previously filed PHQ9 assessment

Parameters with no properties

Parameter	Properties	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
UniqueID	N/A	PHQ9 assessment unique ID (unique to the provided client only)

EditPHQ9 call

return to Operations list

Used to edit a previously filed PHQ9 assessment

Parameters with no properties

Parameter	Properties	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
UniqueID	N/A	PHQ9 assessment unique ID (unique to the provided client only)

Parameters with properties

Parameter	Properties	Value Accepted	Notes
PHQ9Info	WEBSVC.PHQ9Object	WEBSVC.PHQ9Object	The property is itself an object - details provided below.

GetDictionaryItems

return to Operations list

Used to retrieve the dictionary code sets associated with the specified option.

Parameters with no properties

Parameter	Properties	Value Accepted	Notes
SystemCode	N/A	Avatar System Code	Examples: UAT, LIVE, etc.
UserName	N/A	Avatar User ID
Password	N/A	Avatar Password

Object class: WEBSVC.PHQ9Object

return to Object class list

Parameter	Properties	Value Accepted	Notes
WEBSVC.PHQ9Object	AppetiteProblem	Dictionary Code: field #27008 in CWS file
	AssessmentDate	Date
	AssessmentPractitioner	Staff ID
	AssessmentStatus	Dictionary Code: field #27019 in CWS file	Draft/Final status value
	ConcentratingIssue	Dictionary Code: field #27004 in CWS file	Several assessment questions are mapped to this dictionary field (27004)
	DifficultToManage	Dictionary Code: field #27013 in CWS file
	FeelingBad	Dictionary Code: field #27004 in CWS file
	FeelingDown	Dictionary Code: field #27004 in CWS file
	FeelingTired	Dictionary Code: field #27004 in CWS file
	LittleInterest	Dictionary Code: field #27004 in CWS file
	MovementSpeedUnsual	Dictionary Code: field #27004 in CWS file
	ReasonForNotAdministering	Free Text
	SelfHurtThoughts	Dictionary Code: field #27004 in CWS file
	SleepTrouble	Dictionary Code: field #27004 in CWS file
	SSPatientHealthQuestionnaire9Date1	Date
	SSPatientHealthQuestionnaire9Date2	Date
	SSPatientHealthQuestionnaire9Date3	Date
	SSPatientHealthQuestionnaire9Date4	Date
	SSPatientHealthQuestionnaire9Date5	Date
	SSPatientHealthQuestionnaire9FreeTextLong1	Free Text
	SSPatientHealthQuestionnaire9FreeTextLong2	Free Text
	SSPatientHealthQuestionnaire9FreeTextLong3	Free Text
	SSPatientHealthQuestionnaire9FreeTextLong4	Free Text
	SSPatientHealthQuestionnaire9FreeTextLong5	Free Text
	SSPatientHealthQuestionnaire9FreeTextShort1	Free Text
	SSPatientHealthQuestionnaire9FreeTextShort2	Free Text
	SSPatientHealthQuestionnaire9FreeTextShort3	Free Text
	SSPatientHealthQuestionnaire9FreeTextShort4	Free Text
	SSPatientHealthQuestionnaire9FreeTextShort5	Free Text
	SSPatientHealthQuestionnaire9MultipleSelectDictionary1	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary2	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary3	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary4	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary5	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary6	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary7	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary8	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary9	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9MultipleSelectDictionary10	SS Multiple Select Dictionary
	SSPatientHealthQuestionnaire9Practitioner1	Staff ID
	SSPatientHealthQuestionnaire9Practitioner2	Staff ID
	SSPatientHealthQuestionnaire9Practitioner3	Staff ID
	SSPatientHealthQuestionnaire9Practitioner4	Staff ID
	SSPatientHealthQuestionnaire9Practitioner5	Staff ID
	SSPatientHealthQuestionnaire9ScrollingFreeText1	Scrolling Free Text
	SSPatientHealthQuestionnaire9ScrollingFreeText2	Scrolling Free Text
	SSPatientHealthQuestionnaire9ScrollingFreeText3	Scrolling Free Text
	SSPatientHealthQuestionnaire9ScrollingFreeText4	Scrolling Free Text
	SSPatientHealthQuestionnaire9ScrollingFreeText5	Scrolling Free Text
	SSPatientHealthQuestionnaire9SingleSelectDictionary1	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary2	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary3	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary4	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary5	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary6	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary7	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary8	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary9	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9SingleSelectDictionary10	SS Single Select Dictionary
	SSPatientHealthQuestionnaire9Time1	Time
	SSPatientHealthQuestionnaire9Time2	Time
	SSPatientHealthQuestionnaire9Time3	Time
	SSPatientHealthQuestionnaire9Time4	Time
	SSPatientHealthQuestionnaire9Time5	Time