VAM Services

Class: OrderMetaService

OrderMetaService

new OrderMetaService()

Service for Meta (non-clinical) queries relating to the Order domain.

Methods

isEPCSEnabled(callback)

determines if PKI is turned on at the site by verifying electronic Prescribing of Controlled Substances (ePCS) parameters used by CPRS

Parameters:
Name Type Description
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

isEpcsEnabled getEnableEPCS field true or false

Type
Boolean

listDiscontinueReasons(context, callback)

RPC to return a list of valid discontinuation reasons.

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array of labels and urn id's

Type
Array

listTreatmentFactorHints(context, callback)

return HINTS for ORBA Treatment Factors - used by Delphi

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

HelpFrame Collection result object in Array

Type
Array

lookupCoverSheetReports(context, callback)

Returns a list of Cover Sheet reports.

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array of Objects with OE/RR Report properties (if they exist)

Type
Array
Example
[{
        id02: '10',
        mixedcase: true,
        type12: 'SELECTION LIST',
        tabPositions: '2,3',
        pieces: '9,10,2',
        param1: 'A',
        heading: 'Active Problems',
        detailReport: {
            id: 'urn:vista:6100:101_24:36',
            label: 'ORCV ACTIVE PROBLEM DETAILS'
        },
        rpc: { id: 'urn:vista:6100:8994:167', label: 'ORQQPL LIST' }
    }]

lookupDefaultPrinter(location, context, callback)

Returns default printer for user

Parameters:
Name Type Description
location String

A specified location ID, converted to URN (optional)
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

aggregate Array containing value from ORWDP WINPRINT DEFAULT and label from query

Type
Array

lookupDisplayGroup(labelArg, context, callback)

Returns ID of a display group

Parameters:
Name Type Description
labelArg String

String representing name of data in DisplayGroup Collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array containing urn ID

Type
Array

lookupDisplayGroupId(displayArg, context, callback)

Display group pointer for name

Parameters:
Name Type Description
displayArg String

Label or name of data set in DisplayGroup collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Integer extracted from urn

Type
Integer

lookupOrderDialogId(labelArg, context, callback)

Return Order Dialog ID based on name

Parameters:
Name Type Description
labelArg String

Label or name of data set in OrderDialog collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Integer extracted from urn

Type
Integer

lookupPatientCOMObject(context, callback)

Returns Patient COM Object if it exists.

Parameters:
Name Type Description
context Object

The session data.
callback function

The callback function used to process results.
Returns:

An Object containing COM id, label, GUID, and param1 (if it exists)

Type
Object

lookupSort(context, callback)

Return notification sort

Parameters:
Name Type Description
context Object

the session data
callback function

the callback function used to process results
Returns:

To be filled

Type
Array

lookupStartStopDefaults(context, callback)

Return start and stop defaults

Parameters:
Name Type Description
context Object

the session data
callback function

the callback function used to process results
Returns:

Get start and stop default values

Type
Array

Class: OrderMetaService

OrderMetaService

new OrderMetaService()

Service for Meta (non-clinical) queries relating to the Order domain.

Methods

isEPCSEnabled(callback)

determines if PKI is turned on at the site by verifying electronic Prescribing of Controlled Substances (ePCS) parameters used by CPRS

Parameters:
Name Type Description
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

isEpcsEnabled getEnableEPCS field true or false

Type
Boolean

listDiscontinueReasons(context, callback)

RPC to return a list of valid discontinuation reasons.

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array of labels and urn id's

Type
Array

listTreatmentFactorHints(context, callback)

return HINTS for ORBA Treatment Factors - used by Delphi

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

HelpFrame Collection result object in Array

Type
Array

lookupCoverSheetReports(context, callback)

Returns a list of Cover Sheet reports.

Parameters:
Name Type Description
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array of Objects with OE/RR Report properties (if they exist)

Type
Array
Example
[{
        id02: '10',
        mixedcase: true,
        type12: 'SELECTION LIST',
        tabPositions: '2,3',
        pieces: '9,10,2',
        param1: 'A',
        heading: 'Active Problems',
        detailReport: {
            id: 'urn:vista:6100:101_24:36',
            label: 'ORCV ACTIVE PROBLEM DETAILS'
        },
        rpc: { id: 'urn:vista:6100:8994:167', label: 'ORQQPL LIST' }
    }]

lookupDefaultPrinter(location, context, callback)

Returns default printer for user

Parameters:
Name Type Description
location String

A specified location ID, converted to URN (optional)
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

aggregate Array containing value from ORWDP WINPRINT DEFAULT and label from query

Type
Array

lookupDisplayGroup(labelArg, context, callback)

Returns ID of a display group

Parameters:
Name Type Description
labelArg String

String representing name of data in DisplayGroup Collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Array containing urn ID

Type
Array

lookupDisplayGroupId(displayArg, context, callback)

Display group pointer for name

Parameters:
Name Type Description
displayArg String

Label or name of data set in DisplayGroup collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Integer extracted from urn

Type
Integer

lookupOrderDialogId(labelArg, context, callback)

Return Order Dialog ID based on name

Parameters:
Name Type Description
labelArg String

Label or name of data set in OrderDialog collection
context Object

Session context information associated with the service call.
callback function

Function called on process completion, with standard (err, result) signature.
Returns:

Integer extracted from urn

Type
Integer

lookupPatientCOMObject(context, callback)

Returns Patient COM Object if it exists.

Parameters:
Name Type Description
context Object

The session data.
callback function

The callback function used to process results.
Returns:

An Object containing COM id, label, GUID, and param1 (if it exists)

Type
Object

lookupSort(context, callback)

Return notification sort

Parameters:
Name Type Description
context Object

the session data
callback function

the callback function used to process results
Returns:

To be filled

Type
Array

lookupStartStopDefaults(context, callback)

Return start and stop defaults

Parameters:
Name Type Description
context Object

the session data
callback function

the callback function used to process results
Returns:

Get start and stop default values

Type
Array