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*
WIC Referral* - IES*
Georgia Department of Human Services
Statewide Automated Child Welfare Information System
(SACWIS)
TBD
Version 1.0
Table of Contents
General Design (Functional)
| Req. # | Validated Requirement |
|---|---|
WIC - 1.1 |
The system shall send the following data fields to IES for a child ages 0-5 or a pregnant child for a WIC referral: o Child’s Name - First Name - Middle Name - Last Name o Child Suffix o Gender o Race o Ethnicity o Date of Birth o Social Security Number (SSN) o Citizenship/Alienage Status o Child’s most recent active placement address o Office Location (Street) o SSCM Name o Office City o State o County (Legal County) o Placement County o Pregnancy (Y or N) o Email Address of Primary Case Manager o Date of Submission o Prior Medical Assistance Indicator (Y or N) o EMPI ID o Start date of most recent active placement o Source o Program o Foster Parent Name o Foster Parent Phone Number o Foster Parent Email Address o Requesting Aid Indicator (N) o Type of Action o Transaction ID |
WIC - 2.1 |
The system shall send the updated legal status of a child to IES |
WIC - 3.1 |
The system shall send the updated placement address of a child to IES |
WIC - 4.1 |
The system shall store the WIC eligibility status of a child |
Document Purpose
This document provides a detailed description of a Georgia SHINES outbound interface that sends case data to the Integrated Eligibility System to satisfy a WIC Referral for a child.
Functional Description
The WIC Referral Outbound Interface is used to provide information needed to complete a WIC referral for children ages 0-5 or a pregnant individual who is in DFCS custody (In DFCS custody legal statuses are: Permanent Court, Permanent Voluntary, Short Term Emergency Care, Temporary Court, Temporary Voluntary, Joint Commitment with DJJ – Permanent Court, Joint Commitment with DJJ - Temporary Court).
The trigger point for a WIC referral to be sent from SHINES to Gateway is when an individual comes into care (a legal status of in DFCS custody). The information that is currently captured in SHINES at this point will be sent. The only exception to this trigger point is the legal status and placement address. Should the legal status for an WIC-eligible individual change to out of DFCS custody, SHINES will send IES the new legal status. Similarly, should the placement for a WIC-eligible individual change, SHINES will send IES the new placement address. The specific trigger for this update is when the resource changes in the placement. For the initial submission to WIC, the placement information can be sent when the placement is at any status (PROC, PEND, COMP or APRV). For subsequent submissions, the placement will need be in COMP, PEND or APRV status. Temporary placement types will be excluded from submission.
Once an individual is no longer in DFCS custody, WIC updates will not be sent.
In return, IES will send SHINES the WIC referral transmission status. This status will be stored on the backend and will not visible to user.
Security Rules
| User Type | View | Add | Update | Delete | No Access |
|---|---|---|---|---|---|
Case Manager (Assigned) |
X |
X |
X |
||
Supervisor (Assigned) |
X |
X |
X |
Request Elements
Below is a list of the WIC data elements from SHINES that will be sent to IES. At the first trigger point detailed in the functional description above, any of the data elements below that have been captured in SHINES will be sent. By the second and last trigger point, the majority, if not all, of the information below will be captured in SHINES. This final submission will complete the WIC referral.
| Data Element | SHINES Origin |
|---|---|
Child’s Name (First, Middle, Last) |
Person Detail |
Child Suffix |
Person Detail |
Gender |
Person Detail |
Race |
Race/Ethnicity on Person Detail |
Ethnicity |
Race/Ethnicity on Person Detail |
Date of Birth |
Person Detail |
Social Security Number |
Person Identifiers on Person Detail |
Citizenship/Alienage Status |
Citizenship and Identity of Person Detail |
Most Recent Placement Address |
Placement Information |
County of Most Recent Placement Address |
Placement Information |
Name of Case Manager |
Staff Detail |
Office Location of Case Manager |
Staff Detail |
Legal County of Child |
Legal Status |
Pregnancy Indicator |
Person Characteristics on Person Detail or Health Visit Diagnosis on Health Detail |
Email Address of Case Manager |
Staff Detail |
Date of Submission |
N/A (Send Date Referral Sent to IES) |
Prior Medical Assistance Indicator |
Medicaid Application |
EMPI ID |
Person Identifiers on Person Detail |
Start Date of Most Recent Active Placement |
Placement Information |
Source |
N/A (Send ‘SHIN’ when sending to IES) |
Program |
N/A (Send ‘WC’ to IES) |
Foster Parent Name |
Resource Detail (Legal Name) or Person Detail |
Foster Parent Phone Number |
Resource Detail or Person Detail |
Foster Parent Email Address |
Resource Detail or Person Detail |
Requesting Aid |
N/A (Default to ‘N’ when sending to IES) |
Type of Action |
N/A (Initial referral will be considered ‘IN’ and any placement changes will be considered ‘PC’ when sending to IES) |
Transaction ID |
N/A (Unique ID created by SHINES for transaction to IES) |
Legal Status |
Legal Status (Sent only when the status changes after the initial referral) |
Codes Tables
| Field Label | Legal Status |
|---|---|
Codes Table Name (If applicable) |
CLEGSTAT |
Code |
Decode |
AFS |
Aftercare/Supervision |
CTD |
Committed To DJJ |
ILP |
ILP Aftercare |
NAF |
Not In DFCS Custody – Adoption Finalized |
NCT |
Not In DFCS Custody – Child Turned 18 (No ILP) |
NCD |
Not In DFCS Custody – Child Death |
NCO |
Not In DFCS Custody – Custody To Other |
NTT |
Not In DFCS Custody – Custody Transferred To Tribe |
NCE |
Not In DFCS Custody – Emancipated |
NGP |
Not In DFCS Custody – Guardianship |
NPC |
Not In DFCS Custody – Parental Custody |
NPR |
Not In DFCS Custody - Custody To Relative |
NOT |
Not In DFCS Custody – Out of State Child Adopted by Georgia Family |
PCT |
Permanent Court |
PVL |
Permanent Voluntary |
STE |
Short Term Emergency Care |
TCT |
Temporary Court |
TVL |
Temporary Voluntary |
NCS |
Not In DFCS Custody - Custody With Other State |
NDJ |
No Longer Committed to DJJ |
DJA |
DJJ Aftercare |
JCP |
Joint Commitment With DJJ - Permanent Court |
JCT |
Joint Commitment With DJJ - Temporary Court |
NCR |
Not In DFCS Custody - Runaway |
| Field Label | County |
|---|---|
Codes Table Name (If applicable) |
CCOUNT |
Code |
Decode |
001 |
Appling |
003 |
Atkinson |
005 |
Bacon |
007 |
Baker |
009 |
Baldwin |
011 |
Banks |
013 |
Barrow |
015 |
Bartow |
017 |
Ben Hill |
019 |
Berrien |
021 |
Bibb |
023 |
Bleckley |
025 |
Brantley |
027 |
Brooks |
029 |
Bryan |
031 |
Bulloch |
033 |
Burke |
035 |
Butts |
037 |
Calhoun |
039 |
Camden |
043 |
Candler |
045 |
Carroll |
047 |
Catoosa |
049 |
Charlton |
051 |
Chatham |
053 |
Chattahoochee |
055 |
Chattooga |
057 |
Cherokee |
059 |
Clarke |
061 |
Clay |
063 |
Clayton |
065 |
Clinch |
067 |
Cobb |
069 |
Coffee |
071 |
Colquitt |
073 |
Columbia |
075 |
Cook |
077 |
Coweta |
079 |
Crawford |
081 |
Crisp |
083 |
Dade |
085 |
Dawson |
087 |
Decatur |
089 |
Dekalb |
091 |
Dodge |
093 |
Dooly |
095 |
Dougherty |
097 |
Douglas |
099 |
Early |
101 |
Echols |
103 |
Effingham |
105 |
Elbert |
107 |
Emanuel |
109 |
Evans |
111 |
Fannin |
113 |
Fayette |
115 |
Floyd |
117 |
Forsyth |
119 |
Franklin |
121 |
Fulton |
123 |
Gilmer |
125 |
Glascock |
127 |
Glynn |
129 |
Gordon |
131 |
Grady |
133 |
Greene |
135 |
Gwinnett |
137 |
Habersham |
139 |
Hall |
141 |
Hancock |
143 |
Haralson |
145 |
Harris |
147 |
Hart |
149 |
Heard |
151 |
Henry |
153 |
Houston |
155 |
Irwin |
157 |
Jackson |
159 |
Jasper |
161 |
Jeff Davis |
163 |
Jefferson |
165 |
Jenkins |
167 |
Johnson |
169 |
Jones |
171 |
Lamar |
173 |
Lanier |
175 |
Laurens |
177 |
Lee |
179 |
Liberty |
181 |
Lincoln |
183 |
Long |
185 |
Lowndes |
187 |
Lumpkin |
189 |
McDuffie |
191 |
McIntosh |
193 |
Macon |
195 |
Madison |
197 |
Marion |
199 |
Meriwether |
201 |
Miller |
205 |
Mitchell |
207 |
Monroe |
209 |
Montgomery |
211 |
Morgan |
213 |
Murray |
215 |
Muscogee |
217 |
Newton |
219 |
Oconee |
221 |
Oglethorpe |
223 |
Paulding |
225 |
Peach |
227 |
Pickens |
229 |
Pierce |
231 |
Pike |
233 |
Polk |
235 |
Pulaski |
237 |
Putnam |
239 |
Quitman |
241 |
Rabun |
243 |
Randolph |
245 |
Richmond |
247 |
Rockdale |
249 |
Schley |
251 |
Screven |
253 |
Seminole |
255 |
Spalding |
257 |
Stephens |
259 |
Stewart |
261 |
Sumter |
263 |
Talbot |
265 |
Taliaferro |
267 |
Tattnall |
269 |
Taylor |
271 |
Telfair |
273 |
Terrell |
275 |
Thomas |
277 |
Tift |
279 |
Toombs |
281 |
Towns |
283 |
Treutlen |
285 |
Troup |
287 |
Turner |
289 |
Twiggs |
291 |
Union |
293 |
Upson |
295 |
Walker |
297 |
Walton |
299 |
Ware |
301 |
Warren |
303 |
Washington |
305 |
Wayne |
307 |
Webster |
309 |
Wheeler |
311 |
White |
313 |
Whitfield |
315 |
Wilcox |
317 |
Wilkes |
319 |
Wilkinson |
321 |
Worth |
999 |
Out of State |
XXX |
-None- |
| Field Label | Gender |
|---|---|
Codes Table Name (If applicable) |
CSEX |
Code |
Decode |
F |
Female |
M |
Male |
U |
Unknown |
| Field Label | Ethnicity |
|---|---|
Codes Table Name (If applicable) |
CINDETHN |
Code |
Decode |
HS |
Hispanic/Latino |
NH |
Not Hispanic/Latino |
UT |
Unable to Determine |
| Field Label | Race |
|---|---|
Codes Table Name (If applicable) |
CRACE |
Code |
Decode |
AA |
American Indian/Alaskan Native |
AN |
Asian |
BK |
Black/African American |
HP |
Native Hawaiian/Other Pacific Islander |
UD |
Unable to Determine |
WT |
White |
| Field Label | Suffix |
|---|---|
Codes Table Name (If applicable) |
CSUFFIX |
Code |
Decode |
2N |
Second |
3R |
Third |
4T |
Fourth |
5T |
Fifth |
JR |
Jr. |
SR |
Sr. |
MD |
M.D. |
PD |
PhD |
Removed Baseline Functionality
| Functionality Type | Functionality Name/Description | Reason for Removal |
|---|---|---|
N/A |
Design Requirements
| Validated Functional Requirement Number | Conceptual Design Requirement Number | Conceptual Design Requirement |
|---|---|---|
WIC - 1.1 |
WIC - 1.1.1 |
The system shall send WIC requested data fields to IES when a child age 0-5 has a legal status of In DFCS Custody (Permanent Court, Permanent Voluntary, Short Term Emergency Care, Temporary Court, Temporary Voluntary, Joint Commitment with DJJ – Permanent Court, Joint Commitment with DJJ - Temporary Court) |
WIC - 1.1 |
WIC - 1.1.2 |
The system shall send WIC requested data to IES when a pregnant individual has a legal status of In DFCS Custody (Permanent Court, Permanent Voluntary, Short Term Emergency Care, Temporary Court, Temporary Voluntary, Joint Commitment with DJJ – Permanent Court, Joint Commitment with DJJ - Temporary Court) |
WIC - 1.1 |
WIC - 1.1.3 |
The system shall send WIC requested data fields to IES when an initial Medicaid application has been completed for a child age 0-5 |
WIC - 1.1 |
WIC - 1.1.4 |
The system shall send WIC requested data fields to IES when an initial Medicaid application has been completed for a pregnant individual |
WIC - 1.1 |
WIC - 1.1.5 |
The system shall send the first name of a WIC-eligible individual from the 'First:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.6 |
The system shall send the middle name of a WIC-eligible individual from the 'Middle:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.7 |
The system shall send the last name of a WIC-eligible individual from the 'Last:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.8 |
The system shall send the suffix of a WIC-eligible individual from the 'Suffix:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.9 |
The system shall send the gender of a WIC-eligible individual from the 'Gender:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.10 |
The system shall send the race of a WIC-eligible individual from value(s) indicated on the Race - Race/Ethnicity subsection on SHINES of Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.11 |
The system shall send the ethnicity of a WIC-eligible individual from value(s) indicated on the Ethnicity - Race/Ethnicity subsection on SHINES of Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.12 |
The system shall send the date of birth of a WIC-eligible individual from the 'DOB:' field on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.13 |
The system shall send the social security number of a WIC-eligible individual from the Person Identifiers subsection on SHINES Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.14 |
The system shall send the citizenship/alienage status of a WIC-eligible individual from the 'Citizenship/Alien Status:' field on SHINES Citizenship and Identity tab of Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.15 |
The system shall send the most recent placement address (Street, City, State, Zip) of a WIC-eligible individual from the Address/Phone Detail subsection on SHINES Placement Information at any Placement status on first/initial submission (PROC, PEND, COMP, APRV) to IES |
WIC - 1.1 |
WIC - 1.1.16 |
The system shall send the county of the most recent placement of a WIC-eligible individual from the 'County' field on Address/Phone Detail subsection of SHINES Placement Information to IES |
WIC - 1.1 |
WIC - 1.1.17 |
The system shall send the first name of the case manager of a WIC-eligible individual from the 'First:' field on SHINES Staff Detail to IES |
WIC - 1.1 |
WIC - 1.1.18 |
The system shall send the last name of the case manager of a WIC-eligible individual from the 'Last:' field on SHINES Staff Detail to IES |
WIC - 1.1 |
WIC - 1.1.19 |
The system shall send the office location of the case manager of a WIC-eligible individual from the 'Office Location' field on SHINES Staff Detail IES |
WIC - 1.1 |
WIC - 1.1.20 |
The system shall send the legal county code of the WIC-eligible individual from the 'Legal County' field on SHINES Legal Status to IES |
WIC - 1.1 |
WIC - 1.1.21 |
The system shall send the pregnancy indicator of a WIC-eligible individual from the SHINES Person Detail page - Characteristics/Diagnoses submodule in Child - Physical/Medical/Developmental section of Person Characteristics or active diagnosis on Health Detail to IES |
WIC - 1.1 |
WIC - 1.1.22 |
The system shall send the email address of the case manager of a WIC-eligible individual from the email address field on SHINES Address submodule - Staff Detail to IES |
WIC - 1.1 |
WIC - 1.1.23 |
The system shall send the date a WIC referral is sent for the Application Received Date IES field for all WIC Referrals sent from SHINES to IES |
WIC - 1.1 |
WIC - 1.1.24 |
The system shall send the prior medical assistance indicator of a WIC-eligible individual from the SHINES Medicaid Referral Application to IES |
WIC - 1.1 |
WIC - 1.1.25 |
The system shall send the EMPI ID of a WIC-eligible individual from SHINES Person Identifiers - Person Detail to IES |
WIC - 1.1 |
WIC - 1.1.26 |
The system shall send the start date of the most recent active placement of a WIC-eligible individual from SHINES Placement Information to IES |
WIC - 1.1 |
WIC - 1.1.27 |
The system shall send the name of the foster parent of a WIC-eligible individual from the 'Legal Name:' field from SHINES Resource Detail of id_facility or Person Name from SHINES Person Detail of PID tied to child’s most recent active placement to IES |
WIC - 1.1 |
WIC - 1.1.28 |
The system shall send the phone number of the foster parent of a WIC-eligible individual from the Phone List from SHINES Resource Detail or Address/Phone Detail subsection of Placement (for placements tied to Person) to IES |
WIC - 1.1 |
WIC - 1.1.29 |
The system shall send the email address of the foster parent of a WIC-eligible individual from the 'Email Address:' field from SHINES Resource Detail or Email Address field from Person Detail for Person tied to Placement to IES |
WIC - 1.1 |
WIC - 1.1.30 |
The system shall send the value 'N' for the Requesting Aid IES field for all WIC referrals sent from SHINES to IES |
WIC - 1.1 |
WIC - 1.1.31 |
The system shall send the value 'WC' for the Program IES field for all WIC referrals sent from SHINES to IES |
WIC - 1.1 |
WIC - 1.1.32 |
The system shall send the value 'SHIN' for the Source IES field for all WIC referrals sent from SHINES to IES |
WIC - 1.1 |
WIC - 1.1.33 |
The system shall send the value 'IN' for the Type of Action IES field for all first/initial WIC referrals sent from SHINES to IES |
WIC - 1.1 |
WIC - 1.1.34 |
The system shall send the value 'PC' for the Type of Action IES field for resource changes of WIC eligible individuals sent from SHINES to IES |
WIC - 2.1 |
WIC - 2.1.1 |
The system shall send the legal status of a WIC-eligible individual from the SHINES Legal Status page to IES every time the status changes when the child goes out of DFCS custody |
WIC - 3.1 |
WIC - 3.1.1 |
The system shall send the placement address (Street, City, State, Zip) of a WIC-eligible individual from the Address/Phone Detail subsection on SHINES Placement Information to IES every time the resource changes (Placement status needs to be COMP, PEND, APRV) |
WIC – 3.1 |
WIC – 3.1.1.1 |
The system shall send placement change updates when the individual is in DFCS custody |
WIC - 4.1 |
WIC - 4.1.1 |
The system shall store the WIC referral transmission status of a WIC-eligible individual when it is received from IES |
Technical Design
Technical Overview
The WIC Referral Outbound Interface is used to provide information needed to complete a WIC referral for children ages 0-5 or a pregnant individual who is in DFCS custody (In DFCS custody legal statuses are: Permanent Court, Permanent Voluntary, Short Term Emergency Care, Temporary Court, Temporary Voluntary, Joint Commitment with DJJ – Permanent Court, Joint Commitment with DJJ - Temporary Court).
The trigger point for a WIC referral to be sent from SHINES to Gateway is when an individual comes into care (a legal status of in DFCS custody). The information that is currently captured in SHINES at this point will be sent. The only exception to this trigger point is the legal status and placement address. Should the legal status for an WIC-eligible individual change to out of DFCS custody, SHINES will send IES the new legal status. Similarly, should the placement for a WIC-eligible individual change, SHINES will send IES the new placement address. The specific trigger for this update is when the resource changes in the placement. For the initial submission to WIC, the placement information can be sent when the placement is at any status (PROC, PEND, COMP or APRV). For subsequent submissions, the placement will need be in COMP, PEND or APRV status. Temporary placement types will be excluded from submission.
Once an individual is no longer in DFCS custody, WIC updates will not be sent.
Web Service Exchange
Mapping files for the data flow between SHINES and Gateway via GTA
The following entries are made to the SHINES IES_CAPS_REF_OUTBOUND_ENC table based upon the scenarios listed.
| S.No | Scenario | Request Type | Interface Status | Mandatory Params |
|---|---|---|---|---|
1 |
Initial Application |
IN |
NEW |
Please refer to section 1.7 Request Elements for mandatory params |
2 |
Placement Change |
PC |
NEW |
Please refer to section 1.7 Request Elements for mandatory params |
3 |
Legal Status Change |
LC |
NEW |
Please refer to section 1.7 Request Elements for mandatory params |
Document Change Log
| Date | Author | Change Description |
|---|---|---|
12/3/2019 |
Venkat Collooru |
Updated 2.0 Technical Design Sections |
7/2/2018 |
Christine Nguyen |
Added sentence to indicate that when an individual goes out of DFCS custody, no WIC updates will be sent afterwards. Praneeth to determine LOE for this change. |
6/15/2018 |
Christine Nguyen |
Updated mention of WIC eligibility status to WIC referral transmission status to match the design between SHINES and GA Gateway in Section 1.2 (functional descritption), Section 1.19 (design requirements), and Figure 2 that spoke to the backend storage of the status. Gateway does not intend to send anything back to SHINES. The referral transmission status can be found in the outbound table of the database and the status displays ‘SNT’ when it is picked up by WebMethods and sent to Gateway for processing. |
6/14/2018 |
Christine Nguyen |
- Updated design requirements 1.1.1 and 1.1.2 to provide clarification to the design that an in DFCS custody legal status in the FCC stage triggers the WIC referral - Updated Figure 1 in the Functional Description section with the removal of the ‘second trigger’ pertaining to the initial Medicaid application. Also removed the design requirements pertaining to this. |
5/10/2018 |
Christine Nguyen |
Updated requirement 1.1.31 to send ‘WC’ because the max length on the Gateway storyboard is 2. |
10/17/2017 |
Christine Nguyen |
Updates made per L1 comments received – Removed Legal Status codes table as the legal status is only used to determine whether a child is WIC-eligible and is not a data element that is sent to IES Added additional data elements to be sent to IES |
9/22/2017 |
Christine Nguyen |
Initial version created |
Note: A new row explaining document changes must be added to the Document Change Log for each revision. The Document Change Log must be maintained in reverse chronological order. The most recent changes are on the top of the list.