index

Package gb_medical

Common Business interface for the MEDICAL API (gb_medical).
 
The Medical API establishes information about the person's medical condition or physical impairment.
Before medical information can be created, biological information must exist for the person.
 
HR Application Security is invoked when performing query, create, delete, and update operations. To query, create, delete, or update medical information, you must have access to the Employee Class, the employee Home Organization, the employee's jobs Employer Code, and the employee's maximum jobs salary level. Access to these fields is defined by the user ID in the Banner HR security tables. If access is not granted, a query on the medical information will result in no data being found, and the user will not be able to update or delete any records.

Program units
f_api_version   Returns the API version number.
f_exists   Checks to see if a record exists.
f_isequal   Compares two records for equality.
f_query_all   Selects all records for the entity.
f_query_one   Selects one record using key.
f_query_by_rowid   Selects one record using ROWID.
f_query_one_lock   Selects one record and locks it.
p_create   Creates a record.
p_delete   Deletes a record.
p_lock   Locks a record.
p_update   Updates a record.

Types
medical_rec   Business Entity record type
medical_ref   Entity cursor variable type
medical_tab   Entity table type

Constants
M_ENTITY_NAME   Business Entity Name

M_ENTITY_NAME 

M_ENTITY_NAME    CONSTANT VARCHAR2(7) := 'MEDICAL';

Business Entity Name

medical_rec 

