DiagnosisV2 - PM web service
Avatar PM WEBSVC.Diagnosis web service
This web service has the following calls:
- AddClientDiagnosis - Add a diagnosis to an myAvatar Client
- EditClientDiagnosis - Edit details of a diagnosis already assigned to an myAvatar Client
- GetDictionaryItems - Get all the dictionary fields that are used in this web service
- SearchDiagnosisCode - search for a diagnosis code using part of the code or part of the descriptions
This web service has the following object classes:
- WEBSVC.DiagnosisObject
- WEBSVC.ListOfDiagnosisEntryObjects
- WEBSVC.DiagnosisEntryObject
AddClientDiagnosis call
The following tables list the AddClientDiagnosis 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 |
|---|---|---|---|
|
ClientDiagnosisInfo |
DiagnosisObject |
WEBSVC.DiagnosisObject |
This parameter is itself a web service object -- see below for its properties |
EditClientDiagnosis call
The following tables list the EditClientDiagnosis parameters, properties, accepted values, and associated dictionaries.
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ClientID | N/A | Avatar Client ID | |
| EpisodeNumber | N/A | Episode Number | |
| UniqueID | N/A | Avatar Client Diagnosis ID |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
ClientDiagnosisInfo |
DiagnosisObject |
WEBSVC.DiagnosisObject |
This parameter is itself a web service object -- see below for its properties |
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 |
SearchDiagnosisCode Call
The following table lists the SearchDiagnosisCode 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 | |
| ClinicalSearchTerm | N/A | Free Text | IMO diagnosis search term |
Object class: WEBSVC.DiagnosisObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
DiagnosisObject |
AxIVEconomic |
Dictionary Code |
"From Client File, data element 9031." |
| AxIVEconomicRemarks | Free Text | Axis IV: Economic Remarks | |
|
|
AxIVEducational |
Dictionary Code |
"From Client File, data element 9028." |
| AxIVEducationalRemarks | Free Text | Axis IV: Educational Remarks | |
|
|
AxIVHealthCareSvs |
Dictionary Code |
"From Client File, data element 9032." |
| AxIVHealthCareSvsRemarks | Free Text | Axis IV: Health Care Service Remarks | |
|
|
AxIVHousing |
Dictionary Code |
"From Client File, data element 9030." |
| AxIVHousingRemarks | Free Text | Axis IV: Housing Remarks | |
|
|
AxIVLegalSysCrm |
Dictionary Code |
"From Client File, data element 9033." |
| AxIVLegalSysCrmRemarks | Free Text | Axis IV: Legal System/Crime Remarks | |
|
|
AxIVOccupational |
Dictionary Code |
"From Client File, data element 9029." |
| AxIVOccupationalRemarks | Free Text | Axis IV: Occupational Remarks | |
|
|
AxIVOtherProblems |
Dictionary Code |
"From Client File, data element 9034." |
| AxIVOtherProblemsRemarks | Free Text | Axis IV: Other Problems Remarks | |
|
|
AxIVPrimSuppGroup |
Dictionary Code |
"From Client File, data element 9026." |
| AxIVPrimSuppGroupRemarks | Free Text | Axis IV: Primary Support Group Remarks | |
|
|
AxIVSocEnviron |
Dictionary Code |
"From Client File, data element 9027." |
| AxIVSocEnvironRemarks | Free Text | Axis IV: Social Environment Remarks | |
|
|
DRGCode |
DRG Code |
|
|
|
DateOfDiagnosis |
Date |
|
|
|
DiagAxVCrntGAFRating |
Dictionary Code |
"From Client File, data element 622." |
|
|
DiagnosingPractitioner |
Avatar Staff ID |
|
|
|
EstimatedDD |
Date |
Esitmated discharge date. |
|
|
GAFHighestLast12Months |
Dictionary Code |
"From Client File, data element 623." |
|
|
GAFLowestLast12Months |
Dictionary Code |
"From Client File, data element 407." |
|
|
Prognosis |
Free Text |
|
|
|
TimeOfDiagnosis |
Time |
|
|
|
TypeOfDiagnosis |
Dictionary Code |
"From Client File, data element 125." |
|
|
SSDiagnosisFreeText201 |
Free Text |
"Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText202 |
Free Text |
"Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText203 |
Free Text |
"Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText204 |
Free Text |
"Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText205 |
Free Text |
"Has a maximum width of 20 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText401 |
Free Text |
"Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText402 |
Free Text |
"Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText403 |
Free Text |
"Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText404 |
Free Text |
"Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisFreeText405 |
Free Text |
"Has a maximum width of 40 characters. A non-standard, site-specific field." |
|
|
SSDiagnosisDict1 |
Dictionary Code |
"From Client File, data element 31032.1." |
|
|
SSDiagnosisDict2 |
Dictionary Code |
"From Client File, data element 31032.2." |
|
|
SSDiagnosisDict3 |
Dictionary Code |
"From Client File, data element 31032.3." |
|
|
SSDiagnosisDict4 |
Dictionary Code |
"From Client File, data element31032.4." |
|
|
SSDiagnosisDict5 |
Dictionary Code |
"From Client File, data element 31032.5." |
|
|
SSDiagnosisMult1 |
Dictionary Code |
"From Client File, data element 31033.1." |
|
|
SSDiagnosisMult2 |
Dictionary Code |
"From Client File, data element 31033.2." |
|
|
SSDiagnosisMult3 |
Dictionary Code |
"From Client File, data element 31033.3." |
|
|
SSDiagnosisMult4 |
Dictionary Code |
"From Client File, data element 31033.4." |
|
|
SSDiagnosisMult5 |
Dictionary Code |
"From Client File, data element 31033.5." |
|
|
SSDiagnosisDate1 |
Date |
|
|
|
SSDiagnosisDate2 |
Date |
|
|
|
SSDiagnosisDate3 |
Date |
|
|
|
SSDiagnosisDate4 |
Date |
|
|
|
SSDiagnosisDate5 |
Date |
|
|
|
SSDiagnosisTime1 |
Time |
|
|
|
SSDiagnosisTime2 |
Time |
|
|
|
SSDiagnosisTime3 |
Time |
|
|
|
SSDiagnosisTime4 |
Time |
|
|
|
SSDiagnosisTime5 |
Time |
|
|
|
DiagnosisEntries |
WEBSVC.ListOfDiagnosisEntryObjects |
This property of DiagnosisObject is itself an Object -- see below for its properties |
Object class: WEBSVC.ListOfDiagnosisEntryObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
ListOfDiagnosisEntryObjects |
ELEMENTTYPE |
WEBSVC.DiagnosisEntryObject |
This property of DiagnosisEntryObject is itself an Object -- see below for its properties |
Object class: WEBSVC.DiagnosisEntryObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
DiagnosisEntryObject |
Classification |
Dictionary Code |
"From Client File, data element 1805." |
|
|
DateResolved |
Date |
|
|
|
DiagnosingClinician |
Avatar Practitioner ID |
|
|
|
DiagnosisStatus |
Dictionary Code |
"From Client File, data element 2243." |
|
|
OnsetDate |
Date |
|
|
|
OnsetTime |
Time |
|
|
|
PrimCareDiagOngoing |
Free Text |
|
|
|
PrimCareDiagRank |
Dictionary Code |
"From Client File, data element 2245." |
|
|
PrimCareDiagSeverity |
Dictionary Code |
"From Client File, data element 2244." |
|
|
PrimCareDiagStatus |
Dictionary Code |
"From Client File, data element 2243." |
|
|
PrimCareDiagTerminated |
Free Text |
|
|
|
PrimCareDiagType |
Dictionary Code |
"From Client File, data element 2246." |
|
|
PresentOnAdmissionInd |
Dictionary Code |
"From Client File, data element 1804." |
|
|
Ranking |
Dictionary Code |
"From Client File, data element 1801." |
|
|
Remarks |
Free Text |
|
|
|
BillingOrder |
Free Text |
|
|
|
ICD9Code |
ICD-9 Code |
|
|
|
ICD10Code |
ICD-10 Code |
|
|
|
DSM4Code |
DSM-IV Code |
|
|
|
DSM5Code |
DSM-V Code |
|
|
|
SNOMEDCode |
SNOMED Code |
|
| DiagnosisCodeObject | This property of DiagnosisEntryObject is itself an Object -- see below for its properties. |
Object class: WEBSVC.DiagnosisCodeObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
|
DiagnosisCodeObject |
ICD9Code |
ICD-9 Code |
|
| ICD9Description | Free Text | ||
| ICD10Code | ICD-10 Code | ||
| ICD10Description | Free Text | ||
| DSMIVCode | DSM-IV Code | ||
| DSMIVDescription | Free Text | ||
| DSM5Code | DSM-V Code | ||
| DSM5Description | Free Text | ||
| SNOMEDCode | SNOMED Code | ||
| SNOMEDDescription | Free Text | ||
| IMOCode | IMO Code | ||
| LastUpdateDate | Date | ||
| DiagnosisDescription | Free Text | ||
| Status | Free Text | ||
| Mesg | Free Text |