This documentation serves as an introduction to new features and changes=
made for the Ed-Fi EPDM-Community extension set (previously TPDM-Community=
), with links to additional detail. This information is for technical profe=
ssionals who work with the data model, including business analysts, databas=
e administrators, and software developers. If you are looking for updates f=
or EPDM-Core, our slimmed down version of EPDM meant to the Educator Prepar=
ation Starter Kits, for more information see Educator Preparation Data Model Domain=
Contents
- New entity PlanMilestone entity allows for the tracking of progress tow=
ard a plan. A plan can be a certification plan for candidates working towar=
d certification, or students working toward graduation.
Based on the work of ED-FI RFC 26 - TEACHER PREP DATA MODEL, Ed-Fi is bringing a subset o=
f EPDM into Ed-Fi Core as a core supported extension. This means that there=
are now two EPDM extensions:
- EPDM-Core - Based on RFC-26, Ed-Fi has released a new extension (EPDM-C=
ore) with the entities and fields required to power the Program Diversity and Pe=
rsistence Starter Kit and the Clinical Experience and Performance Starter =
Kit. EPDM-Core will be installed by default with ODS/API v5.3 and will =
have the full support of Ed-Fi Core
- EPDM-Community - EPDM-Community is the new name for the existing EPDM. =
This is the full model with everything you've come to expect with the EPDM.=
With this update we are making all EPDM-Community assets open source, in=
cluding the model, allowing the community to modify the model if it does no=
t fit their current needs, you can find the EPDM-Community MetaEd model in =
the Ed-Fi Exchange GitHub
Candidate Indicator - In an effort to sup=
port the need for Indicators that are longitudinal (span multiple years) we=
have updated CandidateIndicator in the following ways:
- Added BeginDate (required)
- Added EndDate (optional)
- Deprecated Period
Adding BeginDate as a required field and adding it to the primary key of=
the entity allows the same indicator to be used in multiple years by just =
updating the date. With the addition of BeginDate and EndDate to the indica=
tor model, period is not longer needed and has been marked as deprecated.=
p>
- The Aid common object (for tracking financial aid) has been deprecated =
and has been replaced with a top level API resource, /tpdm/financialAids. W=
ith aid attached to candidate as it was, the financial aid data had to be l=
oaded with the candidate data. This expects that aid data is stored in the =
Student Information System (SIS), and while sometimes aid is stored in a SI=
S, many times it's in it's own system and thus requires a lot of work to be=
integrated into the SIS data.
- Deprecated (this element can cause confusion when a candidate is enroll=
ed in multiple programs. =
A candidate will be determined to be program complete when an approp=
riate ReasonExited descriptor is selected on the CandidateEducatorPreparati=
onProgramAssociation moving forward.
- Replaced the existing currency data types with decimal 19,4. The MetaEd=
currency datatype translates into a SQL money type and this has caused som=
e technical issues, so we decided to replace currency with decimals. Choosi=
ng a length of 19,4 (nineteen total digits, 4 decimal places) mirrors curre=
ncy and makes for a seamless transition with no updates to this data.
- Deprecated EducatorPreparationProgramType - EducatorPreparationPrgram a=
lready has a required ProgramType descriptor field, and has left this field=
unused in previous EPDM implementations.
CandidateEducatorPreparationProgra=
mAssociation Updates (TPDMX-233 & TPDMX-162)
CandidateIndicator<=
/h5>
- Updated from optional to optional collection, fixing a bug that only al=
lowed one indicator per candidate per EducatorPrepProgram
- Deprecated shared string (replace=
d with DegreeSpecialization common type)
- Deprecated shared string (replace=
d with DegreeSpecialization common type)
- Added cohort year here (deprecated in Candidate)
- Added optional ApplicationReference to CandidateEducatorPreparationPrep=
arationAssociation to better support candidates enrolled in multiple progra=
ms.
- The Person reference and CertificationTitle field have been made o=
ptional. While making the person reference optional is not ideal as it can =
lead to orphaned certification records, when required it fundamentally chan=
ges the way the credential entity works and caused issues when K-12 impleme=
ntations wanted to use both EPDM and the credential entity.
- Added optional EducatorRole descriptor
- Added PerformanceEvaluationDescription, a 255 character optional string=
to allow for more detailed descriptions for the performance evaluation
- Added EvaluationDescription, a 255 character optional string to allow f=
or more detailed descriptions for the evaluation
- Added EvaluationObjectiveDescription, a 255 character optional string t=
o allow for more detailed descriptions for the evaluation objective
- Increased length of the Feedback field from 1024 to 2048 characters
Updated datatype for EvaluationDate from date to datetime to allow f=
or more than 1 evaluation in a given day.
Added EvaluationRatingStatus a=
n optional descriptor, allowing for status to be set for an evaluation
- Added optional goal reference (ParentGoal) to the goal entity allowing =
a hierarchical structure opening up the possibility of action steps for goa=
ls.
Through our work with the EPP starter kit cohort and though discussion w=
ith previous implementers, we found that having financial aid as part of th=
e candidate and not it's own API resource causes issues. When the financial=
aid data is not stored in the Student Information System, (much of the tim=
e it is not), loading financial aid becomes much more difficult as it requi=
res pre-processing to combine SIS and aid data. In addition, working with a=
n iPaaS provider becomes near impossible as there is no chance to combine t=
he data. This lead us to create a new financial aid entity as a top level A=
PI resource, allowing financial aid data to be loaded separate from candida=
tes. You can see the new mode in the Data Handbook
- SalaryAmount - Replaced the existing currency data types with deci=
mal 19,4. The MetaEd currency datatype translates into a SQL money type and=
this has caused some technical issues, so we decided to replace currency w=
ith decimals. Choosing a length of 19,4 (nineteen total digits, 4 decimal p=
laces) mirrors currency and makes for a seamless transition with no updates=
to this data.
- XML Sample data for v1.1 been added to the Ed-Fi-EPDM-Community-Artifacts repository. Note=
that this set of data is not meant to be a true representation of how data=
is to be mapped within EPDM. Its purpose is to test entities and API endpo=
ints for errors.
In many cases,=
the changes to the model are extensive and can be found in the linked trac=
ker tickets. What is shown below are the highlights of the changes for each=
domain.
University and TeacherPreparationProvider have been removed, PostSeconda=
ryInstitution and School should be used instead. To facilitate the move, Po=
stSecondaryInstitution and School have had the following updates:
- Added FederalLocaleCode descriptor.
- Removed SchoolStatus descriptor.
- Added PostSecondaryInstitution reference and AccreditationStatus.
Survey has been extended to use the Person model:
- The SurveyResponse entity has now has a Person reference and the Teache=
rCandidate and Applicant references have been removed.
- SurveyResponseTeacherCandidateTargetAssociation has been renamed to Sur=
veyResponsePersonTargetAssociation and the TeacherCandidate reference has b=
een replaced with a Person reference.
- SurveySectionResponseTeacherCandidateTargetAssociation has been renamed=
to SurveySectionResponsePersonTargetAssociation and the TeacherCandidate r=
eference has been replaced with a Person reference.
To show the inclusivity of the EPDM, at the suggestion of the community =
we removed Teacher or TeacherPreparation from the model. TeacherPreparation=
ProviderProgram has been renamed to EducatorPreparationProgram. The sub-ele=
ments of this entity have also been renamed to be more inclusive of the dat=
a that can be used, for example, TeacherPreparationProgramType descriptor i=
s now EducatorPreparationProgramType.
- School reference (signifying the K=E2=80=9312 school where the fieldwor=
k was completed) was previously a required collection. It is now a single r=
eference and optional. If the fieldwork occurred at multiple schools, multi=
ple records should be added.
- Added an optional reference to the EducatorPreparationProgram in which =
the candidate was enrolled.
Similar to TeacherPreparationProviderProgram, TeacherCandidate and relat=
ed entities have been renamed and Teacher has been removed. Highlights of t=
he changes around candidates:
- The required Student reference has been removed. The reference to a stu=
dent should be determined through the Person reference.
- TeacherCandidateAcademicRecord and TeacherCandidateCourseTranscript hav=
e been removed, use StudentAcademicRecord and CourseTranscript instead.
- Candidate characteristics have been added.
The recruitment pipeline has been updated to tell a more cohesive story.=
Applicants and prospects have been renamed and had their Person references=
removed as they don't meet the definition of a person-role within the Ed-F=
i data standard. Direct lines can now be followed from a prospective studen=
t/staff through the application process and then to an accepted student or =
employed staff member.
- Applicant has been renamed to ApplicantProfile and the Person reference=
has been removed.
- Prospect has been renamed to RecruitmentEventAttendance and the Person =
reference has been removed.
- RecruitmentEventAttendance now requires a RecruitmentEvent.
- A number of fields on Application have been moved to ApplicationProfile=
, including HighestLevelOfEducation, HighlyQualifiedTeacher, HighlyQualifie=
dAcademicSubject, and GPA.
- EmploymentEvent and EmploymentSeparationEvent have been removed from th=
e model.
Added StaffEducationOrganizationEmploymentAssociation and moved a number=
of entities from the Staff extension to be more in line with Ed-Fi modelin=
g practices.
Anonymized student data entities have been removed from the data model. =
This includes AnonymizedStudent, AnonymizedStudentAcademicRecord, Anonymize=
dStudentCourseTranscript, and AnonymizedStudentAssessment.
GrowthMeasures have been removed. Analysis and discussion with various s=
takeholders implementing the EPDM solution revealed that growth measures in=
their current form were not used or useful within the data model.
- XML Sample data for v1.0 been added to the Ed-Fi-EPDM-Extension repository. Note that this set of data is not=
meant to be a true representation of how data is to be mapped within EPDM.=
Its purpose is to test entities and API endpoints for errors.
- A Person model, including a new Person entity, has been added for use i=
n TPDM.
- Originally, the Ed-Fi Data Standard was developed primarily with the st=
udent and staff of a K=E2=80=9312 school in mind. The use cases where =
a single physical person would have multiple representations within Ed-Fi s=
olutions were rare, even when a parent was added to the system. In addition=
, the data for these roles were generally coming from different systems. Un=
ifying the roles under a "person" was difficult.
- As technology within institutions progressed, it's become more common f=
or institutions to have a designated person ID system that provides unique =
identifiers for a "person" no matter their various roles.
- Meanwhile, the EPDM brings focus on a number of additional roles for a =
person in Ed-Fi solutions. With these considerations in mind, the Ed-Fi Dat=
a Standard v3.2.0-c has introduced the concept of a person to the Ed-Fi cor=
e model for use within EPDM.
- More info on the Person model can be found her=
e.
New Per=
formance Evaluation Domain
- After internal review and discussions with the community, we decided to=
combine the concepts found in the Performance Measures and Staff Evaluatio=
n domains into a single domain, Performance Evaluation.
- Along with performance evaluation we have also added a new Goal entity =
to replace the existing TalentManagementGoal entity. The new Goal entity pr=
ovides a richer, more defined concept of a goal.
- Performance Evaluation uses references to the Ed-Fi Person model rather=
than references to the person-roles such as Teacher Candidate, Staff, Appl=
icant, and so forth.
- An overview of the new Performance Evaluation domain can be found here.
Updates to Credentials and Certification Domains
- Credentials and Certification as defined within TPDM have been overhaul=
ed. The changes include:=20
- The ability to track the lifecycle of a credential (through StudentAcad=
emicRecord).
- The ability to define a catalog of credentials. In previous versions, c=
redentials were created and associated to a person at the same time, with t=
he effect that there was not support for pre-built credentials. This update=
adds the CertificationLicense entity, which allows full catalogs of certif=
ications to be created and associated to credentials before being assigned =
to a person.
- Credentials reference the Ed-Fi Person model rather than using direct r=
eferences to the person-role entities.
- An overview of the updated credentials domain can be found here.
Removal of Surve=
y Domain
- With the approval of RFC 25, the Survey domain is part of the Ed-Fi Data Standard. The =
Survey domain has been removed in this version of EPDM.
- Teacher Candidates and Applicants can still "take" a survey (the S=
urveyResponse entity still has references to TeacherCandidates and Applican=
ts).
- Teacher Candidates can still be the target of a survey or a survey sect=
ion.
- Prospects can no longer take a survey.
- More info on the differences between the Survey domain in the prior rel=
ease of EPDM and the one found in the Ed-Fi Data Standard can be found here.
- The FieldworkExperience entity has been reworked to use the Student rol=
e, rather than the Staff or Teacher Candidate role.
- Facts style tables have been removed. For the most frequently used fact=
s tables (EducationOrganizationFacts and EducationOrganizationStudentF=
acts), we have suggested workarounds detailed here.
- The GradebookEntry extension has been removed and the changes it contai=
ned were brought into the core Data Standard.
- TeacherCandidateFieldworkAbsenceEvent and StaffFieldworkAbsenceEvent ha=
ve been removed.
- ProfessionalDevelopmentEventAttendance (now used in the Certification w=
orkflow) has been updated to use person model, and the entities to specific=
roles (TeacherCandidate, Staff, and Prospect) have been removed.
Recruitment and=
Staffing
- To make it easier for an applicant to either apply at multiple organiza=
tions or to the same organization multiple times, a number of fields were m=
oved from Applicant to Application, and the Education Organization requirem=
ent on Applicant has been removed. A full list of the changes can be found =
in TPDMX-108.
- Person references have been added to Teacher Candidate, Applicant,=
and Prospect.
- LevelOfDegreeAwardedDescriptor had minor updates to misspellings i=
n the code value, description, and short descriptions.
- Accreditation Status has been added to the Teacher Preparation Provider=
education organization as a descriptor. The default values provided are li=
sted in TPDMX-132.
- References to Credentials entities on Teacher Candidate, Applicant, and=
Prospect have been removed. Use the reference to Person instead.
- Facts style entities have been removed from EPDM.=20
- For EducationOrganizationStudentFacts, we recommend using the StudentIn=
dicator entity. Details can be found in the Ed-Fi data handbook.
- For EducationOrganizationFacts we have a replacement that better fits s=
tandard Ed-Fi modeling patterns. Details can be found here.
- Absence Event entities were unused and thus removed from the model.
- GradebookEntry extension functionality has been moved into the Ed-Fi co=
re data model.
- CommunityOrganizationExtension, CommunityProviderExtension, E=
ducationOrganizationNetworkExtension, and EducationServiceCenterExtension e=
ntities have been removed. All were unused in EPDM.=20
- The field FederalLocaleCode on these entities will most likely be added=
to the Ed-Fi data standard in a future release.
- To bring TPDM more in line with core Ed-Fi development practices, and t=
o help with the growing number of artifacts for the model, we have created =
a new GitHub repository named Ed-Fi-T=
PDM-Extension. This repository will hold:=20
- XML Sample Data. Data used to test the bulk loader and provide insight =
into how domains are mapped to data exchange elements.
- XML Descriptor values. Default values for TPDM descriptors in XML forma=
t (for loading into the ODS).
- UML diagram for TPDM entities.
- XML Sample data for both v0.7 and v0.8 have been added to the Ed-Fi-TPDM-Extension repository. Note that th=
is set of data is not meant to be a true representation of how data is to b=
e mapped within TPDM. Its purpose is to test entities and API endpoints for=
errors.
- "Real world" sample data has been added. This data is meant to represen=
t how data from an actual Teacher Preparation Provider would be stored in t=
he ODS. It does not have data to represent every use case of the TPDM (the =
XML sample data comes much closer). But, the real-world data provides a ric=
her set of data for those use cases it does cover. We plan to add data for =
additional use cases with subsequent releases. The real world sample data c=
an be downloaded h=
ere
Several enhancements have been made to the Survey domain. With the relea=
se of v0.7, implementers have more options to indicate the object of a surv=
ey (i.e., who or what the survey is about). These options include Teacher C=
andidates, Staff members, and Educational Organizations as the target entit=
y of an entire survey. These entities may also be designated as the object =
of a survey section (i.e., a group of specific questions).
- TPDMX-10 - Add RecruitmentEventType descri=
ptor to RecruitmentEvent
- TPDMX-34 - Add GradePointAverage common ob=
ject to Applicant domain
- TPDMX-40 - Add Applicant identifier to the=
primary key for application
- TPDMX-68 - Add characteristic common objec=
t to applicant
- TPDMX-85 - Add Application Period term des=
criptor to applications
- ODS-3867 - In some instances the console bulk l=
oader will not load data w/o being run through a debugger. If you experienc=
e these issues, we suggest you tun your data loads through a debugger.
This release is a refinement release, which adds new entities and elemen=
ts, and corrects issues discovered in field work.
Noteworthy improvements and enhancements in this release include: <=
/p>
- TPDMX-75 - Change TeacherCandidateAcademic=
Record GradePointAverage to allow for multiple GPA's
- TPDMX-88 - Change TeacherCandidateFieldworkExpe=
rience school reference from single value to multiple
- TPDMX-94 - Add optional School reference to Tea=
cherPreparationProvider and University entities
This release is a refinement release, which adds new entities and elemen=
ts, and corrects issues discovered in field work.
Noteworthy improvements and enhancements in the August 5, 2019 release i=
nclude:
- TPDMX-64 - Add Survey Teacher Candida=
te Association
- TPDMX-65 - Add Survey Staff Association
This release is a refinement release, which adds new entities and elemen=
ts, and corrects issues discovered in field work.
Noteworthy improvements and enhancements in the May 15, 2019 release inc=
lude changes to the Survey and Survey Response entities and the addition of=
TNTP domains and entities to the Recruitment and Staffing interchange sche=
ma.
- TPDMX-35 - Changes to Survey/SurveyRe=
sponse Part 1
- TPDMX-36 - Changes to Survey/SurveyRe=
sponse Part 2
- TPDMX-37 - Changes to Survey/SurveyRe=
sponse Part 3
- TPDMX-38 - Changes to Survey/SurveyRe=
sponse Part 4
- TPDMX-53 - Add TNTP domains to interc=
hange
This release is a refinement release, which adds new entities and elemen=
ts, and corrects issues discovered in field work.
Noteworthy improvements and enhancements in the March 19, 2019 release i=
nclude:
- TPDMX-41 - Add SurveyLevel to Survey<=
/li>
- TPDMX-42 - Add enumerations to Applic=
ation Status descriptor
- TPDMX-44 - Extend field length in sev=
eral areas
- TPDMX-46 - Add Staff Evaluation domai=
ns to the existing StaffSectionAssociation Interchange
- TPDMX-64 - Add Survey Teacher Candida=
te Association
- TPDMX-47 - Change Elements in the Pro=
gram Degree entity to Unbounded
This release is a refinement release, which adds new entities and elemen=
ts, and corrects issues discovered in field work.
Noteworthy improvements and enhancements in the February 5, 2019 release=
include:
- TPDMX-32 - Change PerformanceMeasure.=
RubricReference to unbounded
Additional c=
hanges included in this release are:
- TPDMX-1 =
- Add Major and Minor to Teacher Candidate
- TPDMX-3 =
- Add First Generation Student to Persons
- TPDMX-4 =
- Add Economic Disadvantaged to Persons
- TPDMX-5 =
- Add Application Event
- TPDMX-6 =
- Add Prospect Type to Prospect
- TPDMX-7 =
- Add Reference from TeacherCandidate to Applicant
- TPDMX-8 =
- Change GPA to Collection
- TPDMX-9 =
- Add Element to Capture Continuous Ed versus Prior Occupation
- TPDMX-11&nbs=
p;- Add Optional Reference to TC/Staff in Prospect
- TPDMX-12&nbs=
p;- Remove ProgramParticipation from TeacherCandidate
- TPDMX-13&nbs=
p;- Change PerformanceMeasure.PersonBeingReviewed to Required
- TPDMX-14&nbs=
p;- Add TeacherCandidate and Staff References to Survey
- TPDMX-15&nbs=
p;- Move GradeLevel in TeacherPreparationProviderProgram into TPPDegre=
eType, Make IsRequired
- TPDMX-16&nbs=
p;- Add CertificationExamDate and CertificationExamPassFail
- TPDMX-17&nbs=
p;- Add PerformanceMeasureInstanceDescriptor
- TPDMX-18&nbs=
p;- Add NumberAdministered to Survey
- TPDMX-19&nbs=
p;- Add GradeLevel to common type Vacancies