Docs For Class Encounter

Child classes:

DRG: DRG = Diagnosis related groups.

Ward: Ward methods.

Lab: Laboratory methods.

Inherited Variables

Class: Notes

Notes::$fld_notes
Notes::$is_preloaded
Notes::$preload_dept
Notes::$result
Notes::$tb_notes
Notes::$tb_types

Class: Core

Core::$buffer
Core::$buffer_array
Core::$coretable
Core::$data_array
Core::$dead_stat
Core::$do_intern
Core::$error_msg
Core::$normal_stat
Core::$ok
Core::$rec_count
Core::$ref_array
Core::$res
Core::$sql
Core::$where

Inherited Methods

Class: Notes

Notes::Notes(): Constructor
Notes::getAllTypes(): Gets all types of notes record. Unsorted result.
Notes::getAllTypesSort(): Gets all types of notes record. Sorted result.
Notes::getEncounterNotes(): Gets all notes of a given record number.
Notes::getType(): Gets notes type information based on the type number (nr key).
Notes::_Exists(): Checks if a certain notes record of a certain type exists in the database.
Notes::_getNotes(): Gets a notes record data based on a passed condition.
Notes::_getNotesDateRange(): Gets the date range of a certain notes type that fits to a given condition.
Notes::_insertNotesFromInternalArray(): Save a notes data of a given type number.
Notes::_updateNotesFromInternalArray(): Updates a notes data record based on the primary record key "nr".

Class: Core

Core::coreFieldNames(): Returns the core field names of the core table in an array.
Core::deleteDBCache(): Deletes data from the database cache based on the id key.
Core::FilesListArray(): Returns a list of filename within a path in array.
Core::getAllDataArray(): Returns all records with the all items from the table.
Core::getAllDataObject(): Returns all records with all items from the table.
Core::getAllItemsArray(): Similar to getAllItemsObject() method but returns the records in an associative array.
Core::getAllItemsObject(): Returns all records with the needed items from the table.
Core::getDBCache(): Gets temporary data from the database cache.
Core::getErrorMsg(): Feturns the value of error_msg, the internal error message.
Core::getLastQuery(): Returns the the last sql query string
Core::getResult(): Feturns the value of result
Core::insertDataFromArray(): Inserts data from an array (passed by reference) into a table.
Core::insertDataFromInternalArray(): Inserts data from the internal array previously filled with data by the setDataArray() method.
Core::isPreLoaded(): Returns the value of is_preloaded that is set by methods that preload large number of data.
Core::LastRecordCount(): Returns the value of rec_count
Core::saveDBCache(): Saves temporary data to a cache in database.
Core::setDataArray(): Points the core data array to the external array that holds the data to be stored.
Core::setRefArray(): Points the reference variable $ref_array to the field names' array.
Core::setSQL(): Sets the internal sql query variable to the sql query.
Core::setTable(): Sets the coretable variable to the name of the database table.
Core::setWhereCondition(): Sets the "where" condition in an update query used with the updateDataFromInternalArray() method.
Core::Transact(): Transaction routine, ADODB transaction. It internally uses the ADODB transaction routine.
Core::updateDataFromArray(): Updates a record with the data from an array (passed by reference) based on the primary key.
Core::updateDataFromInternalArray(): Updates a table using data from an internal array previously filled with data by the setDataArray() method.
Core::_prepSaveArray(): Filters the data array intended for saving, removing the key-value pairs that do not correspond to the table's field names.
Core::_RecordExists(): Checks if a certain database record exists based onthe supplied query condition.

Class Details

Patient encounter.

Note this class should be instantiated only after a "$db" adodb connector object has been established by an adodb instance.

Class Variables

$date =

[line 142]

Current date

Type: string

Overrides:

[ Top ]

$encoder =

[line 92]

Name of user

Type: string

Overrides:

[ Top ]

$encounter =

[line 107]

Current department number

Type: int

Overrides:

[ Top ]

$enc_nr =

[line 87]

Current encounter number

Type: int

Overrides:

[ Top ]

$entire_record = FALSE

[line 102]

Flag for returning entire record or a part

Type: boolean

Overrides:

[ Top ]

$fld_sickconfirm = array(
                        'nr',
                        'encounter_nr',
                              'date_confirm',
                        'date_start',
                        'date_end',
                        'date_create',
                        'diagnosis',
                        'dept_nr',
                        'insurance_co_nr',
                        'insurance_co_sub',
                        'status',
                        'history',
                        'modify_id',
                        'modify_time',
                        'create_id',
                        'create_time')

[line 191]

Field names of care_encounter_sickconfirm table

Type: array

Overrides:

[ Top ]

$group_nr =

[line 137]

Current group number

Type: int

Overrides:

[ Top ]

$ignore_status = FALSE

[line 97]

Flag for ignoring certain events

Type: boolean

Overrides:

[ Top ]

$is_loaded = FALSE

[line 112]

Status of preloaded encounter data

Type: boolean

Overrides:

[ Top ]

$loc_nr =

[line 132]

Current localization type number

Type: int

Overrides:

[ Top ]

$record_count =

[line 122]

Current record count

Type: int

Overrides:

[ Top ]

$single_result = FALSE

[line 117]

Flag for returning single result or many

Type: boolean

Overrides:

[ Top ]

