Print Page as PDF
RORAPI01 ICR (4166)

RORAPI01    ICR (4166)

Name Value
NUMBER 4166
IA # 4166
DATE CREATED 2003/07/30
CUSTODIAL PACKAGE CLINICAL CASE REGISTRIES
CUSTODIAL ISC Chicago
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE RORAPI01
NAME RORAPI01
GENERAL DESCRIPTION
This agreement documents the use of entry points in
routine RORAPI01 to get lists of patients from the Clinical Case Registries.
STATUS Active
DURATION Till Otherwise Agreed
ID RORAPI01
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$PATITER
Creates an iterator of patients in the specified
registry.
VARIABLES TYPE VARIABLES DESCRIPTION
IDESC Both
A local variable, passed in by reference, where the
iterator descriptor will be created and returned.
REGNAME Input
Registry Name.
MODE Input
Bit flag to determine iteration mode, where 1 =
Active patients or 2 = Inactive patients (default = both active and inactive
if null).
RESULT Output
RESULT=$$PATITER^RORAPI01(.IDESC,REGNAME,MODE) where
RESULT is 0 if the iterator was successfully created, or <0 if an error
occurred.
$$NEXTPAT
Returns the next patient in the registry.
VARIABLES TYPE VARIABLES DESCRIPTION
IDESC Both
Reference to the patient iterator descriptor created
by $$PATITER.
RESULT Output
RESULT=$$NEXTPAT^RORAPI01(.IDESC) where RESULT is
PatientIEN^InactiveDate, or "" if there are no more patients or <0 if an error
occurred.
$$REGITER
Creates an iterator of the patient registries.
VARIABLES TYPE VARIABLES DESCRIPTION
IDESC Both
A local variable, passed in by reference, where the
iterator descriptor will be created and returned.
PATIEN Input
Patient IEN
MODE Input
Bit flag to determine iteration mode, where 1 =
Active patients or 2 = Inactive patients (default = both active and inactive
if null)
RESULT Output
RESULT=$$REGITER^RORAPI01(.IDESC,PATIEN,MODE) where
RESULT is 0 if the iterator was successfully created, or <0 if an error
occurred.
$$NEXTREG
Returns the next registry for the patient.
VARIABLES TYPE VARIABLES DESCRIPTION
IDESC Both
Reference to the patient iterator descriptor created
by $$REGITER.
RESULT Output
RESULT=$$NEXTREG^RORAPI01(.IDESC) where RESULT is
RegistryIEN^Inactive Date, or "" if there are no more registries for the
patient or <0 if an error occurred.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
ORDER ENTRY/RESULTS REPORTING Salt Lake City