com.mmm.cms.homehealth

Class ScoringResults

java.lang.Object

com.mmm.cms.homehealth.ScoringResults

All Implemented Interfaces:

ScoringResultsIF, java.io.Serializable

public class ScoringResults
extends java.lang.Object
implements ScoringResultsIF, java.io.Serializable

Scoring Results holds the collection of HIPPS code, grouper version Data validity flag, OASIS Treatment Authorization, and the validator used to check the record. The main use of this class is to provide a means of returning detailed scoring information from the Grouper.

Author:

3M Health Information Systems for CMS Home Health

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.mmm.cms.homehealth.proto.ScoringResultsIF

DEFAULT_BLANK_VALUE

Constructor Summary

Constructors

Constructor and Description
ScoringResults()
ScoringResults(CollectionValidationEditsIF validationEdits, java.util.Collection<HomeHealthEventIF> events, HIPPSCodeIF hippsCode, java.lang.String grouperVersion, DataValidityFlagIF dataValidityFlag, TreatmentAuthorizationIF treatmentAuthorization, DiagnosisScoringStatus_EN[] diagnosisScoringStatus, DiagnosisScoringStatus_EN[] nrsDiagnosisScoringStatus)
ScoringResults(HIPPSCodeIF hippsCode, java.lang.String grouperVersion, DataValidityFlagIF dataValidityFlag, TreatmentAuthorizationIF treatmentAuthorization, HomeHealthRecordValidatorIF clinValidator, HomeHealthRecordValidatorIF nValidator) Constructor to set all the internal references
ScoringResults(HomeHealthRecordIF record) Constructor to build an empty Scoring Results
ScoringResults(ScoringResultsIF scoringResults)

Method Summary

Methods

Modifier and Type	Method and Description
HomeHealthRecordValidatorIF	getClinicalValidator() gets the validator used
DiagnosisScoringStatus_EN[]	getDiagnosisScoringStatus() gets the status of a code as it pertains to scoring.
java.lang.Exception	getException() gets any exception that happened during to scoring that possibly stopped the scoring from working properly or at all.
java.lang.String	getGrouperVersion() gets the Grouper version
HIPPSCodeIF	getHIPPSCode() gets the HIPPS code
DiagnosisScoringStatus_EN[]	getNrsDiagnosisScoringStatus() gets the status of a code as it pertains to scoring.
HomeHealthRecordValidatorIF	getNrsValidator() Get the value of nrsValidator
java.util.Collection<HomeHealthEventIF>	getScoringEvents() gets the List of Home Health events; may be null
TreatmentAuthorizationIF	getTreatmentAuthorization() getst the Treatment Authorization
CollectionValidationEditsIF	getValidationEdits() gets the collection of validation edits that should be applied to a scored record in order for the record to score properly - non-HH PPS related edits, such as payor code, may not be part of this collection, but may be.
DataValidityFlagIF	getValidityFlag() gets the Data Validity flag
void	setClinicalValidator(HomeHealthRecordValidatorIF validator) Sets the HomeHealthRecordValidatorIF that was used on the record during the scoring.
void	setDiagnosisScoringStatus(DiagnosisScoringStatus_EN[] diagnosisScoringStatus) sets the status of a code as it pertains to scoring.
void	setException(java.lang.Exception exception) sets any exception that happened during to scoring that possibly stopped the scoring from working properly or at all.
void	setGrouperVersion(java.lang.String grouperVersion) Sets the reference grouper version
void	setHIPPSCode(HIPPSCodeIF hippsCode) Sets the HIPPS code object
void	setNrsDiagnosisScoringStatus(DiagnosisScoringStatus_EN[] nrsDiagnosisScoringStatus) sets the status of a code as it pertains to scoring.
void	setNrsValidator(HomeHealthRecordValidatorIF nrsValidator) Set the value of nrsValidator
void	setScoringEvents(java.util.Collection<HomeHealthEventIF> events) sets the List of Home Health scoring events
void	setTreatmentAuthorization(TreatmentAuthorizationIF treatmentAuthorization) Sets the treatment Authorization object
void	setValidationEdits(CollectionValidationEditsIF validationEdits) Sets the validation edits
void	setValidityFlag(DataValidityFlagIF dataValidityFlag) Sets the validity flag
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScoringResults

public ScoringResults()

ScoringResults

public ScoringResults(HomeHealthRecordIF record)

Constructor to build an empty Scoring Results

Parameters:

record -

ScoringResults

public ScoringResults(HIPPSCodeIF hippsCode,
              java.lang.String grouperVersion,
              DataValidityFlagIF dataValidityFlag,
              TreatmentAuthorizationIF treatmentAuthorization,
              HomeHealthRecordValidatorIF clinValidator,
              HomeHealthRecordValidatorIF nValidator)

Constructor to set all the internal references

Parameters:

hippsCode -

grouperVersion -

dataValidityFlag -

treatmentAuthorization -

clinValidator - - the Clinical Validator

nValidator - - the NRS Validator

ScoringResults

public ScoringResults(CollectionValidationEditsIF validationEdits,
              java.util.Collection<HomeHealthEventIF> events,
              HIPPSCodeIF hippsCode,
              java.lang.String grouperVersion,
              DataValidityFlagIF dataValidityFlag,
              TreatmentAuthorizationIF treatmentAuthorization,
              DiagnosisScoringStatus_EN[] diagnosisScoringStatus,
              DiagnosisScoringStatus_EN[] nrsDiagnosisScoringStatus)

ScoringResults

public ScoringResults(ScoringResultsIF scoringResults)

Method Detail

getNrsValidator

