PHPData - CWS web service
Avatar CWS Patient Health Profile web service.
This functionality enables importing data into tables for filing via the myAvatar 'Patient Health Profile' form. The 'Patient Health Profile' form contains patient Problems, Client-reported Medications, Open Care Gaps, Inpatient Stays, Physician Consultations, and Lab Data. Of these six data types, only Medications and Problems may be directly edited via the 'Patient Health Profile' form. This form will show data imported via this web service.
This web service request has the following operations:
- AddPHPData
This web service has the following object classes:
- WEBSVC.PHPDataObject
- WEBSVC.ListOfPHPProblemDataObjects
- WEBSVC.ListOfPHPOpenCareGapsObjects
- WEBSVC.ListOfPHPInpatientStaysObjects
- WEBSVC.ListOfPHPPhysicianConsultObjects
- WEBSVC.ListOfPHPMedicationsObjects
- WEBSVC.ListOfPHPLabDataObjects
- WEBSVC.PHPProblemDataObject
- WEBSVC.PHPOpenCareGapsObject
- WEBSVC.PHPInpatientStaysObject
- WEBSVC.PHPPhysicianConsultObject
- WEBSVC.PHPMedicationsObject
- WEBSVC.PHPLabDataObject
AddPHPData Call
Creates and adds data to a new 'Patient Health Profile' form template. When creating a new entry via the 'Patient Health Profile' myAvatar form, data will populated from the data filed via the 'AddPHPData' call. If a subsequent 'AddPHPData' call is made, a new template will be created that will replace the previous template when creating a new 'Patient Health Profile' assessment. When editing existing 'Patient Health Profile' assessments, the latest web service template will not be displayed. When editing existing 'Patient Health Profile' assessments, the template originally used to create the assessment will pull forward. Medications may only be filed if the prerequisite myAvatar Order Entry module, as well as the appropriate myAvatar Order Entry prerequisite updates, are installed.
If data validation fails, no data will be filed. Data validation can fail for a number of reasons. Reasons for validation failure may include missing required fields, providing an invalid 'NDC' for a Medication, etc.. When validation fails, the response will contain errors. These errors will detail the nature of the error and the web service object(s) which caused the error(s). If validation succeeds, the response will indicate a successful filing.
The following tables list the AddPHPData 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 |
Parameters with Properties
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPData | WEBSVC.PHPDataObject | WEBSVC.PHPDataObject | This parameter is itself a web service object -- see below for its properties |
Object class: PHPDataObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPProblems | WEBSVC.ListOfPHPProblemDataObjects | WEBSVC.ListOfPHPProblemDataObjects | This parameter is itself a web service object -- see below for its properties |
| PHPOpenCareGaps | WEBSVC.ListOfPHPOpenCareGapsObjects | WEBSVC.ListOfPHPOpenCareGapsObjects | This parameter is itself a web service object -- see below for its properties |
| PHPInpatientStays | WEBSVC.ListOfPHPInpatientStaysObjects | WEBSVC.ListOfPHPInpatientStaysObjects | This parameter is itself a web service object -- see below for its properties |
| PHPPhysicianConsults | WEBSVC.ListOfPHPPhysicianConsultObjects | WEBSVC.ListOfPHPPhysicianConsultObjects | This parameter is itself a web service object -- see below for its properties |
| PHPMedications | WEBSVC.ListOfPHPMedicationsObjects | WEBSVC.ListOfPHPMedicationsObjects | This parameter is itself a web service object -- see below for its properties |
| PHPLabData | WEBSVC.ListOfPHPLabDataObjects | WEBSVC.ListOfPHPLabDataObjects | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPProblemDataObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPProblemDataObjects | N/A | List of WEBSVC.PHPProblemDataObject | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPOpenCareGapsObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPOpenCareGapsObjects | N/A | List of WEBSVC.PHPOpenCareGapsObject | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPInpatientStaysObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPInpatientStaysObjects | N/A | List of WEBSVC.PHPInpatientStaysObject | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPPhysicianConsultObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPPhysicianConsultObjects | N/A | List of WEBSVC.PHPPhysicianConsultObject | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPMedicationsObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPMedicationsObjects | N/A | List of WEBSVC.PHPMedicationsObject | This parameter is itself a web service object -- see below for its properties |
Object class: ListOfPHPLabDataObjects
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| ListOfPHPLabDataObjects | N/A | List of WEBSVC.PHPLabDataObject | This parameter is itself a web service object -- see below for its properties |
Object class: PHPProblemDataObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPProblemDataObject | Type | Dictionary Code | From CWS File, data element 2526 |
| ProblemDate | Date | ||
| Status | Free Text | ||
| Description | Free Text |
Object class: PHPOpenCareGapsObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPOpenCareGapsObject | EventDate | Date | |
| Measure | Free Text | ||
| MeasureDescription | Free Text |
Object class: PHPInpatientStaysObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPInpatientStaysObject | Type | Free Text | |
| DateOfStay | Date | ||
| Facility | Free Text | ||
| LengthOfStay | Free Text | ||
| AdmitCondition | Free Text |
Object class: PHPPhysicianConsultObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPInpatientStaysObject | ConsultDate | Date | |
| Location | Free Text | ||
| ProviderName | Free Text | ||
| PrimaryCondition | Free Text |
Object class: PHPMedicationsObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPInpatientStaysObject | EntryDate | Date | |
| Provider | Free Text | ||
| NDC | Active NDC in either nine or ten-digit formats with or without dashes |
Object class: PHPLabDataObject
| Parameter | Property | Value Accepted | Notes |
|---|---|---|---|
| PHPLabDataObject | LabDate | Date | |
| LabDescription | Free Text | ||
| LabResults | Free Text |