On this page

Legacy SHINES reference document. This page captures a Georgia DHS SHINES interface design as written (vendor spec, typically 2007–2025). It documents the system being replaced, not CRAIG behavior. CRAIG’s current implementation of the same data exchange lives under the craig-exchange API reference and in the design documents. Use this page only when mapping legacy integrations during CRAIG rollout.

Interface Detailed Design Document

CRS EMPI Interface

Georgia Department of Human Services

Statewide Automated Child Welfare Information System

(SACWIS)

03/18/2016

Version 1.[.line-through]2[.line-through]# #2.0

Table of Contents

General Design

Functional Requirements

Req. # Validated Requirement

553.1

Search CRS for a common identifier

553.2

Send client’s first name

553.3

Send client’s middle name

553.4

Send client’s last name

553.5

Send client’s suffix

553.6

Send client’s date of birth

553.7

Send client’s gender

553.8

Send client’s race

553.9

Send client’s ethnicity

553.1

Send client’s county

553.11

Send client’s SSN

553.12

Send case name

553.13

Send the service type

553.14

Send the common identifier

553.15

Send Case Manager name

553.16

Receive a common identifier

553.17

Send Case ID

553.18

Receive client’s first name

553.19

Send Service begin date

553.2

Receive client’s middle name

553.21

Send service end date

553.22

Receive client’s last name

553.23

Receive client’s suffix

553.24

Receive client’s date of birth

553.25

Receive client’s gender

553.26

Receive client’s race

553.27

Receive client’s ethnicity

553.28

Receive client’s county

553.29

Receive client’s SSN

EMPI 1.1

The system shall rename existing CRS references

EMPI 2.1

The system shall add new attributes to the existing Search Interface – Screening web service per the new EMPI story boards.

EMPI 2.2

The system shall add new attributes to the existing Create Interface – Registration web service as per the new EMPI story boards.

EMPI 3.1

The system shall restrict the case manager to register only an individual listed on the EMPI Inquiry page if at least one of the items in the returned lists has a match score of 90% or more

EMPI 3.2

The system shall restrict the case manager to register only an individual on the EMPI Registration page, if at least one of the items in the returned lists has a match score of 90% or more

EMPI 4.1

The system shall inform EMPI through the Update web service when an individual is selected from the screening process

EMPI 5.1

The system shall implement a new Alert web service through GTA, to receive changes from EMPI regarding updates, merge and unmerge on the individuals being used by SHINES application.

EMPI 5.2

System shall inform the SHINES user that EMPI has sent a data change to SHINES

EMPI 6.1

When there is a single record with a 100% match in the MDM search results the system shall automatically select that record.

EMPI 6.2

When there are multiple records with a 100% match in the MDM search results the system shall only allow those assigned to the stage as primary, secondary or in stage hierarchy to select a record from among those with a 100% match.

EMPI 6.3

The system shall only allow those assigned to the stage as primary, secondary or in stage hierarchy to select a record with a match score of 90% to 99% when the results list does not contain any 100% matching records and there is a record(s) that meets these criteria.

EMPI 6.4

The system shall allow those assigned to the stage as primary, secondary or in stage hierarchy to select any record in the MDM results list if all records in the list have match scores of 89% or less.

EMPI 7.1

Data changes for EMPI will not be displayed in the new section described in DR 5.2.1 if the current data in the SHINES database and the latest EMPI data match.

EMPI 7.2

In the new section described in DR 5.2.1 provide functionality to indicate approval and systemically apply the data changes selected by those assigned to the stage as primary, secondary or in stage hierarchy.

Introduction

Document Purpose

The purpose of this document is to give a detailed functional description of how the EMPI CRS interface operates.

Functional Overview

The Enterprise Master Person Index (EMPI) replaces the legacy client index system CRS and acts as a central hub for person data from the different data source agencies – that will disseminate individual information to consuming applications and systems using a well-defined governance structure. EMPI maintains client information (including demographics), address and a person’s active program participation details and a unique common-identifier for each client served by other DHR systems. Systems including SUCCESS (TANF, Food Stamps, Medicaid) and $TARS (Child Support) maintain information leveraging this unique EMPI identifier referred to as IRNs in EMPI. In order to communicate with SUCCESS and $TARS, SACWIS also maintains the IRN for each Person identified in the case. The interface between SACWIS and EMPI facilitate obtaining the IRN from EMPI via the following process.

The Case Manager is provided the opportunity to obtain the IRN from EMPI via a real-time inquiry button on the Person Identifiers Detail page. The button is accessible by this navigation scenario:

The user selects the Person tab in the second level of navigation. That action directs the user to the Person List page where a list of all Persons in the case displays.

Next, the user selects a Person from the Person List by clicking the Name hyperlink. That action navigates the user to the respective person’s Person Detail page.

Finally, the user expands the Person Identifiers sub module and clicks the Add button. Clicking the Add button navigates the user to the Person Identifiers Detail page.

The Client Registration System (CRS) maintains client information (including demographics) and a unique #[.line-through]#common-identifier[.line-through]# for each client served by other DHR systems. Systems including SUCCESS (TANF, Food Stamps, Medicaid) and $TARS (Child Support) maintain information leveraging this unique CRS identifier referred to as IRNs in CRS. [.line-through]#In order to[.line-through]# communicate with SUCCESS and $TARS, SACWIS also maintains the IRN for each Person identified in the case. The interface between SACWIS and CRS facilitate obtaining the IRN from CRS via the following process. #

[.line-through]#Case Manager is provided the opportunity to obtain the IRN from CRS via a real-time inquiry button on the Person Identifiers Detail page. The button is accessible via the following navigation scenario. The user selects the Person tab in the second level of navigation. By clicking the Person tab, the user is initially directed to the Person List page where a list of all Persons in the case displays. The user must then select a Person from the Person List by clicking the Name hyperlink; this action navigates the user to the respective person’s Person Detail page. Next, the user expands the Person Identifiers sub module and clicks the Add button; clicking the Add button navigates the user to the Person Identifiers Detail page. #

