PHP Class OEModule\PatientTicketing\components\PatientTicketing_API

Inheritance: extends BaseAPI
Show file Open project: openeyes/openeyes

Public Properties

Property Type Description
$QUEUESETCATEGORY_SERVICE
$QUEUE_ASSIGNMENT_WIDGET
$TICKET_SERVICE
$TICKET_SUMMARY_WIDGET

Public Methods

Method Description
canAddPatientToQueue ( Patient $patient, Queue $queue ) : mixed
createTicketForEvent ( Event $event, Queue $initial_queue, CWebUser $user, Firm $firm, $data ) : Ticket
createTicketForPatient ( Patient $patient, Queue $initial_queue, CWebUser $user, Firm $firm, $data ) : Ticket
extractQueueData ( Queue $queue, $data, boolean $validate = false ) : array Filters and purifies passed array to get data relevant to a ticket queue assignment.
getFollowUp ( $ticket_id ) : array | boolean Returns a followup value from a patient ticket if present.
getFollowUpFromAutoSave ( $patient_id, $current_queue_id )
getInitialQueues ( Firm $firm ) : Queue[] Returns the initial queues a patient ticket can be created against.
getLatestFollowUp ( $patient ) : array | boolean Returns the most recent followup value for a patient.
getMenuItems ( $position = 1 )
getQueueAssignmentFormURI ( ) : string Simple function to standardise access to the retrieving the Queue Assignment Form.
getQueueForUserAndFirm ( CWebUser $user, Firm $firm, integer $id ) Verifies that the provided queue id is an id for a Queue that the User can add to as the given Firm At the moment, no verification takes place beyond the fact that the id is valid and active.
getQueueSetList ( Firm $firm, Patient $patient = null ) : mixed Returns the Queue Sets a patient ticket can be created in for the given firm.
getTicketForEvent ( $event ) : mixed
updateTicketForEvent ( Event $event ) *

Method Details

canAddPatientToQueue() public method

public canAddPatientToQueue ( Patient $patient, Queue $queue ) : mixed
$patient Patient
$queue OEModule\PatientTicketing\models\Queue
return mixed

createTicketForEvent() public method

public createTicketForEvent ( Event $event, Queue $initial_queue, CWebUser $user, Firm $firm, $data ) : Ticket
$event Event
$initial_queue OEModule\PatientTicketing\models\Queue
$user CWebUser
$firm Firm
$data
return OEModule\PatientTicketing\models\Ticket

createTicketForPatient() public method

public createTicketForPatient ( Patient $patient, Queue $initial_queue, CWebUser $user, Firm $firm, $data ) : Ticket
$patient Patient
$initial_queue OEModule\PatientTicketing\models\Queue
$user CWebUser
$firm Firm
$data
return OEModule\PatientTicketing\models\Ticket

extractQueueData() public method

Filters and purifies passed array to get data relevant to a ticket queue assignment.
public extractQueueData ( Queue $queue, $data, boolean $validate = false ) : array
$queue OEModule\PatientTicketing\models\Queue
$data
$validate boolean
return array

getFollowUp() public method

Returns a followup value from a patient ticket if present.
public getFollowUp ( $ticket_id ) : array | boolean
$ticket_id
return array | boolean followup value or false if not present

getFollowUpFromAutoSave() public method

public getFollowUpFromAutoSave ( $patient_id, $current_queue_id )

getInitialQueues() public method

Returns the initial queues a patient ticket can be created against.
public getInitialQueues ( Firm $firm ) : Queue[]
$firm Firm
return OEModule\PatientTicketing\models\Queue[]

getLatestFollowUp() public method

Returns the most recent followup value for a patient.
public getLatestFollowUp ( $patient ) : array | boolean
$patient
return array | boolean followup value or false if not present

getMenuItems() public method

public getMenuItems ( $position = 1 )

getQueueAssignmentFormURI() public method

Simple function to standardise access to the retrieving the Queue Assignment Form.
public getQueueAssignmentFormURI ( ) : string
return string

getQueueForUserAndFirm() public method

Verifies that the provided queue id is an id for a Queue that the User can add to as the given Firm At the moment, no verification takes place beyond the fact that the id is valid and active.
public getQueueForUserAndFirm ( CWebUser $user, Firm $firm, integer $id )
$user CWebUser
$firm Firm
$id integer

getQueueSetList() public method

(Note: firm filtering is not currently implemented).
public getQueueSetList ( Firm $firm, Patient $patient = null ) : mixed
$firm Firm
$patient Patient
return mixed

getTicketForEvent() public method

public getTicketForEvent ( $event ) : mixed
$event
return mixed

updateTicketForEvent() public method

*
public updateTicketForEvent ( Event $event )
$event Event

Property Details

$QUEUESETCATEGORY_SERVICE public static property

public static $QUEUESETCATEGORY_SERVICE

$QUEUE_ASSIGNMENT_WIDGET public static property

public static $QUEUE_ASSIGNMENT_WIDGET

$TICKET_SERVICE public static property

public static $TICKET_SERVICE

$TICKET_SUMMARY_WIDGET public static property

public static $TICKET_SUMMARY_WIDGET