Ed-Fi RFC 27 (b) - Streamlining Access to Identification Codes, Contact Information, and Demographics

Ed-Fi RFC 27 (b) - Streamlining Access to Identification Codes, Contact Information, and Demographics

Ed-Fi Request for Comment 27 Part B: Streamlining Access to Identification Codes, Contact Information, and Demographics
Product: Ed-Fi-Sponsored Standard
Affects: Ed-Fi Resources API
Obsoletes: --
Obsoleted By: --
Status: DONE

Ed-Fi Alliance
June 20, 2025;

Edits on July 14, 2025: remove Begin Date and End Date from new contact identities.

Edits on October 1, 2025: noting the decision to delete old properties instead of deprecating them.

Synopsis


This Request for Comments (RFC) includes materials that describe proposed additions and revisions to the Ed-Fi Data Standard. This draft material is intended to support review and comment as well as support early usage; users of this material are advised that this work is still under development.

RFC 27 Part B expands on the updates introduced from handling multiple identities and reducing the update burden in the StudentEducationOrganizationAssociation into the core Ed-Fi Data Standard. This enhancement incorporates the following changes:

I. New multiple identity entities:

  • CandidateIdentity

  • ContactIdentity

  • EducationOrganizationIdentity

  • StaffIdentity

  • StudentIdentity

II. New contact and demographics originating from StudentEducationOrganizationAssociation and Staff :

  • StaffContactInformation

  • StaffDemographics

  • StudentContactInformation

  • StudentDemographics

III. Deprecated - not deleted elements. The following domain entities and associations have deprecated deleted fields as the result of the newly requested changes: Update: deprecated fields have now been removed.

  • Candidate

  • StudentEducationOrganizationAssocaiation

  • Student

  • Staff

The Alliance would also like to gather Use Case needs to break out candidate information into new entities:

  • CandidateContactInformation

  • CandidateDemographics

Note: Break out not applied to Contact since it is not a primary person-role like Student, Staff and Candidate

 

Contents

Overview/General Discussion


These improvements were evaluated with the incorporation of the Educator Preparation Data Model into the Ed-Fi Core Model, which drove discussions about the Person model. As a result of the community feedback, there were no large benefits for making Person mandatory, but instead defining new entities for handling multiple identifiers and splitting the common elements from the SEOA.

The proposed changes will enable more ways to track/identify data elements in the system without forcing adoption of a required person model at this time. Furthermore, being able to expand the existing model to accommodate more identifiers per person reduces the impact on vendors currently operating within the Ed-Fi model when compared to the changes that would be involved with forcing a required adoption of the Person model.

This RFC provides the preview of changes for creating the various identity domain entities, and for splitting the SEOA. Other changes already made and that are ready for community review are available in Ed-Fi RFC 27 - Data Standard 6.0 Preview 1.

Community Conversations

The new approach and proposal for how these additional identifiers could be captured and tracked were discussed in the Data Standard Work Group # 9 Meeting on May 16th, 2025, SIS SIG meeting on 6/17/2025, Data Standard Work Group Meeting #10, and will continue to be discussed in upcoming Data Standard meetings before August 2025.

Notable feedback received in these meetings and up to 6/19/2025 is:

  • The need for adding the EducationOrganizationID in the Identity keys and for evaluating the size of the new SEOA.

  • There was not sufficient consensus on the approach to remove the contact and demographic elements from the SEOA. We are waiting on the discussion from the TAG meeting in July, to determine whether we deprecate or delete impacted elements from the SEOA.

Final decision: delete old entities instead of marking them as deprecated; otherwise there will be substantial confusion and extra work for downstream consumers who must look for data in both locations.

Use Cases


Multiple Identity Entities and Reduced Complexity

As mentioned above the Educator Preparation Data Model exposed situations where a single individual can have multiple roles simultaneously which creates the need to easily link data associated. Examples include those records who are students in one context of their continuing education while also being staff at the same time as part of their required training. Other examples include situations where one staff member may be working across multiple districts creating situations where data will be overwritten if there is only one Id and set of information for the person. One of the other pain points that was brought forth by the community is the complexity in the StudentEducationOrganizationAssociation and difficulty in searching the IdentificationCode commons. By breaking the StudentEducationOrganizationAssociation into smaller more manageable components vendors and admins will be better able to query records more specifically and updates can now be made in a targeted way that they do not overwrite whole records. This change will also boost flexibility by allowing the inclusion of Begin and End Dates for each recorded identifier as optional fields. Lastly including EducationOrganization as a reference in the key this enables expanded support for records from different LEAs in such a way that follows the existing pattern of the StudentEducationOrganizationAssociation. As an additional portion of this change the StudentIdentificationCode collection and StaffIdentificationCode collection may be deprecated in a future date having been replaced by the new domain entities. Update: the former elements have now been deleted.