$tabfields = array('encounter_nr',
                              'pid',
                        'encounter_date',
                        'encounter_class_nr',
                        'encounter_type',
                        'encounter_status',
                        'referrer_diagnosis',
                        'referrer_recom_therapy',
                        'referrer_dr',
                        'referrer_dept',
                        'referrer_institution',
                        'referrer_notes',
                        'financial_class',
                        'insurance_nr',
                        'insurance_class_nr',
                        'insurance_firm_id',
                        'insurance_2_nr',
                        'insurance_2_firm_id',
                               'current_ward_nr',
                        'current_room_nr',
                        'in_ward',
                        'current_dept_nr',
                        'current_firm_nr',
                        'current_att_dr',
                        'consulting_dr',
                        'extra_service',
                        'followup_date',
                        'followup_responsibility',
                        'post_encounter_notes',
                        'status',
                        'history',
                        'modify_id',
                        'modify_time',
                        'create_id',
                        'create_time')

[line 152]

Field names of care_encounter table

Type: array

Overrides:

[ Top ]

$tb_appt = 'care_appointment'

[line 82]

Table name for appointments data

Type: string

Overrides:

[ Top ]

$tb_citytown = 'care_address_citytown'

[line 52]

Table name for city/town names

Type: string

Overrides:

[ Top ]

$tb_dept = 'care_department'

[line 72]

Table name for department general data

Type: string

Overrides:

[ Top ]

$tb_dis_type = 'care_type_discharge'

[line 62]

Table name for discharge types

Type: string

Overrides:

[ Top ]

$tb_ec = 'care_class_encounter'

[line 37]

Table name for encounter classes

Type: string

Overrides:

[ Top ]

$tb_enc = 'care_encounter'

[line 22]

Table name for encounter (admission) data

Type: string

Overrides: Array

[ Top ]

$tb_enc_fc = 'care_encounter_financial_class'

[line 32]

Table name for encounter's financial classes

Type: string

Overrides:

[ Top ]

$tb_fc = 'care_class_financial'

[line 27]

Table name for financial classes

Type: string

Overrides:

[ Top ]

$tb_ic = 'care_class_insurance'

[line 42]

Table name for insurance classes

Type: string

Overrides:

[ Top ]

$tb_insco = 'care_insurance_firm'

[line 77]

Table name for insurance firms' general data

Type: string

Overrides:

[ Top ]

$tb_location = 'care_encounter_location'

[line 57]

Table name for encounter's location data

Type: string

Overrides:

[ Top ]

$tb_person = 'care_person'

[line 47]

Table name for person (registration) data

Type: string

Overrides:

[ Top ]

$tb_sickconfirm = 'care_encounter_sickconfirm'

[line 67]

Table name for encounter's sick confirmations

Type: string

Overrides:

[ Top ]

$time =

[line 147]

Current time

Type: string

Overrides:

[ Top ]

$type_nr =

[line 127]

Current type number

Type: int

Overrides:

[ Top ]

Class Methods

Encounter

Encounter Encounter( [int $enc_nr = ''])

[line 212]

Constructor

Parameters:

int $enc_nr - Encounter number

[ Top ]

AdmitInWard

boolean AdmitInWard( int $enr, int $ward_nr, int $room_nr, int $bed_nr)

[line 1469]

Admits a patient in ward with a ward number, room number and bed number.

If the save routine is successful, the "currently in ward" flag of the encounter record will also be set internally.

Parameters:

int $enr - Encounter number
int $ward_nr - Ward number
int $room_nr - Room number
int $bed_nr - Bed number

[ Top ]

AllAttDrServiceClassesObject

mixed AllAttDrServiceClassesObject( )

[line 587]

Gets all service classes of 'att_dr' class.

Parameters:

[ Top ]

AllCareServiceClassesObject

mixed AllCareServiceClassesObject( )

[line 569]

Gets all service classes of 'care' class.

Parameters:

[ Top ]

AllEncounterClassesObject

mixed AllEncounterClassesObject( )

[line 602]

Gets all info of all encounter classes.

The returned adodb object contains rows of array. Each array contains the data with the following index keys:

class_nr = the class number, primary key (numeric)
class_id = the class ID (alphanumeric)
name = the name of class
LD_var = the variable's name for language dependent name of class

Parameters:

[ Top ]

AllRoomServiceClassesObject

mixed AllRoomServiceClassesObject( )

[line 578]

Gets all service classes of 'room' class.

Parameters:

[ Top ]

allSicknessConfirm

mixed allSicknessConfirm( [int $dept_nr = 0], [int $enc_nr = 0])

[line 1912]

Gets all stored sickness confirmations of an encounter based on its department and encounter numbers.

Parameters:

int $dept_nr - Department number , if department number is zero, all available sickness records will be fetched
int $enc_nr - Encounter number

[ Top ]

AllStatus

mixed AllStatus( [int $enc_nr = 0])

[line 2096]

Returns the status information and current locations of an encounter.

The returned adodb object contains rows of arrays. Each array contains data with following index keys:

encounter_status = encounter status
current_room_nr = current room number
current_ward_nr = current ward number
current_dept_nr = current department number
in_dept = "in department" status
in_ward = "in ward" status
is_discharged = discharge status
status = record's technical status

Parameters:

int $enc_nr - Encounter number

[ Top ]

assignInBed

boolean assignInBed( int $enr, int $loc_nr, int $group_nr, string $date, string $time)

[line 1440]

Saves the encounter's room location.

Parameters:

int $enr - Encounter number
int $loc_nr - Bed number
int $group_nr - Room number
string $date - Date
string $time - Time

[ Top ]

assignInDept

boolean assignInDept( int $enr, int $loc_nr, int $group_nr, string $date, string $time)

[line 1454]

Saves the encounter's room location.

If the save routine is successful, the "currently in department" flag of the encounter record will also be set internally.

Parameters:

int $enr - Encounter number
int $loc_nr - Department number
int $group_nr - Department number
string $date - Date
string $time - Time

[ Top ]

assignInRoom

boolean assignInRoom( int $enr, int $loc_nr, int $group_nr, string $date, string $time)

[line 1427]

