Page tree

The Teacher Preparation Data Model, documentation, and related technology are works in progress. All TPDM resources are expected to change, including the draft documentation on this site.



Skip to end of metadata
Go to start of metadata

his documentation serves as an introduction to new features and changes made for the Ed-Fi TPDM Extension set, with links to additional detail. This information is for technical professionals who work with the TPDM, including business analysts, database administrators, and software developers.

Releases & Updates

(v0.7) (Latest)

Improvements & Enhancements

Online TPDM Instance
  • An online version of the Ed-Fi ODS / API + TPDM is available at https://api.ed-fi.org/v0.7.0-tpdm/docs/
  • Similar to the Ed-Fi ODS / API sandbox instance, this instance of the ODS / API + TPDM is connected to a populated datastore. This means you can view and download the OpenAPI spec, test out TPDM API calls, view response data, and so forth.
  • Since the TPDM is an extension of the Ed-Fi ODS / API, you can see the TPDM data in the context of the core ODS / API data model.
Updated Versioning for TPDM
  • As of this release of TPDM, we are updating the versioning scheme. We intend for the TPDM data model to grow and change independently of the underlying Ed-Fi ODS / API technology version. So, we have decoupled the TPDM version from the ODS / API product version (dropping the 3.x) and will now refer to TPDM by its own version number. Thus, this latest release is v0.7.
  • You can view the technical version information at https://api.ed-fi.org/v0.7.0-tpdm/api.
Ed-Fi + TPDM Data Handbook
  • To simplify mapping data to TPDM there is now a Ed-Fi Data Handbook that include TPDM, it can be found here
Updated ODS / API Base Version
  • The ODS / API + TPDM now supports the Ed-Fi ODS / API version 3.2. More information about the ODS / API v3.2 can be found here. The TPDM model has also been updated to be MetaEd v2.0-compliant.
Simplified TPDM Installation
  • To simplify installation of the ODS / API + TPDM, we have created source branches with the TPDM extension already added. These branches come with built-in fixes, including:
    • Updated the Descriptor namespaces. Previously, namespaces were either "tpdm.exchange.ed-fi.org" or "tpdp.exchange.ed-fi.org". We have standardized to "tpdm.ed-fi.org". 
    • Added default gender Descriptors. Gender descriptors were empty in previous releases. We have added them into the v0.7 release by default.
    • Removed sample extensions. The as-shipped v3.2 release of the Ed-Fi ODS / API comes with two sample extensions (Sample and GrandBend) as well as three sample profile projects (ExtensionsSample, Sample, Test). These have been removed from the TPDM-specific branches.
  • To view the simplified installation instructions, see the Getting Started documentation.
  • If you would like to add TPDM to an existing project, you can follow the instructions here. The TPDM MetaEd files on GitHub complete with default Descriptors from the ODS branch are available on GitHub here.
Survey Domain Enhancements

Several enhancements have been made to the Survey domain. With the release of v0.7, implementers have more options to indicate the object of a survey (i.e., who or what the survey is about). These options include Teacher Candidates, Staff members, and Educational Organizations as the target entity 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-25 - Add a response time field to SurveyResponse entity
  • TPDMX-45 - Add a comment to SurveyQuestionResponse entity
  • TPDMX-54 - Add education organization as an optional target of a survey response
  • TPDMX-67 - SurveyResponse location field description has typos
  • TPDMX-78 - Make SurveySection optional for a survey
  • TPDMX-79 - Add teacher candidate as an optional target of a survey section response
  • TPDMX-80 - Add staff as an optional target of a survey section response
  • TPDMX-95 - Add education organization as an optional target of a survey section response
  • TPDMX-96 - Increase length of TextResponse string from 1024 to 2048 (affects SurveyQuestionMatrixElementResponse, RubricLevelResponse, SurveyQuestionResponse)
  • TPDMX-97 - Increase length of QuestionText from 255 to 512 (affects SurveyQuestion)
  • TPDMX-100 -  Rename SurveySectionResponseRating to SurveySectionResponse and make SectionRating optional
Talent Management Enhancements
  • TPDMX-10 - Add RecruitmentEventType descriptor to RecruitmentEvent
  • TPDMX-34 - Add GradePointAverage common object to Applicant domain
  • TPDMX-40 - Add Applicant identifier to the primary key for application
  • TPDMX-68 - Add characteristic common object to applicant 
  • TPDMX-85 - Add Application Period term descriptor to applications