On the Person Identifiers Detail page, the user selects the “CRS ID” in the Type drop down and clicks the “Get CRS ID” button to initiate the real-time inquiry to obtain the IRN from CRS.[.line-through]# #

High-Level Flow

SHINES Informational/Error Messages

Message text Condition

Enter ‘Primary Address’ – including Residential County. Required for EMPI ID.

User does not have a current primary residence address listed with the county

Please select the Principal type when requesting an EMPI ID. The Collateral type does not require an EMPI ID.

User attempts to add an EMPI ID to an individual who is currently listed as a Collateral

There are EMPI changes pending.

User views Person Detail page of an Individual who has received an EMPI alert with updates

System Generated To Dos

To Do Kind (Alert or Task) System Date Text Condition Assigned to Created by Link Destination (if applicable)

Alert

Sys. date

<last name, first name> has received a new EMPI ID via EMPI Alert Update.

A SHINES individual has received merged ID information from EMPI.

Case Manager, Administrator

EMPI

Alert

Sys. date

<last name, first name> has received new Person Demographic information from EMPI. Please Review.

A SHINES individual has received new demographic information from EMPI

Case Manager, Administrator

EMPI

New EMPI data alerts will be displayed on the Staff To Do List Page and Case To Do List Pages respectively.

EMPI Web Services Error Messages Displayed on SHINES Person Detail/EMPI Inquiry/EMPI Registration Pages

SHINES Reason Code EMPI Reason Code Message Code Message text Code Type

61142

PUB-UPD-001

MSG_EMPI_ALERT_UPDATE_SUCC

Client ID <Client ID> has been updated

Message

61143

PUB-MRG-001

MSG_EMPI_ALERT_MERGE

Client ID <Client ID 1> has been merged.

Message

61144

PUB-UNMRG-001

MSG_EMPI_ALERT_UNMERGE

Record is unmerged and the existing Client ID <Client ID> has been re-used

Message

61134

EMPI-M-001

MSG_EMPI_MATCH_SUCC

Match Individual successfully executed in EMPI.

Message

91184

EMPI-M-002

MSG_CRS_NMF_NBR

No Valid Matches were found in EMPI.

Message

61135

EMPI-M-003

MSG_EMPI_MATCH_EMPTY

The Individual Match Request is Empty.

Error

91055

EMPI-M-004

MSG_CRS_FNME_NBR

First Name cannot be empty

Error

91056

EMPI-C-005

MSG_CRS_LNME_NBR

Last Name cannot be empty

Error

61129

EMPI-C-006

MSG_EMPI_GENDER_MISS

Gender cannot be NULL or Empty

Error

92179

EMPI-C-015

MSG_CRS_SNNN_NBR

The SSN is invalid. It should be 9 digit numeric, if provided.

Error

61127

EMPI-C-002

MSG_EMPI_SYS_NM_MISS_ERR

Source System name not provided

Error

61128

EMPI-C-003

MSG_EMPI_WRK_ID_MISS_ERR

worker ID field is empty

Error

61132

EMPI-C-014

MSG_EMPI_SYS_EXCEPTN_ERR

System Exception

Error

61131

EMPI-U-012

MSG_EMPI_SYS_INVALID_ERR

Invalid System name

Error

61136

EMPI-M-014

MSG_EMPI_LIST_PART_ERR

Response list is partial. Returning the first 250 records only. Please narrow your search for optimum results.

Error

61126

EMPI-C-001

MSG_EMPI_CREATE_SUCC

Create Individual request successfully processed

Message

61127

EMPI-C-011

MSG_EMPI_SYS_NM_MISS_ERR

System name not provided

Error

61128

EMPI-C-003

MSG_EMPI_WRK_ID_MISS_ERR

The Worker ID is not provided

Error

61129

EMPI-U-007

MSG_EMPI_GENDER_MISS_ERR

Gender cannot be NULL or Empty

Error

91002

EMPI-C-007

MSG_CRS_ORS_NBR

Race cannot be NULL or Empty

Error

99054

EMPI-U-009

MSG_CRS_IEC_NBR

Ethnicity cannot be NULL or Empty

Error

91007

EMPI-C-009

MSG_CRS_CNI_NBR

County of residence cannot be NULL or Empty

Error

91009

EMPI-C-010

MSG_CRS_DOBI_NBR

The Birth Date is invalid or empty. //BIRTH_DATE: Not a valid date format provided in YYYY/MM/DD format.

Error

92302

EMPI-C-012

MSG_CRS_CNASSN_NBR

Primary SSN already exists in EMPI

Error

61131

EMPI-C-013

MSG_EMPI_DOD_EMPTY_ERR

Death Date is empty when Death indicator is Y

Error

92179

EMPI-C-015

MSG_CRS_SNNN_NBR

The SSN is invalid. It should be 9 digit number, if provided

Error

99041

EMPI-U-018

MSG_CRS_CPNME_NBR

The Phone Number is invalid.

Error

99022

EMPI-C-017

MSG_CRS_DMBE_NBR

Birth Date cannot be NULL or Empty

Error

61133

EMPI-C-020

MSG_EMPI_DOD_INVLD_ERR

Date of Death cannot be null, empty, or invalid

Error

61138

EMPI-C-021

MSG_EMPI_ADDR_TYCD_REQD

Address Type code is required if Address value is provided

Error

61139

EMPI-C-022

MSG_EMPI_CONT_TYCD_REQD

Contact Type code is required if Contact value is provided

Error

61141

EMPI-C-023

MSG_EMPI_SSN_RNGE_ERR

First 3 numbers of SSN cannot be 000, 666, or the range 900-999