Data Model


The following additional Domain Entities have been added or changed as noted below:

Breakout not applied to Contact since it is not a primary person-role like Student, Staff and Candidate

New Identity Entities:

The new and modifications to the existing domain entities can be found in the following:

I. CandidateIdentity

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Candidate Reference object CandidateReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the candidate. CandidateIdentificationSystem Reference object CandidateIdentification SystemDescriptor MetaEd DSL Datatype: DescriptorProperty Yes required A coding scheme that is used for identification and record-keeping purposes by schools, LEAs, SEAs, or other agencies to refer to a candidate. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the candidate information. IdentificationCode String string IdentificationCode MetaEd DSL Datatype: SharedStringProperty No required A unique number or alphanumeric code assigned to an individual by a school,LEA, SEA, or other agency. SQL Recommended Datatype: VARCHAR(60)   AssigningOrganization IdentificationCode String string AssigningOrganization IdentificationCode MetaEd DSL Datatype: SharedStringProperty No optional The organization code or name assigning the IdentificationCode. SQL Recommended Datatype: VARCHAR(60)   BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the first day the identfication code is effective.    SQL Recommended Datatype: DATE EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the identfication code is effective. SQL Recommended Datatype: DATE

II. ContactIdentity

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Contact Reference object ContactReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the contact. ContactIdentificationSystem Reference object ContactIdentificationSystemDescriptor MetaEd DSL Datatype: DescriptorProperty Yes   required A coding scheme that is used for identification and record-keeping purposes by schools, LEAs, SEAs, or other agencies to refer to a contact. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of thecontact information. IdentificationCode String string IdentificationCode MetaEd DSL Datatype: SharedStringProperty No   required A unique number or alphanumeric code assigned to an individual by a school,LEA, SEA, or other agency. SQL Recommended Datatype: VARCHAR(60) AssigningOrganization IdentificationCode String string AssigningOrganization IdentificationCode MetaEd DSL Datatype: SharedStringProperty No   optional The organization code or name assigning the IdentificationCode. SQL Recommended Datatype: VARCHAR(60) BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the first day the identfication code is effective.    SQL Recommended Datatype: DATE EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the identfication code is effective. SQL Recommended Datatype: DATE

III. EducationOrganizationIdentity

Final implementation was as EducationOrganizationIdentificationCode

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization. EducationOrganization IdentificationSystem Reference object EducationOrganizationIdentification SystemDescriptor MetaEd DSL Datatype: DescriptorProperty Yes   required A coding scheme that is used for identification and record-keeping purposes by schools, LEAs, SEAs, or other agencies to refer to an education organization. IdentificationCode String string IdentificationCode MetaEd DSL Datatype: SharedStringProperty No     required A unique number or alphanumeric code assigned to an education organization by an SEA or other agency. SQL Recommended Datatype: VARCHAR(60) AssigningOrganization IdentificationCode String string AssigningOrganization IdentificationCode MetaEd DSL Datatype: SharedStringProperty No     optional The organization code or name assigning the IdentificationCode. SQL Recommended Datatype: VARCHAR(60) BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional   Month, day, and year of the first day the identfication code is effective.  SQL Recommended Datatype: DATE     EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the identfication code is effective. SQL Recommended Datatype: DATE

IV. StaffIdentity

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Staff Reference object StaffReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the staff. StaffIdentificationSystem Reference object StaffIdentificationSystemDescriptor MetaEd DSL Datatype: DescriptorProperty Yes   required A coding scheme that is used for identification and record-keeping purposes by schools, LEAs, SEAs, or other agencies to refer to a staff. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the staff information. IdentificationCode String string IdentificationCode MetaEd DSL Datatype: SharedStringProperty No     required A unique number or alphanumeric code assigned to an individual by a school,LEA, SEA, or other agency. SQL Recommended Datatype: VARCHAR(60) AssigningOrganization IdentificationCode String string AssigningOrganization IdentificationCode MetaEd DSL Datatype: SharedStringProperty No     optional The organization code or name assigning the IdentificationCode. SQL Recommended Datatype: VARCHAR(60) BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional   Month, day, and year of the first day the identfication code is effective.  EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the identfication code is effective.    SQL Recommended Datatype: DATE

