ClientDischargeV2 - Cal-PM web service
Avatar Cal-PM WEBSVC.ClientDischargeV2 web service
This web service has the following call:
- DischargeClient
This web service has the following object class:
- WEBSVC.ClientDischargeObject
DischargeClient call
The following tables list the DischargeClient parameters, properties, accepted values, and associated dictionaries.
Parameters with no Properties
| Parameter | Property | Value Accepted | Notes |
| ClientID | N/A | Avatar Client ID | |
| EpisodeNumber | N/A | Episode Number |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
| ClientDischargeInfo | ClientDischargeObject | WEBSVC.ClientDischargeObject | This parameter is itself a web service object -- see below for its properties |
Object class: WEBSVC.ClientDischargeObject
| Parameter | Property | Value Accepted | Notes |
| ClientDischargeObject | Alias | Free Text | Alias the client uses. |
|
| Alias10 | Free Text | Alias the client uses. |
|
| Alias2 | Free Text | Alias the client uses. |
|
| Alias3 | Free Text | Alias the client uses. |
|
| Alias4 | Free Text | Alias the client uses. |
|
| Alias5 | Free Text | Alias the client uses. |
|
| Alias6 | Free Text | Alias the client uses. |
|
| Alias7 | Free Text | Alias the client uses. |
|
| Alias8 | Free Text | Alias the client uses. |
|
| Alias9 | Free Text | Alias the client uses. |
|
| ClientAddressCity | Free Text |
|
|
| ClientAddressCounty | Dictionary Code | "From Client File, data element 93." |
|
| ClientAddressState | State | The client's state of residence. |
|
| ClientAddressStreet | Free Text |
|
|
| ClientAddressStreet2 | Free Text |
|
|
| ClientAddressZipcode | Zip Code |
|
|
| ClientCellPhone | Phone Number |
|
|
| ClientEmailAddress | Free Text |
|
|
| ClientHomePhone | Phone Number |
|
|
| ClientRace | Dictionary Code | "From Client File, data element 116." |
|
| ClientWorkPhone | Phone Number |
|
|
| CommunicationPreference | Dictionary Code | "From Client File, data element 104." |
|
| CountryOfOrigin | Dictionary Code | "From Client File, data element 150." |
|
| DateOfDeath | Date |
|
|
| DateOfDischarge | Date |
|
|
| ClientLivingArrangement | Dictionary Code | "From Client File, data element 502." |
|
| DischargePractitioner | Avatar Staff ID |
|
|
| DischargeRemarks | Text |
|
|
| DischargeTime | Time |
|
|
| Education | Dictionary Code | "From Client File, data element 625." |
|
| EmploymentStatus | Dictionary Code | "From Client File, data element 517." |
|
| EthnicOrigin | Dictionary Code | "From Client File, data element 8." |
|
| GUID | Globally Unique ID | In the format xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (8-4-4-4-12). |
|
| MaritalStatus | Dictionary Code | "From Client File, data element 10." |
|
| Occupation | Dictionary Code | "From Client File, data element 610." |
|
| PlaceOfBirth | Free Text |
|
|
| PrimaryLanguage | Dictionary Code | "From Client File, data element 149." |
|
| ReasonForDeath | Dictionary Code | "From Client File, data element 972." |
|
| Religion | Dictionary Code | "From Client File, data element 9." |
|
| HospitalInstructions | Free Text |
|
|
| SSDischAdmFreeTxt20one | Free Text | "Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt20two | Free Text | "Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt20three | Free Text | "Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt20four | Free Text | "Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt20five | Free Text | "Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt40one | Free Text | "Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt40two | Free Text | "Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt40three | Free Text | "Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt40four | Free Text | "Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
| SSDischAdmFreeTxt40five | Free Text | "Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
| SSDischargeAdmDict1 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.1." |
|
| SSDischargeAdmDict2 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.2." |
|
| SSDischargeAdmDict3 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.3." |
|
| SSDischargeAdmDict4 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.4." |
|
| SSDischargeAdmDict5 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.5." |
|
| SSDischargeAdmDict6 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.6." |
|
| SSDischargeAdmDict7 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.7." |
|
| SSDischargeAdmDict8 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.8." |
|
| SSDischargeAdmDict9 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21013.9." |
|
| SSDischargeAdmFreeTxt1 | Text | "A non-standard, site-specific field. " |
|
| SSDischargeAdmFreeTxt2 | Text | "A non-standard, site-specific field. " |
|
| SSDischargeAdmFreeTxt3 | Text | "A non-standard, site-specific field. " |
|
| SSDischargeAdmFreeTxt4 | Text | "A non-standard, site-specific field. " |
|
| SSDischargeAdmFreeTxt5 | Text | "A non-standard, site-specific field. " |
|
| SSDischargeAdmMult1 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21047.1." |
|
| SSDischargeAdmMult2 | Dictionary Code | "A non-standard, site-specific field. From Client File, data element 21047.2." |
|
| SSDischargeAdmStaff1 | Avatar Staff ID | "A non-standard, site-specific field." |
|
| SSDischargeAdmStaff2 | Avatar Staff ID | "A non-standard, site-specific field." |
|
| SSDischargeAdmStaff3 | Avatar Staff ID | "A non-standard, site-specific field." |
|
| SSDischargeAdmStaff4 | Avatar Staff ID | "A non-standard, site-specific field." |
|
| SSDischargeAdmStaff5 | Avatar Staff ID | "A non-standard, site-specific field." |
|
| SSDischargeAdmTime1 | Time | "A non-standard, site-specific field." |
|
| TypeOfDischarge | Dictionary Code | "From Client File, data element 970." |
|
| PatientStatusCode | Dictionary Code | "From Client File, data element 70205." |
|
| DischargeLegalClass | Dictionary Code | "From Client File, data element 70206." |
|
| DischargeStatus | Dictionary Code | "From Client File, data element 70207." |
|
| EmployStatusDischarge | Dictionary Code | "From Client File, data element 70208." |
|
| PartSoberAbsDischarge | Dictionary Code | "From Client File, data element 70209." |
|
| PrimAlcDrugProblem | Dictionary Code | "From Client File, data element 70233." |
|
| PrimAlcDrugProblemOther | Free Text |
|
|
| SecAlcDrugProblem | Dictionary Code | "From Client File, data element 70233." |
|
| SecAlcDrugProblemOther | Free Text |
|
|
| TerAlcDrugProblem | Dictionary Code | "From Client File, data element 70233." |
|
| TerAlcDrugProblemOther | Free Text |
|
|
| PartPregDuringTreatment | Dictionary Code | "From Client File, data element 70213." |
|
| PerPartFreqUseDischarge | Dictionary Code | "From Client File, data element 70250." |
|
| OSHPDTypeOfCare | Dictionary Code | "From Client File, data element 70410." |
|
| OSHPDZipCode | Zip Code |
|
|
| SourceOfAdmissionSite | Dictionary Code | "From Client File, data element 70404." |
|
| LicensureOfSite | Dictionary Code | "From Client File, data element 70405." |
|
| Route | Dictionary Code | "From Client File, data element 70406." |
|
| OSHPDTypeOfAdmission | Dictionary Code | "From Client File, data element 70407." |
|
| ExpSourcePymtPayorCat | Dictionary Code | "From Client File, data element 70408." |
|
| TypeOfCoverage | Dictionary Code | "From Client File, data element 70409." |
|
| NameOfPlan | Dictionary Code | "From Client File, data element 70410." |
|
| DispositionOfPatient | Dictionary Code | "From Client File, data element 70411." |
|
| DNROrdersOnFile | Dictionary Code | "From Client File, data element 70412." |
|
| PrincipalECode | Dictionary Code | "From Client File, data element 70413." |
|
| OtherECode1 | Dictionary Code | "From Client File, data element 70413." |
|
| OtherECode2 | Dictionary Code | "From Client File, data element 70413." |
|
| OtherECode3 | Dictionary Code | "From Client File, data element 70413." |
|
| OtherECode4 | Dictionary Code | "From Client File, data element 70413." |
|
| UTCTimestamp | Time Stamp | In the format YYYY-MM-DD hh:mm:ss. |