Error

61147

EMPI-U-001

MSG_EMPI_UPDATE_SUCC

Update Individual successfully executed in EMPI.

Message

92404

EMPI-U-004

MSG_CRS_CIACE_NBR

Mandatory Field Missing or Invalid: CLIENT ID

Error

91009

EMPI-U-011

MSG_CRS_DOBI_NBR

The Birth Date is invalid or empty.

Error

61130

EMPI-M-012

MSG_EMPI_SYS_INVALID_ERR

Invalid System name

Error

61137

EMPI-U-015

MSG_EMPI_UPDATE_REQD

Update request received. Task has been created and assigned to Data Steward in EMPI

Message

99041

EMPI-U-018

MSG_CRS_CPNME_NBR

Phone Number is invalid.

Error

91011

EMPI-U-019

MSG_CRS_CNICRS_NBR

Client ID Not Found.

Error

61140

EMPI-U-025

MSG_EMPI_ADDR_NULL_ERR

AddressLine1 cannot be made NULL if City and State are provided.

Error

Search EMPI CRS for Client

Functional Description

On the Person Identifiers Detail page, the user selects the “EMPI ID” in the Type drop down and clicks the “EMPI Request” button to initiate the real-time inquiry to obtain the EMPI ID from EMPI. Once the user clicks the “EMPI Request” button on the Person Identifiers Detail page, the user is taken to the EMPI Inquiry page. For additional information about the EMPI Inquiry page including mock-ups, see the EMPI Inquiry detailed design.

Once the user clicks the “Get CRS ID” button on the Person Identifiers Detail page, the real-time inquiry to CRS is initiated by calling the HRRSSCRN request in CRS via the interface.[.line-through]# #

Process Flow

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the Appendix A: EMPI Source to Target Mapping document.

Table of request attributes sent from SACWIS to EMPI (EMPI Match)

Data Element RequiredField? Request Attribute EMPI Data Type EMPI Field Length

First Name

Y

clientFirstName

String

30

Last Name

Y

clientLastName

String

30

Date of Birth

N

clientdateOfBirth

DATE

10

Gender

Y

clientSex

String

1

Social Security Number

N

clientSSN

String

9

Race

N

africanAmerican, white, asian, pacificislander, americanIndian

String

2

Ethnicity

N

ethnicity

String

2

Address Line 1

N

addressLine1

String

100

Address Line 2

N

addressline2

Numeric

100

City/Locality Name

N

cityName

String

25

County Code

N

countyName

String

3

State/Province Code

N

stateCode

String

2

Zip Code

N

zipCode

String

9

Source System

Y

sourceSystem

String

50

Worker Identification

Y

UserID

String

50

Return Code

N

returnCode

String

10

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the document.

Table of response attributes that will be received from EMPI in the Match Response

Data Element Required Field? Response Attribute EMPI Data Type EMPI Field Length

Client ID

N

InIrnClientId

String

9

First Name

Y

szFName

String

30

Middle Name

N

szMName

String

30

Last Name

Y

szLName

String

30

Date of Birth

N

uDob

DATE

Gender Code

Y

szSexCode

String

1

Social Security Number

N

uSsn

String

9

County of Residence

N

N/A

String

3

Race

Y

szRaceCode, szBInNtvAmerican, szBInAsian, szBInAfAmerican, szBInPcfcislander, szBInWhite

String

2

Ethnicity

Y

szEthnCode

String

2

MDM Match Score

Y

mdmMatchScore

Integer

3

Count of Match Result Returned

Y

countMatchResRet

Integer

4

Address Type

N

addressTypeCode

String

2

Address Line 1

N

addressLine1

String

100

Address Line 2

N

addressLine2

String

100

City/Locality Name

N

cityName

String

25

County Code

N

countyName

String

3

State/Province Code

N

stateCode

String

2

Zip Code

N

zipCode

String

9

Message Code

Y

shinesCode

String

10

Source System

Y

sourceSystem

String

50

Error Code

Y

empiCode

String

10

Worker Identification

Y

szRacfid

String

10

Register Client in EMPI

1.4.1 Functional Description

After the Case Manager clicks the “EMPI Request” button on the Person Identifiers Detail page, the HRRSSCRN inquiry request initiates in EMPI via the interface and attempts to locate the Person/Client. If the result set contains no matching records, or the result set contains records with a matching percentage of less than 90%, the Registration button will be enabled. If the returned results do not contain the client the user is looking for the user can click the Registration button, which displays the EMPI Registration page. For additional information about the EMPI Registration page including mock-ups, see the EMPI Registration detailed design.

Process Flow

Table of request attributes from SACWIS to EMPI for Screening (EMPI Match)

Table of request attributes from SACWIS to EMPI for Screening (EMPI Match)

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the document.

Table of request attributes from SACWIS to EMPI for Registration (EMPI Create)

Data Element RequiredField? Request Attribute EMPI Data Type EMPI Field Length

First Name

Y

client_first_name

String

30

Last Name

Y

client_last_name

String

30

Gender

Y

client_sex_cd

String

1

Primary Language

N

primaryLanguage

String

4

Date of Birth

N

client_dob_dt

Date

Birth City

N

birthcityName

String

25

Birth State

N

birthStateCode

String

2

County of Residence

Y

persAddrCounty

String

3

Ethnicity

Y

client_ethnicity_code

String

2

Marital Status

N

MaritalStatus

String

2

Social Security Number

N

clientSSN

String

9

DOB Verification Code

Y

clint_dob_ver_cd

String

2

DOB Verification Date

Y

clint_dob_dt

Date

Race

Y

client_race_cd, clint_native_american, client_asian, client_african_american, client_pacific_islander, client_white

String

2

City/Locality Name

N

birthcityName

String

25

State/Province Code

N

birthStateCode

String

2

County Code

N

persAddrCounty