Saves the encounter's room location.

Parameters:

int $enr - Encounter number
int $loc_nr - Room number
int $group_nr - Ward number
string $date - Date
string $time - Time

[ Top ]

assignInWard

boolean assignInWard( int $enr, int $loc_nr, int $group_nr, string $date, string $time)

[line 1412]

Saves the encounter's ward location.

If the save routine is successful, the "currently in ward" flag of the encounter record will also be set internally.

Parameters:

int $enr - Encounter number
int $loc_nr - Ward number
int $group_nr - Department number
string $date - Date
string $time - Time

[ Top ]

AttDrServiceClass

mixed AttDrServiceClass( int $enc_nr)

[line 378]

Gets the attending physician service class information of an encounter based on encounter number.

The returned adodb record object contains an array with the data having the following index keys:

sc_att_dr_class_nr = the financial class number of encounter
sc_att_dr_start = the start date
sc_att_dr_end = the end date
sc_att_dr_nr = the service record's primary key number
sc_att_dr_name = the service name
sc_att_dr_code = the service code
sc_att_dr_LD_var = the variable's name for language dependent name of the service

Parameters:

int $enc_nr - Encounter number

[ Top ]

BillingClass

void BillingClass( )

[line 733]

Alias of FinancialClass()

Parameters:

[ Top ]

BirthDate

mixed BirthDate( )

[line 684]

Returns date of birth in yyyy-mm-format.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

Cancel

boolean Cancel( [int $enc_nr = 0], string $by)

[line 1671]

Cancels an encounter, but only when its encounter_status is set to '' (emtpy) or 'allow_cancel'.

Sets the encounter_status= 'cancelled', status='void', is_discharged=1 and stores history and modify infos

Parameters:

int $enc_nr - Encounter number
string $by - Optional name of person responsible for cancellation

[ Top ]

CareServiceClass

mixed CareServiceClass( int $enc_nr)

[line 342]

Gets the Nursing care service class information of an encounter based on encounter number.

The returned adodb record object contains an array with the data having the following index keys:

sc_care_class_nr = the financial class number of encounter
sc_care_start = the start date
sc_care_end = the end date
sc_care_nr = the service record's primary key number
sc_care_name = the service name
sc_care_code = the service code
sc_care_LD_var = the variable's name for language dependent name of the service

Parameters:

int $enc_nr - Encounter number

[ Top ]

ConsultingDr

mixed ConsultingDr( )

[line 919]

Returns consulting physician's name.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

createWaitingOutpatientList

mixed createWaitingOutpatientList( [int $dept_nr = 0])

[line 2054]

createWaitingOutpatientList() creates a list of outpatients waiting to be admitted in the clinic

The returned adodb object contains rows of arrays. Each array contains data with following index keys:

encounter_nr = the encounter number
encounter_class_nr = the encounter class number (1 = inpatient, 2 = outpatient)
current_dept_nr = the current department number
pid = PID number
name_last = person's last or family name
name_first = person's first or given name
date_birth = date of birth
sex = sex
dept_nr = current department number
name_short = short department name
LD_var = variable's name for the foreign language version of department name

Parameters:

int $dept_nr - Department number, if empty all departments will be searched

[ Top ]

CurrentAttDrNr

mixed CurrentAttDrNr( )

[line 849]

Returns current attending physician number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

CurrentDeptNr

mixed CurrentDeptNr( )

[line 831]

Returns current department number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

CurrentFirmNr

mixed CurrentFirmNr( )

[line 840]

Returns current firm number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

CurrentRoomNr

mixed CurrentRoomNr( )

[line 822]

Returns current room number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

CurrentWardNr

mixed CurrentWardNr( )

[line 813]

Returns current ward number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

Discharge

boolean Discharge( int $enr, int $d_type_nr, [string $date = ''], [string $time = ''])

[line 1759]

Complete discharge of patient from the hospital or clinic.

Parameters:

int $enr - Encounter number
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

DischargeFromBed

boolean DischargeFromBed( int $enr, int $d_type_nr, [string $date = ''], [string $time = ''])

[line 1818]

Complete discharge of patient from the bed but patient remains in room.

Parameters:

int $enr - Encounter number
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

DischargeFromDept

boolean DischargeFromDept( int $enr, int $d_type_nr, [string $date = ''], [string $time = ''], [boolean $rst_enc = 1])

[line 1776]

Complete discharge of patient from the department, but patient remains admitted.

Parameters:

int $enr - Encounter number
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge
boolean $rst_enc - Reset encounter flag (reserved)

[ Top ]

DischargeFromRoom

boolean DischargeFromRoom( int $enr, int $d_type_nr, [string $date = ''], [string $time = ''])

[line 1804]

Complete discharge of patient from the room but patient remains in ward.

Parameters:

int $enr - Encounter number
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

DischargeFromWard

boolean DischargeFromWard( int $enr, int $d_type_nr, [string $date = ''], [string $time = ''])

[line 1790]

Complete discharge of patient from the ward but patient remains admitted.

Parameters:

int $enr - Encounter number
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

EncounterClass

mixed EncounterClass( )

[line 714]

Returns encounter or admission class.

For example: 1 = inpatient , 2 = outpatient.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

EncounterDate

mixed EncounterDate( )

[line 702]

Returns date of admission.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

EncounterExists

mixed EncounterExists( int $enc_nr)

[line 1289]

Checks if the encounter exists in the database based on the encounter number key.

If the encounter exists, its PID number will be returned, else FALSE will be returned.

Parameters:

int $enc_nr - Encounter number

[ Top ]

EncounterInsuranceData

mixed EncounterInsuranceData( [int $enc_nr = 0])

[line 1955]

Returns the insurance relevant data of an encounter.

