Skip to main content

PractitionerRegister - PM web service

Avatar WEBSVC.PractitionerRegister web service

This web service has the following calls:

  • EditPractitionerRegister - Edit enrollment information of an existing practitioner as it would be done in 'Practitioner Enrollment' form
  • GetDictionaryItems - lists dictionary codes and values used in 'Practitioner Enrollment' form
  • PractitionerRegister - Record a new practitioner enrollment into myAvatar
  • UpdatePractitionerInformation - Edit existing practitioner's information as done in 'Practitioner Information(Confidential)' form.
  • AddPractitionerGuarantorCoverage - Add Guarantor Coverage Entry to a clinician/practitioner in Practitioner Enrollment form.
  • UpdatePractitionerGuarantorCoverage - Update an existing Guarantor Coverage Entry to a clinician/practitioner in Practitioner Enrollment form.
  • DeletePractitionerGuarantorCoverage - Delete an existing Guarantor Coverage Entry to a clinician/practitioner in Practitioner Enrollment form.

EditPractitionerRegister call

The following tables list the EditPractitionerRegister parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserID N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerID N/A The staff member ID  

Parameters with Properties

Parameter Property Value Accepted Notes

PractitionerRegistration

ARRAPractitionerType

Dictionary field # 220 in Staff File

 

 

ARRAReportableMeasures

Dictionary field # 2300 in Staff File

 

 

BeeperNumber

Phone Number

 

 

CategoriesForCoverage

Dictionary field # 70 in Staff File

Required by Web Service

 

CellPhone

Phone Number

 

 

DateOfBirth

Date

 

 

Discipline

Dictionary field # 75 in Staff File

Required by Web Service

 

EducationLevel

Dictionary field # 76 in Staff File

 

 

EthnicOrigin

Dictionary field # 8 in Client File

 

 

ExcludeFromCalendar

Dictionary field # 102 in Staff File

 

 

HomeCity

Free Text

 

 

HomePhone

Phone Number

 

 

HomeState

State

 

 

HomeStreet

Free Text

 

 

HomeZipCode

Zip Code

 

 

LocatedInMedOfficeBuilding

Dictionary field # 200 in Staff File

 

 

NPINumber

Free Text

 

 

Name

Name

Required by Web Service

 

OfficeAddressCity

Free Text

Required by Web Service

 

OfficeAddressState

State

Required by Web Service

 

OfficeAddressStreet

Free Text

Required by Web Service

 

OfficeAddressZipCode

Zip Code

Required by Web Service

 

OfficeTelephone1

Phone Number

Required by Web Service

 

OfficeTelephone2

Phone Number

 

 

PractitionerCategory

Dictionary field # 79 in Staff File

Required by Web Service

 

PractitionerCredentials

Dictionary field # 214 in Staff File

 

 

PractitionerLanguage

Free Text

 

 

PractitionerSubType

Dictionary field # 83 in Staff File

 

 

PractitionerType

Dictionary field # 82 in Staff File

 

 

RegistrationDate

Date

Required by Web Service

 

Sex

Dictionary field # 18 in Staff File

 

 

TaxonomyCode

Free Text

 

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  
UserName N/A Avatar User ID  
Password N/A Avatar Password  

PractitionerRegister call

The following tables list the PractitionerRegister parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserName N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerID N/A The staff member ID  

Parameters with Properties

Parameter Property Value Accepted Notes

PractitionerRegistration

ARRAPractitionerType

Dictionary field # 220 in Staff File

 

 

ARRAReportableMeasures

Dictionary field # 2300 in Staff File

 

 

BeeperNumber

Phone Number

 

 

CategoriesForCoverage

Dictionary field # 70 in Staff File

Required by Web Service

 

CellPhone

Phone Number

 

 

DateOfBirth

Date

 

 

Discipline

Dictionary field # 75 in Staff File

Required by Web Service

 

EducationLevel

Dictionary field # 76 in Staff File

 

 

EthnicOrigin

Dictionary field # 8 in Client File

 

 

ExcludeFromCalendar

Dictionary field # 102 in Staff File

 

 

HomeCity

Free Text

 

 

HomePhone

Phone Number

 

 

HomeState

State

 

 

HomeStreet

Free Text

 

 

HomeZipCode

Zip Code

 

 

LocatedInMedOfficeBuilding

Dictionary field # 200 in Staff File

 

 

NPINumber

Free Text

 

 

Name

Name

Required by Web Service

 

OfficeAddressCity

Free Text

Required by Web Service

 

OfficeAddressState

State

Required by Web Service

 

OfficeAddressStreet

Free Text

Required by Web Service

 

OfficeAddressZipCode

Zip Code

Required by Web Service

 

OfficeTelephone1

Phone Number

Required by Web Service

 

OfficeTelephone2

Phone Number

 

 

PractitionerCategory

Dictionary field # 79 in Staff File

Required by Web Service

 

PractitionerCredentials

Dictionary field # 214 in Staff File

 

 

PractitionerLanguage

Free Text

 

 

PractitionerSubType

Dictionary field # 83 in Staff File

 

 

PractitionerType

Dictionary field # 82 in Staff File

 

 

RegistrationDate

Date

Required by Web Service

 

Sex

Dictionary field # 18 in Staff File

 

 

TaxonomyCode

Free Text

 

UpdatePractitionerInformation call

The following tables list the UpdatePractitionerInformation parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserName N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerID N/A The staff member ID  

Parameters with Properties

Parameter Property Value Accepted Notes
PractitionerInformation DEAExpirationDate Date  
  DEALicenseNumber Number  
  SocialSecurityNumber Social Security Number  

AddPractitionerGuarantorCoverage call

The following tables list the AddPractitionerGuarantorCoverage parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserID N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerID N/A The staff member ID  

Parameters with Properties

Parameter Property Value Accepted Notes
PractitionerGuarantorCoverage PractitionerGuarantorCoverageObject WEBSVC.PractitionerGuarantorCoverageObject This Parameter is itself a web service object -- see below for its properties.

DeletePractitionerGuarantorCoverage call

The following tables list the DeletePractitionerGuarantorCoverage parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserID N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerGuarantorCoverageID N/A Integer Existing values can be found in ID field of SYSTEM.staff_guarantor_coverage table
PractitionerID N/A The staff member ID  

UpdatePractitionerGuarantorGuarantorCoverage call

The following tables list the UpdatePractitionerGuarantorGuarantorCoverage parameters, properties, accepted values, and associated dictionaries.

Parameters with no Properties

Parameter Property Value Accepted Notes
SystemCode N/A Avatar System Code  
UserID N/A Avatar User ID  
Password N/A Avatar Password  
PractitionerID N/A The staff member ID  

Parameters with Properties

Parameter Property Value Accepted Notes
PractitionerGuarantorCoverage PractitionerGuarantorCoverageObject WEBSVC.PractitionerGuarantorCoverageObject This Parameter is itself a web service object -- see below for its properties.

Object class: WEBSVC.PractitionerGuarantorCoverageObject

Parameter Property Value Accepted Notes
PractitionerGuarantorCoverageObject Guarantor Free Text Avatar Guarantor ID
  EffectiveDate Date  
  LapseDate Date