Skip to main content

ClientChargeInput - PM web service

Avatar PM WEBSVC.ClientChargeInput web service

This web service has the following calls:

This web service has the following object class:​

​FileClientChargeInput call

The following tables list the FileClientChargeInput 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

ClientChargeInputObject

WEBSVC.ClientChargeInputObject  

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

FileClientChargeInputICD10 call

The following tables list the FileClientChargeInputICD10 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

ClientChargeInputObject

WEBSVC.ClientChargeInputObject2  

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

DeleteClientChargeInput call

The following table lists the DeleteClientChargeInput 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  
JOINTOTXHISTORY N/A Avatar service identifier Identifies the specific service to be deleted.
ReversalCode N/A Reversal code dictionary code  

 

GetReversalCodes

The following table lists the GetReversalCodes 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  

 

Object class name: WEBSVC.ClientChargeInputObject

Parameter

Property

Value Accepted

Notes

ClientChargeInputObject

AppointmentConfirmed

Dictionary Code

"From Client File, data element 10104. Must be 'Y' or 'N'."

 

AppointmentDate

Date

 

 

AppointmentEndTime

Time

 

 

AppointmentNotes

Text

 

 

AppointmentSite

Avatar Site ID

 

 

AppointmentStartTime

Time

 

 

AppointmentStatus

Dictionary Code

"From Client File, data element 10005."

 

Billable

Dictionary Code

"From Client File, data element 10009. Must be 'Y' or 'N'."

 

ClientID

Avatar Client ID

 

 

CoPractitioner

Avatar Staff ID

 

 

ConfirmationNotes

Text

 

 

CostOfService

Amount

 

 

DateOfService

Date

 

 

Duration

Number

 

 

EpisodeNumber

Episode Number

 

 

GroupNumber

Avatar Group Number

 

 

Location

Dictionary Code

"From Client File, data element 10006."

 

MedicalDiagnosis1

ICD-9 Code

 

 

MedicalDiagnosis2

ICD-9 Code

 

 

MissedVisit

Dictionary Code

"From Client File, data element 10101. Must be 'Y' or 'N'."

 

MissedVisitNotes

Text

 

 

MissedVisitServiceCode

Avatar Service Code

 

 

Modifiers

One or more modifiers

In the format: M1-M2-M3-M4

 

NoteReferenceCode837Billing

Dictionary Code

"From Client File, data element 8201."

 

NoteReferenceText837Billing

Free Text

 

 

NumberOfClients

Number

 

 

OralCavityDesignationCode

Dictionary Code

"From Client File, data element 10803."

 

Practitioner

Avatar Staff ID

 

 

PriorPlacementDate

Date

 

 

Program

Avatar Program Code

 

 

ProsthesisCrownOrInlayCode

Dictionary Code

"From Client File, data element 10804."

 

ReferringPractitioner

Avatar Staff ID

 

 

ReferringProvider

Avatar Referring Provider ID

 

 

SSTxMultipleSelectDictionary1

Free Text

"From Client File, data element 21050.1. A non-standard, site-specific field."

 

SSTreatmentDSMCode1

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode2

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode3

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode4

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode5

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDate1

Date

"A non-standard, site-specific field."

 

SSTreatmentDate2

Date

"A non-standard, site-specific field."

 

SSTreatmentDate3

Date

"A non-standard, site-specific field."

 

SSTreatmentDate4

Date

"A non-standard, site-specific field."

 

SSTreatmentDate5

Date

"A non-standard, site-specific field."

 

SSTreatmentDictionary1

Dictionary Code

"From Client File, data element 21023.1. A non-standard, site-specific field."

 

SSTreatmentDictionary2

Dictionary Code

"From Client File, data element 21023.2. A non-standard, site-specific field."

 

SSTreatmentDictionary3

Dictionary Code

"From Client File, data element 21023.3. A non-standard, site-specific field."

 

SSTreatmentDictionary4

Dictionary Code

"From Client File, data element 21023.4. A non-standard, site-specific field."

 

SSTreatmentDictionary5

Dictionary Code

"From Client File, data element 21023.5. A non-standard, site-specific field."

 

SSTreatmentDictionary6

Dictionary Code

"From Client File, data element 21023.6. A non-standard, site-specific field."

 

SSTreatmentDictionary7

Dictionary Code

"From Client File, data element 21023.7. A non-standard, site-specific field."

 

SSTreatmentDictionary8

Dictionary Code

"From Client File, data element 21023.8. A non-standard, site-specific field."

 

SSTreatmentDictionary9

Dictionary Code

"From Client File, data element 21023.9. A non-standard, site-specific field."

 

