ClientDischarge - PM web service
Avatar PM WEBSVC.ClientDischarge web service
This web service has the following calls:
- DischargeClient
- GetDictionaryItems
DischargeClient call
The following tables list the DischargeClient parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| SystemCode | N/A | Avatar System Code | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password | |
| ClientID | N/A | The client ID | |
| EpisodeNumber | N/A | The episode number |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
ClientDischargeInfo |
AccompaniedBy |
Free Text |
|
|
|
Alias |
Free Text |
|
|
|
Alias10 |
Free Text |
|
|
|
Alias2 |
Free Text |
|
|
|
Alias3 |
Free Text |
|
|
|
Alias4 |
Free Text |
|
|
|
Alias5 |
Free Text |
|
|
|
Alias6 |
Free Text |
|
|
|
Alias7 |
Free Text |
|
|
|
Alias8 |
Free Text |
|
|
|
Alias9 |
Free Text |
|
|
|
Arrests30DayPriorDisc |
Number |
|
|
|
Citizenship |
Dictionary field # 160 in Client File |
|
|
|
ClientAddressCity |
Free Text |
|
|
|
ClientAddressCountry |
Dictionary field # 99 in Client File |
|
|
|
ClientAddressCounty |
Dictionary field # 93 in Client File |
|
|
|
ClientAddressState |
State |
|
|
|
ClientAddressStreet |
Free Text |
|
|
|
ClientAddressStreet2 |
Free Text |
|
|
|
ClientAddressZipcode |
Zip Code |
|
|
|
ClientCellPhone |
Phone Number |
|
|
|
ClientConfAddressCity |
Free Text |
|
|
|
ClientConfAddressCountry |
Free Text |
|
|
|
ClientConfAddressState |
State |
|
|
|
ClientConfAddressStreet |
Free Text |
|
|
|
ClientConfAddressStreet2 |
Free Text |
|
|
|
ClientConfAddressZipcode |
Zip Code |
|
|
|
ClientConfPhoneNumber |
Phone Number |
|
|
|
ClientEmailAddress |
Free Text |
|
|
|
ClientHomePhone |
Phone Number |
|
|
|
ClientLivingArrangement |
Dictionary field # 502 in Client File |
|
|
|
ClientMailAddressCity |
Free Text |
|
|
|
ClientMailAddressCountry |
Free Text |
|
|
|
ClientMailAddressState |
State |
|
|
|
ClientMailAddressStreet |
Free Text |
|
|
|
ClientMailAddressStreet2 |
Free Text |
|
|
|
ClientMailAddressZipcode |
Zip Code |
|
|
|
ClientRace |
Dictionary field # 116 in Client File |
|
|
|
ClientWorkPhone |
Phone Number |
|
|
|
CommunicationPreference |
Dictionary field # 104 in Client File |
|
|
|
CountryOfOrigin |
Dictionary field # 150 in Client File |
|
|
|
CurrentResCode |
Dictionary field # 151 in Client File |
|
|
|
DateOfDeath |
Date |
|
|
|
DateOfDischarge |
Date |
Required by Web Service |
|
|
DiscEmploymentStatus |
Free Text |
|
|
|
DischargePractitioner |
Staff ID |
|
|
|
DischargeReferralType |
Dictionary field # 503 in Client File |
|
|
|
DischargeRemarks |
Scrolling Text |
|
|
|
DischargeTime |
Time |
Required by Web Service |
|
|
Education |
Dictionary field # 625 in Client File |
|
|
|
EmploymentStatus |
Dictionary field # 517 in Client File |
|
|
|
EthnicOrigin |
Dictionary field # 8 in Client File |
|
|
|
Guarantor1 |
Free Text |
|
|
|
Guarantor10 |
Free Text |
|
|
|
Guarantor2 |
Free Text |
|
|
|
Guarantor3 |
Free Text |
|
|
|
Guarantor4 |
Free Text |
|
|
|
Guarantor5 |
Free Text |
|
|
|
Guarantor6 |
Free Text |
|
|
|
Guarantor7 |
Free Text |
|
|
|
Guarantor8 |
Free Text |
|
|
|
Guarantor9 |
Free Text |
|
|
|
HomelessIndicator |
Dictionary field # 152 in Client File |
|
|
|
HospitalInstructions |
Scrolling Text |
|
|
|
MaritalStatus |
Dictionary field # 10 in Client File |
|
|
|
Occupation |
Dictionary field # 610 in Client File |
|
|
|
OtherEthnicOrigins |
Free Text |
|
|
|
OtherRaces |
Free Text |
|
|
|
PlaceOfBirth |
Free Text |
|
|
|
PolicyNumber1 |
Free Text |
|
|
|
PolicyNumber10 |
Free Text |
|
|
|
PolicyNumber2 |
Free Text |
|
|
|
PolicyNumber3 |
Free Text |
|
|
|
PolicyNumber4 |
Free Text |
|
|
|
PolicyNumber5 |
Free Text |
|
|
|
PolicyNumber6 |
Free Text |
|
|
|
PolicyNumber7 |
Free Text |
|
|
|
PolicyNumber8 |
Free Text |
|
|
|
PolicyNumber9 |
Free Text |
|
|
|
PreferredProvidersEthnicOrigin |
Dictionary field # 8 in Client File |
|
|
|
PreferredProvidersSex |
Dictionary field # 3 in Client File |
|
|
|
PrimPresentingProblem |
Dictionary field # 10061 in Client File |
|
|
|
PrimaryLanguage |
Dictionary field # 149 in Client File |
|
|
|
ReasonForDeath |
Dictionary field # 972 in Client File |
|
|
|
Religion |
Dictionary field # 9 in Client File |
|
|
|
SSDemographicsDate1 |
Date |
|
|
|
SSDemographicsDate2 |
Date |
|
|
|
SSDemographicsDate3 |
Date |
|
|
|
SSDemographicsDate4 |
Date |
|
|
|
SSDemographicsDate5 |
Date |
|
|
|
SSDemographicsDict1 |
Free Text |
|
|
|
SSDemographicsDict10 |
Free Text |
|
|
|
SSDemographicsDict2 |
Free Text |
|
|
|
SSDemographicsDict3 |
Free Text |
|
|
|
SSDemographicsDict4 |
Free Text |
|
|
|
SSDemographicsDict5 |
Free Text |
|
|
|
SSDemographicsDict6 |
Free Text |
|
|
|
SSDemographicsDict7 |
Free Text |
|
|
|
SSDemographicsDict8 |
Free Text |
|
|
|
SSDemographicsDict9 |
Free Text |
|
|
|
SSDemographicsFreeText201 |
Free Text |
|
|
|
SSDemographicsFreeText202 |
Free Text |
|
|
|
SSDemographicsFreeText203 |
Free Text |
|
|
|
SSDemographicsFreeText204 |
Free Text |
|
|
|
SSDemographicsFreeText205 |
Free Text |
|
|
|
SSDemographicsFreeText401 |
Free Text |
|
|
|
SSDemographicsFreeText402 |
Free Text |
|
|
|
SSDemographicsFreeText403 |
Free Text |
|
|
|
SSDemographicsFreeText404 |
Free Text |
|
|
|
SSDemographicsFreeText405 |
Free Text |
|
|
|
SSDemographicsMult1 |
Free Text |
|
|
|
SSDemographicsMult2 |
Free Text |
|
|
|
SSDemographicsMult3 |
Free Text |
|
|
|
SSDemographicsMult4 |
Free Text |
|
|
|
SSDemographicsMult5 |
Free Text |
|
|
|
SSDemographicsPhone1 |
Phone Number |
|
|
|
SSDemographicsPhone2 |
Phone Number |
|
|
|
SSDemographicsPhone3 |
Phone Number |
|
|
|
SSDemographicsPhone4 |
Phone Number |
|
|
|
SSDemographicsPhone5 |
Phone Number |
|
|
|
SSDemographicsPractitioner1 |
Staff ID |
|
|
|
SSDemographicsPractitioner2 |
Staff ID |
|
|
|
SSDemographicsPractitioner3 |
Staff ID |
|
|
|
SSDemographicsPractitioner4 |
Staff ID |
|
|
|
SSDemographicsPractitioner5 |
Staff ID |
|
|
|
SSDemographicsScrollFreeText1 |
Scrolling Text |
|
|
|
SSDemographicsScrollFreeText2 |
Scrolling Text |
|
|
|
SSDemographicsScrollFreeText3 |
Scrolling Text |
|
|
|
SSDemographicsScrollFreeText4 |
Scrolling Text |
|
|
|
SSDemographicsScrollFreeText5 |
Scrolling Text |
|
|
|
SSDemographicsTime1 |
Time |
|
|
|
SSDemographicsTime2 |
Time |
|
|
|
SSDemographicsTime3 |
Time |
|
|
|
SSDemographicsTime4 |
Time |
|
|
|
SSDemographicsTime5 |
Time |
|
|
|
SSDischAdmFreeTxt20five |
Free Text |
|
|
|
SSDischAdmFreeTxt20four |
Free Text |
|
|
|
SSDischAdmFreeTxt20one |
Free Text |
|
|
|
SSDischAdmFreeTxt20three |
Free Text |
|
|
|
SSDischAdmFreeTxt20two |
Free Text |
|
|
|
SSDischAdmFreeTxt40five |
Free Text |
|
|
|
SSDischAdmFreeTxt40four |
Free Text |
|
|
|
SSDischAdmFreeTxt40one |
Free Text |
|
|
|
SSDischAdmFreeTxt40three |
Free Text |
|
|
|
SSDischAdmFreeTxt40two |
Free Text |
|
|
|
SSDischargeAdmDate1 |
Date |
|
|
|
SSDischargeAdmDate2 |
Date |
|
|
|
SSDischargeAdmDate3 |
Date |
|
|
|
SSDischargeAdmDate4 |
Date |
|
|
|
SSDischargeAdmDate5 |
Date |
|
|
|
SSDischargeAdmDict1 |
Free Text |
|
|
|
SSDischargeAdmDict2 |
Free Text |
|
|
|
SSDischargeAdmDict3 |
Free Text |
|
|
|
SSDischargeAdmDict4 |
Free Text |
|
|
|
SSDischargeAdmDict5 |
Free Text |
|
|
|
SSDischargeAdmDict6 |
Free Text |
|
|
|
SSDischargeAdmDict7 |
Free Text |
|
|
|
SSDischargeAdmDict8 |
Free Text |
|
|
|
SSDischargeAdmDict9 |
Free Text |
|
|
|
SSDischargeAdmFreeTxt1 |
Scrolling Text |
|
|
|
SSDischargeAdmFreeTxt2 |
Scrolling Text |
|
|
|
SSDischargeAdmFreeTxt3 |
Scrolling Text |
|
|
|
SSDischargeAdmFreeTxt4 |
Scrolling Text |
|
|
|
SSDischargeAdmFreeTxt5 |
Scrolling Text |
|
|
|
SSDischargeAdmMult1 |
Free Text |
|
|
|
SSDischargeAdmMult2 |
Free Text |
|
|
|
SSDischargeAdmStaff1 |
Staff ID |
|
|
|
SSDischargeAdmStaff2 |
Staff ID |
|
|
|
SSDischargeAdmStaff3 |
Staff ID |
|
|
|
SSDischargeAdmStaff4 |
Staff ID |
|
|
|
SSDischargeAdmStaff5 |
Staff ID |
|
|
|
SSDischargeAdmTime1 |
Time |
|
|
|
SSDischargeAdmTime2 |
Time |
|
|
|
SSDischargeAdmTime3 |
Time |
|
|
|
SSDischargeAdmTime4 |
Time |
|
|
|
SSDischargeAdmTime5 |
Time |
|
|
|
SecPresentingProblem |
Dictionary field # 10062 in Client File |
|
|
|
TertPresentingProblem |
Dictionary field # 10063 in Client File |
|
|
|
TypeOfDischarge |
Dictionary field # 970 in Client File |
Required by Web Service |
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 | |
| UserName | N/A | Avatar User ID | |
| Password | N/A | Avatar Password |