Numeric

3

Alias SSN Number

N

Alias_ssn_num_0

String

9

ID Value

N

clientIdentifier

Numeric

10

Source System

Y

sourceSystem

String

50

Worker Identification

Y

UserID

Numeric

10

Middle Name

N

client_mid_name

String

30

Name Suffix

N

client_suf_name

String

5

Client City

Y

clint_city_cd

N/A

N/A

Alias Race Cd

Y

Alias_race_cd

N/A

N/A

Alias Native American

Y

Alias_native_american

N/A

N/A

Alias Asian

Y

Alias_asian

N/A

N/A

Alias African American

Y

Alias_african_american

N/A

N/A

Alias Pacific Islander

Y

Alias_pacific_islander

N/A

N/A

Alias White

Y

Alias_white

N/A

N/A

Alias Ethnicity Code

Y

Alias_ethnicity_code

N/A

N/A

Alias Gender Code

Y

Alias_sex_cd

S9

N/A

Alias SSN Number 1

Y

Alias_ssn_num_1

String

15

Alias SSN Number 2

Y

Alias_ssn_num_2

String

N/A

Alias SSN Number 3

Y

Alias_ssn_num_3

String

N/A

Alias SSN Number 4

Y

Alias_ssn_num_4

String

N/A

Cycle Date

Y

cycleDate

Date

Return Value

Y

returnValue

String

N/A

Benefit Month

Y

benefitMonth

Date

N/A

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the document.

Table of response attributes that will be received from EMPI in the Create Response

Data Element Required? Request Attribute EMPI Field Type EMPI Field Length

Client ID

Y

clientId

9

Message Code

Y

shinesCode

String

10

Error Code

Y

empiCode

String

10

Worker Identification

Y

shinesWorkerID

String

10

Update Client in EMPI

Functional Description

When the user selects one of the matching records from the returned list after screening, and successfully saves the EMPI ID in SHINES by clicking ‘Save’ button on the Person Identifiers Detail page, SHINEs will inform EMPI about our participation in regards to that individual.

Whenever an individual is selected from the screening process, the EMPI ID and update information will be stored in a new SHINES EMPI Update outbound table. Web Methods will implement a new web service to process the records in that table and send the stored data in an Update request to EMPI.

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the document.

Table of request attributes that will be sent from the EMPI_UPDATE_OUTBOUND table to EMPI in an UPDATE request

Request Data Element Required Field? Required Field? SACWIS Table Name SACWIS Field Name EMPI Field Type EMPI Field Length

Client ID

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

ID_CLIENT

String

9

First Name

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

NM_FIRST

String

30

Last Name

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

NM_LAST

String

30

Gender

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_GENDER

String

1

Date of Birth

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

DT_BIRTH

Date

County of Residence

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_CNTY_RESIDENCE

String

3

Ethnicity

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_ETHNICITY

String

2

Race

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_RACE

String

2

ID Value

N

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

ID_EMPI_NBR

String

9

Source System

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_SOURCE_SYSTEM

String

50

Worker Identification

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

ID_WORKER

String

30

EMPI Error Code

N

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

CD_EMPI_ERROR

String

50

Process Date

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

DT_PROCESS

Date

African American Ind

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

IND_CLIENT_AFN_AMER

N/A

N/A

Asian Ind

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

IND_CLIENT_ASIAN

N/A

N/A

Native American Ind

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

IND_CLIENT_NAT_AMER

N/A

N/A

Pacific Islander Ind

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

IND_CLIENT_PAC_ISLD

N/A

N/A

White Ind

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

IND_CLIENT_WHITE

N/A

N/A

Interface Status

Y

EMPI_UPDATE_OUTBOUND

EMPI_UPDATE_OUTBOUND

INTERFACE_STATUS

N/A

N/A

Alert Service from EMPI

Functional Description

As EMPI acts as a central hub for person data for different data source agencies, such as $TARS and SUCCESS, SHINES will receive alerts for any changes made to that Individual in EMPI from other participating systems through the Alert web service from EMPI. SHINES will need to develop a web service to consume the changes sent. EMPI will invoke the Alert web service to send the alerts to case managers within SHINES on update and merge events for the Individual that exists in SHINES on the request. Unmerge actions will not be performed within SHINES to prevent the altering of identifiers tied to different individuals in SHINES. Within the $TARS and SUCCESS systems, one or more identifiers may be linked to the same individual however, that may not be the case within the SHINES system.

Update Alert: For the Update event, the updated Individual record will be sent from EMPI to SHINES along with the Alert web message containing the Data elements that are changed and a message code indicating what Data elements have been changed. The Update record will contain a set of mandatory data elements (first name, last name, race, ethnicity, gender) and also other data elements (refer to the Alert Data Elements tab for a list of the data elements for which Alerts need to be sent). This information will be displayed on the Individual’s Person Detail page under EMPI Data Changes section where changes can be made if a user with appropriate rights is on the person’s related open case. Otherwise, the information will be displayed on the Individual’s Person Detail page with editing options disabled. An alert will be sent to the primary case manager and their case hierarchy informing them of this new demographic information.

A new section titled EMPI Data Changes has been added to the Person Detail page in a new submodule. If an individual currently has no Open cases, this section will not display. If a user is currently viewing the Individual’s Person Detail page on an Open case and Closed stage, this demographic information will display but will be unmodifiable. If a user is currently viewing an Individual’s Person Detail page on an Open case and Open stage, this demographic information will display and will be modifiable. In this section, two columns will appear with the SHINES versus EMPI information for the targeted individual. A case manager can make changes by selecting the checkboxes on each row of the desired change they would like to make. These changes can be applied to the targeted individual’s SHINES data by selecting the “Update” button. When no checkboxes have been selected, no changes are made and therefore, considered not accepted.

