DG UPDATE NAME COMPONENTS (4168)    REMOTE PROCEDURE (8994)

Name Value
NAME DG UPDATE NAME COMPONENTS
TAG UPDNC
ROUTINE DGNAME
RETURN VALUE TYPE ARRAY
AVAILABILITY PUBLIC
VERSION 1
APP PROXY ALLOWED No
DESCRIPTION
This Remote Procedure updates or retrieves values in a NAME COMPONENTS 
file (#20) entry.
INPUT PARAMETER
  • FLAG
    PARAMETER TYPE:   LITERAL
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This parameter acts as a flag to control how the Remote Procedure 
     
    If the parameter does not contain a "G", the Remote Procedure operates in 
    "UPDATE" mode and is used to set the values of the above fields to the 
    values passed in the NAME COMPONENTS parameter.
    functions. If it contains a "G", the Remote Procedure operates in "GET" 
    mode and returns the values of the following fields in the NAME 
    COMPONENTS file (#20):
     
      FAMILY (LAST) NAME (#1)
      GIVEN (FIRST) NAME (#2)
      MIDDLE NAME (#3)
      SUFFIX (#5)
    
  • IEN
    PARAMETER TYPE:   LITERAL
    REQUIRED:   YES
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This parameter contain is the IEN of either an entry in the PATIENT file 
    IEN of the NAME COMPONENTS file entry to update.
    (#2), or an entry in the NAME COMPONENTS file (#20), depending on whether 
    this remote procedure is being called in GET or UPDATE mode.
     
    If the FLAG parameter contains a "G" (GET mode), IEN is the DFN of the 
    PATIENT file entry for which the NAME and ALIAS name components should be 
    returned.
     
    If the FLAG parameter does not contain a "G" (UPDATE mode), IEN is the 
    
  • NAME COMPONENTS
    PARAMETER TYPE:   LIST
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    If this Remote Procedure is being called in UPDATE mode (i.e., the FLAG 
     
    To delete the value of a Name Component field, the array element can be
    set to "" or "@". To keep the value of a specific name component
    unchanged, don't pass that array element.
     
    If this Remote Procedure is being called in GET mode (i.e., the FLAG 
    parameter contains a "G"), then this parameter is ignored.
    parameter does not contain a "G"), then this parameter contain the values
    to file in the NAME COMPONENTS file (#20) entry with the IEN passed. It is
    an array with the following format:
     
      ARRAY("FAMILY") = The Family (Last) Name
      ARRAY("GIVEN") = The Given (First) Name
      ARRAY("MIDDLE") = The Middle Name
      ARRAY("SUFFIX") = The Suffix
    
RETURN PARAMETER DESCRIPTION
If the FLAG parameter contains a "G" (GET mode), the following array will
        ...
 
or, if there are errors, the returned array has the following format:
 
        RETURN(0) = -1^Patient with DFN <dfn> cannot be found.
        RETURN(0) = -1^<error message returned by GETS^DIQ call>
 
If the FLAG parameter does not contain a "G" (UPDATE mode), the following 
array node is returned:
 
be returned:
        RETURN(0) = 1^<IEN of NAME COMPONENTS entry updated>
 
or if there is an error, the following is returned:
 
        RETURN(0) = -1^<error message returned from FILE^DIE call>
 
        RETURN(0) = <name components IEN for patient>^<last name>
                      ^<first name>^<middle name>^<suffix>
        RETURN(1) = <name components IEN for first alias>^<last name>
                      ^<first name>^<middle name>^<suffix>
        RETURN(2) = <name components IEN for second alias>^<last name>
                      ^<first name>^<middle name>^<suffix>