FreeMED. Remitt

Communication and document creation class for interfacing with a REMITT server.

Summary
Communication and document creation class for interfacing with a REMITT server.
Retrieves the protocol revision being used by a REMITT server.
Determine if the REMITT server is up.
Retrieves the current status of a REMITT billing run by its unique identifier.
Wrapper for Remitt.Interface.ListOptions
Wrapper for Remitt.Interface.ListPlugins
Wrapper for Remitt.Interface.GetOutputMonths
Wrapper for Remitt.Interface.GetOutputYears
Logs into the Remitt server, and stores authentication data received in the session.
Stores billing data in a temporary key table.
Renders procedure entries into XML file to be transmitted to REMITT server.
Renders procedure entries into XML file to be transmitted to REMITT server for patient statement billing
Automagically determines what kind of resource this is supposed to be and creates a PHP.xmlrpcval object to wrap it in.
Call Remitt server with the specified parameters.
Determines if in an array is a structure (associative array) or a regular array.

Functions

GetFileList

function GetFileList ($type,
$criteria,
$value)

Parameters

$typeType of files
$criteriaType of criteria (ex: years)
$valueCriteria

Returns

Array of files

GetProtocolVersion

function GetProtocolVersion ( )

Retrieves the protocol revision being used by a REMITT server.  Is supported from REMITT version 0.1+.

Returns

Version number.

GetServerStatus

function GetServerStatus ( )

Determine if the REMITT server is up.

Returns

true if up, false if not

GetStatus

function GetStatus ($unique)

Retrieves the current status of a REMITT billing run by its unique identifier.

Parameters

$uniqueUnique identifier

Returns

NULL meaning still in process, or name of result file.

ListOptions

function ListOptions ($type,  
$plugin,  
$media =  NULL,
$format =  NULL)

Wrapper for Remitt.Interface.ListOptions

Parameters

$typePlugin type (Render, Translation, Transport)
$pluginName of the plugin to query
$media(optional) Electronic or Paper.  If neither is specified, defaults to all media forms.  (Default is NULL)
$format(optional) Input XML format.  Defaults to NULL, which disables the qualification.

Returns

Array of available options for the specified plugin

ListPlugins

function ListPlugins ($type)

Wrapper for Remitt.Interface.ListPlugins

Parameters

$typePlugin type (Render, Translation, Transport)

Returns

Array of available plugins

ListOutputMonths

function ListOutputMonths ($year =  NULL)

Wrapper for Remitt.Interface.GetOutputMonths

Parameters

$year(optional) Year to list months for

Returns

Hash of years => number of output files available.

ListOutputYears

function ListOutputYears ( )

Wrapper for Remitt.Interface.GetOutputYears

Returns

Hash of years => number of output files available.

Login

function Login ($username,
$password)

Logs into the Remitt server, and stores authentication data received in the session.

Parameters

$usernameUsername to be passed to the Remitt server
$passwordPassword to be passed to the Remitt server

ProcessBill

function ProcessBill ($billkey,
$render,
$transport)

ProcessStatement

function ProcessStatement ($procedures)

StoreBillKey

function StoreBillKey ($billkey)

Stores billing data in a temporary key table.

Parameters

$billkeyData to be serialized

Returns

Table key for billkey

RenderPayerXML

function RenderPayerXML ($_procedures,  
$bc = 1,
$bs = 1,
$ch = 1)

Renders procedure entries into XML file to be transmitted to REMITT server.

Parameters

$proceduresArray of procedure id keys to be processed.
$bcBilling contact id.  Defaults to 1.
$bsBilling service id.  Default to 1.
$chClearinghouse id.  Defaults to 1.

Returns

Text of XML file.

RenderStatementXML

function RenderStatementXML ($_procedures)

Renders procedure entries into XML file to be transmitted to REMITT server for patient statement billing

Parameters

$proceduresArray of procedure id keys to be processed.

Returns

Text of XML file.

_autoserialize

function _autoserialize ($mixed)

Automagically determines what kind of resource this is supposed to be and creates a PHP.xmlrpcval object to wrap it in.

Parameters

$mixedOriginal object, any type

Returns

PHP.xmlrpcval object

_call

function _call ($method,  
$parameters =  NULL,
$debug =  false)

Call Remitt server with the specified parameters.  This should only be used by internal Remitt methods to complete abstraction.

Parameters

$methodMethod on the Remitt server to call
$parameters(optional) Array of parameters to call $method with.  Defaults to NULL.
$debug(optional) Whether debug code should be shown.  Defaults to false.

Returns

Reply to call as PHP variable.

_is_struct

function _is_struct ($var)

Determines if in an array is a structure (associative array) or a regular array.

Parameters

$varVariable to be typed

Returns

Boolean, true if $var is an associative array, false if it is not.

function GetFileList ($type,
$criteria,
$value)
function GetProtocolVersion ( )
Retrieves the protocol revision being used by a REMITT server.
function GetServerStatus ( )
Determine if the REMITT server is up.
function GetStatus ($unique)
Retrieves the current status of a REMITT billing run by its unique identifier.
function ListOptions ($type,  
$plugin,  
$media =  NULL,
$format =  NULL)
Wrapper for Remitt.Interface.ListOptions
function ListPlugins ($type)
Wrapper for Remitt.Interface.ListPlugins
function ListOutputMonths ($year =  NULL)
Wrapper for Remitt.Interface.GetOutputMonths
function ListOutputYears ( )
Wrapper for Remitt.Interface.GetOutputYears
function Login ($username,
$password)
Logs into the Remitt server, and stores authentication data received in the session.
function ProcessBill ($billkey,
$render,
$transport)
function ProcessStatement ($procedures)
function StoreBillKey ($billkey)
Stores billing data in a temporary key table.
function RenderPayerXML ($_procedures,  
$bc = 1,
$bs = 1,
$ch = 1)
Renders procedure entries into XML file to be transmitted to REMITT server.
function RenderStatementXML ($_procedures)
Renders procedure entries into XML file to be transmitted to REMITT server for patient statement billing
function _autoserialize ($mixed)
Automagically determines what kind of resource this is supposed to be and creates a PHP.xmlrpcval object to wrap it in.
function _call ($method,  
$parameters =  NULL,
$debug =  false)
Call Remitt server with the specified parameters.
function _is_struct ($var)
Determines if in an array is a structure (associative array) or a regular array.