V. StudentIdentity

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Student Reference object StudentReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the student. StudentIdentificationSystem Reference object StudentIdentificationSystemDescriptor MetaEd DSL Datatype: DescriptorProperty Yes required A coding scheme that is used for identification and record-keeping purposes by schools, LEAs, SEAs, or other agencies to refer to a student. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the student information. IdentificationCode String string IdentificationCode MetaEd DSL Datatype: SharedStringProperty No   required A unique number or alphanumeric code assigned to an individual by a school,LEA, SEA, or other agency. SQL Recommended Datatype: VARCHAR(60) AssigningOrganization IdentificationCode String string AssigningOrganization IdentificationCode MetaEd DSL Datatype: SharedStringProperty No   optional The organization code or name assigning the IdentificationCode. SQL Recommended Datatype: VARCHAR(60) BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the first day the identfication code is effective.  SQL Recommended Datatype: DATE   EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the identfication code is effective.    SQL Recommended Datatype: DATE

New Contact And Demographics Entities:

I. StaffContactInformation

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Staff Reference object StaffReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the staff. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the staff information. Address Reference object Addresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an address, including the street address, city, state, and ZIP code. InternationalAddress Reference object InternationalAddresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an international address. Telephone Reference object Telephones MetaEd DSL Datatype: CommonProperty No optional collection The 10-digit telephone number, including the area code, for the person. ElectronicMail Reference object ElectronicMails MetaEd DSL Datatype: CommonProperty No optional collection The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.

II. StaffDemographics

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Staff Reference object StaffReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the staff. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the staff information. Sex Reference object SexDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The staff's birth sex as reported to the education organization. GenderIdentity String string GenderIdentity MetaEd DSL Datatype: SharedStringProperty No optional The staff's gender as last reported to the education organization. SQL Recommended Datatype: VARCHAR(60) Race Reference object Races MetaEd DSL Datatype: DescriptorProperty No optional collection The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies as last reported to the education organization. The data model allows for multiple entries so that each individual can specify all appropriate races. HispanicLatinoEthnicity - Deprecated (Removal scheduled for 2029) Boolean boolean HispanicLatinoEthnicity MetaEd DSL Datatype: BooleanProperty No optional An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race, as last reported to the education organization. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." SQL Recommended Datatype: BOOLEAN AncestryEthnicOrigin Reference object AncestryEthnicOrigins MetaEd DSL Datatype: DescriptorProperty No optional collection The original peoples or cultures with which the individual identifies. Citizenship Reference object Citizenship MetaEd DSL Datatype: InlineCommonProperty No optional Contains information relative to U.S. citizenship status and its associated probationary documentation. TribalAffiliation Reference object TribalAffiliations MetaEd DSL Datatype: DescriptorProperty No optional collection An American Indian tribe with which the student is affiliated as last reported to the education organization. Language Reference object Languages MetaEd DSL Datatype: CommonProperty No optional collection The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-3 language codes. BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the first day the information is valid.    SQL Recommended Datatype: DATE EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the information is valid.    SQL Recommended Datatype: DATE

III. StudentContactInformation

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Student Reference object StudentReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the student. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the student information. Address Reference object Addresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an address, including the street address, city, state, and ZIP code. InternationalAddress Reference object InternationalAddresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an international address. Telephone Reference object Telephones MetaEd DSL Datatype: CommonProperty No optional collection The 10-digit telephone number, including the area code, for the person. ElectronicMail Reference object ElectronicMails MetaEd DSL Datatype: CommonProperty No optional collection The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs.

IV. StudentDemographics

