Indiana Ed-Fi Data v2.4/3.1 - Parents

This entity represents a parent or guardian of a student, such as mother, father or caretaker.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

ActionTrigger
Post

When the Guardian check box is checked AND one person is a student and one person is not a student.

  • The guardian does NOT have to be a member of the same household as the student to report.
  • Start date must be on or before today's date.
  • End date must be on or after today's date.

  • A record will not send if the student they are associated with has an enrollment marked as a no show, state exclude or enrollment is in a calendar or school marked as Exclude.
Put

A record will be updated when any of the following are changed and saved:

  • When the person’s identity record is changed.
  • When one of the person’s household locations is changed.
  • When one of the person’s household memberships is changed.
  • When one of the person’s relationships that is marked Guardian is changed.
  • When the contact information has changed:  Phone or email.
DeleteN/A - a Parent record is a shared resource among all districts in the state and cannot be deleted.  When the Student Parent Association is removed, the district will no longer have authorization to see the parent record.

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.

ActionTrigger
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
ResyncIf a record is in the Ed-Fi Identity Mapping table and not in the ODS, it will be deleted from the Ed-Fi Identity Mapping table.
ResyncIf a record is in the ODS and it does not have a matching record in Campus or the Ed-Fi Identity Mapping table, it will be deleted from the ODS.
ResyncIf a mapping is changed in Resource Preferences, a resync will need to be done to reflect the changes.

Natural Key Changes, Cascading Updates, and Deletes Logic

This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.

ActionTrigger
Delete/PostCascading Deletes:  The logic for an Ed-FI ID change will update all resources impacted by this change.


Scope Year Logic

This table describes scope year logic of this object.

Business Rules

A parent record will report when they are a guardian to a student with an enrollment aligned to a scoped year.

  • The related pair start date must be null or on/before the scope year end date to report.
  • The related pair end date must be null or on/after the scope year end date to report.
  • Data will only send for the years that have valid configuration.
  • A resync must be completed on the Parents resource when a new scope year is connected in order for this data to send.

When using data in Campus that has an effective date, the following logic will be applied to determine the scope year(s) to report the data to.

  • Current Year: Records will be compared to today's date to determine if the record is eligible to report.
  • Previous Years: The record's date must be on or before the schools year's end date defined in the School Years editor.  If blank, the default date of 6/30/xxxx is used.
  • Future Years: The record's date must be on or after the schools year's start date defined in the School Years editor.  If blank, the default date of 7/01/xxxx is used.

When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) to report the data to.

  • Current Year: The records start date must be on or before today's date and the records end date must be on or after today's date.
  • Previous Years: The record's start date must be on or before the school year's end date and the record's end date must be after the school year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used.
  • Future Years: The record's start date must be on or before the schools year's start date and the record's end date must be on or after the school year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.


Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectTypeObject Key Data Source
PersonpersonID


Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus TableEd-Fi ActionFields
relatedPairPost/Put/DeleteThe primary table used for sending data for this resource.
householdPutAddresses
contactPutEmail, Telephone
identityputFirst name, Last Name, Middle Name Suffix, gender


Object Data Elements

This table describes data elements sent within the Parents resource.

Data Element
Label
Business RequirementBusiness RulesM, C or O

Location

idThe unique identifier of the resource. M 
parentUniqueIdA unique alpha-numeric code assigned to a parent.

Reports DistrictID + PersonID.

MCensus >People >Demographics

System Administration > Resources > District Information

person.id
district.Number
addressesReport the person's address(s).
  1. Reports the Primary address that is marked as "Mailing"
    • If more than 1 Primary Address is marked as Mailing, report address with most recent Household Membership Start Date.
    • Else, report the address with most recent Address Start Date.
  2. See Business Rule S3 in Scope Year logic to determine the eligibility of records.
  3. See Array section for data logic for each field.
O

Census > Household Addresses> 

Mailing


Census > Household Membership> 

Start Date


Census > Household Addresses > 

Start Date


HouseholdLocation.mailing
HouseholdMember.startDate

Householdlocation.StartDate
electronicMailsThe numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.
  1. Reports the email address entered for that person
    • Do not report if Email is marked as "Private".
  2. If blank, does not report.
  3. See Array section for data logic for each field.
OCensus > People > Demographics > Email

contact.email
firstNameA name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. NEDM First Name.
  1. If any Legal Information is present, report the 'Legal First Name' from the person's current identity record.
  2. If Legal Information is not present, report the 'First Name' from the person's current identity record.
MCensus > People >Identities > First Name

identity.firstName
generationCode
Suffix
An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).
  1. If any Legal Information is present, report the 'Legal Suffix' from the person's current identity record
    • Do not report if blank
  2. If Legal Information is not present, report the 'Suffix' from the person's current identity record.
    • Do not report if blank
CCensus > People > Identities > Suffix

