| TITLE | VALUE | |
|---|---|---|
| NAME | DG UPDATE NAME COMPONENTS | |
| DESCRIPTION | This Remote Procedure updates or retrieves values in a NAME COMPONENTS file (#20) entry. | |
| TAG | UPDNC | |
| ROUTINE | DGNAME | |
| INPUT PARAMETERS | SEQUENCE NUMBER | 1 |
| INPUT PARAMETER | FLAG | |
| DESCRIPTION | This parameter acts as a flag to control how the Remote Procedure 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) 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. | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | ||
| INPUT PARAMETERS | SEQUENCE NUMBER | 2 |
| INPUT PARAMETER | IEN | |
| DESCRIPTION | This parameter contain is the IEN of either an entry in the PATIENT file (#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 IEN of the NAME COMPONENTS file entry to update. | |
| PARAMETER TYPE | LITERAL | |
| REQUIRED | YES | |
| MAXIMUM DATA LENGTH | ||
| INPUT PARAMETERS | SEQUENCE NUMBER | 3 |
| INPUT PARAMETER | NAME COMPONENTS | |
| DESCRIPTION | If this Remote Procedure is being called in UPDATE mode (i.e., the FLAG 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 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 TYPE | LIST | |
| REQUIRED | ||
| MAXIMUM DATA LENGTH | ||
| RETURN VALUE TYPE | ARRAY | |
| RETURN PARAMETER DESCRIPTION | If the FLAG parameter contains a "G" (GET mode), the following array will be returned: RETURN(0) = ^ RETURN(1) = ^ RETURN(2) = ^ ... or, if there are errors, the returned array has the following format: RETURN(0) = -1^Patient with DFN cannot be found. RETURN(0) = -1^ If the FLAG parameter does not contain a "G" (UPDATE mode), the following array node is returned: RETURN(0) = 1^ or if there is an error, the following is returned: RETURN(0) = -1^ | |
| AVAILABILITY | PUBLIC | |
| INACTIVE | ||
| CLIENT MANAGER | ||
| WORD WRAP ON | ||
| VERSION | 1 | |
| SUPPRESS RDV USER SETUP | ||
| APP PROXY ALLOWED | No | |