The returned adodb object contains rows of arrays. Each array contains data with following index keys:

insurance_nr = the insurance number
name = insurance company's name
sub_area = insurance company's sub area

Parameters:

int $enc_nr - Encounter number

[ Top ]

EncounterStatus

mixed EncounterStatus( )

[line 893]

Returns encounter status.

Types of encounter status:

disallow_cancel
cancelled
valid
empty char

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

EncounterType

mixed EncounterType( )

[line 910]

Returns encounter type. Currently reserved.

Encounter types:

emergency
normal
walk-in
home visit

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

FinancialClass

mixed FinancialClass( )

[line 726]

Returns financial class.

For example: 1 = private , 2 = common , 3 = self pay.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

FirstName

mixed FirstName( )

[line 675]

Returns first or given name.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

FollowUpDate

mixed FollowUpDate( )

[line 928]

Returns follow-up date in yyyy-mm-dd format.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

FollowUpResponsibility

mixed FollowUpResponsibility( )

[line 937]

Returns the name of physician or service responsible for follow-up.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

getAllServiceClassesObject

mixed getAllServiceClassesObject( [string $type = ''])

[line 553]

Gets all service classes of a given class.

Parameters:

string $type - service class 'care', 'room', 'att_dr'

[ Top ]

getBasic4Data

mixed getBasic4Data( int $enc_nr)

[line 1854]

Gets an adodb object containing the "very basic" encounter's first name, family name, birth date and sex.

Parameters:

int $enc_nr - Encounter number

[ Top ]

getDischargeTypesData

mixed getDischargeTypesData( )

[line 1715]

Gets the discharge types.

The resulting adodb record object contains rows of arrays. Each array contains the discharge type information with the following index keys:

nr = The primary key number
name = the name of discharge type
LD_var = the variable name for the foreign language version of the discharge name

Parameters:

[ Top ]

getEncounterClassInfo

mixed getEncounterClassInfo( int $class_nr)

[line 1085]

Gets the encounter class' information based on its class_nr key.

The returned array contains data with following index keys:

class_id = the class id (alphanumeric)
name = the class name
LD_var = the variable's name for the language dependent version of the class name

Parameters:

int $class_nr - Encounter number

[ Top ]

getInsuranceClassInfo

mixed getInsuranceClassInfo( int $class_nr)

[line 1110]

Gets the insurance class' information based on its class_nr key.

The returned array contains data with following index keys:

class_id = the class id (alphanumeric)
name = the class name
LD_var = the variable's name for the language dependent version of the class name

Parameters:

int $class_nr - Encounter number

[ Top ]

getLoadedEncounterData

mixed getLoadedEncounterData( )

[line 1844]

Returns the contents of the internal encounter data buffer $encounter

Parameters:

[ Top ]

getNewEncounterNr

integer getNewEncounterNr( int $ref_nr, int $enc_class_nr)

[line 267]

Gets a new encounter number.

A reference number must be passed as parameter. The returned number will the highest number above the reference number PLUS 1.

Parameters:

int $ref_nr - Reference Encounter number
int $enc_class_nr - Encounter class number (1=inpatient, 2=outpatient)

[ Top ]

getServiceClass

mixed getServiceClass( int $type, int $enc_nr)

[line 304]

Gets the service class information of an encounter based on service type and encounter number.

Parameters:

int $type - service class number
int $enc_nr - Encounter number

[ Top ]

getSicknessConfirm

mixed getSicknessConfirm( [int $nr = 0])

[line 1891]

Gets a stored sickness confirmation of an encounter.

The returned adodb object contains rows of arrays. Each array contains sickness data with following index keys:

all keys as stored in the $fld_sickconfirm array
sig_stamp = Signature stamp of the department
logo_mime_type = Mime type (or extension) of the department's logo image

Parameters:

int $nr - Primary key number of the record

[ Top ]

InBed

mixed InBed( int $enr, int $loc_nr)

[line 1356]

Checks if the encounter has been finally assigned a bed.

If the bed location is finally assigned, its record primary key number will be returned, else FALSE.

Parameters:

int $enr - Encounter number
int $loc_nr - Bed number

[ Top ]

InDept

mixed InDept( int $enr, int $loc_nr)

[line 1370]

Checks if the encounter (outpatient) is finally admitted to a department (or clinic).

If finally admitted to department location, its record primary key number will be returned, else FALSE.

Parameters:

int $enr - Encounter number
int $loc_nr - Department number

[ Top ]

InRoom

mixed InRoom( int $enr, int $loc_nr)

[line 1342]

Checks if the encounter has been finally assigned a room.

If the room location is finally assigned, its record primary key number will be returned, else FALSE.

Parameters:

int $enr - Encounter number
int $loc_nr - Room number

[ Top ]

InsuranceFirmID

mixed InsuranceFirmID( )

[line 804]

Returns insurance company's id used in the encounter.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

InsuranceNr

mixed InsuranceNr( )

[line 795]

Returns insurance number used in the encounter.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

internResolveEncounterNr

boolean internResolveEncounterNr( [int $enc_nr = ''])

[line 287]

Resolves the encounter number internally.

If there is no encounter number passed as parameter to a method, the method will use the buffered current encounter number, else it returns FALSE.

Parameters:

int $enc_nr - Encounter number

[ Top ]

InWard

mixed InWard( int $enr, int $loc_nr)

[line 1328]

Checks if the encounter is finally admitted in a ward.

If the encounter is in the said ward location, its record primary key number will be returned, else FALSE.

Parameters:

int $enr - Encounter number
int $loc_nr - Ward number

[ Top ]

In_Dept

boolean In_Dept( )

[line 867]

Returns status flag if patient is finally admitted in department.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

In_Ward

