Skip to main content

ClinicianServicesV2 - Cal-PM web service

Avatar Cal-PM WEBSVC.ClinicianServicesV2 web service

This web service has the following calls:

  • putClinicianAssociation - Add a new Performing Provider to Contracting Provider's Registration in the Contracting Provider Registration form.
  • putClinicianCreation - Create a new Practitioner via PractitionerEnrollment form as well as a new MSO Performing Provider via the Performing Provider Registration form.
  • putClinicianDisassociation - Remove Clinician ID from Contracting Provider's Registration in Contracting Provider Registration form.
  • putClinicianTermination - File termination of a practitioner in Practitioner Termination form as well as add an End Date to MSO Performing Provider in Performing Provider Registration form.
  • putClinicianUpdate - Update Cal-PM Practitioner via the Practitioner Enrollment form as well as update the MSO Performing Provider via the Performing Provider Registration 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.

This web service has the following object class:

  • WEBSVC.ClinicianAssociationObject
  • WEBSVC.ClinicianDetailsObject
  • WEBSVC.ClinicianTaxonomyObject
  • WEBSVC.ClinicianPrimaryLicenseObject
  • WEBSVC.PractitionerGuarantorCoverageObject

putClinicianAssociation call

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

Parameters with Properties

Parameter

Property

Value Accepted

Notes

ClinicianAssociation

ClinicianAssociationObject

WEBSVC.ClinicianAssociationObject

This parameter is itself a web service object -- see below for its properties

putClinicianCreation and putClinicianUpdate call

The following tables list the putClinicianCreation parameters, properties, accepted values, and associated dictionaries. Note that putClinicianUpdate has the same properties as putClinicianCreation

Parameters with Properties

Parameter

Property

Value Accepted

Notes

ClinicianDetails

ClinicianDetailsObject

WEBSVC.ClinicianDetailsObject

This parameter is itself a web service object -- see below for its properties

putClinicianDisassociation call

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

Parameters with no Properties

Parameter

Property

Value Accepted

Notes

  ContractingProviderID    
  FundingSourceID Free Text  
  ContractingProviderRegistrationStartDate Date  
  ClinicianID Free Text Avatar Staff ID
  ClinicianNPI Free Text NPI Number
  ClinicianRegistrationStartDate Date Registration Date
  AssociationEffectiveStartDate Date  

putClinicianTermination call

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

Parameters with no Properties

Parameter

Property

Value Accepted

Notes

  ClinicianID Free Text Avatar Staff ID
  ClinicianNPI Free Text NPI 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

PractitionerID

N/A

Numeric Practitioner 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

UpdatePractitionerGuarantorCoverage call

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

Parameters with no Properties

Parameter

Property

Value Accepted

Notes

PractitionerID

N/A

Numeric Practitioner ID

 

PractitionerGuarantorCoverageID

N/A

row ID of Guarantor Coverage entry in SYSTEM.staff_guarantor_coverage

 

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

PractitionerID

N/A

Numeric Practitioner ID

 

PractitionerGuarantorCoverageID

N/A

row ID of Guarantor Coverage entry in SYSTEM.staff_guarantor_coverage

 

Object class: WEBSVC.ClinicianAssociationObject

Parameter

Property

Value Accepted

Notes

ClinicianAssociationObject ContractingProviderID Free Text  
  FundingSourceID Free Text  
  ContractingProviderRegistrationStartDate Date  
  ClinicianID Free Text Avatar Staff ID
  ClinicianNPI Free Text NPI Number
  ClinicianRegistrationStartDate Date  
  AssociationEffectiveStartDate Date  
  AssociationEffectiveEndDate Date  
  ClinicianTaxonomyData WEBSVC.ClinicianTaxonomyObject This parameter is itself a web service object -- see below for its properties
  DoesClinicianAcceptReferrals Free Text: "Y" or "N" MSO Dictionary 621 in Provider File
  ClinicianEmailAddress Free Text  
  ProgramNPI Free Text List of repeating nodes
  MappingPage Free Text Valid values: "1","2","3" or "4"
  UseLessDetailedMapping Free Text MSO Dictionary 13090 in Other Tabled File