Property UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Student Reference object StudentReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the student. EducationOrganization Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the student information. Sex Reference object SexDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The student's birth sex as reported to the education organization. GenderIdentity String string GenderIdentity MetaEd DSL Datatype: SharedStringProperty No optional The student's gender as last reported to the education organization. SQL Recommended Datatype: VARCHAR(60) Race Reference object Races MetaEd DSL Datatype: DescriptorProperty No optional collection The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies as last reported to the education organization. The data model allows for multiple entries so that each individual can specify all appropriate races. HispanicLatinoEthnicity - Deprecated (Removal scheduled for 2029) Boolean boolean HispanicLatinoEthnicity MetaEd DSL Datatype: BooleanProperty No optional An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race, as last reported to the education organization. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." SQL Recommended Datatype: BOOLEAN AncestryEthnicOrigin Reference object AncestryEthnicOrigins MetaEd DSL Datatype: DescriptorProperty No optional collection The original peoples or cultures with which the individual identifies. Citizenship Reference object Citizenship MetaEd DSL Datatype: InlineCommonProperty No optional Contains information relative to U.S. citizenship status and its associated probationary documentation. TribalAffiliation Reference object TribalAffiliations MetaEd DSL Datatype: DescriptorProperty No optional collection An American Indian tribe with which the student is affiliated as last reported to the education organization. LimitedEnglishProficiency Reference object LimitedEnglishProficiencyDescriptor MetaEd DSL Datatype: DescriptorProperty No optional An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient. Language Reference object Languages MetaEd DSL Datatype: CommonProperty No optional collection The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-3 language codes. Disability Reference object Disabilites MetaEd DSL Datatype: CommonProperty No optional collection The disability condition(s) that best describes an individual's impairment, as determined by evaluation(s) conducted by the education organization. SupporterMilitary Connection Reference object SupporterMilitary ConnectionDescriptor MetaEd DSL Datatype: DescriptorProperty No optional Military connection of the person/people whom the student is a dependent of. BeginDate Date number BeginDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the first day the information is valid.    SQL Recommended Datatype: DATE EndDate Date number EndDate MetaEd DSL Datatype: DateProperty No optional     Month, day, and year of the last day the information is valid.    SQL Recommended Datatype: DATE

Changes to current domain entities and SEOA

I. Candidate

Property Deprecation Reason UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition CandidateIdentifier String string CandidateIdentifier MetaEd DSL Datatype: SharedStringProperty Yes required A unique alphanumeric code assigned to a candidate. SQL Recommended Datatype: VARCHAR(32) Name Reference object Name MetaEd DSL Datatype: InlineCommonProperty No required Full legal name of the person. OtherName Reference object OtherNames MetaEd DSL Datatype: CommonProperty No optional collection Other names (e.g., alias, nickname, previous legal name) associated with a person. Sex Moved to Candidate Demographics Reference object SexDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The sex of the candidate. BirthData Reference object BirthData MetaEd DSL Datatype: InlineCommonProperty No required The set of elements that capture relevant data regarding a person's birth, including birth date and place of birth. Address Moved to Candidate Contact Information Reference object Addresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an address, including the street address, city, state, and ZIP code. Telephone Moved to Candidate Contact Information Reference object Telephones MetaEd DSL Datatype: CommonProperty No optional collection The 10-digit telephone number, including the area code, for the person. ElectronicMail Moved to Candidate Contact Information Reference object ElectronicMails MetaEd DSL Datatype: CommonProperty No optional collection The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. HispanicLatinoEthnicity Moved to Candidate Demographics   Boolean boolean HispanicLatinoEthnicity MetaEd DSL Datatype: BooleanProperty No optional An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." SQL Recommended Datatype: BOOLEAN Race Moved to Candidate Demographics Reference object Races MetaEd DSL Datatype: DescriptorProperty No optional collection The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The data model allows for multiple entries so that each individual can specify all appropriate races. EconomicDisadvantaged Moved to Candidate Demographics   Boolean boolean EconomicDisadvantaged MetaEd DSL Datatype: BooleanProperty No optional An indication of inadequate financial condition of an individual's family, as determined by family income, number of family members/dependents, participation in public assistance programs, and/or other characteristics considered relevant by federal, state, and local policy. SQL Recommended Datatype: BOOLEAN LimitedEnglishProficiency Moved to Candidate Demographics Reference object LimitedEnglishProficiency Descriptor MetaEd DSL Datatype: DescriptorProperty No optional An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient. Language Moved to Candidate Demographics Reference object Languages MetaEd DSL Datatype: CommonProperty No optional collection The language(s) the individual uses to communicate. Disability Moved to Candidate Demographics Reference object Disabilities MetaEd DSL Datatype: CommonProperty No optional collection The disability condition(s) that best describes an individual's impairment. DisplacementStatus   String string DisplacementStatus MetaEd DSL Datatype: SharedStringProperty No optional Indicates a state health or weather related event that displaces a group of students, and may require additional funding, educational, or social services. SQL Recommended Datatype: VARCHAR(30) Gender Moved to Candidate Demographics Reference object GenderDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The gender of the candidate. EnglishLanguageExam   Reference object EnglishLanguageExam Descriptor MetaEd DSL Datatype: DescriptorProperty No optional Indicates that a person passed, failed, or did not take an English Language assessment (e.g., TOEFFL). FirstGenerationStudent     Boolean boolean FirstGenerationStudent MetaEd DSL Datatype: BooleanProperty No optional Indicator of whether individual is a first generation college student. SQL Recommended Datatype: BOOLEAN Person Reference object PersonReference MetaEd DSL Datatype: DomainEntityProperty No optional Relates the candidate to a generic person.

