Home   Package List   Routine Alphabetical List   Global Alphabetical List   FileMan Files List   FileMan Sub-Files List   Package Component Lists   Package-Namespace Mapping  
Source Information |  Call Graph |  External References |  All
Print Page as PDF
Remote Procedure: ROR REPORT SCHEDULE

Package: Clinical Case Registries

Remote Procedure: ROR REPORT SCHEDULE


Source Information

Name Value
NAME ROR REPORT SCHEDULE
TAG SCHEDREP
ROUTINE RORRP010
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
Schedules the report and returns the task information.
INPUT PARAMETER
  1. INPUT PARAMETER:   REGIEN
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Registry IEN (if $G(REGIEN)'>0 the task will not be associated with any
    particular registry).
    
  2. INPUT PARAMETER:   RPTCODE
    PARAMETER TYPE:   LITERAL
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    Code of the report (value of the CODE field of the report descriptor in
    the ROR REPORT file).
    
  3. INPUT PARAMETER:   ZTDTH
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Date/time to start the task (external value). By default (if $G(ZDTH)=""),
    the task will be scheduled to run after 3-second pause.
    
  4. INPUT PARAMETER:   PARAMS
    PARAMETER TYPE:   LIST
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    Report parameters in XML format. For example:
          Mult[5] := '<PATIENTS DE_DURING="1" INPATIENT="1" OUTPATIENT="1">';
          ...
        </GROUP>
      </ICDFILT>
    Lab Tests
    ---------
      <LABTESTS [ALL="1"]>
        <LT ID="IEN" [LOW="..."] [HIGH="..."]>Name</LT>
        ...
          Mult[6] := '<CPTLST>';
      </LABTESTS>
    Local Fields
    ------------
      <LOCAL_FIELDS>
        <FIELD ID="IEN" [MODE="1"|"-1"] 
          [NAME="FieldName"]>Description</FIELD>
      </LOCAL_FIELDS>
          Mult[7] := '<CPT ID="00120">ANESTH, EAR SURGERY</CPT>';
    Lab Result Ranges
    -----------------
      <LRGRANGES>
        <LRGRANGE ID="GroupCode" USE="1"
          [LOW="..."] [HIGH="..."]>GroupName</LRGRANGE>
      </LRGRANGES>
    Number of patients with highest utilization
    -------------------------------------------
          Mult[8] := '<CPT ID="00124">ANESTH, EAR EXAM</CPT>';
      <MAXUTNUM>...</MAXUTNUM>
    Minimum number of procedures/results to display
    -----------------------------------------------
      <MINRPNUM>...</MINRPNUM>
    Optional Columns
    ----------------
          Mult[9] := '</CPTLST>';
      <OPTIONAL_COLUMNS>
        <COLUMN ID="ColumnName"/>
      </OPTIONAL_COLUMNS>
    Report Options
    --------------
      <OPTIONS [COMPLETE="1"] [SUMMARY="1"]
        [REGMEDSMRY="1"] [PTLIST="1"]/>
          ...
    Other Registries
    ----------------
      <OTHER_REGISTRIES>
        <REGISTRY ID="RegIEN" [MODE="1"|"-1"]
          [NAME="RegName"]>Description</REGISTRY>
        ...
      </OTHER_REGISTRIES>
          Mult[n] := '</PARAMS>';
    Subset of Patients
    ------------------
      <PATIENTS [CONFIRMED="1"] [PENDING="1"]
        [DE_BEFORE="1"] [DE_DURING="1"] [DE_AFTER="1"]
        [INPATIENT="1"] [OUTPATIENT="1"]
        [COMPLEX="1"] [BASIC="1"]
        [LAB="1"] [NOLAB="1"] 
        [NOTSEEN="1"] [SEEN="1"] [CAREONLY="1"]
        [PHARM="1"] [NOPHARM="1"]
        end;
        [PROC="1"] [NOPROC="1"]/>
        <PT ID="DFN" [SSN="SSN"]>Name</PT>
        ...
      </PATIENTS>
    User Defined Comment
    --------------------
      <TASK_COMMENT>...</TASK_COMMENT>
    Utilization Types
    -----------------
      <UTIL_TYPES [ALL="1"]>
        <UT ID="UtlCode"/>
        ...
      </UTIL_TYPES>
      VADRUGCLS     VA drug classes included in the report
    Clinics
                    Example:
                      Mult['"VADRUGCLS(1)"'] := 'IN140';
                      Mult['"VADRUGCLS(2)"'] := 'IN150';
      VIRAL_LOAD    Viral Load options
                      ^01: Include Viral Load (0/1)
                      ^02: Use range          (0/1)
                      ^03: Low
                      ^04: High
    -------
                    Example (include all):
                      Mult['"VIRAL_LOAD"'] := '1';
                    Example (use range):
                      Mult['"VIRAL_LOAD"'] := '1^1^3000^100000';
      <CLINICS [ALL="1"]>
        <CLINIC ID="IEN">Name</CLINIC>
        ...
      </CLINICS>
    CPT Codes
    ---------
      with RPCBroker.Param[4] do
      <CPTLST [ALL="1"]>
        <CPT ID="CPT">Name</CPT>
        ...
      </CPTLST>
    Date Range
    ----------
    (Medications date range for the Combined Meds and Labs report)
      <DATE_RANGE TYPE="Type" [START="..." END="..."]
        begin
        [CUTOFF="..."] [YEAR="..." [QUARTER="..."]
        [FISCAL="1"]]/>
    Lab Date Range
    --------------
      <DATE_RANGE_2 TYPE="Type" [START="..." END="..."]
        [CUTOFF="..."] [YEAR="..." [QUARTER="..."]
        [FISCAL="1"]]/>
          PType :=list;
    Utilization Date Range
    ----------------------
      <DATE_RANGE_3 TYPE="Type" [START="..." END="..."]
        [CUTOFF="..."] [YEAR="..." [QUARTER="..."]
        [FISCAL="1"]]/>
    Divisions
    ---------
          Mult[1] := '<?xml version="1.0" encoding="UTF-8"?>'
      <DIVISIONS [ALL="1"]>
        <DIV ID="IEN">Name</DIV>
        ...
      </DIVISIONS>
    Medications, Drug Classes, and Medication Groups
    ------------------------------------------------
      <DRUGS [AGGR_GENERIC=1] [AGGR_FORMUL=1] [ALL="1"]
        [INVESTIG="1"] [REGMEDS="1"]>
          Mult[2] := '<PARAMS>';
        <GROUP [ID="GroupName"] [INVESTIG="1"] [REGMEDS="1"]>
          <GENERIC>
            <DRUG ID="IEN">Name</DRUG>
            ...
          </GENERIC>
          <FORMULATIONS>
            <DRUG ID="IEN">Name</DRUG>
            ...
          </FORMULATIONS>
          <VARXCLS>
          Mult[3] := '<TASK_COMMENT>Ear procedures 2003</TASK_COMMENT>'
            <VARXCL ID="IEN" CODE="ClassCode">Name</VARXCL>
            ...
          </VARXCLS>
        </GROUP>
        ...
      </DRUGS>
    ICD Codes
    -----------
          Mult[4] := '<DATE_RANGE TYPE="YEAR" YEAR="2003"/>';
      <ICDLST [ALL="1"]>
        <GROUP ID="Group Name">
          <ICD ID="ICD Code" VERSION="ICD-9/ICD-10">Name</ICD>
          ...
        </GROUP>
      </ICDLST>
      <ICDFILT FILTER="ALL/INCLUDE/EXCLUDE">
        <GROUP ID="Group Name">
          <ICD ID="ICD Code" VERSION="ICD-9/ICD-10">Name</ICD>
    
  5. INPUT PARAMETER:   SCHCODE
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    Rescheduling code ("1D", "1M", "D@12:00", etc).
    
RETURN PARAMETER DESCRIPTION
A negative value of the first "^"-piece of the Results[0] indicates that
  Results[i]            Error Descriptor
                          ^01: Error code
                          ^02: Message
                          ^03: Place of the error
Error descriptors are returned in reverse chronological order (most recent
error first).                                                 
Otherwise, the Results[0] contains number of task descriptors returned in
an error occurred during the execution of the remote procedure. In this
the Results array (always 1) and number of elements that comprise a task
descriptor:
  Results[0]            Result Descriptor
                          ^01: 1
                          ^02: Number of elements that comprise a task
                               descriptor (TIN)
The subsequent nodes of the Results array (from 1 to TIN) contain the
information about the scheduled task (see the ROR TASK INFO remote 
case, the second piece of the Results[0] will contain number of the error
procedure for more details).
descriptors returned in the subsequent nodes of the Results array.
  Results[0]            Result Descriptor
                          ^01: The last error code (LASTERR)
                          ^02: Number of the error descriptors

Call Graph

Call Graph

Call Graph Total: 1

Package Total Call Graph
Clinical Case Registries 1 SCHEDREP^RORRP010  

External References

Name Field # of Occurrence
SCHEDREP^RORRP010 1
Source Information |  Call Graph |  External References |  All