boolean In_Ward( )

[line 858]

Returns status flag if patient is finally admitted in ward.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

isCurrentlyAdmitted

mixed isCurrentlyAdmitted( int $nr, [string $type = '_ENC'])

[line 1023]

Checks if an encounter number is currently admitted (both inpatient & outpatient).

Parameters:

int $nr - Encounter number
string $type - Type of param $nr (_ENC = encounter nr, _PID = pid nr) , defaults to _ENC = encounter nr.

[ Top ]

isENCCurrentlyAdmitted

mixed isENCCurrentlyAdmitted( int $nr)

[line 1053]

Checks if a given encounter number is currently admitted.

Parameters:

int $nr - Encounter number

[ Top ]

isPIDCurrentlyAdmitted

mixed isPIDCurrentlyAdmitted( int $nr)

[line 1044]

Checks if the person's is currently admitted based on his PID number.

Parameters:

int $nr - PID number

[ Top ]

Is_Discharged

boolean Is_Discharged( )

[line 876]

Returns status flag if patient is finally discharged.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

LastName

mixed LastName( )

[line 666]

Returns last or family name.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

loadEncounterData

boolean loadEncounterData( int $enc_nr)

[line 639]

Loads the encounter data including some data from the registration into an internal buffer array $encounter.

This method returns only TRUE (data loaded) or FALSE (data not loaded). The load success status can also be tested later by using the internal $is_loaded flag.

The individual data is to be fetched via the appropriate methods.

all keys as set in the $tabfields array
pid = the PID number of the patient
title = the patient title
name_last = last or family name
name_first = first or given name
date_birth = date of birth in yyyy-mm-format
sex = sex
addr_str = street name
addr_str_nr = street number (alphanumeric)
addr_zip = zip code
blood_group = blood group (A, B, AB, O)
photo_filename = filename of the stored ID photo
citytown_name = name of the city or town
death_date = date of death (in case deceased)

The content of the internal buffer $encounter array can also be fetched by the method getLoadedEncounterData()

Parameters:

int $enc_nr - Encounter number

[ Top ]

markAppointmentDone

boolean markAppointmentDone( [int $appt_nr = 0], [int $class_nr = 0], [int $enc_nr = 0])

[line 1976]

Marks an appointment's status as "done" and links the encounter number resulting from the appointment.

Parameters:

int $appt_nr - Appointment record number
int $class_nr - Final type of encounter (1= inpatient, 2= outpatient)
int $enc_nr - Encounter number that resulted from the appointment

[ Top ]

OutPatientsBasic

mixed OutPatientsBasic( [int $dept_nr = 0])

[line 2009]

Gets basic information of all outpatients.

The returned adodb object contains rows of arrays. Each array contains data with following index keys:

encounter_nr = the encounter number
pid = PID number
insurance_class_nr = insurance class number
title = person's title
name_last = person's last or family name
name_first = person's first or given name
date_birth = date of birth
sex = sex
photo_filename = filename of the stored picture ID
time = appointment's scheduled time
urgency = appointment's urgency level
LD_var = variable's name for the foreign language version of insurance class name
insurance_name = default insurance class name
notes = clinic's notes primary key number

Parameters:

int $dept_nr - Department number, if empty all departments will be searched

[ Top ]

PhotoFilename

mixed PhotoFilename( )

[line 1001]

Returns filename of the person's picture id.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

PID

mixed PID( )

[line 693]

Returns PID number.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

PostEncounterNotes

mixed PostEncounterNotes( )

[line 946]

Returns post encounter notes. Short notes after discharge, not to be used for discharge summary report.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RecordCreatorID

mixed RecordCreatorID( )

[line 992]

Returns record's creator id or name. Technical.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RecordHistory

mixed RecordHistory( )

[line 974]

Returns record entry's history. This is the techical history of the record entry, not of the admission.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RecordModifierID

mixed RecordModifierID( )

[line 983]

Returns record's modifier id or name. Technical.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RecordStatus

mixed RecordStatus( )

[line 965]

Returns the record entry's status. This status is technical and has nothing to do with the encounter status.

Status types:

empty char
normal
inactive
void
hidden
deleted

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

Referer

mixed Referer( )

[line 768]

Returns referer's name.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RefererDept

mixed RefererDept( )

[line 777]

Returns refererring department.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RefererDiagnosis

mixed RefererDiagnosis( )

[line 741]

Returns referer's diagnosis text.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RefererInstitution

mixed RefererInstitution( )

[line 786]

Returns referring institution.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RefererNotes

mixed RefererNotes( )

[line 759]

Returns referer's extra notes text.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

RefererRecomTherapy

mixed RefererRecomTherapy( )

[line 750]

Returns referer's recommended therapy text.

Use only after the encounter data was successfully loaded by the loadEncounterData() method.

Parameters:

[ Top ]

ReplaceWard

boolean ReplaceWard( int $enr, int $ward_nr)

[line 1687]

Replaces the current ward number and resets the in_ward flag to 0: status is "not in ward".

Parameters:

int $enr - Encounter number
int $ward_nr - New ward number

[ Top ]

ResetAllCurrentPlaces

boolean ResetAllCurrentPlaces( int $enr)

[line 1659]

Resets encounter's current locations to 0.

Resetted locations are:

current ward number
current room number
current departement number
current firm number
in ward flag

Parameters:

int $enr - Encounter nr

[ Top ]

resetCurrentDept

boolean resetCurrentDept( int $enr)

[line 1596]

Resets encounter's current department number to 0.

Parameters:

int $enr - Encounter nr

[ Top ]

resetCurrentWard

boolean resetCurrentWard( int $enr)

[line 1587]

Resets encounter's current ward number to 0.

Parameters:

int $enr - Encounter nr

[ Top ]

RoomServiceClass

mixed RoomServiceClass( int $enc_nr)

[line 360]

Gets the room service class information of an encounter based on encounter number.

The returned adodb record object contains an array with the data having the following index keys:

sc_room_class_nr = the financial class number of encounter
sc_room_start = the start date
sc_room_end = the end date
sc_room_nr = the service record's primary key number
sc_room_name = the service name
sc_room_code = the service code
sc_room_LD_var = the variable's name for language dependent name of the service

Parameters:

int $enc_nr - Encounter number

[ Top ]

saveAttDrServiceClass

boolean saveAttDrServiceClass( array &$val_array, int $enc_nr)

[line 467]

Saves the attending service class information of an encounter based on service type and encounter number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_att_dr_class_nr = the financial class number of encounter
sc_att_dr_start = the start date
sc_att_dr_end = the end date
sc_att_dr_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.
int $enc_nr - Encounter number

[ Top ]

saveCareServiceClass

boolean saveCareServiceClass( array &$val_array, int $enc_nr)

[line 431]

Saves the nursing care service class information of an encounter based on service type and encounter number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_care_class_nr = the financial class number of encounter
sc_care_start = the start date
sc_care_end = the end date
sc_care_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.
int $enc_nr - Encounter number

[ Top ]

saveDischargeNotesFromArray

boolean saveDischargeNotesFromArray( array &$data_array)

[line 1829]

Saves discharge notes of an encounter.

The data must be contained in an associative array and passed to the function by reference.

Parameters:

array &$data_array - Data to be saved

[ Top ]

saveRoomServiceClass

boolean saveRoomServiceClass( array &$val_array, int $enc_nr)

[line 449]

Saves the room service class information of an encounter based on service type and encounter number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_room_class_nr = the financial class number of encounter
sc_room_start = the start date
sc_room_end = the end date
sc_room_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.
int $enc_nr - Encounter number

[ Top ]

saveServiceClass

boolean saveServiceClass( string $type, array &$val_array, [int $enc_nr = ''])

[line 390]

Saves the service class information of an encounter based on service type and encounter number.

The service data must be packed in an associative array and passed by reference.

Parameters:

string $type - service class 'care', 'room', 'att_dr'
array &$val_array - Service data for saving. Associative. By reference.
int $enc_nr - Encounter number

[ Top ]

saveSicknessConfirm

boolean saveSicknessConfirm( array &$data)

[line 1935]

Saves a sickness confirmation of an encounter.

Parameters:

array &$data - Sickness confirmation data. By reference.

[ Top ]

searchEncounterBasicInfo

mixed searchEncounterBasicInfo( string $key, [string $sortitem = ''], [string $order = ''])

[line 1237]

Search returning the basic admission information as outlined at _searchAdmissionBasicInfo().

This method gives the possibility to sort the results based on an item and sorting direction.

Parameters:

string $key - Search keyword
string $sortitem - Item as sort basis
string $order - Sorting direction. ASC = ascending, DESC = descending, empty = ascending

[ Top ]

searchInpatientBasicInfo

mixed searchInpatientBasicInfo( str $key)

[line 1199]

Searches and returns inpatient admissions based on a supplied keyword.

See _searchAdmissionBasicInfo() for details of the resulting data structure.

Example usage:


1     $kw="Magellan";
2      if($result=$obj->searchInpatientBasicInfo($kw)){
3         echo $obj->LastRecordCount();  # Prints the number of resulting rows
4         while($admission=$result->FetchRow()){
5             echo $admission['name_last'];  # Prints the patient's name
6           ......
7         }
8      }

Parameters:

str $key - Search keyword

[ Top ]

searchInpatientNotInWardBasicInfo

mixed searchInpatientNotInWardBasicInfo( string $key)

[line 1278]

Search for inpatients who are not yet finally admittd in ward, returning basic information as outlined at _searchAdmissionBasicInfo().

The resulting data is usually listed on the "waiting list" modules.

Parameters:

string $key - Search keyword

[ Top ]

searchLimitEncounterBasicInfo

mixed searchLimitEncounterBasicInfo( string $key, int $len, int $so, [string $sortitem = ''], [string $order = 'ASC'])

[line 1264]

Limited results search returning basic information as outlined at _searchAdmissionBasicInfo().

This method gives the possibility to sort the results based on an item and sorting direction.

Parameters:

string $key - Search keyword
int $len - Maximum number of rows returned
int $so - Start index of rows returned
string $sortitem - Item as sort basis
string $order - Sorting direction. ASC = ascending, DESC = descending, empty = ascending

[ Top ]

searchOutpatientBasicInfo

mixed searchOutpatientBasicInfo( str $key)

[line 1224]

Searches and returns inpatient admissions based on a supplied keyword.

See _searchAdmissionBasicInfo() for details of the resulting data structure.

Example usage:


1     $kw="Jennifer";
2      if($result=$obj->searchOutpatientBasicInfo($kw)){
3         echo $obj->LastRecordCount();  # Prints the number of resulting rows
4         while($admission=$result->FetchRow()){
5             echo $admission['name_last'];  # Prints the patient's name
6           ......
7         }
8      }

Parameters:

str $key - Search keyword

[ Top ]

setAdmittedInWard

boolean setAdmittedInWard( int $enr, int $ward_nr, int $room_nr, int $bed_nr)

[line 1644]

Sets encounter's two status to "In ward" and "disallow cancel". Sets the current ward number and current room number.

Parameters:

int $enr - Encounter nr
int $ward_nr - Ward nr
int $room_nr - Room nr
int $bed_nr - Bed nr (reserved)

[ Top ]

setCoreTable

void setCoreTable( string $table)

