| DESCRIPTION | 
GET Patients that match the partial lookup. The partial lookup can be a
partial name, Date of Birth, Chart Number, SSN, or empty which will
return all patients.
 
 | 
| RETURN PARAMETER DESCRIPTION | 
   1. NAME - NAME from PATIENT file 
  10. USERNAME 
  56 PMARITAL - Patient Marital Status 
  57 PRELIGION - Patient Religious Preference 
  58 PTACTIVE - Patient Temporary Address Active? (.12105) 
  59 PTADDRESS1 - Patient Temporary Address Line 1 (.1211) 
  60 PTADDRESS2 - Patient Temporary Address Line 2 (.1212) 
  61 PTADDRESS3 - Patient Temporary Address Line 3 (.1213) 
  62 PTCITY - Patient Temporary City (.1214) 
  63 PTSTATE - Patient Temporary State (.1215) 
  64 PTZIP - Patient Temporary Zip (.1216) 
  65 PTZIP+4 - Patient Temporary Zip+4 (.12112) 
  11. PRIGRP - ENROLLMENT PRIORITY text from PATIENT ENROLLMENT file 
  66 PTCOUNTRY - Patient Temporary Country (.1223) 
  67 PTCOUNTY - Patient Temporary County (.12111) 
  68 PTPHONE - Patient Temporary Phone (.1219) 
  69 PTSTART - Patient Temporary Address Start Date (.1217) 
  70 PTEND - Patient Temporary Address End Date (.1218) 
  71 PCELL - Patient Cell Phone (.134) 
  72 PPAGER - Patient Pager Number (.135) 
  73 PEMAIL - Patient Email Address (.133) 
  74 PF_FFF - Patient FUGITIVE FELON FLAG 1=YES 
  75 PF_VCD - Patient VETERAN CATASTROPHICALLY DISABLED? 
               Valid Values: 
                      Y=YES N=NO 
  76 PFNATIONAL - Patient national Flags 
           (PRF ASSIGNMENT/PRF NATIONAL FLAG) separated by ^ 
     Each ^ piece contains the following | pipe pieces: 
      1. PRFAID - PRF Assignment ID pointer to PRF ASSIGNMENT file 
                  (#26.13) 
      2. PRFSTAT - PRF Assignment Status 0=INACTIVE 1=ACTIVE 
      3. PRFNID - PRF National Flag ID pointer to PRF NATIONAL FLAG file
                  (#26.15) 
      4. PRFNNAME - PRF National Flag name 
                  GROUP 1 
      5. PRFNSTAT - PRF National Flag status 0=INACTIVE 1=ACTIVE 
  77 PFLOCAL - Patient Local Flags
               (PRF ASSIGNMENT/PRF Local FLAG) separated by ^
     Each ^ piece contains the following | pipe pieces: 
       1. PRFAID - PRF Assignment ID pointer to PRF ASSIGNMENT file 
(#26.13)
       2. PRFSTAT - PRF Assignment Status 0=INACTIVE 1=ACTIVE 
       3. PRFLID - PRF Local Flag ID pointer to PRF LOCAL FLAG file 
(#26.11)
       4. PRFLNAME - PRF Local Flag name 
                  GROUP 2 
       5. PRFLSTAT - PRF Local Flag status 0=INACTIVE 1=ACTIVE 
 78 SUBGRP - value from the ENROLLMENT SUBGROUP field of the
             PATIENT ENROLLMENT file (#27.11) 
              Valid values are a b c d e g 
 79 CAT8G  - Category 8g flag - True if PriGRP ='Group 8' AND SUBGRP-'g'
 80 SIMILAR = Similar Patients 
      MESSSAGE | Patients 
       Patients separated by ;; 
        Each ;; piece contains the following ~ pieces 
        DFN ~ NAME ~ DOB ~ SSN (last 4)
                  GROUP 3 
 81 PRIMARY CARE PROVIDER
 82 MENTAL HEALTH PROVIDE6R
                  GROUP 4 
                  GROUP 5 
                  GROUP 6 
                  GROUP 7 
   2. HRN  
                  GROUP 8 
  12. ELIGIEN - Pointer to MAS ELIGIBILITY CODE file 8.1 
  13. ELIGNAME - NAME from MAS ELIGIBILITY CODE file 
  14. SVCCONN - SERVICE CONNECTED field from PATIENT ENROLLMENT file 
                Valid values: 
                 YES 
                 NO 
  15. SVCCONNP - SERVICE CONNECTED PERCENTAGE field from 
                 PATIENT ENROLLMENT file 
                 Numeric between 0-100 
   3. SSN - last 4 of SSN 
  16. TYPEIEN - Pointer to TYPE OF PATIENT file 391 
  17. TYPENAME - NAME from TYPE OF PATIENT file 391 
  18. PADDRES1 - Patient Address line 1 
  19. PADDRES2 - Patient Address line 2 
  20. PADDRES3 - Patient Address line 3 
  21. PCITY - Patient City 
  22. PSTATE - Patient state name 
  23. PCOUNTRY - Patient country pointer to COUNTRY CODE file 
  24. PZIP4 - Patient Zip+4 
  25. GAF - <text> | <GAF score> | <GAF date> | <diagnosis by IEN> 
   4. DOB - Date of Birth 
            | <diagnosis by name> 
  26 SENSITIVE - Sensitive Record Access data separated by pipe |: 
     1. return code: 
        -1-RPC/API failed 
           Required variable not defined 
     0-No display/action required 
           Not accessing own, employee, or sensitive record 
     1-Display warning message 
           Sensitive and DG SENSITIVITY key holder 
           or Employee and DG SECURITY OFFICER key holder 
   5. IEN - DFN pointer to PATIENT file 
     2-Display warning message/require OK to continue 
           Sensitive and not a DG SENSITIVITY key holder 
           Employee and not a DG SECURITY OFFICER key holder 
     3-Access to record denied 
           Accessing own record 
     4-Access to Patient (#2) file records denied 
           SSN not defined 
  27 PRACE - Patient Race pointer to RACE file 10 | separates entries
  28 PRACEN - Patient Race name from RACE file | separates entries 
  29 PETH - Patient Ethnicity list separated by pipe | 
   6. GENDER 
            Pointer to ETHNICITY file 10.2 
  30 PETHN - Patient Ethnicity names spearated by pipe | 
  31 LASTSUB - last subscripts from previous call 
               Supported by DOB, ALL PATIENTS, and Partial name 
               lookup types 
  32 BADADD = BAD ADDRESS INDICATOR (.121) 
      1=UNDELIVERABLE 
      2=HOMELESS 
      3=OTHER 
      4=ADDRESS NOT FOUND 
   7. INSTIEN 
  33 HPHONE = Home phone (.131) 
  34 OPHONE = Office phone (.132) 
  35 NOK - Primary Next of Kin (.211) 
  36 KNAME - Primary Next of Kin name 
  37 KREL - Primary Next of Kin Relationship to Patient (.212) 
  38 KPHONE - Primary Next of Kin Phone (.219) 
  39 KSTREET - Primary Next of Kin Street Address [Line 1] 
                      (.213) 
  40 KSTREET2 - Primary Next of Kin Street Address [Line 2] 
                        (.214) 
   8. INSTNAME 
  41 KSTREET3 - Primary Next of Kin Street Address [Line 3] 
                       (.215) 
  42 KCITY - Primary Next of Kin City (.216) 
  43 KSTATE - Primary Next of Kin State (.217) 
  44 KZIP - Primary Next of Kin Zip (.218) 
  45 NOK2 - Secondary Next of Kin (.2191) 
  46 K2NAME - Secondary Next of Kin name (.2191) 
  47 K2REL - Secondary Next of Kin Relationship to Patient 
                    (.2192) 
  48 K2PHONE - Secondary Next of Kin Phone (.2199) 
   9. USERIEN 
  49 K2STREET - Secondary Next of Kin Street Address [Line 1] 
                       (.2193) 
  50 K2STREET2 - Secondary Next of Kin Street Address [Line 2] 
                       (.2194) 
  51 K2STREET3 - Secondary Next of Kin Street Address [Line 3] 
                        (.2195) 
  52 K2CITY - Secondary Next of Kin City (.2196) 
  53 K2STATE - Secondary Next of Kin State (.2197) 
  54 K2ZIP - Secondary Next of Kin Zip (.2198) 
  55 PCOUNTY - Patient County (.117) 
 |