VAFC GETRELATIONSHIPS (4389)    REMOTE PROCEDURE (8994)

Name Value
NAME VAFC GETRELATIONSHIPS
TAG GET
ROUTINE VAFCREL
RETURN VALUE TYPE WORD PROCESSING
AVAILABILITY PUBLIC
WORD WRAP ON TRUE
VERSION 1
DESCRIPTION
Given a patient DFN this Remote Procedure Call returns a 
 list of IAM VA MPI Relationship records with relationship type, 
relationship status, relationship status change date and relationship 
type rolecode (which defines direction of the relationship [i.e. Son to 
Father vs Father to Son or Caregiver to Veteran receiving care vs Veteran 
receiving care to Caregiver].
INPUT PARAMETER
  • DFN
    PARAMETER TYPE:   WORD PROCESSING
    MAXIMUM DATA LENGTH:   255
    REQUIRED:   YES
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    The patient DFN from the PATIENT file (#2), aka IEN.
    
RETURN PARAMETER DESCRIPTION
The RETURN(0) array will always be returned.
 
Examples:
---------
 
RETURN(0)="1^RELATIONSHIPS RETURNED"
 
RETURN(0)="0^NO RELATIONSHIPS RETURNED"
 
RETURN(0)="-1^ERROR:Timeout Limit Reached"  *** note: timeout limit is 10 
seconds  Possible error conditions
 
RETURN(0)="-1^ERROR:Internal Error"
RETURN(0)="-1^ERROR:Unknown ID"
 
 
RETURN(1-n) - If relationships found for a given DFN, it will contain the 
list of Relationships in the following format:
 
ICN^Relationship Type^Relationship Type Display^Relationship Role
Code^Relationship Status^Relationship Status Display^Relationship
Status Change Date^Assigned Name
RETURN(0)   - If relationships found for a given DFN, it will contain 1 
 
Where there are standardized Relationship Types values defined by the HL7 
standard they will be used and attached is the url to those standard 
values 
(https://www.hl7.org/fhir/valueset-relatedperson-relationshiptype.html)
 
Examples:
---------
 
RETURN(1)="1002345678V123456^CGP^CAREGIVER: 
in the 1st piece and "RELATIONSHIPS RETURNED" text in 2nd piece
PRIMARY^QUAL^ACTIVE^APPROVED^20200220^Jones, William M"
RETURN(2)="1901234590V098766^CGS^CAREGIVER: 
SECONDARY^QUAL^ACTIVE^APPROVED^20200220^Jones, Donna"
RETURN(3)="1002345678V123456^SONC^SON^QUAL^ACTIVE^ACTIVE^20200220^Jones, 
Mike"
RETURN(4)="1901234590V098766^CGP^CAREGIVER: 
PRIMARY^QUAL^TERMINATED^BENEFIT END DATE^20170220^Jones, Donna"
RETURN(5)="1007879802V000909^SPS^SPOUSE^QUAL^ACTIVE^^ACTIVE^20120301^Jones
, Donna"
RETURN(6)="1089022222V123423^BRO^BROTHER^QUAL^ACTIVE^ACTIVE^20111202^Jones
              If no relationships not found for a given DFN, it will 
, Joseph"
contain 0 in the 1st piece and "NO RELATIONSHIPS RETURNED" text in 2nd 
piece
              If error condition, it will contain -1 in the 1st piece and 
error message text in 2nd piece