MPIF001 ICR (2701)

Name

Value

NUMBER

2701

IA #

2701

DATE CREATED

1999/01/12

CUSTODIAL PACKAGE

MASTER PATIENT INDEX VISTA

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

MPIF001

NAME

MPIF001

GENERAL DESCRIPTION

Function APIs to return values on the MPI node in the
Patient file.  This DBIA documents some entry points for accessing the MPI
node in the Patient file for use by the CIRN developers and others that may
need this data.

STATUS

Active

MPIF001

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$GETICN

$$GETICN^MPIF001(DFN)  This function returns the ICN,
including checksum for a given DFN or -1^error message.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN - IEN of patient in Patient file (#2)

$$GETDFN

$$GETDFN^MPIF001(ICN)  This function returns the IEN
of the patient in the Patient file for a given ICN or -1^error message.

VARIABLES	TYPE	VARIABLES DESCRIPTION
ICN	Input	ICN - Integration Control Number (ICN) (not including checksum) for a given patient in the Patient file (#2).

$$CMOR2

$$CMOR2^MPIF001(DFN)  This function returns the CMOR
Site Name for a given DFN or -1^error message.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN - IEN of patient in Patient file (#2).

$$CMORNAME

$$CMORNAME^MPIF001(CIEN)  This function returns CMOR
Site Name for a given Institution IEN or -1^error message.

VARIABLES	TYPE	VARIABLES DESCRIPTION
CIEN	Input	CIEN - IEN for entry in Institution file (#4).

$$GETVCCI

$$GETVCCI^MPIF001(DFN)  This function returns CMOR
Station Number for a given DFN or -1^error message.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN - IEN of patient in Patient file (#2).

$$IFLOCAL

$$IFLOCAL^MPIF001(DFN)  This function is used to see
if a patient has a Local ICN. Returning:  1 = patient has a Local ICN.  0 =
patient does not exist, DFN is not defined or no MPI node OR Patient doesn't
have a local ICN.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN - IEN of patient in Patient file (#2).

$$IFVCCI

$$IFVCCI^MPIF001(DFN)  This function returns 1 if
your facility is the CMOR for the given patient.  Returning: 1 = your site is
the CMOR. -1 = your site is NOT the CMOR.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN - IEN of patient in Patient file (#2).

$$HL7CMOR

$$HL7CMOR^MPIF001(DFN,SEP)  This function returns the
CMOR Station Number and Institution Name for a given patient.  Returns:
Station Number <sep> Institution Name or -1^error message.  SEP defaults to ^
if not defined.

VARIABLES	TYPE	VARIABLES DESCRIPTION
DFN	Input	DFN = IEN for patient in Patient file (#2).
SEP	Input	SEP = delimeter to separate station number and name. Not required. Defaults to ^ if not provided.

GETICN

See $$GETICN