Object class: WEBSVC.ClinicianTaxonomyObject

Parameter

Property

Value Accepted

Notes

ClinicianTaxonomyObject CategoryTaxonomyEffectiveDate Date  
  CategoryTaxonomyExpirationDate Date  
  ClinicianPractitionerCategory Free Text PM Dictionary 79 in Staff File
  ClinicianDiscipline Free Text PM Dictionary 75 in Staff File
  ClinicianPractitionerCategoriesOfCoverage Free Text PM Dictionary 70 in Staff File
  ClinicianTaxonomyCode Free Text PM Dictionary 9610 in Staff File

Object class: WEBSVC.ClinicianDetailsObject

Parameter

Property

Value Accepted

Notes

ClinicianDetailsObject ClinicianID Free Text Avatar Staff ID
  ClinicianNPI Free Text NPI Number
  ClinicianFirstName Free Text  
  ClinicianLastName Free Text  
  ClinicianRegistrationStartDate Date Registration Date
  ClinicianTaxonomyData ClinicianTaxonomyObject This parameter is itself a web service object -- see ClinicianTaxonomyObject section for its properties
  ClinicianOfficeAddressStreet1 Free Text Office Address - Street
  ClinicianOfficeAddressZip Zip Code Office Address - Zip Code
  ClinicianOfficeAddressCity Free Text Office Address - City
  ClinicianOfficeAddressState Free Text Two letter code for Office Address - State
  ClinicianOfficePhoneNumber1 Phone Number Office Telephone (1)
  ClinicianOfficePhoneNumber2 Phone Number Office Telephone (2)
  ClinicianEmailAddress Free Text  
  ClinicianHomeAddressStreet1 Free Text Home - Street
  ClinicianHomeAddressZip Zip Code Home - Zip Code
  ClinicianHomeAddressCity Free Text Home - City
  ClinicianHomeAddressState Free Text Two letter code for Home - State
  ClinicianHomePhoneNumber Phone Number Home Telephone
  ClinicianCellularPhoneNumber Phone Number Cellular Telephone
  ClinicianLanguages Free Text Practitioner Language
  ClinicianEthnicity Free Text Ethnic Origin
  ClinicianGender Free Text Sex
  ClinicianProgramAssociation Free Text Program Association
  ClinicianPrimaryLicenses ClinicianPrimaryLicenseObject This parameter is itself a web service object -- see ClinicianPrimaryLicenseObject section for its properties
  DEALicenseNumber Free Text  
  DEAExpirationDate Date  
  TreatmentAgeGroupSpecialities Free Text  
  HospitalPrivileges Free Text  
  PerformingProviderAgeGroup Free Text  
  SpecialAccomodations Free Text  
  Specialities Free Text  
  SSClinicianFreeText201 Free Text SS Clinician Free Text (20) 1
  SSClinicianDate1 Date SS Clinician Date 1
  SSClinicianDate2 Date SS Clinician Date 2

Object class: WEBSVC.ClinicianPrimaryLicenseObject

Parameter

Property

Value Accepted

Notes

ClinicianPrimaryLicenseObject ClinicianPrimaryLicTypeCode Free Text  
  ClinicianPrimaryLicStateCode Free Text  
  ClinicianPrimaryLicRegCertNumber Free Text  
  ClinicianPrimaryLicRegCertEffectiveDate Date  
  ClinicianPrimaryLicRegCertExpirationDate Date  
  ClinicianPrimaryLicDataVerifiedCode Free Text  

Object class: WEBSVC.PractitionerGuarantorCoverageObject

Parameter

Property

Value Accepted

Notes

PractitionerGuarantorCoverageObject Guarantor   Avatar Guarantor code
  EffectiveDate Date Effective Date
  LapseDate Date Lapse Date