VAFC VOA ADD PATIENT (2711)    REMOTE PROCEDURE (8994)

Name Value
NAME VAFC VOA ADD PATIENT
TAG ADD
ROUTINE VAFCPTAD
RETURN VALUE TYPE ARRAY
AVAILABILITY RESTRICTED
INACTIVE ACTIVE
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
This Remote Procedure Call allows the remote creation of a VistA
PATIENT (#2) record at the Preferred Facility for the Veteran
On-Line Application (VOA) project.
INPUT PARAMETER
  • PARAM
    PARAMETER TYPE:   LIST
    MAXIMUM DATA LENGTH:   2000
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    PARAM may contain the following values: (R) Required (O) Optional
                          (#2) file. The name is converted ino the format:
      (O) PARAM("ResAddState")    = 2-character state abbreviation
                                      (for a US address)
      (O) PARAM("ResAddZIP")      = Zip code (5 or 9 digits) (for a US
                                      address)
      (O) PARAM("ResPhone")       = Home phone
      (O) PARAM("ResAddCountry")  = 3-character country code
                                      (e.g., USA, CAN, MEX)
                             
      (O) PARAM("ResAddProvince") = Province (for a foreign address)
      (O) PARAM("ResAddPCode")    = Postal code (for a foreign address)
                            LastName,FirstName MiddleName Suffix
                          when the entry is added. Then, if the NAME
                          COMPONENTS flag for this site is set to 1, the Name
                          Components passed in PARAM("LONGNAME") are filed in
                          the NAME COMPONENTS (#20) file for that patient. If
                          PARAM("LONGNAME") is not passed, then the Name
                          Components from PARAM("NAME") are filed.
                         
      (O) PARAM("LONGNAME") = Last Name^First Name^Middle Name^Suffix
    The values are passed into this RPC from the Master Patient Index (MPI) 
                              If the full name is greater than 30 characters
                              in length, the unshortened components can be
                              sent in this parameter. After an entry is
                              created in the PATIENT (#2) file with the name
                              passed in PARAM("NAME"), if the NAME COMPONENTS
                              FLAG at this site is set to 1, the Name
                              Components passed in this parameter are filed
                              into the NAME COMPONENTS (#20) for this entry.
                         
      (R) PARAM("GENDER") = External format - MALE or FEMALE
    via the MPI PSIM ADD PREF FACILITY Remote Procedure.
                            SEX of the applicant to be added to the PATIENT
                            (#2) file.
                         
      (R) PARAM("DOB") = External date format; can be imprecise. Month and/or
                         day alone, without year is not allowed. DATE OF BIRTH
                         of the applicant to be added to the PATIENT (#2)
                         file.
                         
      (R) PARAM("SSN") = Format: nine numbers / no dashes, or a NULL value.
                         The SOCIAL SECURITY NUMBER of the applicant to be 
         
                         added to the PATIENT (#2) file. If SSN is sent with a
                         null value, then the patient is given a PSEUDO SSN
                         number and the PSEUDO SSN REASON field is also set to
                         "SSN UNKNOWN/FOLLOW-UP REQUIRED".
                        
      (R) PARAM("SRVCNCTD") = YES or NO
                              Is the applicant to be added to the PATIENT (#2)
                              file SERVICE CONNECTED?
                      
      (R) PARAM("TYPE") = Primary patient TYPE:
      (R) PARAM("PRFCLTY") = Preferred Facility Station Number. Must be the
                            ACTIVE DUTY,
                            ALLIED VETERAN,
                            COLLATERAL,
                            EMPLOYEE,
                            MILITARY RETIREE,
                            NON-VETERAN (OTHER),
                            NSC VETERAN,
                            SC VETERAN, OR
                            TRICARE
                          Primary patient TYPE of the applicant to be added to
                             same as the receiving site.
                          the PATIENT (#2) file.
                      
      (R) PARAM("VET") = YES or NO
                         Is the applicant to be added to the PATIENT (#2) file
                         a VETERAN?
                      
      (R) PARAM("FULLICN ") = A 10 digit NUMBER, followed by V (delimiter),
                              followed by a 6 digit CHECKSUM NUMBER.
                              The full INTEGRATION CONTROL NUMBER (ICN) of the
                              applicant to be added to the PATIENT (#2) file.
                          
          
      (O) PARAM("POBCTY") = City name.
                            PLACE OF BIRTH [CITY] of the applicant to be added
                            to the PATIENT (#2) file.
                      
      (O) PARAM("POBST") = 2-character STATE ABBREVIATION
                           PLACE OF BIRTH [STATE] of the applicant to be added
                           to the PATIENT (#2) file.
                      
      (O) PARAM("MMN") = MOTHER'S MAIDEN NAME.
      (R) PARAM("NAME") = Last Name^First Name^Middle Name^Suffix
                         Maiden name of the mother of the applicant to be
                         added to the PATIENT (#2) file.
                      
      (O) PARAM("MBI") = MULTIPLE BIRTH INDICATOR. Y or N
                      
      (O) PARAM("ALIAS",#) = ALIAS
                               LastName^FirstName^MiddleName^Suffix^SSN
                             The Alias Name is converted to:
                               LastName,FirstName MiddleName Suffix
                             The # subscript is a sequential number.
                          Name of the applicant to be added to the PATIENT
                      
      (O) PARAM("ENROLLMENT") = Set equal to 1 if Enrollment/Eligibility 
                                messaging should be triggered to further 
                                update the identity/registration of the
                                individual at the site.
                      
      (O) PARAM("ResAddL1")       = Street address line1
      (O) PARAM("ResAddL2")       = Street address line2
      (O) PARAM("ResAddL3")       = Street address line3
      (O) PARAM("ResAddCity")     = City address
    
RETURN PARAMETER DESCRIPTION
This RPC will return a string with up to 4 ^-pieces.
                If the NAME COMPONENTS FLAG is set to 1 at this site, this
                piece contains a 1 to indicate that name components passed
                in PARAM("LONGNAME") (if passed) or PARAM("NAME") were
                filed into the NAME COMPONENTS (#20) file for this
                patient.
 
If an entry already exists in the PATIENT (#2) file that has an ICN equal 
to the ICN passed in PARAM("FULLICN"), then the following is returned. 
(Note that the Patient record is not updated with any of the data passed 
in the PARAM input array.)
 
 
   1^DFN of the existing PATIENT with an ICN equal to PARAM("FULLICN")
 
If the patient could not be added to the PATIENT file the following is 
returned:
 
  -1^<error text>
   
Example output:
 
If a PATIENT (#2) file entry was created successfully,
  1^<dfn>
  1^<dfn>^^1
  1^<dfn>^<error text about alias failing to update>
  1^<dfn>^<error text about alias failing to update>^1
 
  -1^<error text>
 
  1st ^-piece = 1
  2nd ^-piece = DFN of the PATIENT created
  3rd ^-piece = if the patient was created but ALIAS data failed to 
                  update, this piece contains an error message
  4th ^-piece = 1 or null