VPS GET SURVEY DATA (3371)    REMOTE PROCEDURE (8994)

Name Value
NAME VPS GET SURVEY DATA
TAG GETRPC
ROUTINE VPSSRVY2
RETURN VALUE TYPE GLOBAL ARRAY
WORD WRAP ON TRUE
DESCRIPTION 
Retrieves an array containing the patient's Clinical Survey information.
INPUT PARAMETER
  • VPSPID
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   25
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    Patient ID such as the patient SSN OR DFN OR ICN OR VIC/CAC
for whom the Clinical Questionnaire information is being
requested.
  • VPSQIEN
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   9
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    Questionnaire IEN for filtering the results.
  • VPSQNM
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   60
    SEQUENCE NUMBER:   4
    DESCRIPTION:   
    Questionnaire Name for filtering the results.
  • VPSFDT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   14
    SEQUENCE NUMBER:   5
    DESCRIPTION:   
    Date From for filtering the results
  • VPSTDT
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   14
    SEQUENCE NUMBER:   6
    DESCRIPTION:   
    Date To for filtering the results
  • VPSNUM
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   4
    SEQUENCE NUMBER:   7
    DESCRIPTION:   
    Maxumum number of occurrences to return.
  • VPSTYP
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   7
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    Patient ID TYPE such as SSN or DFN OR ICN OR VIC/CAC.
  • AHFLG
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   1
    REQUIRED:   NO
    SEQUENCE NUMBER:   8
    DESCRIPTION:   
    Answer History Flag
 
0 - current answer (default)
1 - all answers to the question
RETURN PARAMETER DESCRIPTION 
AN array is returned.
   VPSRES(2) =     PATIENT ^ QUESTIONNAIRE TEMPLATE ID ^ QUESTIONNAIRE 
TEMPLATE NAME ^ QUESTIONNAIRE TEMPLATE IEN ^ VERSION
   VPSRES(3) =     <RESPONSE>
   VPSRES(4) =          RESPONSE IDENTIFIER ^ DATE/TIME TAKEN ^ DATE/TIME 
LAST MODIFIED
   VPSRES(5) =          COMPLETION STATUS ^ PATIENT SAFETY ^ IMMEDIATE 
ACTION ^ SURVEY CALCULATED VALUE
   VPSRES(6) =          <APPOINTMENT CHECK-IN>
   VPSRES(7) =               APPOINTMENT CHECK-IN ID
   VPSRES(8) =          </APPOINTMENT CHECK-IN>
 
   VPSRES(9) =          <ADDITIONAL CALCULATED VALUE>
   VPSRES(10) =               ADDITIONAL CALC VALUE NAME ^ ADDITIONAL 
CALC VALUE SCORE
   VPSRES(11) =          </ADDITIONAL CALCULATED VALUE>
   VPSRES(12) =          <QUESTIONS>
   VPSRES(13) =               QUESTION NUMBER ^ QUESTION CALCULATED VALUE
   VPSRES(14) =               <QUESTION PRESENTED>
   VPSRES(15) =                    QUESTION TEXT....
   VPSRES(16) =               </QUESTION PRESENTED>
   VPSRES(17) =               <ANSWER>
 OUTPUT
   VPSRES(18) =                    ANSWER IDENTIFIER ^ INTERFACE USED ^ 
RESPONDENT ^ RESPONDENT NAME ^ ANSWER DATE/TIME ^ INTERVIEWER NAME ^ 
KIOSK IDENTIFIER ^ KIOSK SESSION IDENTIFIER ^ KIOSK GROUP IDENTIFIER
   VPSRES(19) =                    <ANSWER RESPONSE>
   VPSRES(20) =                         ANSWER TEXT
   VPSRES(21) =                    </ANSWER RESPONSE>
   VPSRES(22) =               </ANSWER>
   VPSRES(23) =          </QUESTIONS>
   VPSRES(24) =     </RESPONSE>
   VPSRES(25) = </CSQ>
  If error
   VPSRES(26) = <CSQ> 
   ...
   VPSRES(n) = </CSQ>
   VPSRES(0)=-1^Error Message
 
  otherwise
   VPSRES(0)=1^Number of Questionnaires
   VPSRES(1) = <CSQ>