II. Staff

Property Deprecation Reason UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition StaffUniqueId   String string StaffUniqueId MetaEd DSL Datatype: SharedStringProperty Yes required A unique alphanumeric code assigned to a staff. SQL Recommended Datatype: VARCHAR(32) StaffIdentificationCode Moved to StaffIdentity entity Reference object IdentificationCodes MetaEd DSL Datatype: CommonProperty No optional collection A unique number or alphanumeric code assigned to a staff member by a school, school system, a state, or other agency or entity. Name   Reference object Name MetaEd DSL Datatype: InlineCommonProperty No required Full legal name of the person. OtherName   Reference object OtherNames MetaEd DSL Datatype: CommonProperty No optional collection Other names (e.g., alias, nickname, previous legal name) associated with a person. Sex Moved to StaffDemographics Reference object SexDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The birth sex of the staff member. GenderIdentity Moved to StaffDemographics String string GenderIdentity MetaEd DSL Datatype: SharedStringProperty No optional The gender the staff member identifies themselves as. SQL Recommended Datatype: VARCHAR(60) BirthDate   Date number BirthDate MetaEd DSL Datatype: DateProperty No optional The month, day, and year on which an individual was born. SQL Recommended Datatype: DATE Address Moved to StaffContact Information Reference object Addresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an address, including the street address, city, state, and ZIP code. InternationalAddress Moved to StaffContact Information Reference object InternationalAddresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an international address. Telephone Moved to StaffContact Information Reference object Telephones MetaEd DSL Datatype: CommonProperty No optional collection The 10-digit telephone number, including the area code, for the person. ElectronicMail Moved to StaffContact Information Reference object ElectronicMails MetaEd DSL Datatype: CommonProperty No optional collection The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. HispanicLatinoEthnicity  This element is scheduled for removal by 2029. Users of this element are advised to use Race instead. Boolean boolean HispanicLatinoEthnicity MetaEd DSL Datatype: BooleanProperty No optional An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." SQL Recommended Datatype: BOOLEAN Race Moved to StaffDemographics Reference object Races MetaEd DSL Datatype: DescriptorProperty No optional collection The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies. The way this data element is listed, it must allow for multiple entries so that each individual can specify all appropriate races. Citizenship Moved to StaffDemographics Reference object Citizenship MetaEd DSL Datatype: InlineCommonProperty No optional Contains information relative to U.S. citizenship status and its associated probationary documentation. Language Moved to StaffDemographics Reference object Languages MetaEd DSL Datatype: CommonProperty No optional collection The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-2 language codes. HighestCompletedLevel OfEducation   Reference object HighestCompletedLevelOfEducationDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The extent of formal instruction an individual has received (e.g., the highest grade in school completed or its equivalent or the highest degree received). YearsOfPrior Professional Experience   Number number YearsOfPrior ProfessionalExperience MetaEd DSL Datatype: SharedDecimalProperty No optional The total number of years that an individual has previously held a similar professional position in one or more education institutions prior to the current school year. SQL Recommended Datatype: DECIMAL(5, 2) YearsOfPriorTeaching Experience   Number number YearsOfPriorTeaching Experience MetaEd DSL Datatype: SharedDecimalProperty No optional The total number of years that an individual has previously held a teaching position in one or more education institutions prior to the current school year. SQL Recommended Datatype: DECIMAL(5, 2) LoginId   String string LoginId MetaEd DSL Datatype: SharedStringProperty No optional The login ID for the user; used for security access control interface. SQL Recommended Datatype: VARCHAR(60) HighlyQualifiedTeacher   Boolean boolean HighlyQualifiedTeacher MetaEd DSL Datatype: BooleanProperty No optional An indication of whether a teacher is classified as highly qualified for his/her assignment according to state definition. This attribute indicates the teacher is highly qualified for ALL Sections being taught. SQL Recommended Datatype: BOOLEAN Recognition   Reference object Recognitions MetaEd DSL Datatype: CommonProperty No optional collection Recognitions given to the staff for accomplishments in a co-curricular or extracurricular activity. Credential   Reference object Credentials MetaEd DSL Datatype: DomainEntityProperty No optional collection The legal document giving authorization to perform teaching assignment services. TribalAffiliation Moved to StaffDemographics Reference object TribalAffiliations MetaEd DSL Datatype: DescriptorProperty No optional collection An American Indian tribe with which the staff member is affiliated. Person   Reference object PersonReference MetaEd DSL Datatype: DomainEntityProperty No optional Relates the staff to a generic person. AncestryEthnicOrigin Moved to StaffDemographics Reference object AncestryEthnicOrigins MetaEd DSL Datatype: DescriptorProperty No optional collection The original peoples or cultures with which the individual identifies.

