ProgramMaintenance - PM web service
- Last updated
-
-
Save as PDF
Avatar PM WEBSVC.ProgramMaintenance web service
This web service has the following calls:
- AddProgramMaintenance - Add a new Program code to myAvatar
- GetDictionaryItems - Get all the dictionary fields that are used in this web service
- UpdateProgramMaintenance - Update an existing myAvatar Program code's details
AddProgramMaintenance
The following tables list the AddProgramMaintenance 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 |
|
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| ProgramMaintenanceInfo |
ProgramMaintenanceObject |
WEBSVC.ProgramMaintenanceObject |
This parameter is itself a web service object -- see below for its properties |
GetDictionaryItems
The following tables list 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 |
|
UpdateProgramMaintenance
The following tables list the UpdateProgramMaintenance 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 |
|
Parameters with properties
| Parameter |
Property |
Value Accepted |
Notes |
| ProgramMaintenanceInfo |
ProgramMaintenanceObject |
WEBSVC.ProgramMaintenanceObject |
This parameter is itself a web service object -- see below for its properties |
Object class name: WEBSVC.ProgramMaintenanceObject
| Parameter |
Property |
Value Accepted |
Notes |
| ProgramMaintenanceObject |
Active |
Dictionary |
"Y" or "N". Other Tabled Files dictionary item 1504 |
| |
AdmissionChargeCode |
Service Code |
Admission Charge Code. Valid values can be found in SYSTEM.billing_tx_master_fee_table |
| |
AllowChargeEntry |
Dictionary |
Allow Charge Entry. "Y" or "N". Other Tabled Files dictionary Item 1536 |
| |
AllowTranFollowPgm |
Free Text |
Allow Transfer Only To The Following Programs. |
| |
AssociatedServicePrograms |
Program Codes |
Associated Service Programs. "&" delimited list of program codes. Program codes can be found in SYSTEM.table_program_definition.program_code |
| |
DailyChargeCode |
Service Code |
Daily Charge Code. |
| |
DailyChargeCode2 |
Service Code |
Daily Charge Code 2. |
| |
DailyChargeCode3 |
Service Code |
Daily Charge Code 3. |
| |
DailyChargeCode4 |
Service Code |
Daily Charge Code 4. |
| |
DailyChargeCode5 |
Service Code |
Daily Charge Code 5. |
| |
DefaultAllowSvcClientTP |
Free Text |
Default Allowable Services in the Client Treatment Plan. |
| |
DefNumDaysExpDischarge |
Free Text |
Default Number Of Days For Expected Discharge. |
| |
Description |
Free Text |
Description. |
| |
DispActiveEpiEpiLookup |
Dictionary |
Display Only Active Episodes In Episode Lookup. "Y" or "N". Tabled Files dictionary item 1537 |
| |
EmerRoomPgmUsedARRACQMRpt |
Free Text |
Emergency Room Program (Used for ARRA CQM Reports). |
| |
EnbSvcEntryRestrictPgm |
Free Text |
Enable Service Entry Restriction for Program. |
| |
EncounterCPTCode |
Free Text |
Encounter CPT Code |
| |
EncounterSNOMEDCodeMUHosp |
Free Text |
Encounter SNOMED Code (MU Hospital) |
| |
SSExtDictDataElement |
WEBSVC.ExtDictDataElements |
This parameter is itself a web service object -- see below for its properties |
| |
FacilityIdCode |
Free Text. |
Facility Identification Code |
| |
FacilityIdCodeQual |
Dictionary |
Facility Identification Code Qualifier. Tabled Files dictionary item 1650 |
| |
FacilityRefId |
Free Text |
Facility Reference Identification |
| |
FacilityRefIdQual |
Dictionary |
Facility Reference Identification Qualifier. Tabled Files dictionary item 1652 |
| |
Fillgapsvcentrecdursvc |
Free Text |
Fill gaps in service entry record for duration of service? |
| |
HCOId |
Free Text |
HCO Id. |
| |
PgmAssociatedExtAmbProv |
Free Text |
Is This Program Associated With An External Ambulatory Provider? |
| |
LACountyProgram |
Free Text |
LA County Program |
| |
LimitOpenActEpiToOne |
Free Text |
Limit Open Active Episodes To One |
| |
Location |
Dictionary |
Location. Client File dictionary item 1509 |
| |
OtherPgmGrouperId |
Free Text |
Other Program Grouper/Identifier |
| |
PrimarilyMedicalProgram |
Dictionary |
Primarily Medical Program. Client File dictionary item 1518 |
| |
PrimaryCareProgram |
Free Text |
Primary Care Program |
| |
Program |
Free Text |
Program. |
| |
ProgramAddressCity |
Free Text |
Program Address - City |
| |
ProgramAddressState |
|
Program Address - State |
| |
ProgramAddressStreet |
Free Text |
Program Address - Street |
| |
ProgramAddressZipcode |
Zip Code |
Program Address - Zipcode |
| |
ProgramCode |
Free Text |
Program Code. program_code |
| |
ProgramFaxNumber |
Free Text |
Program Fax Number |
| |
ProgramPhoneNumber |
Phone Number |
Program Phone Number |
| |
ProgramTaxId |
Free Text |
Program Tax Id |
| |
ProgramTaxonomyCode |
Free Text |
Program Taxonomy Code |
| |
ProgramType |
Dictionary |
Program Type. Client File dictionary item 1508 |
| |
RRG |
Dictionary |
RRG. Client File dictionary item 1507 |
| |
ReqAdmitPract |
Dictonary |
Require Admitting Practitioner. "Y" or "N". Tabled File dictionary item 1660 |
| |
RoomandBoardBillingCode |
Free Text |
Room and Board Billing Code |
| |
SelPgmAllMultInpAdmLeave |
Free Text |
Select Programs To Allow Multiple Inpatient Admissions During Leave |
| |
SvcCodefillgaps |
Free Text |
Service Code to use to fill gaps |
| |
SvcPractusefillgaps |
Free Text |
Service Practitioner to use to fill gaps |
| |
Services |
Free Text |
Services. |
| |
UsrRcvWrnErCltSvcAftDchDt |
Dictionary |
Should A User Receive A Warning Or An Error If A Client Has A Service Occuring After Discharge Date? Tabled Files dictionary item 1560 |
| |
TreatmentService |
Dictionary |
Treatment Service. Client file dictionary item 101 |
| |
TreatmentSetting |
Dictionary |
Treatment Setting. Client file dictionary item 1505 |
| |
Unit |
Dictionary |
Unit. Client file dictionary item 202 |
| |
Units |
Dictionary |
Units. Client file dictionary item 1601 |
| |
UsageType |
Dictionary |
Usage Type. Client file dictionary item 1576 |