General Updates

  • TPDMX-21 - Add a comment field to RubricLevelResponse
  • TPDMX-22 - Add CoteachingStyleObserved descriptor to PerformanceMeasure, remove CoteachingObserved boolean
  • TPDMX-30 - Add GradeLevelDescriptor to AnonymizedStudent entity
  • TPDMX-33 - HispanicLatinoEthnicity should be an optional field on TeacherCandidate entity
  • TPDMX-49 -  Change HoursPerWeek on FieldworkExperience entity to HoursCompleted
  • TPDMX-50 - Updates to CertificationExam common object
  • TPDMX-52 - Rename StaffTeacherCandidateAssociation to CompleterAsStaffAssociation to alleviate confusion with TeacherCandidateStaffAssociation
  • TPDMX-57 - Add Standard Error to TeacherCandidateStudentGrowthMeasure entity
  • TPDMX-102 - Expand StaffStudentGrowthMeasure to allow for multiple score per teacher per year
  • TPDMX-105 -  Increase length of TeacherPreparationProviderProgram name field from 60 characters to 255 characters

Known Issues

  • ODS-3867 - In some instances the console bulk loader will not load data w/o being run through a debugger. If you experience these issues, we suggest you tun your data loads through a debugger.

(v3.0.6) 

This release is a refinement release, which adds new entities and elements, and corrects issues discovered in field work.

General Improvements & Enhancements 

Noteworthy improvements and enhancements in this release include: 

  • TPDMX-75 - Change TeacherCandidateAcademicRecord GradePointAverage to allow for multiple GPA's
  • TPDMX-88 - Change TeacherCandidateFieldworkExperience school reference from single value to multiple
  • TPDMX-94 - Add optional School reference to TeacherPreparationProvider and University entities

August 5, 2019 (v3.0.5)

This release is a refinement release, which adds new entities and elements, and corrects issues discovered in field work.

General Improvements & Enhancements 

Noteworthy improvements and enhancements in the August 5, 2019 release include: 

  • TPDMX-64 - Add Survey Teacher Candidate Association
  • TPDMX-65 - Add Survey Staff Association

May 15, 2019 (v3.0.4)

This release is a refinement release, which adds new entities and elements, and corrects issues discovered in field work.

General Improvements & Enhancements 

Noteworthy improvements and enhancements in the May 15, 2019 release include changes to the Survey and Survey Response entities and the addition of TNTP domains and entities to the Recruitment and Staffing interchange schema. 

  • TPDMX-35 - Changes to Survey/SurveyResponse Part 1
  • TPDMX-36 - Changes to Survey/SurveyResponse Part 2
  • TPDMX-37 - Changes to Survey/SurveyResponse Part 3
  • TPDMX-38 - Changes to Survey/SurveyResponse Part 4
  • TPDMX-53 - Add TNTP domains to interchange

March 19, 2019 (v3.0.3)

This release is a refinement release, which adds new entities and elements, and corrects issues discovered in field work.

General Improvements & Enhancements 

Noteworthy improvements and enhancements in the March 19, 2019 release include: 

  • TPDMX-41 - Add SurveyLevel to Survey
  • TPDMX-42 - Add enumerations to Application Status descriptor
  • TPDMX-44 - Extend field length in several areas
  • TPDMX-46 - Add Staff Evaluation domains to the existing StaffSectionAssociation Interchange
  • TPDMX-64 - Add Survey Teacher Candidate Association
  • TPDMX-47 - Change Elements in the Program Degree entity to Unbounded

February 5, 2019 (v3.0.2)

This release is a refinement release, which adds new entities and elements, and corrects issues discovered in field work.

General Improvements & Enhancements 

Noteworthy improvements and enhancements in the February 5, 2019 release include: 

  • TPDMX-32 - Change PerformanceMeasure.RubricReference to unbounded

Additional changes 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 - Add Optional Reference to TC/Staff in Prospect
  • TPDMX-12 - Remove ProgramParticipation from TeacherCandidate
  • TPDMX-13 - Change PerformanceMeasure.PersonBeingReviewed to Required
  • TPDMX-14 - Add TeacherCandidate and Staff References to Survey
  • TPDMX-15 - Move GradeLevel in TeacherPreparationProviderProgram into TPPDegreeType, Make IsRequired
  • TPDMX-16 - Add CertificationExamDate and CertificationExamPassFail
  • TPDMX-17 - Add PerformanceMeasureInstanceDescriptor
  • TPDMX-18 - Add NumberAdministered to Survey
  • TPDMX-19 - Add GradeLevel to common type Vacancies


  • No labels