CAREGIVER RELATIONSHIPS ICR (7249)

Name

Value

NUMBER

7249

IA #

7249

DATE CREATED

2021/04/30

CUSTODIAL PACKAGE

REGISTRATION

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

VAFCREL

NAME

CAREGIVER RELATIONSHIPS

GENERAL DESCRIPTION

The purpose of this Integration Control Registration is
to grant packages the ability to retrieve patient caregiver relationship
information.

STATUS

Active

KEYWORDS

VAFCREL
CAREGIVER
RELATIONSHIP

VAFCREL

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

GET

Given a patient data file number (DFN) this
application programming interface (API) returns a list of Identity and Access
Management (IAM) Veterans Affairs (VA) Master Patient Index (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].

VARIABLES

TYPE

VARIABLES DESCRIPTION

DFN

Input

Patient DFN from the PATIENT file (#2).

RETURN

Output

The RETURN(0) array will always be returned.

RETURN(0) - If relationships found for a given DFN, it will contain 1 in the
1st piece and "RELATIONSHIPS RETURNED" text in 2nd piece

If no relationships are found for a given DFN, it will contain 0 in the 1st
piece and "NO RELATIONSHIPS RETURNED" text in 2nd piece.

If there is an error condition, it will contain -1 in the 1st piece and error
message text in 2nd piece.

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 are 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

Where there are standardized Relationship Types values defined by the HL7
standard they will be used and below is the url to those standard values:

https://www.hl7.org/fhir/valueset-relatedperson-relationshiptype.html

Examples:
---------

RETURN(1)="1002345678V123456^CGP^CAREGIVER:
PRIMARY^QUAL^ACTIVE^APPROVED^20200220^CAREGIVER, ONE"

RETURN(2)="1901234590V098766^CGS^CAREGIVER:
SECONDARY^QUAL^ACTIVE^APPROVED^20200220^CAREGIVER,TWO"

RETURN(3)="1002345678V123456^SONC^SON^QUAL^ACTIVE^ACTIVE^20200220^CAREGIVE
R,THREE"

RETURN(4)="1901234590V098766^CGP^CAREGIVER: PRIMARY^QUAL^TERMINATED^BENEFIT
END DATE^20170220^CAREGIVER,FOUR"

RETURN(5)="1007879802V000909^SPS^SPOUSE^QUAL^ACTIVE^^ACTIVE^20120301^CAREG
IVER,FIVE"

RETURN(6)="1089022222V123423^BRO^BROTHER^QUAL^ACTIVE^ACTIVE^20111202^CAREG
IVER,SIX"

DATE ACTIVATED

2022/01/27