identity.suffix
international
Addresses
An unordered collection of parentInternationalAddresses. This entity represents a parent or guardian of a student, such as mother, father or caretaker.

This field is optional, does not report.

O 
languagesThe language(s) the individual uses to communicate. 

This field is optional, does not report.



lastSurnameThe name borne in common by members of a family. NEDM Last Name/Surname.
  1. If any Legal Information is present, report the 'Legal Last Name' from the person's current identity record.
  2. If Legal Information is not present, report the 'Last Name' from the person's current identity record.
MCensus > People > Identities > Last Name

identity.lastName
loginIdThe login ID for the user; used for security access control interface.

This field is optional, does not report.

O 
maidenNameThe person''s maiden name, if applicable.

This field is optional, does not report.

O 
middleNameA secondary name given to an individual at birth, baptism, or during another naming ceremony. NEDM Middle Name.
  1. If any Legal Information is present, report the 'Legal Middle Name' from the person's current identity record.
    • Do not report if blank
  2. If Legal Information is not present, report the 'Middle Name' from the person's current identity record.
    • Do not report if blank
OCensus >People >Identities > Middle Name

identity.middleName
otherNamesAn unordered collection of parentOtherNames. This entity represents a parent or guardian of a student, such as mother, father or caretaker.

This field is optional, does not report.

O 
personal
identification
Documents
An unordered collection of Parent Identification Documents. This entity represents a parent or guardian of a student, such as mother, father or caretaker.

This field is optional, does not report.

O 
personalTitlePrefixA prefix used to denote the title, degree, position or seniority of the person.

This field is optional, does not report.

O 
sexDescriptorA person's gender.
  1. If any Legal Information is present, use the 'Legal Gender' from the person's current identity record.
    • Report based on the value selected in the droplist:
      1. Female reports 'Female'.
      2. Male reports 'Male'.
      3. Blank or Non-Binary reports 'Not Selected'.
  2. If Legal Information is not present, use the 'Gender' from the person's current identity record.
    • Report based on the value selected in the droplist:
      1. Female reports 'Female'.
      2. Male reports 'Male'.
      3. Blank or Non-Binary reports 'Not Selected'.
OCensus > People > Identities >Gender

identity.Gender
telephonesAn unordered collection of parentTelephones. This entity represents a parent or guardian of a student, such as mother, father or caretaker.,
  1. Reports the Phone numbers entered in the Personal Contact Information for that person.
    • do not report Phone Number is marked as "Private".
  2. If blank, does not report.
  3. See Array section for data logic for each field.
OCensus > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager

contact.homephone

contact. workphone

contact.cellphone

contact.pager

_etagA unique system-generated value that identifies the version of the resource.

This field is optional, does not report.

O 

Array Data Elements

Click here to expand...

Addresses

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI Path

addressTypeDescriptorKey for Address

All addresses report as 'Home'.


M 
localeDescriptorA general geographic indicator that categorizes U.S. territory (e.g., City, Suburban).

This is optional, does not report.

O
stateAbbreviationDescriptorThe abbreviation for the state (within the United States) or outlying area in which an address is located.

Reports the State for the address being reported.

MCensus > Households > Address Information > State

address.state
apartmentRoomSuiteNumberThe apartment, room, or suite number of an address.

Reports the value entered in Apt field if populated.

OCensus > Households > Address Information Apt

address.apt
buildingSiteNumberThe number of the building on the site, if more than one building shares the same address.

This is optional, does not report.

O 
cityThe name of the city in which an address is located.

Reports the City for the address being reported.

MCensus > Households > Address Information City

address.city
congressionalDistrict

The congressional district in which an address is located.

This is optional, does not report.

O
countyFIPSCode5 digit code consisting of the two digit state code followed by the three digit FIPS code for the county.

This is optional, do not report.

O 
doNotPublishIndicator

An indication that the address should not be published.

  1. Reports 'True' if the Private checkbox is checked on the address being reported.
  2. Else, report 'False'.
OCensus > Households > Address Information  Private

householdlocation.private
latitudeThe geographic latitude of the physical address.

This is optional, do not report.

O 
longitudeThe geographic longitude of the physical address.

This is optional, do not report.

O 
nameOfCountyThe name of the county, parish, borough, or comparable unit (within a state) in which an address is located.

Reports the County for the addressing being reported.

OCensus > Households > Address Information County

address.county
postalCodeThe five or nine digit zip code portion of an address.

Reports the Zip Code for the address being reported.

MCensus > Households > Address Information  Zip Code

address.zip
streetNumberNameThe street number and street name or post office box number of an address.Reports Address PO Box + Number + Street + Tag + Prefix + Dir.
  • If the PO Box is checked, add 'PO Box' in front of the Number being reported.
MCensus > Households > Address Information

address.postOfficeBox

address.number

address.street

address.tag

address.prefix

address.dir


beginDateThe first date the address is valid. For physical addresses, the date the person moved to that address.

This is optional, do not report.