SSTreatmentFreeText101

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText102

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText103

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText104

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText105

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText401

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText402

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText403

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText404

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText405

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText801

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText802

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText803

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText804

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText805

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentGuarantor1

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor2

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor3

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor4

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor5

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentICD9Code1

IDC-9 Code

"A non-standard, site-specific field."

 

SSTreatmentICD9Code2

IDC-9 Code

"A non-standard, site-specific field."

 

SSTreatmentICD9Code3

IDC-9 Code

"A non-standard, site-specific field."

 

SSTreatmentICD9Code4

IDC-9 Code

"A non-standard, site-specific field."

 

SSTreatmentICD9Code5

IDC-9 Code

"A non-standard, site-specific field."

 

SSTreatmentPractitioner1

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner2

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner3

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner4

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner5

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText1

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText2

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText3

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText4

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText5

Free Text

"A non-standard, site-specific field."

 

SSTxMultipleSelectDictionary2

Dictionary Code

"From Client File, data element 21050.2. A non-standard, site-specific field."

 

SecondCoStaffMember

Avatar Staff ID

 

 

ServiceCode

Avatar Service Code

 

 

ServiceEndTime

Time

 

 

ServiceStartTime

Time

 

 

ToothNumber

Free Text

 

 

ToothStatusCode

Dictionary Code

"From Client File, data element 10801."

 

ToothSurfaceCode

Dictionary Code

"From Client File, data element 10802."

 

UnitsOfService

Number

 

 

MedicalDiagnosis3

ICD-9 Code

 

 

MedicalDiagnosis4

ICD-9 Code

 

 

Discipline

Free Text

 

 

ServiceStatus

Avatar Service Status

 

 

InitialTxDate2300DTP03

Date

 

 

DateOfAccident2300DTP03

Date

 

 

FormLoc10AutoAccidentPlace

State

The location the accident occurred in.

 

RelatedCausesInfo2300CLM11

Dictionary Code

"From Client File, data element 1503."

 

FirstBillingDate

Date

 

 

SSTreatmentInteger1

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger2

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger3

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger4

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger5

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger6

Number

"A non-standard, site-specific field."

 

AdditionalServiceInformation

Dictionary Code

"From Client File, data element 1105."

 

PsychotherapyAddOnDuration

Number

 

 

AddOnNotes

Free Text

 

Object class name: WEBSVC.ClientChargeInputObject2

Parameter

Property

Value Accepted

Notes

ClientChargeInputObject2

AppointmentConfirmed

Dictionary Code

"From Client File, data element 10104. Must be 'Y' or 'N'."

 

AppointmentDate

Date

 

 

AppointmentEndTime

Time

 

 

AppointmentNotes

Text

 

 

AppointmentSite

Avatar Site ID

 

 

AppointmentStartTime

Time

 

 

AppointmentStatus

Dictionary Code

"From Client File, data element 10005."

 

Billable

Dictionary Code

"From Client File, data element 10009. Must be 'Y' or 'N'."

 

ClientID

Avatar Client ID

 

 

CoPractitioner

Avatar Staff ID

 

 

ConfirmationNotes

Text

 

 

CostOfService

Amount

 

 

DateOfService

Date

 

 

Duration

Number

 

 

EpisodeNumber

Episode Number

 

 

GroupNumber

Avatar Group Number

 

 

Location

Dictionary Code

"From Client File, data element 10006."

 

DiagnosisObj1

ICD-10 Code

WEBSVC.DiagnosisCodeObject

 

DiagnosisObj2

ICD-10 Code

WEBSVC.DiagnosisCodeObject

 

MissedVisit

Dictionary Code

"From Client File, data element 10101. Must be 'Y' or 'N'."

 

MissedVisitNotes

Text

 

 

MissedVisitServiceCode

Avatar Service Code

 

 

Modifiers

One or more modifiers

In the format: M1-M2-M3-M4

 

NoteReferenceCode837Billing

Dictionary Code

"From Client File, data element 8201."

 

NoteReferenceText837Billing

Free Text

 

 

NumberOfClients

Number

 

 

OralCavityDesignationCode

Dictionary Code

"From Client File, data element 10803."

 

Practitioner

Avatar Staff ID

 

 

PriorPlacementDate

Date

 

 

Program

Avatar Program Code

 

 

ProsthesisCrownOrInlayCode

Dictionary Code

"From Client File, data element 10804."

 

ReferringPractitioner

Avatar Staff ID

 

 

ReferringProvider

Avatar Referring Provider ID

 

 

SSTxMultipleSelectDictionary1

Free Text