[line 249]

Sets core's table name variable to a table name

Parameters:

string $table - Table name

[ Top ]

setCurrentAttdDr

boolean setCurrentAttdDr( int $enr, int $assign_nr)

[line 1578]

Sets encounter's current attending physician number.

Parameters:

int $enr - Encounter nr
int $assign_nr - Attending physician number

[ Top ]

setCurrentDept

boolean setCurrentDept( int $enr, int $assign_nr)

[line 1548]

Sets encounter's current department number.

Parameters:

int $enr - Encounter nr
int $assign_nr - New department number

[ Top ]

setCurrentDeptInDept

boolean setCurrentDeptInDept( int $enr, int $assign_nr)

[line 1558]

Sets encounter's current department number and sets the "currently in department" status of the encounter..

Parameters:

int $enr - Encounter nr
int $assign_nr - New department number

[ Top ]

setCurrentFirm

boolean setCurrentFirm( int $enr, int $assign_nr)

[line 1568]

Sets encounter's current firm number.

Parameters:

int $enr - Encounter nr
int $assign_nr - New firm number

[ Top ]

setCurrentRoom

boolean setCurrentRoom( int $enr, int $assign_nr)

[line 1538]

Sets encounter's current room number.

Parameters:

int $enr - Encounter nr
int $assign_nr - New room number

[ Top ]

setCurrentWard

boolean setCurrentWard( int $enr, int $assign_nr)

[line 1518]

Sets encounter's current ward number.

Parameters:

int $enr - Encounter nr
int $assign_nr - New ward number

[ Top ]

setCurrentWardInWard

boolean setCurrentWardInWard( int $enr, int $assign_nr)

[line 1528]

Sets encounter's current ward number and set the "currently in ward" status of the encounter.

Parameters:

int $enr - Encounter nr
int $assign_nr - New ward number

[ Top ]

setEncoder

void setEncoder( [string $encoder = ''])

[line 228]

Sets internal encoder buffer to current encoder's name

Parameters:

string $encoder - encoder's name

[ Top ]

setEncounterNr

void setEncounterNr( [int $enc_nr = ''])

[line 221]

Sets internal encounter number buffer to current encounter number

Parameters:

int $enc_nr - Encounter number

[ Top ]

setGetEntireRecord

void setGetEntireRecord( [boolean $bool = FALSE])

[line 242]

Sets internal entire record flag to current record status

Parameters:

boolean $bool - Entire record status

[ Top ]

setHistorySeen

boolean setHistorySeen( [string $encoder = ''], [int $enc_nr = ''])

[line 1063]

Adds a "View" note to the record's history data.

Parameters:

string $encoder - Name of person viewing the data
int $enc_nr - Encounter number

[ Top ]

setIgnoreStatus

void setIgnoreStatus( [boolean $bool = FALSE])

[line 235]

Sets internal ignore status flag to current ignore status

Parameters:

boolean $bool - Ignore status

[ Top ]

setInDept

boolean setInDept( int $enr)

[line 1623]

Sets encounter's current "department" status to "In department". Sets the encounter to "disallow cancel".

Parameters:

int $enr - Encounter nr

[ Top ]

setInWard

boolean setInWard( int $enr)

[line 1605]

Sets encounter's current "ward" status to "In ward". Sets the encounter to "disallow cancel".

Parameters:

int $enr - Encounter nr

[ Top ]

setIsDischarged

boolean setIsDischarged( int $enr, string $date, string $time)

[line 1699]

Sets the discharge status that the encounter/admission is fully discharged.

Sets the is_discharged field of care_encounter table and resets the current department,ward,room fields.

Parameters:

int $enr - Encounter number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

setNotInDept

boolean setNotInDept( int $enr)

[line 1632]

Resets encounter's current "department" status to "not in department".

Parameters:

int $enr - Encounter nr

[ Top ]

setNotInWard

boolean setNotInWard( int $enr)

[line 1614]

Resets encounter's current "ward" status to "not in ward".

Parameters:

int $enr - Encounter nr

[ Top ]

setSingleResult

void setSingleResult( [boolean $bool = FALSE])

[line 256]

Sets internal single result flag to current single result status

Parameters:

boolean $bool - Single result status

[ Top ]

updateAttDrServiceClass

boolean updateAttDrServiceClass( array &$val_array, int $nr)

[line 542]

Updates the room service class information of an encounter based on service type and record's primary key number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_att_dr_nr = the record's primary key number
sc_att_dr_class_nr = the financial class number of encounter
sc_att_dr_start = the start date
sc_att_dr_end = the end date
sc_att_dr_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.
int $nr - Record's primary key number. (reserved)

[ Top ]

updateCareServiceClass

boolean updateCareServiceClass( array &$val_array)

[line 502]

Updates the nursing care service class information of an encounter based on service type and record's primary key number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_care_nr = the record's primary key number
sc_care_class_nr = the financial class number of encounter
sc_care_start = the start date
sc_care_end = the end date
sc_care_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.

[ Top ]

updateEncounterFromInternalArray

void updateEncounterFromInternalArray( [int $item_nr = ''])

[line 1011]

Updates the encounter record with data from the internal buffer array.

Parameters:

int $item_nr - Encounter number returns boolean

[ Top ]

updateRoomServiceClass

boolean updateRoomServiceClass( array &$val_array, int $nr)

[line 522]

Updates the room service class information of an encounter based on service type and record's primary key number.

The service data must be packed in an associative array and passed by reference. The data must have the following index keys:

sc_room_nr = the record's primary key number
sc_room_class_nr = the financial class number of encounter
sc_room_start = the start date
sc_room_end = the end date
sc_room_encoder = the user name

Parameters:

array &$val_array - Service data for saving. Associative. By reference.
int $nr - Record's primary key number. (reserved)

[ Top ]

updateServiceClass

boolean updateServiceClass( string $type, array &$val_array)

[line 478]

Update the service class information of an encounter based on service type record's primary key number.

The service data must be packed in an associative array and passed by reference.

Parameters:

string $type - service class 'care', 'room', 'att_dr'
array &$val_array - Service data for saving. Associative. By reference.

[ Top ]

useSicknessConfirm

void useSicknessConfirm( )

[line 1873]

Points the core to the care_encounter_sickconfirm table and fields

Parameters:

[ Top ]

_discharge

boolean _discharge( int $enr, int $loc_types, int $d_type_nr, [string $date = ''], [string $time = ''])

[line 1735]

Complete discharge or encounter.

Avoid using this function directly. Use the appropriate methods

Parameters:

int $enr - Encounter number
int $loc_types - Location type number (ward number or department number)
int $d_type_nr - Discharge type number
string $date - Date of discharge
string $time - Time of discharge

[ Top ]

_InLocation

mixed _InLocation( int $type_nr)

[line 1311]

Checks if the encounter is in a location based on the location's type number.

If the encounter is in the said location, its record primary key number will be returned, else FALSE. This method uses the internaly buffered encounter number. The number must be set first before using this method either with setEncounterNr() or by directly assigning to the $enc_nr variable .

Parameters:

int $type_nr - Encounter number

[ Top ]

_searchAdmissionBasicInfo

mixed _searchAdmissionBasicInfo( string $key, [int $enc_class = 0], [string $add_opt = ''], [boolean $limit = FALSE], [int $len = 30], [int $so = 0])

[line 1147]

Private search function, usually called by another method.

The resulting count can be fetched with the LastRecordCount() method.

The returned adodb object contains rows of arrays. Each array contains "basic" admission data with following index keys:

encounter_nr = encounter number
encounter_class_nr = encounter class number: 1 = inpatient, 2 = outpatient
pid = the patient's PID number
name_last = last or family name
name_first = first or given name
date_birth = date of birth in yyyy-mm-dd format
addr_zip = zip code
blood_group = patient's blood group

Parameters:

string $key - Search keyword
int $enc_class - Encounter class number. default = 0
string $add_opt - Optional addtion to WHERE clause like e.g. for sorting
boolean $limit - Flag whether the select query is limited or not, default FALSE = unlimited
int $len - Maximum number or rows returned in case of limited select, default = 30 rows
int $so - Start index offset in case of limited select, default 0 = start

[ Top ]

_setCurrentAssignment

boolean _setCurrentAssignment( int $enr, [string $data = ''], [string $act = 'Modified'])

[line 1504]

Updates location assignment items. Generic method for setting location assigment information.

Parameters:

int $enr - Encounter nr
string $data - Data for updating, formatted in sql syntax
string $act - Modification action for appeding to the record's history, defaults to "modified"

[ Top ]

_setLocation

boolean _setLocation( [int $enr = 0], [int $type_nr = 0], [int $loc_nr = 0], int $group_nr, [string $date = ''], [string $time = ''])

[line 1387]

Saves the encounter location with a given location type, location group and location number.

Parameters:

int $enr - Encounter number
int $type_nr - Location type number
int $loc_nr - Location number
int $group_nr - Location group number
string $date - Date
string $time - Time

[ Top ]

Class: Encounter

Class Overview [line 17]

Author(s):

Version:

Copyright:

Variables

Methods

Child classes:

Inherited Variables

Class: Notes

Class: Core

Inherited Methods

Class: Notes

Class: Core

Class Details

Tags:

Class Variables

$date =

$encoder =

$encounter =

$enc_nr =

$entire_record = FALSE

$fld_sickconfirm = array( 'nr', 'encounter_nr', 'date_confirm', 'date_start', 'date_end', 'date_create', 'diagnosis', 'dept_nr', 'insurance_co_nr', 'insurance_co_sub', 'status', 'history', 'modify_id', 'modify_time', 'create_id', 'create_time')

$group_nr =

$ignore_status = FALSE

$is_loaded = FALSE

$loc_nr =

$record_count =

$single_result = FALSE

$tb_appt = 'care_appointment'

$tb_citytown = 'care_address_citytown'

$tb_dept = 'care_department'

$tb_dis_type = 'care_type_discharge'

$tb_ec = 'care_class_encounter'

$tb_enc = 'care_encounter'

$tb_enc_fc = 'care_encounter_financial_class'

$tb_fc = 'care_class_financial'

$tb_ic = 'care_class_insurance'

$tb_insco = 'care_insurance_firm'

$tb_location = 'care_encounter_location'

$tb_person = 'care_person'

$tb_sickconfirm = 'care_encounter_sickconfirm'

$time =

$type_nr =

Class Methods

Encounter

Parameters:

AdmitInWard

Tags:

Parameters:

AllAttDrServiceClassesObject

Tags:

Parameters:

AllCareServiceClassesObject

Tags:

Parameters:

AllEncounterClassesObject

Tags:

Parameters:

AllRoomServiceClassesObject

Tags:

Parameters:

allSicknessConfirm

Tags:

Parameters:

AllStatus

Tags:

Parameters:

assignInBed

Tags:

Parameters:

assignInDept

Tags:

Parameters:

assignInRoom

Tags:

Parameters:

assignInWard

Tags:

Parameters:

$fld_sickconfirm = array(
'nr',
'encounter_nr',
'date_confirm',
'date_start',
'date_end',
'date_create',
'diagnosis',
'dept_nr',
'insurance_co_nr',
'insurance_co_sub',
'status',
'history',
'modify_id',
'modify_time',
'create_id',
'create_time')