Print Page as PDF
VAFCAPI ICR (7323)

VAFCAPI    ICR (7323)

Name Value
NUMBER 7323
IA # 7323
DATE CREATED 2022/01/28
CUSTODIAL PACKAGE REGISTRATION
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE VAFCAPI
NAME VAFCAPI
GENERAL DESCRIPTION 
The Master Veteran Index (MVI) team has created this
Application Programming Interface (API) which will allows the adding/updating
or validation of Sexual Orientation (SO) and Gender Identity Traits of a
patient's record in the PATIENT (#2) file.

Currently the Sexual Orientation (#.025) field multiple and the Sexual
Orientation Description (#.0251) field in the PATIENT (#2) file can be
added/updated or validated with this API.
STATUS Active
KEYWORDS
  • SOGI
  • SEXUAL ORIENTATION
  • .025
  • .0251
  • SO
  • VAFCAPI
DURATION Till Otherwise Agreed
ID VAFCAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$SOGI(DFN,.ARRAY,UPDATE) 
To add or update a Sexual Orientation and/or Sexual
Orientation Description.

Arguments:   DFN   - pointer to entry in Patient file
ARRAY - list of Sexual Orientation related components
UPDATE- file or validate Sexual Orientation components
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input 
Pointer to entry in the Patient (#2) file (required)
ARRAY Input 
ARRAY("SexOr",n) = code^status^note

n      - counter for list of sexual orientation(s) traits

code (required) - will be filed in the SEXUAL ORIENTATION (#.01) field of the
SEXUAL ORIENTATION (#.025) multiple of the PATIENT (#2) file.  It corresponds
to the TYPE CODE (#1) field of the SEXUAL ORIENTATION TYPES. (#47.77) file

status (required) - will be filed in the STATUS (#.02) field of the SEXUAL
ORIENTATION (#.025) multiple of the PATIENT (#2) file and currently defined as
'A' (Active), 'I' (Inactive), 'E' (Entered in Error).

note (optional) - ien from the TIU DOCUMENT (#8925) file.

ARRAY("SexOrDes") (optional) - will be filed in the SEXUAL ORIENTATION
DESCRIPTION (#.0251) field of the PATIENT (#2) file and describes the 'Other'
sexual orientation.
UPDATE Input 

1 - Sexual Orientation components are filed, otherwise only data validation
is performed (optional)
RET Output 

0 - if update is successful

-1^error message - if unsuccessful
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE SUBSCRIBING DETAILS
CLINICAL REMINDERS 
Effective with patch PXRM*2.0*78, users in CPRS will be
able to use Clinical Reminders to add/update or validate the Sexual
Orientation multiple (#.025) and the Sexual Orientation Description (#.0251)
in the PATIENT (#2) file.
DATE ACTIVATED 2022/02/08