Package gb_immunization

Common Business interface for the IMMUNIZATION API (gb_immunization).

The Immunization API establishes information regarding a person's immunization history.

Program units

f_api_version	Returns the API version number.
f_exists	Checks 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

immunization_rec	Business Entity record type.
immunization_ref	Entity cursor variable type.
immunization_tab	Entity table type.

Constants

M_ENTITY_NAME	Business Entity Name.
M_BASE_TABLE_NAME	Base table name.

M_ENTITY_NAME

M_ENTITY_NAME        CONSTANT VARCHAR2(12) := 'IMMUNIZATION';

Business Entity Name.

M_BASE_TABLE_NAME

M_BASE_TABLE_NAME    CONSTANT VARCHAR2(7) := 'GORIMMU';

Base table name.

immunization_rec

TYPE immunization_rec IS RECORD (
  r_pidm                    gorimmu.gorimmu_pidm%TYPE,
  r_immu_code               gorimmu.gorimmu_immu_code%TYPE,
  r_seq_no                  gorimmu.gorimmu_seq_no%TYPE,
  r_user_id                 gorimmu.gorimmu_user_id%TYPE,
  r_immu_date               gorimmu.gorimmu_immu_date%TYPE,
  r_imst_code               gorimmu.gorimmu_imst_code%TYPE,
  r_comment                 gorimmu.gorimmu_comment%TYPE,
  r_data_origin             gorimmu.gorimmu_data_origin%TYPE,
  r_internal_record_id      gb_common.internal_record_id_type);

Business Entity record type.

immunization_ref

TYPE immunization_ref IS REF CURSOR RETURN immunization_rec;

Entity cursor variable type.

immunization_tab

TYPE immunization_tab IS TABLE OF immunization_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      gorimmu.gorimmu_pidm%TYPE,
                  p_immu_code gorimmu.gorimmu_immu_code%TYPE,
                  p_seq_no    gorimmu.gorimmu_seq_no%TYPE,
                  p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN VARCHAR2

Checks if a record exists.

Parameters

	p_pidm	Internal Identification number. NUMBER(8) Required Key.
	p_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) 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 immunization_rec,
                   rec_two immunization_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 immunization_rec Required.
	rec_two	The second record to compare. Type immunization_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      gorimmu.gorimmu_pidm%TYPE,
                     p_immu_code gorimmu.gorimmu_immu_code%TYPE,
                     p_seq_no    gorimmu.gorimmu_seq_no%TYPE)
  RETURN immunization_ref

Selects all records for the entity.

Parameters

	p_pidm	Internal Identification number. NUMBER(8) Required Key.
	p_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) Required Key.

Returns

A cursor variable that will fetch a set of records.

f_query_one

FUNCTION f_query_one(p_pidm      gorimmu.gorimmu_pidm%TYPE,
                     p_immu_code gorimmu.gorimmu_immu_code%TYPE,
                     p_seq_no    gorimmu.gorimmu_seq_no%TYPE)
  RETURN immunization_ref

Selects one record using key.

Parameters

	p_pidm	Internal Identification number. NUMBER(8) Required Key.
	p_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) 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 immunization_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      gorimmu.gorimmu_pidm%TYPE,
                          p_immu_code gorimmu.gorimmu_immu_code%TYPE,
                          p_seq_no    gorimmu.gorimmu_seq_no%TYPE,
                          p_rowid     gb_common.internal_record_id_type DEFAULT NULL)
  RETURN immunization_ref

Selects one record and locks it.

Parameters

	p_pidm	Internal Identification number. NUMBER(8) Required Key.
	p_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) 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        gorimmu.gorimmu_pidm%TYPE,
                   p_immu_code   gorimmu.gorimmu_immu_code%TYPE,
                   p_seq_no      gorimmu.gorimmu_seq_no%TYPE,
                   p_user_id     gorimmu.gorimmu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_immu_date   gorimmu.gorimmu_immu_date%TYPE DEFAULT NULL,
                   p_imst_code   gorimmu.gorimmu_imst_code%TYPE DEFAULT NULL,
                   p_comment     gorimmu.gorimmu_comment%TYPE DEFAULT NULL,
                   p_data_origin gorimmu.gorimmu_data_origin%TYPE DEFAULT NULL,
                   p_seq_no_out  OUT gorimmu.gorimmu_seq_no%TYPE,
                   p_rowid_out   OUT gb_common.internal_record_id_type)

Creates a record.

Parameters

	p_pidm	Internal Identification number. NUMBER(8) Required Key.
	p_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) Required Key.
	p_user_id	User ID of the person who created or last updated this record. VARCHAR2(30) Required.
	p_immu_date	Date of immunization. DATE.
	p_imst_code	Gtvimst status code. VARCHAR2(2).
	p_comment	Immunization Comment. VARCHAR2(4000).
	p_data_origin	Source system that generated the data. VARCHAR2(30).
	p_rowid_out	Database ROWID of the record to be created. VARCHAR2(18) Required.

p_delete

PROCEDURE p_delete(p_pidm      gorimmu.gorimmu_pidm%TYPE,
                   p_immu_code gorimmu.gorimmu_immu_code%TYPE,
                   p_seq_no    gorimmu.gorimmu_seq_no%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_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) Required Key.
	p_rowid	Database ROWID of the record to be deleted. VARCHAR2(18).

p_lock

PROCEDURE p_lock(p_pidm        gorimmu.gorimmu_pidm%TYPE,
                 p_immu_code   gorimmu.gorimmu_immu_code%TYPE,
                 p_seq_no      gorimmu.gorimmu_seq_no%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_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) Required Key.
	p_rowid_inout	Database ROWID of the record to be locked. VARCHAR2(18) Required.

p_update

PROCEDURE p_update(p_pidm        gorimmu.gorimmu_pidm%TYPE,
                   p_immu_code   gorimmu.gorimmu_immu_code%TYPE,
                   p_seq_no      gorimmu.gorimmu_seq_no%TYPE,
                   p_user_id     gorimmu.gorimmu_user_id%TYPE DEFAULT gb_common.f_sct_user,
                   p_immu_date   gorimmu.gorimmu_immu_date%TYPE DEFAULT dml_common.f_unspecified_date,
                   p_imst_code   gorimmu.gorimmu_imst_code%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_comment     gorimmu.gorimmu_comment%TYPE DEFAULT dml_common.f_unspecified_string,
                   p_data_origin gorimmu.gorimmu_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_immu_code	Gtvimmu Immunization Code. VARCHAR2(10) Required Key.
	p_seq_no	Gtvimmu code innoculation sequence number. NUMBER(2) Required Key.
	p_user_id	User ID of the person who created or last updated this record. VARCHAR2(30) Required.
	p_immu_date	Date of immunization. DATE.
	p_imst_code	Gtvimst status code. VARCHAR2(2).
	p_comment	Immunization Comment. VARCHAR2(4000).
	p_data_origin	Source system that generated the data. VARCHAR2(30).
	p_rowid	Database ROWID of the record to be updated. VARCHAR2(18).