Skip to main content

AppointmentSchedulingV2 - PM web service

  1. Last updated
  2. Save as PDF

Avatar PM WEBSVC.AppointmentScheduling web service

This web service has the following calls:

  • AddAppointment - Create a new appointment
  • DeleteAppointment - Delete an existing appointment
  • GetAppointments - Get details of an existing appointment
  • GetDictionaryItems - Get dictionary codes and values of dictionary fields used in this web service
  • UpdateAppointment - Update Details of an existing appointment

This web service has the following object classes:

  • WEBSVC.AppointmentSchedulingObject
  • WEBSVC.GetAppointmentsObject
  • WEBSVC.AppointmentDiagnosisObject

​AddAppointment call

The following tables list the AddAppointment 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  
StaffID N/A Avatar Staff ID  
LoginSource N/A    
Parameters with Properties
Parameter Property Value Accepted Notes
AppointmentSchedulingInfo AppointmentSchedulingObject WEBSVC.AppointmentSchedulingObject This parameter is itself a web service object -- see below for its properties

DeleteAppointment Call

The following table lists the DeleteAppointment 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  
AppointmentSchedulingUniqueID N/A Appointment ID number A unique identifier for an appointment.
LoginSource N/A    

GetAppointments call

The following tables list the GetAppointments 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  
Parameters with Properties
Parameter Property Value accepted Notes
GetAppointmentsInfo GetAppointmentsObject WEBSVC.GetAppointmentsObject 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.

UpdateAppointment call

The following table lists the UpdateAppointment 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  
StaffID N/A Avatar Staff ID  
AppointmentSchedulingUniqueID N/A Appointment ID Number A unique identifier for an appointment.
LoginSource N/A    
Parameters with Properties
Parameter Property Value Accepted Notes
AppointmentSchedulingInfo AppointmentSchedulingObject WEBSVC.AppointmentSchedulingObject This parameter is itself a web service object -- see below for its properties

Object class name:WEBSVC.AppointmentSchedulingObject