III. Student

Property Deprecation Reason UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition StudentUniqueId String string StudentUniqueId MetaEd DSL Datatype: SharedStringProperty Yes required A unique alphanumeric code assigned to a student. SQL Recommended Datatype: VARCHAR(32) Name Reference object Name MetaEd DSL Datatype: InlineCommonProperty No required Full legal name of the person. OtherName Reference object OtherNames MetaEd DSL Datatype: CommonProperty No optional collection Other names (e.g., alias, nickname, previous legal name) associated with a person. BirthData Reference object BirthData MetaEd DSL Datatype: InlineCommonProperty No required The set of elements that capture relevant data regarding a person's birth, including birth date and place of birth. Citizenship Moved to Student Demographics Reference object Citizenship MetaEd DSL Datatype: InlineCommonProperty No optional Contains information relative to U.S. citizenship status and its associated probationary documentation. Person Reference object PersonReference MetaEd DSL Datatype: DomainEntityProperty No optional Relates the student to a generic person. StudentUniqueId String string StudentUniqueId MetaEd DSL Datatype: SharedStringProperty Yes required A unique alphanumeric code assigned to a student.

IV. StudentEducationOrganizationAssociation

Property Deprecation Reason UML Datatype JSON Datatype JSON Element Name Other Identity Cardinality Definition Student   Reference object StudentReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the student. EducationOrganization   Reference object EducationOrganizationReference MetaEd DSL Datatype: DomainEntityProperty Yes required A reference to the education organization representing the context of the student information. StudentIdentificationCode Moved to StudentIdentity entity Reference object StudentIdentificationCodes MetaEd DSL Datatype: CommonProperty No optional collection A coding scheme that is used for identification and record-keeping purposes by schools, social services, or other agencies to refer to a student. Sex Moved to Student Demographics Reference object SexDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The student's birth sex as reported to the education organization. GenderIdentity Moved to Student Demographics String string GenderIdentity MetaEd DSL Datatype: SharedStringProperty No optional The student's gender as last reported to the education organization. SQL Recommended Datatype: VARCHAR(60) Address Moved to StudentContact Information Reference object Addresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an address, including the street address, city, state, and ZIP code. InternationalAddress Moved to StudentContact Information Reference object InternationalAddresses MetaEd DSL Datatype: CommonProperty No optional collection The set of elements that describes an international address. Telephone Moved to StudentContact Information Reference object Telephones MetaEd DSL Datatype: CommonProperty No optional collection The 10-digit telephone number, including the area code, for the person. ElectronicMail Moved to StudentContact Information Reference object ElectronicMails MetaEd DSL Datatype: CommonProperty No optional collection The numbers, letters, and symbols used to identify an electronic mail (e-mail) user within the network to which the individual or organization belongs. ProfileThumbnail   String string ProfileThumbnail MetaEd DSL Datatype: SharedStringProperty No optional Locator reference for the student photo. The specification for that reference is left to local definition. SQL Recommended Datatype: VARCHAR(255) HispanicLatinoEthnicity This element is scheduled for removal by 2029. Users of this element are advised to use Race instead. Boolean boolean HispanicLatinoEthnicity MetaEd DSL Datatype: BooleanProperty No optional An indication that the individual traces his or her origin or descent to Mexico, Puerto Rico, Cuba, Central, and South America, and other Spanish cultures, regardless of race, as last reported to the education organization. The term, "Spanish origin," can be used in addition to "Hispanic or Latino." SQL Recommended Datatype: BOOLEAN Race Moved to Student Demographics Reference object Races MetaEd DSL Datatype: DescriptorProperty No optional collection The general racial category which most clearly reflects the individual's recognition of his or her community or with which the individual most identifies as last reported to the education organization. The data model allows for multiple entries so that each individual can specify all appropriate races. TribalAffiliation Moved to Student Demographics Reference object TribalAffiliations MetaEd DSL Datatype: DescriptorProperty No optional collection An American Indian tribe with which the student is affiliated as last reported to the education organization. StudentCharacteristic   Reference object StudentCharacteristics MetaEd DSL Datatype: CommonProperty No optional collection Reflects important characteristics of a student. If a student has a characteristic present, that characteristic is considered true or active for that student. If a characteristic is not present, no assumption is made as to the applicability of the characteristic, but local policy may dictate otherwise. LimitedEnglishProficiency Moved to Student Demographics Reference object LimitedEnglishProficiency Descriptor MetaEd DSL Datatype: DescriptorProperty No optional An indication that the student has been identified as limited English proficient by the Language Proficiency Assessment Committee (LPAC), or English proficient. Language Moved to Student Demographics Reference object Languages MetaEd DSL Datatype: CommonProperty No optional collection The language(s) the individual uses to communicate. It is strongly recommended that entries use only ISO 639-3 language codes. Disability Moved to Student Demographics Reference object Disabilities MetaEd DSL Datatype: CommonProperty No optional collection The disability condition(s) that best describes an individual's impairment, as determined by evaluation(s) conducted by the education organization. CohortYear   Reference object CohortYears MetaEd DSL Datatype: CommonProperty No optional collection The type and year of a cohort (e.g., 9th grade) the student belongs to as determined by the year that student entered a specific grade. StudentIndicator   Reference object StudentIndicators MetaEd DSL Datatype: CommonProperty No optional collection An indicator or metric computed for the student (e.g., at risk). LoginId   String string LoginId MetaEd DSL Datatype: SharedStringProperty No optional The login ID for the user; used for security access control interface. SQL Recommended Datatype: VARCHAR(60) AncestryEthnicOrigin Moved to Student Demographics Reference object AncestryEthnicOrigins MetaEd DSL Datatype: DescriptorProperty No optional collection The original peoples or cultures with which the individual identifies. PrimaryLearningDevice AwayFromSchool   Reference object PrimaryLearningDeviceAwayFromSchoolDescriptor MetaEd DSL Datatype: DescriptorProperty No optional The type of device the student uses most often to complete learning activities away from school. PrimaryLearningDevice Access   Reference object PrimaryLearningDeviceAccess Descriptor MetaEd DSL Datatype: DescriptorProperty No optional An indication of whether the primary learning device is shared or not shared with another individual. PrimaryLearningDevice Provider   Reference object PrimaryLearningDeviceProvider Descriptor MetaEd DSL Datatype: DescriptorProperty No optional The provider of the primary learning device. InternetAccessIn Residence   Boolean boolean InternetAccessInResidence MetaEd DSL Datatype: BooleanProperty No optional An indication of whether the student is able to access the internet in their primary place of residence. SQL Recommended Datatype: BOOLEAN BarrierToInternetAccess InResidence   Reference object BarrierToInternetAccessIn ResidenceDescriptor MetaEd DSL Datatype: DescriptorProperty No optional An indication of the barrier to having internet access in the student’s primary place of residence.

Breakout not applied to Contact since it is not a primary person-role like Student, Staff and Candidate

Revised StudentEducationOrganizationAssociation UML

image-20250616-211158.png

 

API Specifications

Pending

Feedback

Please contact Maria Ragone via e-mail or using Ed-Fi’s Slack subscription to provide feedback on this RFC.