Merge Alert: For #[.line-through]#any #[.line-through]#person merges[.line-through]# done#, by participating systems $TARS and SUCCESS[.line-through]# on an Individual that SHINES has notified EMPI about#, #[.line-through]#EMPI When an EMPI merge is requested by any non-SHINES participating system to EMPI, EMPI informs all systems including SHINES of the merge request via the data steward process. Upon arrival approval from all participating systems, including SHINES, to perform the merge, EMPI will invoke the Alert web service to send a response that contains the Key Message block and Client ID block data elements. If the SHINES individual in the alert currently has an EMPI ID that does not match the non-SHINES active EMPI ID in the request, their the individual’s EMPI ID is inactive will be deactivated and end-dated. The active ID in the request will be made their active EMPI ID. If the SHINES individual in the alert currently has an active ID that matches the active ID in the request, no change will be made as their current ID is already the active EMPI ID in SHINES for the merged EMPI Individual. An alert will be sent to the primary case manager and their case hierarchy informing them of this new merge information related to the Individual on the request that exists in SHINES, regardless of whether they are active or inactive.

Unmerge Alert: For any person unmerge performed, by participating systems $TARS and SUCCESS[.line-through]# on an Individual that SHINES has notified EMPI about,# When an EMPI unmerge is requested by any participating systems to EMPI, EMPI informs all systems, including SHINES, of the request. EMPI will invoke the Alert web service to send a response that contains the Key Message block and Client ID block data elements corresponding to the newly created Client ID. SHINES will simply store this information in the inbound database table and no other action will be performed.

All EMPI data that is received through the interface will be saved in the SHINES database for audit purposes. The latest EMPI data in the Alert response will be programmatically compared to the current SHINES database data. If the values differ, a SHINES task/alert will be generated to the Case Manager or Supervisor to notify them of the changes and prompt them to either accept or reject the changes under the Staff to-do list.

Upon approval of the task, the #[.line-through]#selected #[.line-through]#changes will be #[.line-through]#systematically applied to the database and[.line-through]# the updated data and change history#[.line-through]# will [.line-through]#be displayed[.line-through]# in the [.line-through]#P[.line-through]erson #[.line-through]#Detail #[.line-through]#page and its sub-module pages. Upon reject[.line-through]ion[.line-through], no changes #[.line-through]#will be #[.line-through]#made to the SHINES application. #[.line-through]#T[.line-through]he #[.line-through]#database will be updated with either the #[.line-through]#approval or reject[.line-through]ion[.line-through]# information#. #[.line-through]#However, i[.line-through]f the current SHINES data and the #[.line-through]#EMPI data from the Alert response #[.line-through]#are the same, a task/alert will not be sent to the Case Manager or #[.line-through]#Supervisor[.line-through]# and the [.line-through]#change history[.line-through]# will not be displayed [.line-through]#in[.line-through]# the Person Detail page#[.line-through]# and its sub-module pages. #

Process Flow

The following table describes the EMPI attributes either sent to or received from the EMPI system. For additional details of the interface please refer to the document.

Table of response attributes received from EMPI ALERT response and stored in the EMPI_ALERT_INBOUND Table.

Response Data Element Required Field? SACWIS Table Name SACWIS Field Name EMPI Field Type EMPI Field Length

Update Date

Y

EMPI_ALERT_INBOUND

UPDATE_DATE

Date

Event Type

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

10

Client ID

Y

EMPI_ALERT_INBOUND

ID_PERSON

String

9

First Name

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

15

Last Name

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

20

Message Code

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

10

Event Date

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Date

First Name

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

15

Last Name

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

20

Middle Name

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

12

Gender

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

Generation Suffix code

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

4

Prefix

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

3

Primary Language

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

Social Security Number

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Numeric

9

Birth State

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

2

Date of Birth

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Date

Birth City

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

22

Death Date

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Date

Indicator for Death

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

Ethnicity

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

EMPI Individual Status Indicator

N

EMPI_ALERT_INBOUND

IND_EMPI_INDV_STATUS

String

2

Marital Status

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

US Citizenship Indicator

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

2

SSN Verification Code

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Date

SSN Verification Date

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

2

DOB Verification Code

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

Date

DOB Verification Date

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

1

Confidentiality Type Code

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

100

Race

Y

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

2

IDType

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

20

IDStatus

N

EMPI_ALERT_INBOUND

ID_STATUS

String

1

IDValue

N

EMPI_ALERT_INBOUND

LATEST_EMPI_DATA

String

9

Design Requirements

Validated Functional Requirement Number Conceptual Design Requirement Number Conceptual Design Requirement

EMPI 1.1

EMPI 1.1.1

Rename CRS Inquiry page to EMPI Inquiry page

EMPI 1.1

EMPI 1.1.2

Rename CRS Registration page to EMPI Registration page

EMPI 1.1

EMPI 1.1.3

Update Type drop down to show EMPI ID# instead of CRS ID# on Person Identifiers Detail page

EMPI 1.1

EMPI 1.1.4

Modify CRS Request button to display as EMPI Request button on Person Identifiers Detail page

EMPI 1.1

EMPI 1.1.5

Modify Add to CRS button display as Add to EMPI button on EMPI Registration page.

EMPI 1.1

EMPI 1.1.6

Update all the messages on the EMPI Registration page to display EMPI instead of CRS.

EMPI 1.1

EMPI 1.1.7

Update all the messages on the Person Identifier page to display EMPI instead of CRS.

EMPI 1.1

EMPI 1.8.1

Update all the label changes from CRS to EMPI on Application and Background page

EMPI 1.1

EMPI 1.1.9

Update all the CRS references in implementation classes in SHINES to EMPI.

EMPI 1.1

EMPI 1.1.10

Update all the database CRS ID# values to EMPI ID#

EMPI 2.1

EMPI 2.1.1

