TITLE | VALUE | |
---|---|---|
NAME | SDES EDIT RECALL REQ 2 | |
DESCRIPTION | UPDATE AN EXISTING ENTRY IN RECALL REMINDERS (#403.5) BASED ON THE IEN PASSED IN. | |
TAG | UPDRECALLREQ | |
ROUTINE | SDESUPDRECREQ2 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
INPUT PARAMETER | RECALLIEN | |
DESCRIPTION | IEN pointer to RECALL REMINDERS (#403.5) | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
INPUT PARAMETER | DFN | |
DESCRIPTION | POINTER TO PATIENT (#2) FILE | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 30 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
INPUT PARAMETER | ACCESSION_NUMBER | |
DESCRIPTION | ACCESSION # (FREE TEXT) | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 25 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 4 |
INPUT PARAMETER | COMMENT | |
DESCRIPTION | COMMENT (FREE TEXT) | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 80 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 5 |
INPUT PARAMETER | FASTING | |
DESCRIPTION | LABS: FASTING NON-FASTING @ - NONE | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 12 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 6 |
INPUT PARAMETER | APPOINTMENT_TYPE | |
DESCRIPTION | Name 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 | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 1 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 7 |
INPUT PARAMETER | RECALL_PROVIDER_IEN | |
DESCRIPTION | RECALL PROVIDER - POINTER TO RECALL REMINDERS PROVIDERS (#403.54) FILE | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 20 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 8 |
INPUT PARAMETER | CLINIC_IEN | |
DESCRIPTION | CLINIC POINTER TO HOSPITAL LOCATION (#44) FILE | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 20 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 9 |
INPUT PARAMETER | APPOINTMENT_LENGTH | |
DESCRIPTION | LENGTH OF APPOINTMENT NUMERIC BETWEEN 10 AND 120. IF VALUE SENT IN IS LESS THAN 10 OR GREATER THAN 120 SETS TO NULL. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 10 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 10 |
INPUT PARAMETER | RECALL_DATE | |
DESCRIPTION | Recall date in ISO8601 date format (no time). e.g., CCYY-MM-DD | |
PARAMETER TYPE | LITERAL | |
REQUIRED | YES | |
MAXIMUM DATA LENGTH | 7 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 11 |
INPUT PARAMETER | RECALL_DATE_PER_PATIENT | |
DESCRIPTION | Recall date (per patient) in ISO8601 date format (no time). e.g., CCYY-MM-DD | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 7 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 12 |
INPUT PARAMETER | DATE_REMINDER_SENT | |
DESCRIPTION | Date Reminder was sent in ISO8601 date format (no time). e.g., CCYY-MM-DD | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 7 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 13 |
INPUT PARAMETER | USERIEN | |
DESCRIPTION | USER WHO ENTERED/EDITED RECALL (POINTER TO NEW PERSON FILE #200), DEFAULTS TO CURRENT USER. | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 20 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 14 |
INPUT PARAMETER | SECOND_PRINT_DATE | |
DESCRIPTION | Second print date in ISO8601 date format (no time). e.g., CCYY-MM-DD | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 7 | |
INPUT PARAMETERS | SEQUENCE NUMBER | 15 |
INPUT PARAMETER | EASTRCKNGNMBR | |
DESCRIPTION | ENTERPRISE APPLICATION SERVINCE(EAS) TRACKING NUMBER | |
PARAMETER TYPE | LITERAL | |
REQUIRED | NO | |
MAXIMUM DATA LENGTH | 40 | |
RETURN VALUE TYPE | ARRAY | |
RETURN PARAMETER DESCRIPTION | Successful Return: { "RecallReqEdit": { "IEN": 27569 } } Otherwise, JSON Errors will be returned for any invalid/missing parameters. { "Error": [ "Missing Recall ID.", "Missing Patient ID.", "Missing Fasting value.", "Missing Recall Reminders Appointment Type ID.", "Missing Recall Reminders Provider ID.", "Missing Clinic ID.", "Missing Recall Date." ], "RecallReqEdit": { "IEN": "" } } | |
AVAILABILITY | RESTRICTED | |
INACTIVE | ||
CLIENT MANAGER | ||
WORD WRAP ON | ||
VERSION | ||
SUPPRESS RDV USER SETUP | ||
APP PROXY ALLOWED | Yes |