"From Client File, data element 21050.1. A non-standard, site-specific field."

 

SSTreatmentDSMCode1

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode2

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode3

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode4

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDSMCode5

DSM-IV Code

"A non-standard, site-specific field."

 

SSTreatmentDate1

Date

"A non-standard, site-specific field."

 

SSTreatmentDate2

Date

"A non-standard, site-specific field."

 

SSTreatmentDate3

Date

"A non-standard, site-specific field."

 

SSTreatmentDate4

Date

"A non-standard, site-specific field."

 

SSTreatmentDate5

Date

"A non-standard, site-specific field."

 

SSTreatmentDictionary1

Dictionary Code

"From Client File, data element 21023.1. A non-standard, site-specific field."

 

SSTreatmentDictionary2

Dictionary Code

"From Client File, data element 21023.2. A non-standard, site-specific field."

 

SSTreatmentDictionary3

Dictionary Code

"From Client File, data element 21023.3. A non-standard, site-specific field."

 

SSTreatmentDictionary4

Dictionary Code

"From Client File, data element 21023.4. A non-standard, site-specific field."

 

SSTreatmentDictionary5

Dictionary Code

"From Client File, data element 21023.5. A non-standard, site-specific field."

 

SSTreatmentDictionary6

Dictionary Code

"From Client File, data element 21023.6. A non-standard, site-specific field."

 

SSTreatmentDictionary7

Dictionary Code

"From Client File, data element 21023.7. A non-standard, site-specific field."

 

SSTreatmentDictionary8

Dictionary Code

"From Client File, data element 21023.8. A non-standard, site-specific field."

 

SSTreatmentDictionary9

Dictionary Code

"From Client File, data element 21023.9. A non-standard, site-specific field."

 

SSTreatmentFreeText101

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText102

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText103

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText104

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText105

Free Text

"Has a maximum width of 10 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText401

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText402

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText403

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText404

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText405

Free Text

"Has a maximum width of 40 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText801

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText802

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText803

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText804

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentFreeText805

Free Text

"Has a maximum width of 80 characters. A non-standard, site-specific field."

 

SSTreatmentGuarantor1

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor2

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor3

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor4

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentGuarantor5

Avatar Guarantor ID

"A non-standard, site-specific field."

 

SSTreatmentICD10Code1

IDC-10 Code

"A non-standard, site-specific field."

 

SSTreatmentICD10Code2

IDC-10 Code

"A non-standard, site-specific field."

 

SSTreatmentICD10Code3

IDC-10 Code

"A non-standard, site-specific field."

 

SSTreatmentICD10Code4

IDC-10 Code

"A non-standard, site-specific field."

 

SSTreatmentICD10Code5

IDC-10 Code

"A non-standard, site-specific field."

 

SSTreatmentPractitioner1

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner2

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner3

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner4

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentPractitioner5

Avatar Staff ID

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText1

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText2

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText3

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText4

Free Text

"A non-standard, site-specific field."

 

SSTreatmentScrollingFreeText5

Free Text

"A non-standard, site-specific field."

 

SSTxMultipleSelectDictionary2

Dictionary Code

"From Client File, data element 21050.2. A non-standard, site-specific field."

 

SecondCoStaffMember

Avatar Staff ID

 

 

ServiceCode

Avatar Service Code

 

 

ServiceEndTime

Time

 

 

ServiceStartTime

Time

 

 

ToothNumber

Free Text

 

 

ToothStatusCode

Dictionary Code

"From Client File, data element 10801."

 

ToothSurfaceCode

Dictionary Code

"From Client File, data element 10802."

 

UnitsOfService

Number

 

 

DiagnosisObj3

ICD-10 Code

WEBSVC.DiagnosisCodeObject

 

DiagnosisObj4

ICD-10 Code

WEBSVC.DiagnosisCodeObject

 

Discipline

Free Text

 

 

ServiceStatus

Avatar Service Status

 

 

InitialTxDate2300DTP03

Date

 

 

DateOfAccident2300DTP03

Date

 

 

FormLoc10AutoAccidentPlace

State

The location the accident occurred in.

 

RelatedCausesInfo2300CLM11

Dictionary Code

"From Client File, data element 1503."

 

FirstBillingDate

Date

 

 

SSTreatmentInteger1

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger2

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger3

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger4

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger5

Number

"A non-standard, site-specific field."

 

SSTreatmentInteger6

Number

"A non-standard, site-specific field."

 

AdditionalServiceInformation

Dictionary Code

"From Client File, data element 1105."

 

PsychotherapyAddOnDuration

Number

 

 

AddOnNotes

Free Text