Print Page as PDF
IMMUNIZATION APIS ICR (6387)

IMMUNIZATION APIS    ICR (6387)

Name Value
NUMBER 6387
IA # 6387
DATE CREATED 2016/03/08
CUSTODIAL PACKAGE PCE PATIENT CARE ENCOUNTER
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE PXAPIIM
NAME IMMUNIZATION APIS
STATUS Active
KEYWORDS
  • PCE
  • IMMUNIZATION
  • STATUS
  • VIMM
DURATION Till Otherwise Agreed
ID PXAPIIM
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$IMMSTAT
Returns the current immunization status.
A: Active
H: Inactive, but Selectable for Historic
I: Inactive
VARIABLES TYPE VARIABLES DESCRIPTION
PXIMM Input
(required) Pointer to IMMUNIZATION file #9999999.14.
HIST
Return patient's immunization or skin test history
for a given list of immunizations or skin tests.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULTS Output
Returns an array as follows.

For Immunizations:

RESULT(n)=Immunization Name ^ Date Administered ^ Series ^ Facility

For Skin Tests:

RESULTS(n)=Skin Test Name ^ Date Admin ^ Date Read ^ Reading ^ Result ^
Facility
TYPE Input
"SK": for Skin Tests; "IM": For Immunizations.
IENLIST Input
Array of IENs from the Immunization/Skin Test file
(passed by reference). Format: IENLIST(IEN)="".
DFN Input
Patient (#2) IEN.
SORT Input
Sort order.  1: Most recent first; 0: Oldest first.
IMMGRP
Returns a list of immunizations that share the same
CVX code and Vaccine Group Name(s) as IMM, as well as Contraindications that
are limited to IMM.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Output
Returns an array as follows:

RESULT("CVX",CVX_CODE,IMM_IEN) = Immunization Name

RESULT("VG",GROUP_NAME,IMM_IEN) = Immunization Name

RESULT("ICR",CONTRA_VARIEN) = Contraindication Name
IMM Input
(Required) Pointer to IMMUNIZATION file #9999999.14.
READENT
Find most recent immunization admin for vaccine that
requires reading.  Only return if there is no reading entered previously.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Output
Returns an array as follows:

RESULT(1)=V Immunization IEN ^ Immunization Name ^ Immunization admin
date/time
DFN Input
(required) Pointer to the PATIENT file #2.
READVALS
Returns data type for reading fields.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULTS Output
Returns an array. The "RANGE" subscript is the range
for the V Immunization, Reading (#1402) field. The other subscripts are the
set of codes values for the RESULTS (#1401) field.

RESULTS("RANGE")=Minimum:Maximum:Maximum decimals
RESULTS(Code)=Value
CVXTOIEN
Return an Immunization IEN for a given CVX code.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Output
Returns a string in the following format:

Immunization IEN ^ Name ^ Status  (1: Active; 0: Inactive) ^ Selectable for
Historic
CVX Input
(Required) The CVX Code.
PATICR
Finds all of a patient's contraindications/refusals
using the following criteria:

1. Any current-dated contraindication/refusal for IMM AND any immunization
that shares the same CVX code.

2. If vaccine group was refused (Refused Vaccine Group (#1205) is set to Yes),
then include any current-dated* refusals for an immunization that shares the
same vaccine group as IMM.

3. Any current-dated* contraindications where the contraindication has IMM
listed in the "Immunization Limited To" multiple.

4. Any current-dated* contraindications where the contraindication does not
have anything listed in the "Immunization Limited To" multiple, excluding
Severe Reaction Previous Dose.

* If BEGDATE and ENDDATE are null, then "current-dated" means where STOP >=
TODAY.

* If BEGDATE and ENDDATE are defined, then "current-dated" means where START
<= ENDDATE, and STOP is >= BEGDATE.
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Output
Returns an array in the following format.

RESULT(DAS) = Visit IEN ^ Contra/Refusal variable pointer | Contra/Refusal
Name ^ Immunization IEN | Name ^ Warn Until Date ^ D/T Recorded ^ Event D/T ^
Encounter Provider IEN | Name ^ Refused Vaccine Group (1/0)

RESULT(DAS,"COMMENTS") = Comments

When the entry is from IMM CONTRAINDICATION REASONS this is defined:

RESULT(DAS,"CONTRAINDICATION/PRECAUTION")=CONTRAINDICATION/PRECAUTION
DFN Input
(Required) Pointer to the Patient (#2) file.
IMM Input
(Required) Pointer to #9999999.14.
BEGDATE Input
(Optional; defaults to TODAY) Begin Search Date.
ENDDATE Input
(Required) (optional; defaults to 9999999) End Search
Date.
SUBSCRIBING PACKAGE
DATE ACTIVATED 2021/12/07