ClientDemographics - PM web service
Avatar PM WEBSVC.ClientDemographics web service
This web service has the following calls:
- GetDictionaryItems
- UpdateClientDemographics
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 |
UpdateClientDemographics call
The following tables list the UpdateClientDemographics 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 |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
ClientDemographicsInfo |
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 |
|
|
|
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 |
|
|
|
ClientDeclinedToProvideInfo |
Dictionary field # 164 in Client File |
|
|
|
ClientEmailAddress |
Free Text |
|
|
|
ClientFirstName |
Free Text |
|
|
|
ClientHomePhone |
Phone Number |
|
|
|
ClientLastName |
Free Text |
|
|
|
ClientMailAddressCity |
Free Text |
|
|
|
ClientMailAddressCountry |
Free Text |
|
|
|
ClientMailAddressState |
State |
|
|
|
ClientMailAddressStreet |
Free Text |
|
|
|
ClientMailAddressStreet2 |
Free Text |
|
|
|
ClientMailAddressZipcode |
Zip Code |
|
|
|
ClientMiddleName |
Free Text |
|
|
|
ClientName |
Free Text |
|
|
|
ClientPrefix |
Dictionary field # 175 in Client File |
|
|
|
ClientRace |
Dictionary field # 116 in Client File |
|
|
|
ClientSuffix |
Dictionary field # 174 in Client File |
|
|
|
ClientWorkPhone |
Phone Number |
|
|
|
CommunicationPreference |
Dictionary field # 104 in Client File |
|
|
|
CountryOfOrigin |
Dictionary field # 150 in Client File |
|
|
|
DateOfBirth |
Date |
|
|
|
Education |
Dictionary field # 625 in Client File |
|
|
|
EmploymentStatus |
Dictionary field # 517 in Client File |
|
|
|
EnglishProficiency |
Dictionary field # 354 in Client File |
|
|
|
EthnicOrigin |
Dictionary field # 8 in Client File |
|
|
|
ExpectedDueDate |
Date |
|
|
|
FacilityChartNumber |
Free Text |
|
|
|
FamilyIncome |
Dollar Amount |
|
|
|
FamilySize |
Number |
|
|
|
GUID |
GUID |
|
|
|
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 |
|
|
|
LactatingStatus |
Dictionary field # 377 in Client File |
|
|
|
MaidenName |
Free Text |
|
|
|
MaritalStatus |
Dictionary field # 10 in Client File |
|
|
|
MothersMaidenName |
Free Text |
|
|
|
NameQualifier |
Dictionary field # 381 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 |
|
|
|
PregnancyStatus |
Dictionary field # 357 in Client File |
|
|
|
PrimaryLanguage |
Dictionary field # 149 in Client File |
|
|
|
ProtectionIndicator |
Dictionary field # 379 in Client File |
|
|
|
ProtectionIndicatorDate |
Date |
|
|
|
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 |
|
|
|
Sex |
Dictionary field # 3 in Client File |
Required by Web Service |
|
|
Smoker |
Dictionary field # 9603 in Client File |
|
|
|
SmokingStatusAssessmentDate |
Date |
|
|
|
SocialSecurityNumber |
Social Security Number |
|
|
|
SocialSecurityNumber2 |
Social Security Number |
|
|
|
SocialSecurityNumber3 |
Social Security Number |
|
|
|
SocialSecurityNumber4 |
Social Security Number |
|
|
|
UTCTimestamp |
Timestamp |
Required by Web Service |