Property Value Accepted Notes
ApptDate Date  
ApptEndTime Time  
ApptNotes Text  
ApptReqFollowUp Dictionary Code "From Appointment Client File, data element 10250."
ApptStartTime Free Text  
ApptStatus Dictionary Code "From Client File, data element 10005."
ClientID Avatar Client ID  
ClientToPayAtFront Dictionary Code "From Appointment Client File, data element 10068."
ConfirmationNotes Text  
Confirmed Dictionary Code "From Appointment Client File, data element 10104."
CoStaffMember Avatar Staff ID  
Episode Episode Number  
EvidBasedPractsCSI Dictionary Code "From Appointment Client File, data element 70680."
FollowUpApptDueDate Date  
FollowUpApptFor Free Text  
FollowUpStatus Dictionary Code "From Appointment Client Files, data element 10253."
Group Free Text  
Location Dictionary Code "From Client Files, data element 10006."
MedicalDiag1 Diagnosis Code  
MedicalDiag2 Diagnosis Code  
MedicalDiag3 Diagnosis Code  
MedicalDiag4 Diagnosis Code  
MissedVisit Dictionary Code "From Appointment Client Files, data element 10101."
DiagnosisObj1 WEBSVC.AppointmentDiagnosisObject This property of the AppointmentSchedulingObject is itself an object -- see below for its properties.
DiagnosisObj2 WEBSVC.AppointmentDiagnosisObject This property of the AppointmentSchedulingObject is itself an object -- see below for its properties.
DiagnosisObj3 WEBSVC.AppointmentDiagnosisObject This property of the AppointmentSchedulingObject is itself an object -- see below for its properties.
DiagnosisObj4 WEBSVC.AppointmentDiagnosisObject This property of the AppointmentSchedulingObject is itself an object -- see below for its properties.
MissedVisitNotes Text  
MissedVisitSvcCode Free Text  
Modifiers One or more modifiers "In the format: M1,M2,M3,M4."
NumberOfClients Free Text  
Program Avatar Program Code  
ReasonForFollowUp Text  
ReasonForVisit Text  
RefPractitioner Avatar Staff ID  
RefProvider Free Text  
SecondCoStaffMember Avatar Staff ID  
ServiceCode Avatar Service Code  
Site Avatar Site Code  
SSApptSchedDate1 Date "A non-standard, site-specific field."
SSApptSchedDate2 Date "A non-standard, site-specific field."
SSApptSchedDate3 Date "A non-standard, site-specific field."
SSApptSchedDate4 Date "A non-standard, site-specific field."
SSApptSchedDate5 Date "A non-standard, site-specific field."
SSApptSchedDict1 Dictionary Code "From Appointment Client Files, data element 80007.1. A non-standard, site-specific field."
SSApptSchedDict2 Dictionary Code "From Appointment Client Files, data element 80007.2. A non-standard, site-specific field."
SSApptSchedDict3 Dictionary Code "From Appointment Client Files, data element 80007.3. A non-standard, site-specific field."
SSApptSchedDict4 Dictionary Code "From Appointment Client Files, data element 80007.4. A non-standard, site-specific field."
SSApptSchedDict5 Dictionary Code "From Appointment Client Files, data element 80007.5. A non-standard, site-specific field."
SSApptSchedFreeText101 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText102 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText103 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText104 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText105 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText201 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText202 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText203 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText204 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText205 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText401 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText402 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText403 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText404 Free Text "A non-standard, site-specific field."
SSApptSchedFreeText405 Free Text "A non-standard, site-specific field."
SSApptSchedInteger1 Number "A non-standard, site-specific field."
SSApptSchedInteger2 Number "A non-standard, site-specific field."
SSApptSchedInteger3 Number "A non-standard, site-specific field."
SSApptSchedInteger4 Number "A non-standard, site-specific field."
SSApptSchedInteger5 Number "A non-standard, site-specific field."
SSApptSchedInteger6 Number "A non-standard, site-specific field."
SSApptSchedMultSelDict1 Dictionary Code "From Appointment Client Files, data element 80008.1. A non-standard, site-specific field. "
SSApptSchedMultSelDict2 Dictionary Code "From Appointment Client Files, data element 80008.2. A non-standard, site-specific field."
SSApptSchedMultSelDict3 Dictionary Code "From Appointment Client Files, data element 80008.3. A non-standard, site-specific field."
SSApptSchedMultSelDict4 Dictionary Code "From Appointment Client Files, data element 80008.4. A non-standard, site-specific field."
SSApptSchedMultSelDict5 Dictionary Code "From Appointment Client Files, data element 80008.5. A non-standard, site-specific field."
SSApptSchedPracLookup1 Staff ID "A non-standard, site-specific field."
SSApptSchedPracLookup2 Staff ID "A non-standard, site-specific field."
SSApptSchedPracLookup3 Staff ID "A non-standard, site-specific field."
SSApptSchedPracLookup4 Staff ID "A non-standard, site-specific field."
SSApptSchedPracLookup5 Staff ID "A non-standard, site-specific field."
SSApptSchedScrFreeText1 Free Text "A non-standard, site-specific field."
SSApptSchedScrFreeText2 Free Text "A non-standard, site-specific field."
SSApptSchedScrFreeText3 Free Text "A non-standard, site-specific field."
SSApptSchedScrFreeText4 Free Text "A non-standard, site-specific field."
SSApptSchedScrFreeText5 Free Text "A non-standard, site-specific field."
SSApptSchedTime1 Time "A non-standard, site-specific field."
SSApptSchedTime2 Time "A non-standard, site-specific field."
SSApptSchedTime3 Time "A non-standard, site-specific field."
SSApptSchedTime4 Time "A non-standard, site-specific field."
SSApptSchedTime5 Time "A non-standard, site-specific field."
AdditionalServiceInformation Free Text "A non-standard, site-specific field."
PsychotherapyAddOnDuration Number "A non-standard, site-specific field."

Object class name: WEBSVC.GetAppointmentsObject

Property Value Accepted Notes
UniqueID Free Text "Unique ID of an appointment row."
ApptBeginDate Date  
ApptEndDate Date  
Posted Dictionary Code "From Appointment Staff Files, data element 70000."
Site Avatar Site ID  
Staff Avatar Staff ID  
Verified Dictionary Code "From Appointment Client Files, data element 70002."
PATID Free Text The Client ID
IncludeClientDetail Free Text Enter '1' to include client details. Enter '0' if client details are to be excluded in results
DataEntryTime Free Text Date and time after which the appointments were entered. Must be in this format: '[YY]YY-MM-DD [hh:mm:ss] [am | pm]'. Eg: '16-01-01 12:30 pm' will limit results to appointments entered after that date and time.

Object class name: WEBSVC.AppointmentDiagnosisObject

Property Value Accepted
ICD9Code ICD-9 Code
ICD10Code ICD-10 Code
DSMIVCode DSM-IV Code
DSM5Code DSM-5 Code
SNOMEDCode SNOMED Code
IMOCode IMO Code
DiagnosisDescription Free Text
Status Free Text
Mesg Free Text

 

  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Page type
    Reference
  2. Tags
    1. av:pm
    2. myAvatar Web Services
    3. role:systemadmin
    4. search:ready