O 
endDateThe last date the address is valid. For physical addresses, this would be the date the person moved from that address.

This is optional, do not report.

O 

 

Parent Electronic Mail

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Location

electronicMailTypeDescriptorKey for ElectronicMail.
  1. Primary Email address will report as "Home/Personal".
  2. Secondary Email address will report as "Work".
Note: These are not descriptors, these are types.

See types list in "Electronic Email Types" below.

MCensus > People > Demographics > Personal Contact Information > Email / Secondary Email

contact.Email
contact.SecondaryEmail
doNotPublishIndicator

An indication that the electronic email address should not be published.

This is optional, do not report.

O
electronicMailAddressThe numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.

Reports the email address entered for that person.

MCensus > People > Demographics > Email

contact.email
primaryEmailAddressIndicatorAn indication that the electronic mail address should be used as the principal electronic mail address for an individual or organization.

This is optional, do not report.

O 

 

Parent Telephone

Data Element Label

Business Requirement

Business Rules

M,C or O

Location

telephoneNumberType
Descriptor
Key for Telephone Number.

Reports based on the Phone Number type entered in Campus based on the chart below:

Campus PhoneEd-Fi Coe
Cell PhoneMobile
Other PhoneHome
Work PhoneWork
PagerOther
MCensus > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager
doNotPublishIndicator

An indication that the telephone number should not be published.

This is optional, does not report.

O
orderOfPriorityThe order of priority assigned to telephone numbers to define which number to attempt first, second, etc.

This is optional, does not report.

O 
telephoneNumberThe 10-digit telephone number, including the area code, for the person.
  1. Reports the Phone numbers entered in the Personal Contact Information for that person.
  2. If blank, does not report.
MCensus > People > Demographics > Personal Contact Information > Other Phone, Work Phone, Cell Phone, Pager
textMessageCapabilityIndicatorAn indication that the telephone number is technically capable of sending and receiving Short Message Service (SMS) text messages.

This is optional, does not report.

O 

Type/Descriptor

Click here to expand...

Address Type Descriptor

Code Value

Description

Namespace

Short Description

BillingBillinguri://ed-fi.org/AddressTypeDescriptorBilling
Doubled - up (i.e., living with another family)Doubled - up (i.e., living with another family)uri://ed-fi.org/AddressTypeDescriptorDoubled - up (i.e., living with another family)
Father AddressFather Addressuri://ed-fi.org/AddressTypeDescriptorFather Address
Guardian AddressGuardian Addressuri://ed-fi.org/AddressTypeDescriptorGuardian Address
HomeHomeuri://ed-fi.org/AddressTypeDescriptorHome
Hotels/MotelsHotels/Motelsuri://ed-fi.org/AddressTypeDescriptorHotels/Motels
MailingMailinguri://ed-fi.org/AddressTypeDescriptorMailing
Mother AddressMother Addressuri://ed-fi.org/AddressTypeDescriptorMother Address
OtherOtheruri://ed-fi.org/AddressTypeDescriptorOther
PhysicalPhysicaluri://ed-fi.org/AddressTypeDescriptorPhysical
Shelter, Transitional housing, Awaiting FosterShelters, Transitional housing, Awaiting Foster Careuri://ed-fi.org/AddressTypeDescriptorShelters, Transitional housing, Awaiting Foster Care
ShippingShippinguri://ed-fi.org/AddressTypeDescriptorShipping
TemporaryTemporaryuri://ed-fi.org/AddressTypeDescriptorTemporary
UnshelteredUnsheltered (e.g. cars, parks, campgrounds, temporary trailers including FEMA trailers, or abandoned buildings)uri://ed-fi.org/AddressTypeDescriptorUnsheltered (cars, parks, temporary trailers, or abandoned buildings)
WorkWorkuri://ed-fi.org/AddressTypeDescriptorWork

Electronic Mail Types

Code Value

Description

Short Description

Home/PersonalHome/PersonalHome/Personal
OrganizationOrganizationOrganization
OtherOtherOther
WorkWorkWork

Telephone Type Descriptors

Code Value

Description

Namespace

Short Description

Emergency 1Emergency 1uri://ed-fi.org/TelephoneNumberTypeDescriptorEmergency 1
Emergency 2Emergency 2uri://ed-fi.org/TelephoneNumberTypeDescriptorEmergency 2
FaxFaxuri://ed-fi.org/TelephoneNumberTypeDescriptorFax
HomeHomeuri://ed-fi.org/TelephoneNumberTypeDescriptorHome
MobileMobileuri://ed-fi.org/TelephoneNumberTypeDescriptorMobile
OtherOtheruri://ed-fi.org/TelephoneNumberTypeDescriptorOther
UnlistedUnlisteduri://ed-fi.org/TelephoneNumberTypeDescriptorUnlisted
WorkWorkuri://ed-fi.org/TelephoneNumberTypeDescriptorWork