Update Screening web service request to send Race, Ethnicity, source system and address details to EMPI

EMPI 2.1

EMPI 2.1.2

Update Screening web service response to receive Race, MDM scores, Address details, Message codes, and Error codes from EMPI

EMPI 2.1

EMPI 2.1.3

Update EMPI Inquiry Screening page on SHINES application page to show MDM score and Address information for the response

EMPI 2.1

EMPI 2.1.4

Update the EMPI Inquiry page of the SHINES application to display messages or error codes as part of validation.

EMPI 2.1

EMPI 2.1.5

Update the EMPI Inquiry page of the SHINES application to display the new MDM Score help text

EMPI 2.2

EMPI 2.2.1

Update Registration web service request to send Race, Confidentiality, source system and address details to EMPI

EMPI 2.2

EMPI 2.2.2

Update Registration web service response to receive Error codes, Message codes from EMPI.

EMPI 2.2

EMPI 2.2.3

Update EMPI Registration page on SHINES application to display messages or error codes as part of validation as well to show MDM score and Address information.

EMPI 2.2

EMPI 2.2.4

The Person Detail page in SHINES shares error messages with the EMPI Registration page: Update the Person Detail page to display those updated error messages.

EMPI 2.2

EMPI 2.2.5

Update the EMPI Registration page of the SHINES application to display the new MDM Score help text.

EMPI 3.1

EMPI 3.1.1

The system shall hide the Registration button on EMPI Inquiry page, if at least one of the items in the returned list has a match score of 90% or more.

EMPI 3.1

EMPI 3.1.2

The system shall force case manager to select the record with 100% match record even if there are other records which are in the range of 90 – 99% and also hide the Registration button on EMPI inquiry page

EMPI 3.1

EMPI 3.1.3

If the system returns results where the match score is between 90 – 99%, the system shall force the case manager to use one entry within the range and also hide the Registration button on the EMPI inquiry page.

EMPI 3.1

EMPI 3.1.4

If the system returns results where the match score is less than 90%, the system shall allow the case manager to pick one of those and shall also show the Registration button on the EMPI inquiry page.

EMPI 3.2

EMPI 3.2.1

The system shall hide the Add to EMPI button on the EMPI Registration page, if at least one of the items in the returned list has a match score of 90% or more.

EMPI 3.2

EMPI 3.2.2

The system shall force case manager to select the record with 100% match record even if there are other records which are in the range of 90 – 99% and also hide the Add to EMPI button on EMPI Registration page.

EMPI 3.2

EMPI 3.2.3

If the system returns results where the match score is between 90 – 99%, the system shall force the case manager to use an item within the range and also hide the Add to EMPI button on EMPI Registration page.

EMPI 3.2

EMPI 3.2.4

If the system returns results where match score is less than 90%, the system shall allow the case manager to pick one of those items and also show the Add to EMPI button on EMPI Registration page.

EMPI 4.1

EMPI 4.1.1

Web Methods will implement a new web service to process records in the SHINES EMPI Update outbound table.

EMPI 4.1

EMPI 4.1.2

The system shall create a new EMPI Update outbound table in the SHINES database so that web Methods can send this stored data to EMPI.

EMPI 4.1

EMPI 4.1.3

SHINES shall invoke the update service when a user selects a matching record and successfully saves the EMPI ID in SHINES by clicking ‘Save’ button on the Person Identifiers Detail page.

EMPI 5.1

EMPI 5.1.1

Web Methods will initiate calls to a new SHINES web service which processes and populates EMPI Alert data in the SHINES EMPI Alert inbound table.

EMPI 5.1

EMPI 5.1.2

Implement the web service response through GTA – web method broker to receive attributes.

EMPI 5.1

EMPI 5.1.3

System shall create a new table in SHINES database to store the information received.

EMPI 5.1

EMPI 5.1.4

System shall accept and store all information from EMPI.

EMPI 5.2

EMPI 5.2.1

For individuals on open cases, the system shall display the current SHINES data and the most recent EMPI data in a new expandable section on the Person Detail page.

EMPI 5.2

EMPI 5.2.2

For individuals on closed cases, the system shall provide an indication that EMPI data has changed.

EMPI 6.1

EMPI 6.1.1

Do not provide radio buttons or in any way allow those assigned to the stage as primary, secondary or in stage hierarchy to select any record from the MDM search results.

EMPI 6.2

EMPI 6.2.1

Provide a radio button for each record that is a 100% match. Those assigned to the stage as primary, secondary or in stage hierarchy may use the radio button to select any record in the MDM results that is a 100% match.

EMPI 6.2

EMPI 6.2.2

Do not provide a radio button or in any way allow those assigned to the stage as primary, secondary or in stage hierarchy to select a record that is a less than 100% match if any record in the results is a 100% match

EMPI 6.2

EMPI 6.2.3

No more than 1 record may be selected from the MDM results list.

EMPI 6.3

EMPI 6.3.1

Provide a radio button for each record that has a match score from 90% to 99%. Those assigned to the stage as primary, secondary or in stage hierarchy may use the radio button to select any record in the MDM results with a match score of 90% to 99%.

EMPI 6.3

EMPI 6.3.2

Do not allow those assigned to the stage as primary, secondary or in stage hierarchy to select a record with a match score below 90% if the results list includes a record(s) with a match score of 90% to 99% and does not include a record with a 100% match score. If the User selects a score below 90%, they will receive an error message via popup.

EMPI 6.3

EMPI 6.3.3

No more than 1 record can be selected from the MDM results list

EMPI 6.4

EMPI 6.4.1

Provide a radio button for each record. Those assigned to the stage as primary, secondary or in stage hierarchy may use the radio button to select any record in the MDM results list

EMPI 6.4

EMPI 6.4.2

No more than 1 record can be selected from the MDM results list.

EMPI 6.4

EMPI 6.4.3

