SDES CREATE RECALL REQ 2 (4711)    REMOTE PROCEDURE (8994)

Name Value
NAME SDES CREATE RECALL REQ 2
TAG CREATERECREQ
ROUTINE SDESUPDRECREQ2
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
APP PROXY ALLOWED Yes
DESCRIPTION
CREATE A NEW ENTRY INTO THE RECALL REMINDERS (#403.5) FILE FOR PATIENT 
DFN.
INPUT PARAMETER
  • DFN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    DFN Pointer to PATIENT FILE (#2)
    
  • RECALL_DATE_PER_PATIENT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   NO
    SEQUENCE NUMBER:   10
    DESCRIPTION:   
    Recall date (per patient) in ISO8601 date format (e.g., CCYY-MM-DD)
    
  • DATE_REMINDER_SENT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   NO
    SEQUENCE NUMBER:   11
    DESCRIPTION:   
    Date reminder sent in ISO8601 format (e.g., CCYY-MM-DD)
    
  • USERIEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   NO
    SEQUENCE NUMBER:   12
    DESCRIPTION:   
    USER WHO ENTERED RECALL (POINTER TO NEW PERSON (#200) FILE), DEFAULTS TO 
    CURRENT USER.
    
  • SECOND_PRINT_DATE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   NO
    SEQUENCE NUMBER:   13
    DESCRIPTION:   
    Second print date in ISO8601 format (e.g., CCYY-MM-DD).
    
  • DATE ENTERED
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   NO
    SEQUENCE NUMBER:   14
    DESCRIPTION:   
    Date recall was added.   Date is in ISO8601 format (e.g., CCYY-MM-DD)
    
  • EASTRCKNGNMBR
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   40
    REQUIRED:   NO
    SEQUENCE NUMBER:   15
    DESCRIPTION:   
    ENTERPRISE APPLICATION SERVICE (EAS) TRACKING NUMBER
    
  • ACCESSION_NUMBER
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    ACCESSION NUMBER (FREE TEXT)
    
  • COMMENT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   80
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    COMMENT (FREE TEXT)
    
  • FASTING
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   12
    REQUIRED:   YES
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
     LABS:
        FASTING
        NON-FASTING
        @ - NONE
    
  • APPOINTMENT_TYPE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   1
    REQUIRED:   YES
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    Name or IEN of the RECALL REMINDERS APPT TYPE (#403.51) FILE
     1             FOLLOW-UP          F
     4             OTHER              O
     3             SEMI-ANNUAL EXAM   SA
     2             YEARLY EXAM        YEAR
    
  • RECALL_PROVIDER_IEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   6
    DESCRIPTION:   
    RECALL PROVIDER - POINTER TO RECALL REMINDERS PROVIDERS (#403.54) FILE
    
  • CLINIC_IEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   20
    REQUIRED:   YES
    SEQUENCE NUMBER:   7
    DESCRIPTION:   
    CLINIC POINTER TO HOSPITAL LOCATION (#44) FILE
    
  • APPOINTMENT_LENGTH
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   NO
    SEQUENCE NUMBER:   8
    DESCRIPTION:   
    LENGTH OF APPOINTMENT NUMERIC BETWEEN 10 AND 120.  IF VALUE SENT IN IS 
    LESS THAN 10 OR GREATER THAN 120 SETS TO NULL.
    
  • RECALL_DATE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   10
    REQUIRED:   YES
    SEQUENCE NUMBER:   9
    DESCRIPTION:   
    Recall Date in ISO8601 format (e.g., CCYY-MM-DD)
    
RETURN PARAMETER DESCRIPTION
Successful Return:
parameters.
 
{
        "Error": [
                "Missing Patient ID.",
                "Missing Fasting value.",
                "Missing Recall Reminders Appointment Type ID.",
                "Missing Recall Reminders Provider ID.",
                "Missing Clinic ID.",
                "Missing Recall Date."
 
        ],
        "RecallReqCreate": {
                "IEN": ""
        }
}
{
        "RecallReqCreate": {
                "IEN": 27557
        }
}
 
Otherwise, JSON Errors will be returned for any invalid/missing