TYPE medical_rec IS RECORD (
  r_pidm                    sprmedi.sprmedi_pidm%TYPE,
  r_medi_code               sprmedi.sprmedi_medi_code%TYPE,
  r_mdeq_code               sprmedi.sprmedi_mdeq_code%TYPE,
  r_comment                 sprmedi.sprmedi_comment%TYPE,
  r_disa_code               sprmedi.sprmedi_disa_code%TYPE,
  r_spsr_code               sprmedi.sprmedi_spsr_code%TYPE,
  r_onset_age               sprmedi.sprmedi_onset_age%TYPE,
  r_disb_ind                sprmedi.sprmedi_disb_ind%TYPE,
  r_user_id                 sprmedi.sprmedi_user_id%TYPE,
  r_medi_code_date          sprmedi.sprmedi_medi_code_date%TYPE,
  r_data_origin             sprmedi.sprmedi_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type

medical_ref 

TYPE medical_ref IS REF CURSOR RETURN medical_rec;

Entity cursor variable type

medical_tab 

TYPE medical_tab IS TABLE OF medical_rec INDEX BY BINARY_INTEGER;

Entity table type

f_api_version 

FUNCTION f_api_version RETURN PLS_INTEGER

Returns the API version number.

Returns
Version of the API signature. Changes only when the signature changes.

f_exists 

FUNCTION f_exists(p_pidm      sprmedi.sprmedi_pidm%TYPE,
                  p_medi_code sprmedi.sprmedi_medi_code%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks to see if a record exists.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
Y if found, otherwise N.

f_isequal 

FUNCTION f_isequal(rec_one medical_rec,
                   rec_two medical_rec) RETURN VARCHAR2

Compares two records for equality.
Tests each field of rec_one against the corresponding field of rec_two. Two null values are considered equal.

Parameters
rec_one   The first record to compare. Type medical_rec Required
rec_two   The second record to compare. Type medical_rec Required

Returns
Y if all values in records are equal, otherwise N. Nulls match Nulls.

f_query_all 

FUNCTION f_query_all(p_pidm      sprmedi.sprmedi_pidm%TYPE,
                     p_medi_code sprmedi.sprmedi_medi_code%TYPE DEFAULT NULL)
  RETURN medical_ref

Selects all records for the entity.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key

Returns
A cursor variable that will fetch the set of records.

f_query_one 

FUNCTION f_query_one(p_pidm      sprmedi.sprmedi_pidm%TYPE,
                     p_medi_code sprmedi.sprmedi_medi_code%TYPE)
  RETURN medical_ref

Selects one record using key.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key

Returns
A cursor variable that will fetch exactly one record.

f_query_by_rowid 

FUNCTION f_query_by_rowid(p_rowid gb_common.internal_record_id_type)
  RETURN medical_ref

Selects one record using ROWID.

Parameters
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18) Required

Returns
A cursor variable that will fetch exactly one record.

f_query_one_lock 

FUNCTION f_query_one_lock(p_pidm      sprmedi.sprmedi_pidm%TYPE,
                          p_medi_code sprmedi.sprmedi_medi_code%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN medical_ref

Selects one record and locks it.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be selected. VARCHAR2(18)

Returns
A cursor variable for one record, locking the record.

p_create 

PROCEDURE p_create(p_pidm           sprmedi.sprmedi_pidm%TYPE,
                   p_medi_code      sprmedi.sprmedi_medi_code%TYPE,
                   p_mdeq_code      sprmedi.sprmedi_mdeq_code%TYPE DEFAULT NULL,
                   p_comment        sprmedi.sprmedi_comment%TYPE DEFAULT NULL,
                   p_disa_code      sprmedi.sprmedi_disa_code%TYPE DEFAULT NULL,
                   p_spsr_code      sprmedi.sprmedi_spsr_code%TYPE DEFAULT NULL,
                   p_onset_age      sprmedi.sprmedi_onset_age%TYPE DEFAULT NULL,
                   p_disb_ind       sprmedi.sprmedi_disb_ind%TYPE,
                   p_user_id        sprmedi.sprmedi_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_medi_code_date sprmedi.sprmedi_medi_code_date%TYPE DEFAULT NULL,
                   p_data_origin    sprmedi.sprmedi_data_origin%TYPE DEFAULT NULL,
                   p_rowid_out      OUT gb_common.internal_record_id_type)

Creates a record.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_mdeq_code   The medical equipment code representing what equipment is necessary to respond to the person's medical condition or physical impairment.* The code must be previously defined on the Medical Equipment Code Validation table. VARCHAR2(3)
p_comment   Freeform comment related to the person's medical condition or physical impairment. VARCHAR2(4000)
p_disa_code   The disability type code representing the nature of the person's medical condition or physical impairment. The code must be previously defined on the Disability Type Code Validation table. VARCHAR2(2)
p_spsr_code   The disability service code representing services available to the person. The code must be previously defined on the Disability Service Validation table. VARCHAR2(2)
p_onset_age   The age at which the person developed medical condition or physical impairment. NUMBER(2)
p_disb_ind   Indicates if the person's medical condition or physical impairment is their primary disability. Only one primary disability is allowed per person. VARCHAR2(1)
p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30)
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_medi_code_date   The date associated with the Medical Code. DATE
p_rowid_out   Database ROWID of the record to be created. VARCHAR2(18) Required

p_delete 

PROCEDURE p_delete(p_pidm      sprmedi.sprmedi_pidm%TYPE,
                   p_medi_code sprmedi.sprmedi_medi_code%TYPE,
                   p_rowid     gb_common.internal_record_id_type DEFAULT NULL)

Deletes a record.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_rowid   Database ROWID of the record to be deleted. VARCHAR2(18)

p_lock 

PROCEDURE p_lock(p_pidm        sprmedi.sprmedi_pidm%TYPE,
                 p_medi_code   sprmedi.sprmedi_medi_code%TYPE,
                 p_rowid_inout IN OUT gb_common.internal_record_id_type)

Locks a record.
If ROWID is not passed in, the record is located using the key values and the ROWID of the locked row is passed in p_rowid_inout

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_rowid_inout   Database ROWID of the record to be locked. VARCHAR2(18) Required

p_update 

PROCEDURE p_update(p_pidm           sprmedi.sprmedi_pidm%TYPE,
                   p_medi_code      sprmedi.sprmedi_medi_code%TYPE,
                   p_mdeq_code      sprmedi.sprmedi_mdeq_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment        sprmedi.sprmedi_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_disa_code      sprmedi.sprmedi_disa_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_spsr_code      sprmedi.sprmedi_spsr_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_onset_age      sprmedi.sprmedi_onset_age%TYPE DEFAULT dml_common.f_unspecified_number,
                   p_disb_ind       sprmedi.sprmedi_disb_ind%TYPE,
                   p_user_id        sprmedi.sprmedi_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_medi_code_date sprmedi.sprmedi_medi_code_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_data_origin    sprmedi.sprmedi_data_origin%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_rowid          gb_common.internal_record_id_type DEFAULT NULL)

Updates a record.

Parameters
p_pidm   Internal identification number. NUMBER(8) Required Key
p_medi_code   The medical code representing the person's medical condition or physical impairment. The code must be previously defined on the Medical Code Validation table. VARCHAR2(10) Required Key
p_mdeq_code   The medical equipment code representing what equipment is necessary to respond to the person's medical condition or physical impairment. The code must be previously defined on the Medical Equipment Code Validation table. VARCHAR2(3)
p_comment   Freeform comment related to the person's medical condition or physical impairment. VARCHAR2(4000)
p_disa_code   The disability type code representing the nature of the person's medical condition or physical impairment. The code must be previously defined on the Disability Type Code Validation table. VARCHAR2(2)
p_spsr_code   The disability service code representing services available to the person. The code must be previously defined on the Disability Service Validation table. VARCHAR2(2)
p_onset_age   The age at which the person developed medical condition or physical impairment. NUMBER(2)
p_disb_ind   Indicates if the person's medical condition or physical impairment is their primary disability. Only one primary disability is allowed per person. VARCHAR2(1)
p_user_id   The Oracle ID of the user who changed the record. VARCHAR2(30)
p_medi_code_date   The date associated with the Medical Code. DATE
p_data_origin   Source system that created or updated the row. VARCHAR2(30)
p_rowid   Database ROWID of the record to be updated. VARCHAR2(18)