Those assigned to the stage as primary, secondary or in stage hierarchy may either choose a record from the MDM results list or register the client for a new EMPI ID. Those assigned to the stage as primary, secondary or in stage hierarchy may not perform both of these actions.

EMPI 7.1

EMPI 7.1.1

Do not display data in the new section described in DR 5.2.1 if the current SHINES database data and the latest EMPI data match.

EMPI 7.1

EMPI 7.1.2

Do not alert the SHINES user that EMPI has provided new demographic data if that new data matches what currently exists in the SHINES database.

EMPI 7.2

EMPI 7.2.1

Add an approval indicator next to each data change listed in the new expandable section on the “Person Detail” page. (e.g. radio button, check box, etc.)

EMPI 7.2

EMPI 7.2.2

Add functionality to systemically apply to the SHINES database all data changes approved by those assigned to the stage as primary, secondary or in stage hierarchy. This functionality needs to be initiated by a party assigned to the stage as primary, secondary or in stage hierarchy. (e.g. button labeled “Apply Data Changes”, etc.)

EMPI 7.2

EMPI 7.2.3

Add an alert to both the “Staff To Do” and “Case To Do” lists in SHINES that will be visible whenever EMPI data changes are available for the open stage.

Technical Design

Technical Overview

The CRS application runs as a COBOL application in a mainframe environment using DB2 as the database. The application has an interface that is invoked via CICS transactions. The search transaction returns up to 250 matches, and the register function returns status and CRS ID. If the multiple results does not match the exact fields then the user needs to narrow the search by using SACWIS would not directly interact with CRS. GTA (Georgia Technology Authority) would interact with the CRS and would provide an interface for SACWIS to interact. GTA uses WebMethods, which will interface with the CICS transaction exposed as a web service interface by CRS. SACWIS will invoke the web service in real time, using SOAP/XML as the transport mechanism.

CRS Technical Specifications

Hardware/OS: IBM Mainframe

Programming Language: COBOL

Database: DB2

Transactional Monitor: CICS

Physical Location: GTA

Current Interfaces: CICS transaction

Protocols: WebMethods to provide Web Service interface to CICS transaction

Search CRS for Client

Technical Description

The SACWIS application invokes a web service through the WebMethods ServiceNet interface and the data is encrypted by SSL. WebMethods invokes the CICS transaction by parsing the XML fields in the SACWIS request payload and passing them on to the COBOL CICS transaction. The COBOL process then performs the search, and returns 250 rows. The WebMethods interface converts that data into XML, and returns the values in real-time to SACWIS. SACWIS then parses the XML and display the results using the CRS Search Results page.

Sequence Diagram

Message Description

This message contains demographic information for a client within SACWIS to perform an inquiry against client records already in CRS. CRS will perform an inquiry operation by invoking the CICS HRRSSCRN function on the mainframe, and this function will use the values in this message as search parameters.

Here is a potential sample message:

<CRS_SERVICE name=”HRRSSCRN”> <NAME> <LAST>Smith</LAST> <FIRST>John</FIRST> <MIDDLE>Donald</MIDDLE> <SUFFIX>Jr</SUFFIX> </NAME> <SEX>M</SEX> <SOCIAL_SECURITY_NUMBER>123456789</SOCIAL_SECURITY_NUMBER> <WHITE>Y</WHITE> <ETHNICITY_CODE>W</ETHNICITY_CODE> </CRS_SERVICE>

Table of outbound fields from SACWIS to CRS

See Section 1.3.3

Table of inbound fields from CRS to SACWIS

See Section 1.3.4

Method Narrative

Case Managers enters details on each person in a case on the Person Detail page. The user must* *enter a valid Social Security Number, along with first and last name, gender, race, and ethnicity in order to initiate the CRS search. Date of birth may also be used if available and known. The user presses the “Get CRS ID” button on the Person Identifiers Detail page (button displays after selecting CRS as the Type) to invoke the search for that client. If the user supplies an SSN and the CRS search returns no matches, the application removes the SSN from the search criteria and searches again based on the demographic data. Search results are then displayed on the CRS Search Results page.

Error Handling

CRS is a real-time user interface, so the SACWIS user is informed of errors right away. If the web service is not available, the user is informed accordingly and requested to try again at a later time. I f there is a failure on the mainframe side, the user is informed accordingly and asked to try again at a later time.

Field Level Errors

Validation of SACWIS data occurs on the respective pages. No additional field level error handling is required.

Row Level Errors

None

Process Level Errors

Web Service, CICS, and other application failures are reported to the user, and the user is requested to try the operation again at a later time.

Triggering/Scheduling

CRS ID request is initiated by the Case Manager selecting ‘CRS’ as the Type on the Person Identifiers page and then clicking the displayed “Get CRS ID” button.

Matching Criteria

The user entered information must match with CRS on SSN, last name, gender, race, and ethnicity to be considered a true match. If a social security number is specified as search criteria, the CRS interface first searches using the SSN. If no match is found based on SSN, the SACWIS application removes SSN (as a search criteria) and searches CRS again behind the scenes.

To summarize, screening without an SSN performs a search on the demographic info passed as follows:

FIRST CHECK BY SSN (if available)

SECOND CHECK BY (LAST, FIRST, MIDDLE, SUFFIX, DOB, RACE, SEX)

If no matches: Remove DOB as a search criterion.

THIRD CHECK BY (LAST, FIRST, MIDDLE, SUFFIX, SEX, RACE)

If no matches: Remove Race as search criteria

FOURTH CHECK BY (LAST, FIRST, MIDDLE, SUFFIX, SEX)

Dependencies

.

Register Client in CRS

Technical Description

