CalOMSAnnualUpdate - Cal-PM web service
Avatar Cal-PM WEBSVC.CalOMSAnnualUpdate web service
This web service has the following calls:
- FileCalOMSAnnualUpdate
- DeleteCalOMSAnnualUpdate
- GetDictionaryItems
This web service has the following object class:
- WEBSVC.CalOMSAnnualUpdateObject
FileCalOMSAnnualUpdate call
The following tables list the FileCalOMSAnnualUpdate 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 |
|
| ClientID | N/A | Avatar Client ID | |
| EpisodeNumber | N/A | Episode Number |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
| CalOMSAnnualUpdateInfo | CalOMSAnnualUpdateObject | WEBSVC.CalOMSAnnualUpdateObject | This parameter is itself a web service object -- see below for its properties |
DeleteCalOMSAnnualUpdate call
The following table lists the DeleteCalOMSAnnualUpdate 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 |
|
| GUID | N/A | Globally Unique ID | A unique identifier for the update to be deleted. In the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12). |
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.CalOMSAnnualUpdateObject
| CalOMSAnnualUpdateObject | AlcoholFrequency | Number | A number between 0 and 30 (inclusive). |
|
| AnnualUpdateDate | Date |
|
|
| CommunicableDiseases | Dictionary Code | "Has the client been diagnosed with a communicable disease since admission? From Client File, data element 70626." |
|
| Consent | Dictionary Code | "From Client File, data element 70519." |
|
| CurrentFirstName | Free Text |
|
|
| CurrentLastName | Free Text |
|
|
| CurrentLivingArrangements | Dictionary Code | "From Client File, data element 70635." |
|
| Disability | Dictionary Code | "From Client File, data element 70518." |
|
| EmergencyRoomLast30Days | Number | A number between 0 and 99 (inclusive). |
|
| EmergencyRoomUse | Number | Emergency room use (for mental health). A number between 0 and 99 (inclusive). |
|
| EmploymentStatus | Dictionary Code | "From Client File, data element 70607." |
|
| EnrolledInJobTraining | Dictionary Code | "From Client File, data element 70611." |
|
| EnrolledInSchool | Dictionary Code | "From Client File, data element 70543." |
|
| FamilyConflictLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| GUID | Globally Unique ID | In the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12). |
|
| HIVTestResults | Dictionary Code | "From Client File, data element 70628." |
|
| HIVTested | Dictionary Code | "From Client File, data element 70627." |
|
| HepatitisC | Dictionary Code | "Has the client been tested for Hepatitis C since admission? From Client File, data element 70623." |
|
| HighestSchoolCompleted | Dictionary Code | "From Client File, data element 70612." |
|
| Homeless | Dictionary Code | "From Client File, data element 70634." |
|
| HomelessLivingArrangement | Dictionary Code | "From Client File, data element 70679." |
|
| HospOvernightLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| IVUse | Number | A number between 0 and 30 (inclusive). |
|
| IllegalActivityDays | Number | Number of times in the last 30 days the client has engaged in illegal activity for a profit. |
|
| LegalWorkMoney | Number | The amount of money the client has earned from legal work in the last 30 days. |
|
| LivingWithSomeone | Number | A number between 0 and 30 (inclusive). |
|
| MedicalProblemsLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| MentalHealthMedication | Dictionary Code | "From Client File, data element 70632." |
|
| MentalIllness | Dictionary Code | "From Client File, data element 70629." |
|
| NeedleUseLast12Months | Dictionary Code | "From Client File, data element 70605." |
|
| NonLaborForceDescription | Dictionary Code | "The description of what the client does, if they are not in the work force. From Client File, data element 70608." |
|
| NumArrestsLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| NumChild17orYounger | Free Text | Number of children the client has. |
|
| NumChild5orYounger | Free Text | Number of children the client has that are 5 or under. |
|
| NumChildEnroll | Free Text | Number of children the client has that are in treatment services with the client. |
|
| NumChildLivingElsewhere | Free Text | Number of children the client has that live with someone else. |
|
| NumChildMovedByCPS | Free Text | Number of children the client has that live with someone else because of a child protective order. |
|
| NumChildParentRightsTerm | Free Text | Number of children the client has that live with someone else and for whom parental rights have been terminated. |
|
| NumChildRightsTermByCPS | Free Text | Number of children the client has that live with someone else and for whom parental rights have been terminated due to a child protective order. |
|
| NumChildWithYou30Days | Free Text | Number of children who have spent the majority of the time living with the client for the past 30 days. |
|
| NumChildWithYou6Months | Free Text | Number of children who have spent the majority of the time living with the client for the past 6 months. |
|
| NumJailDaysLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| NumPrisonDaysLast30Days | Number | A number between 0 and 30 (inclusive). |
|
| OpenCaseCPS | Dictionary Code | "From Client File, data element 70643." |
|
| PhysicalAbuse30Days | Dictionary Code | "From Client File, data element 70654." |
|
| PregnantDuringTreatment | Dictionary Code | "From Client File, data element 70621." |
|
| PrimaryDrugCode | Dictionary Code | "From Client File, data element 70595." |
|
| PrimaryDrugFrequency | Number | A number between 0 and 30 (inclusive). |
|
| PrimaryDrugName | Free Text | The description associated with PrimaryDrugCode. |
|
| PrimaryDrugRoute | Dictionary Code | "From Client File, data element 70598." |
|
| PsychiatricFacilityUse | Number | A number between 0 and 30 (inclusive). |
|
| STDs | Dictionary Code | "STDs the client has been diagnosed with since admission. From Client File, data element 70625." |
|
| STDsYN | Dictionary Code | "Has the client been diagnosed with an STD since admission? From Client File, data element 70623." |
|
| SecondaryDrugCode | Dictionary Code | "From Client File, data element 70595." |
|
| SecondaryDrugFrequency | Number | A number between 0 and 30 (inclusive). |
|
| SecondaryDrugName | Free Text | The description associated with SecondaryDrugCode. |
|
| SecondaryDrugRoute | Dictionary Code | "From Client File, data element 70598." |
|
| SexualAbuse30Days | Dictionary Code | "Has the client been sexually abused in the last 30 days? From Client File, data element 70646." |
|
| SoberAbstinent | Dictionary Code | "From Client File, data element 70606." |
|
| SocialSecurityNumber | Social Security Number |
|
|
| SocialSupport | Number | A number between 0 and 30 (inclusive). |
|
| Tuberculosis | Dictionary Code | "Has the client been diagnosed with tuberculosis since admission? From Client File, data element 70622." |
|
| UTCTimestamp | Time Stamp | In the format YYYY-MM-DD hh:mm:ss. |
|
| WorkPast30Days | Number | A number between 0 and 30 (inclusive). |
|
| ZipCodeAtCurrentResidence | Zip Code |
|