public HomeHealthRecordValidatorIF getNrsValidator()

Get the value of nrsValidator

Specified by:

getNrsValidator in interface ScoringResultsIF

Returns:

the value of nrsValidator

setNrsValidator

public void setNrsValidator(HomeHealthRecordValidatorIF nrsValidator)

Set the value of nrsValidator

Specified by:

setNrsValidator in interface ScoringResultsIF

Parameters:

nrsValidator - new value of nrsValidator

getValidityFlag

public DataValidityFlagIF getValidityFlag()

gets the Data Validity flag

Specified by:

getValidityFlag in interface ScoringResultsIF

Returns:

a non-null DataValidityFlagIF

setValidityFlag

public void setValidityFlag(DataValidityFlagIF dataValidityFlag)

Sets the validity flag

Parameters:

dataValidityFlag -

getGrouperVersion

public java.lang.String getGrouperVersion()

gets the Grouper version

Specified by:

getGrouperVersion in interface ScoringResultsIF

Returns:

a non-null String. Should not be blank.

setGrouperVersion

public void setGrouperVersion(java.lang.String grouperVersion)

Sets the reference grouper version

Parameters:

grouperVersion -

getHIPPSCode

public HIPPSCodeIF getHIPPSCode()

gets the HIPPS code

Specified by:

getHIPPSCode in interface ScoringResultsIF

Returns:

a non-null HIPPSCodeIF object

setHIPPSCode

public void setHIPPSCode(HIPPSCodeIF hippsCode)

Sets the HIPPS code object

Parameters:

hippsCode -

getTreatmentAuthorization

public TreatmentAuthorizationIF getTreatmentAuthorization()

getst the Treatment Authorization

Specified by:

getTreatmentAuthorization in interface ScoringResultsIF

Returns:

a non-null TreatmentAuthorizationIF

setTreatmentAuthorization

public void setTreatmentAuthorization(TreatmentAuthorizationIF treatmentAuthorization)

Sets the treatment Authorization object

Parameters:

treatmentAuthorization -

getClinicalValidator

public HomeHealthRecordValidatorIF getClinicalValidator()

gets the validator used

Specified by:

getClinicalValidator in interface ScoringResultsIF

Returns:

The HomeHealthRecordValidatorIF used on the record during the scoring, this may be null

setClinicalValidator

public void setClinicalValidator(HomeHealthRecordValidatorIF validator)

Sets the HomeHealthRecordValidatorIF that was used on the record during the scoring.

Specified by:

setClinicalValidator in interface ScoringResultsIF

Parameters:

validator -

getDiagnosisScoringStatus

public DiagnosisScoringStatus_EN[] getDiagnosisScoringStatus()

Description copied from interface: ScoringResultsIF

gets the status of a code as it pertains to scoring.

Specified by:

getDiagnosisScoringStatus in interface ScoringResultsIF

Returns:

getException

public java.lang.Exception getException()

Description copied from interface: ScoringResultsIF

gets any exception that happened during to scoring that possibly stopped the scoring from working properly or at all. If there is no exception during scoring, then this value will be null.

Specified by:

getException in interface ScoringResultsIF

Returns:

getNrsDiagnosisScoringStatus

public DiagnosisScoringStatus_EN[] getNrsDiagnosisScoringStatus()

Description copied from interface: ScoringResultsIF

gets the status of a code as it pertains to scoring.

Specified by:

getNrsDiagnosisScoringStatus in interface ScoringResultsIF

Returns:

getScoringEvents

public java.util.Collection<HomeHealthEventIF> getScoringEvents()

Description copied from interface: ScoringResultsIF

gets the List of Home Health events; may be null

Specified by:

getScoringEvents in interface ScoringResultsIF

Returns:

non-empty List or null

getValidationEdits

public CollectionValidationEditsIF getValidationEdits()

Description copied from interface: ScoringResultsIF

gets the collection of validation edits that should be applied to a scored record in order for the record to score properly - non-HH PPS related edits, such as payor code, may not be part of this collection, but may be.

Specified by:

getValidationEdits in interface ScoringResultsIF

Returns:

null if validation was not applied to a scored record, and a non-collection if the validation was applied, however, the collection may be empty if there were no edits.

setDiagnosisScoringStatus

public void setDiagnosisScoringStatus(DiagnosisScoringStatus_EN[] diagnosisScoringStatus)

Description copied from interface: ScoringResultsIF

sets the status of a code as it pertains to scoring.

Specified by:

setDiagnosisScoringStatus in interface ScoringResultsIF

setException

public void setException(java.lang.Exception exception)

Description copied from interface: ScoringResultsIF

sets any exception that happened during to scoring that possibly stopped the scoring from working properly or at all.

Specified by:

setException in interface ScoringResultsIF

setNrsDiagnosisScoringStatus

public void setNrsDiagnosisScoringStatus(DiagnosisScoringStatus_EN[] nrsDiagnosisScoringStatus)

Description copied from interface: ScoringResultsIF

sets the status of a code as it pertains to scoring.

Specified by:

setNrsDiagnosisScoringStatus in interface ScoringResultsIF

setScoringEvents

public void setScoringEvents(java.util.Collection<HomeHealthEventIF> events)

Description copied from interface: ScoringResultsIF

sets the List of Home Health scoring events

Specified by:

setScoringEvents in interface ScoringResultsIF

Parameters:

events - - may be null

setValidationEdits

public void setValidationEdits(CollectionValidationEditsIF validationEdits)

Description copied from interface: ScoringResultsIF

Sets the validation edits

Specified by:

setValidationEdits in interface ScoringResultsIF

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object