The SACWIS application invokes a web service through the WebMethods ServiceNet interface and the data is encrypted by SSL. WebMethods invokes the CICS transaction by parsing the XML fields in the SACWIS request payload and passing them on to the COBOL CICS transaction. The COBOL process then adds the client to CRS. Next, the WebMethods interface converts the relevant data into XML and returns the values in real-time to SACWIS. SACWIS parses the XML, displays result on the Person Identifiers Detail page, and stores the IRN in the Oracle database.

Sequence diagram

Message Description

This message contains name, Social Security Number, and demographic information for a client in SACWIS for purposes of registering that client (creating a record for the client) in CRS. CRS will validate the information and create the record when the HRRSREGS CICS function is invoked on the mainframe.

Table of Outbound fields from SACWIS to CRS

See section 1.4.3

Table of Inbound fields from CRS to SACWIS

See section 1.4.4

Method Narrative

Case Managers enter the details of each person on the Person Detail page. If the CRS search request does not return any search results for the respective person, the user can then register the person in CRS as a new client clicking the Add to CRS button on the CRS Search Results page. This registration process creates the client in CRS via a real-time, synchronous web service call.

Error Handling

CRS is a real-time user interface, so the SACWIS user is informed of errors immediately. If the web service is not available, the user is informed accordingly requested to try again at a later time. If there is a failure on the mainframe side, the user is informed accordingly and also requested to try again at a later time.

Field Level Errors

Data validation and transformation occurs in SACWIS prior to reaching CRS. Therefore, no additional field level validation is required in the interface.

Row Level Errors

None

Process Level Errors

Web Service, CICS, and other application failures are reported to the user, and the user is requested to try the operation again at a later time.

Triggering/Scheduling

The Register request is initiated by clicking the “Add to CRS” button on the CRS Search Results page.

Matching Criteria

None

Dependencies

Reference

The interface between the EMPI system and SACWIS is brokered by the Web Methods architecture supported by GTA. The detailed message description and the broker architecture will be available in the GTA detail design that will be created and maintained by GTA.

EMPI* DOB Verification codes:*

Date Of Birth Verification Codes Date Of Birth Verification Codes

AC

Alien Card

BC

Birth Certificate

BR

Baptismal Record

CS

Client Statement

DL

Driver’s License

FB

Family Bible

HC

Hospital Certificate

NV

Not Verified Failed

OT

Verified Other

SS

Verified SSN Record

EMPI* SSN Verification codes:*

SSN Verification Codes SSN Verification Codes

Alias Social Security Number

CA

Verified Social Security Numbr Card

CO

Not Verified Conversion

CS

Client Statement

ER

Social Security Number Error

FV

Verified SSN Interface

LE

Verified Letter

MC

Verified Medicare Card

NV

Not Verified Failed

OT

Verified Other

Appendix A: EMPI Source - to - Target Mapping (Match, Create, Update, Alert)

Appendix B: EMPI Message Code Mapping (Match, Create, Update, Alert)

Appendix C: EMPI Code Value Mapping

Open Discussion Points

Point# Description Resolution/Comments Status (Open, In Progress, Resolved)

Document Change Log

Date Author Change Description

03/30/2016

Christine Nguyen

Added EMPI Reason Codes to 1.2.6, updated name of table 1.2.6, updated text in 1.6.1 for clarity, updated design requirement (1.6) EMPI 3.2 to clarify 100% match records are automatically selected

3/16/2016

Christine Nguyen and Roshanda Minor

Added 1.2.4 to detail SHINES Informational/Error Messages Added 1.2.5 to detail System Generated To Do’s Removed redundant EMPI informational/error messages

tabl3/15/2016

Christine Nguyen, Roshanda Minor, Ashwini Rege

EMPI error messages updated to include the most up-to-date set and moved under General Design Updated 1.6 under Update Alert to include detail on EMPI Data Changes submodule on Person Detail and checkboxes for updates Removed error messages throughout that are no longer applicable Replaced CRS with EMPI when applicable, Section 2.0 remains the same

03/10/2016

Christine Nguyen and Roshanda Minor

Clarified the description for merge and unmerge alerts within 1.6 Alert Service from EMPI Updated to replace CRS text with EMPI – 2.3.6, 2.3.7, 2.3.11

03/09/2016

Christine Nguyen and Roshanda Minor

Updated 1.6 Alert Service from EMPI to provide further detail on Update and Merge Alerts

02/23/2016

Pamela Gifford and Roshanda Minor

Version 2.0, EMPI – Prepare document for delivery Added overview flow

8/2/2015

Jason Browning

EMPI Peer Review Modifications.

07/30/2015

Jason Browning and Roshanda Minor

EMPI is almost a complete rewrite. Updated all sections. Everything from 1.3.3 ”Table of request attributes sent from SACWIS to EMPI (EMPI Match)” onward is new. Edited the Functional Design section to match the new high level requirements HL1 – HL7. Refactored CRS to EMPI throughout the text, flows, screen shots and tables, added new description for matching process, modified flows, added screen shots to illustrate new functionality and modified the inbound and outbound tables to show the request and response fields for EMPI Match, Create, Update and Alert. Added Appendix A for EMPI Error Code Mappings

02/13/2015

Praneeth Ala

CO 5

08/14/2007

Michael Chillman

Updated requirements

07/24/2007

Michael Chillman

Added comments for error code processing

06/28/2007

Michael Chillman

Added that name elements passed to CRS must be in upper case and added User Id parameters that will be passed in both the for both the screening and registration services

03/27/2007

Dinesh Jayapalan

Updated with design and data changes. Added additional information obtained from CRS team to reference section.

03/01/2007

Dinesh Jayapalan

Updated with State’s (CWS) comments

01/26/2007

Dinesh Jayapalan

Updated design with new requirements. Added page mockups. Added description and process flow diagrams. Added sequence diagram.

08/21/2006

John Ramspott

Added more detail on screening and matching criteria.

08/01/2006

John Ramspott

Initial Document Creation

Edit this page · latest