ProgressNotes.Group.Request - CWS web service
myAvatar CWS Progress Notes Group web service
This web service request has the following operations:
- AddGroupNotes
- GetGroupNoteItems
- GetDictionaryItems
This web service has the following object classes:
- WEBSVC.ProgressNotes.Group.Object
AddGroupNotes Call
The following tables list the AddGroupNotes parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| SystemCode | N/A | Avatar System Code | Examples: SAMPLE, LIVE, etc. |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| Option | N/A | Progress Notes Option ID | This is used to distinguish copies of "Progress Notes (Group and Individual)". Examples: PN23000, PN23001 |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
ProgressNoteInfo |
ProgressNotes.Group.Object |
WEBSVC.ProgressNotes.Group.Object |
This parameter is itself a web service object -- see below for its properties |
GetGroupNoteItems Call
This web service call returns information about a group note and each individual patient in the progress note group. The information allows an end user to individualize each note via the 'WEBSVC.ProgressNotes.Client.Request' web service and 'SelectNoteToEdit' field.
The following tables list the GetGroupNoteItems parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| SystemCode | N/A | Avatar System Code | Examples: SAMPLE, LIVE, etc. |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| GroupID | N/A | Avatar Group ID | |
| NoteDate | N/A | Date | This parameter is the date the group note was written. |
GetDictionaryItems Call
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: SAMPLE, LIVE, etc. |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |
Object class: WEBSVC.ProgressNotes.Group.Object
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ProgressNotes.Group.Object | AddOnNotes | Free Text | |
| AdditionalServiceInformation | Dictionary Code | From CWS Table File, data element 245 | |
| CoPractitioner | Avatar Staff ID | ||
| CoPractitioner2 | Avatar Staff ID | ||
| CoPractitioner2DurationMinutes | Free Text | ||
| CoPractitionerDurationMinutes | Free Text | ||
| DateOfGroup | Date | ||
| EpisodeNumber | Avatar Episode Number | ||
| EvidenceBasedPracticesServiceStrategiesCSI | Free Text | ||
| GroupNameOrNumber | Avatar Group ID | ||
| Location | Dictionary Code | From Client File, data element 10006 | |
| MissedVisitServiceCode | Avatar Service Code | ||
| Note | Free Text | ||
| NoteAddressesWhichExistingServiceAppointment | Dictionary Code | Service Unique ID is required if "ProgressNoteFor" is set to "Existing Service"; Appointment ID is required if set to "Existing Appointment" | |
| NoteType | Dictionary Code | From CWS Table File, data element 254 | |
| NumberOfClientsInGroup | Dictionary Code | ||
| Practitioner | Avatar Staff ID | ||
| ProgressNoteFor | Dictionary Code | From CWS Table File, data element 265 | |
| PsychotherapyAddOnDuration | Dictionary Code | ||
| SSGroupNotesDSMCode1 | DSM-IV Code | ||
| SSGroupNotesDSMCode10 | DSM-IV Code | ||
| SSGroupNotesDSMCode2 | DSM-IV Code | ||
| SSGroupNotesDSMCode3 | DSM-IV Code | ||
| SSGroupNotesDSMCode4 | DSM-IV Code | ||
| SSGroupNotesDSMCode5 | DSM-IV Code | ||
| SSGroupNotesDSMCode6 | DSM-IV Code | ||
| SSGroupNotesDSMCode7 | DSM-IV Code | ||
| SSGroupNotesDSMCode8 | DSM-IV Code | ||
| SSGroupNotesDSMCode9 | DSM-IV Code | ||
| SSGroupNotesDate1 | Date | ||
| SSGroupNotesDate10 | Date | ||
| SSGroupNotesDate2 | Date | ||
| SSGroupNotesDate3 | Date | ||
| SSGroupNotesDate4 | Date | ||
| SSGroupNotesDate5 | Date | ||
| SSGroupNotesDate6 | Date | ||
| SSGroupNotesDate7 | Date | ||
| SSGroupNotesDate8 | Date | ||
| SSGroupNotesDate9 | Date | ||
| SSGroupNotesFreeText201 | Free Text | ||
| SSGroupNotesFreeText2010 | Free Text | ||
| SSGroupNotesFreeText202 | Free Text | ||
| SSGroupNotesFreeText203 | Free Text | ||
| SSGroupNotesFreeText204 | Free Text | ||
| SSGroupNotesFreeText205 | Free Text | ||
| SSGroupNotesFreeText206 | Free Text | ||
| SSGroupNotesFreeText207 | Free Text | ||
| SSGroupNotesFreeText208 | Free Text | ||
| SSGroupNotesFreeText209 | Free Text | ||
| SSGroupNotesFreeText401 | Free Text | ||
| SSGroupNotesFreeText4010 | Free Text | ||
| SSGroupNotesFreeText402 | Free Text | ||
| SSGroupNotesFreeText403 | Free Text | ||
| SSGroupNotesFreeText404 | Free Text | ||
| SSGroupNotesFreeText405 | Free Text | ||
| SSGroupNotesFreeText406 | Free Text | ||
| SSGroupNotesFreeText407 | Free Text | ||
| SSGroupNotesFreeText408 | Free Text | ||
| SSGroupNotesFreeText409 | Free Text | ||
| SSGroupNotesFreeText801 | Free Text | ||
| SSGroupNotesFreeText8010 | Free Text | ||
| SSGroupNotesFreeText802 | Free Text | ||
| SSGroupNotesFreeText803 | Free Text | ||
| SSGroupNotesFreeText804 | Free Text | ||
| SSGroupNotesFreeText805 | Free Text | ||
| SSGroupNotesFreeText806 | Free Text | ||
| SSGroupNotesFreeText807 | Free Text | ||
| SSGroupNotesFreeText808 | Free Text | ||
| SSGroupNotesFreeText809 | Free Text | ||
| SSGroupNotesICD9Code1 | ICD9 Code | ||
| SSGroupNotesICD9Code10 | ICD9 Code | ||
| SSGroupNotesICD9Code2 | ICD9 Code | ||
| SSGroupNotesICD9Code3 | ICD9 Code | ||
| SSGroupNotesICD9Code4 | ICD9 Code | ||
| SSGroupNotesICD9Code5 | ICD9 Code | ||
| SSGroupNotesICD9Code6 | ICD9 Code | ||
| SSGroupNotesICD9Code7 | ICD9 Code | ||
| SSGroupNotesICD9Code8 | ICD9 Code | ||
| SSGroupNotesICD9Code9 | ICD9 Code | ||
| SSGroupNotesInteger1 | Integer | ||
| SSGroupNotesInteger2 | Integer | ||
| SSGroupNotesInteger3 | Integer | ||
| SSGroupNotesInteger4 | Integer | ||
| SSGroupNotesInteger5 | Integer | ||
| SSGroupNotesInteger6 | Integer | ||
| SSGroupNotesMulitpleResponseDictionary1 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary10 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary2 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary3 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary4 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary5 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary6 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary7 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary8 | Dictionary Code | ||
| SSGroupNotesMulitpleResponseDictionary9 | Dictionary Code | ||
| SSGroupNotesPractitioner1 | Avatar Staff ID | ||
| SSGroupNotesPractitioner10 | Avatar Staff ID | ||
| SSGroupNotesPractitioner2 | Avatar Staff ID | ||
| SSGroupNotesPractitioner3 | Avatar Staff ID | ||
| SSGroupNotesPractitioner4 | Avatar Staff ID | ||
| SSGroupNotesPractitioner5 | Avatar Staff ID | ||
| SSGroupNotesPractitioner6 | Avatar Staff ID | ||
| SSGroupNotesPractitioner7 | Avatar Staff ID | ||
| SSGroupNotesPractitioner8 | Avatar Staff ID | ||
| SSGroupNotesPractitioner9 | Avatar Staff ID | ||
| SSGroupNotesScrollingFreeText1 | Free Text | ||
| SSGroupNotesScrollingFreeText10 | Free Text | ||
| SSGroupNotesScrollingFreeText2 | Free Text | ||
| SSGroupNotesScrollingFreeText3 | Free Text | ||
| SSGroupNotesScrollingFreeText4 | Free Text | ||
| SSGroupNotesScrollingFreeText5 | Free Text | ||
| SSGroupNotesScrollingFreeText6 | Free Text | ||
| SSGroupNotesScrollingFreeText7 | Free Text | ||
| SSGroupNotesScrollingFreeText8 | Free Text | ||
| SSGroupNotesScrollingFreeText9 | Free Text | ||
| SSGroupNotesSingleResponseDictionary1 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary10 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary2 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary3 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary4 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary5 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary6 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary7 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary8 | Dictionary Code | ||
| SSGroupNotesSingleResponseDictionary9 | Dictionary Code | ||
| SSGroupNotesTime1 | Time | ||
| SSGroupNotesTime10 | Time | ||
| SSGroupNotesTime2 | Time | ||
| SSGroupNotesTime3 | Time | ||
| SSGroupNotesTime4 | Time | ||
| SSGroupNotesTime5 | Time | ||
| SSGroupNotesTime6 | Time | ||
| SSGroupNotesTime7 | Time | ||
| SSGroupNotesTime8 | Time | ||
| SSGroupNotesTime9 | Time | ||
| ServiceChargeCode | Avatar Service Code | ||
| ServiceDuration | Dictionary Code | ||
| ServiceEndTime | Time | ||
| ServiceProgram | Avatar Program Code | ||
| ServiceStartTime | Time | ||
| UserToSendCoSignToDoItemTo | CWS Workflow User | ||
| UserToSendScratchNoteToDoItemTo | CWS Workflow User |