You are on page 1of 18

TEXASSTUDENTDATASYSTEM

CanonicalDataModel
DesignGuidelines

Phase2Update:December6,2010
EdComer

2010Michael&SusanDellFoundation.AllRightsReserved.
ThisdocumentwascreatedbyDoubleLinePartners,LLCwithsupportfromtheMichael&Susan
DellFoundation.
ThisdocumentisbeingsharedindraftformandisbasedonPhase2oftheDistrictConnections
Databaseproject.Asadditionalphasesoftheprojectareexecuted,thisdocumentwillbe
updatedtoreflectrefinements,experiencesandobservationsfromthoseefforts.

i
TableofContents
Introduction..................................................................................................................1
WhatisaCanonicalDataModel?.............................................................................................1
TargetAudienceandStakeholders...........................................................................................2
CDMReferenceModel..................................................................................................3
CDMPrinciples........................................................................................................................3
CDMReferenceModelNotation..............................................................................................3
CDMNamingConventions.......................................................................................................6
CDMDomains..........................................................................................................................7
CDMDesignRulesandPatterns...............................................................................................7
CDMXMLSchema.......................................................................................................11
CDMXMLSchemaPrinciples..................................................................................................11
InterchangeSchemaDesignPattern.......................................................................................11
CDMCoreSchemaOrganization............................................................................................12
DomainTypes................................................................................................................................13
AssociationTypes..........................................................................................................................13
Generalizations..............................................................................................................................14
Enumerations................................................................................................................................15
EnumeratedCollections................................................................................................................15
ExtensionstotheCDMCore...................................................................................................16


TSDSWorkingDocument/Phase2December6,20101

Introduction
Thisdocumentoutlinesthedesignconcepts,principles,patterns,andconventionsusedforthe
CanonicalDataModel(CDM)anditsassociatedXMLschema.Thisdocumentisacompanionto
thefollowing:
CDMTechnicalImplementationGuideProvidesanoverviewtotheCDMXMLschema
andprovidesguidancetotechnicalpersonnelonapplyingthestandard.
CDMReferenceModelProvidesareferenceforthedetailedCDMartifactsand
associatedcrossreferences.
WhatisaCanonicalDataModel?
Acanonicaldatamodel(CDM)definesthebusinessentitiesrelevantforaspecificdomain,their
attributes,theirassociations,andtheirsemantics.Asareferencemodel,theCDMisanabstract
frameworkfromwhichconcreteimplementationsarederived.TheassociatedCDMXML
schemadefinesacoresetofdomain,association,andattributetypes,amethodforextending
theschema,andamethodforcomposingconcreteinterchangeschemas.
Areferencemodel,initsbroadestsense,ismodelofsomethingthatembodiesthebasicideaof
somethingandcanbelookedatasareferenceforvariouspurposes.Referencemodelsembody
thefollowingconcepts:
1

Abstract:areferencemodelisabstract.Thethingsdescribedbyareferencemodelare
notactualthings,butanabstractrepresentationofthings.
EntitiesandRelationships:Areferencemodelcontainsbothentities(thingsthatexist)
andrelationships(howtheyinteractwithoneanother).Alistofentities,byitself,isnot
sufficienttodescribeareferencemodel.
WithinanEnvironment:Areferencemodeldoesnotattempttodescribe"allthings."A
referencemodelisusedtoclarify"thingswithinanenvironment"orascopeora
problemspace.
TechnologyAgnostic:Areferencemodelisamechanismforunderstandingthe
problemsfaced,notthesolutionsinvolved,andassuch,mustbeindependentofthe
selectedsolutionsinordertoprovidevaluetothepractitioner.
TheCDMisadatareferencemodelthatismeanttoenableinformationsharingandreuseof
educationdata.SpecificallythescopeoftheCDMisfocusedonP12educationdatarelevantto
theLocalEducationAgency(LEA),whichincludesLEAtoStateEducationAgency(SEA)orLEAto
Federalreporting.

1
DefinitionderivedfromWikipedia,http://en.wikipedia.org/wiki/Reference_model

TSDSWorkingDocument/Phase2December6,20102

TargetAudienceandStakeholders
ThetargetaudiencefortheCDMincludeshighleveltechnicalpersonnelconsistingofenterprise
architectsanddataarchitects.
ThestakeholdersfortheCDMare:
LEApersonnelwhoproduceorconsumedata,includingsuperintendents,principals,
teachers,counselors,ITmanagers,andSEAandFederaldatasubmissionsspecialists
SEAandFederallevelpersonnelinvolvedinsettingdatarequirementsforLEAs,
acceptingLEAdatasubmissionsandutilizingandinterpretingLEAdataforpolicyand
decisionmaking.
Regionaleducationservicecenters(ESCs)thatprovidedatarelatedservicestoLEAs
Vendorsengagedinprovidinginformationtechnologysupportandtoolstothe
educationindustry,particularlyattheLEAlevel.
Researchersdesigningorengagedineducationdataanalysis.

TSDSWorkingDocument/Phase2December6,20103

CDMReferenceModel
Thecanonicaldatamodel(CDM)definesthebusinessentitiesrelevantfortheeducation
domain,theirassociations,andtheirsemantics.Asareferencemodel,theCDMisanabstract
frameworkfromwhichconcreteimplementationsarederived.
TheassociatedCDMXMLschemadefinesacoresetofdomain,association,andattributetypes,
amethodforextendingtheschema,andamethodforcomposingconcreteinterchange
schemas.
CDMPrinciples
TheCDMreferencemodelisbaseduponthefollowingcoreprinciples:
Understandability.TheCDMreflectsthecommonvocabularyofthedomain.Itdoes
notintroduceobtuseabstractions.Itismodularlyorganizedintoreadilyunderstood
views.
Independence.TheCDMisindependentofanyspecificapplication,butrather
synthesizesthedataintegrationrequirementsofallrelevantapplications.
ImmutableKernel.Thecorestructures(entitiesandrelationships)oftheCDMare
logicallycommonacrossallapplicationsandarenotexpectedtochange.
Extensibility.TheCDMisdesignedtobeextendedforparticularinstallationsandfor
futurechangeandevolution.
CommutativeMapping.Theprocessofmappingspecificinformationmodelsintothe
CDMmustpreservedataandoperations.
SeparationofConcerns.TheCDMlogicallyseparatesthedatabywhocontrolsorowns
thedata.Forexample,statespecificinformation(inourcaseinformationthatapplies
onlytoTexas)isseparatedoutintoanextensiononthemodel.
CDMReferenceModelNotation
TheCDMreferencemodelisexpressedasUnifiedModelLanguage(UML)classdiagrams,using
asubsetofthesymbologyasexplainedinthissection
2
.UMLClassdiagramscapturethelogical
structureofadomainasasetofclasses,theirfeatures(akaattributes)andtherelationships
(akaassociations)betweenthem.UMLclassdiagramswerespecificallyselectedoverEntity
Relationshipdiagramsbecauseoftheirabilitytoalsocapturethegeneralizationassociations
betweenclasses.

2
UnifiedModelingLanguageVersion2.2,ObjectManagementGroup,Feb2009,
http://www.omg.org/spec/UML/2.2/

TSDSWorkingDocument/Phase2December6,20104

WedisputetheNEDMclaimthatERandUMLdiagramsareonlyappropriatetorepresentlogical
orphysicalmodels.BothhavebeenwidelyusedforreferencemodelsliketheCDM.We
similarlydisagreewiththeNEDMclaimthatadditionofattributedetailcannotberepresented
usingERdiagramsorUMLobjectdiagrams.ERandUMLtoolssupporttheentryofattribute
detail.
3

Classesrepresentthemajorentitiesorobjectsintheeducationdomain.Physicalentitiessuch
asstudents,teachers,campusesandlocationsarerepresentedasclasses.
Nonphysicalentitiesintheeducationspacearealsorepresentedinthis
manner,suchascourses,sections,attendanceevents,anddisciplineaction.
Theattributesofclassesrepresentfeaturesorcharacteristicsofthe
entitythatareimportantinourscopededucationdomain.For
example,genderisanattributeofastudentthatisimportantto
captureintheeducationdomain.
Complexattributesthathavemanycomponentsaredefinedasseparateclassesandreferenced
asthetypeoftheattribute.Forexample,thecomplexattributetypeaddresshascomponents
streetaddress,city,state,andzipcode.
Unlessotherwiseindicated,attributesareofcardinality1,meaning
thattheyaresinglevaluedandrequired.Othercardinalitiesare
showninsquarebrackets.
Relationshipsorassociationsrepresentlogicalconnectionsbetweenentitiesthatareimportant
inourscopededucationdomain.Forexample,studentsareassociatedwithcampusesthrough
enrollment.Thedirectionofanassociationindicatesreadability(asinStudentHasAssociated
Campus)inthedomainmodel.Thedirectionoftheassociationhasadditionalmeaninginthe
XMLschema,indicatingtheclassfromwhichtherelationshipisspecified.Cardinalities(e.g.,1
to1,1tomany,manytomany)areshownforallassociations.

Anassociationclassisusedwhenanassociationhasattributes.Forexample,thedateof
enrollmentisanimportantattributeoftheenrollmentassociationbetweenstudentand
campus.

3
NationalEducationDataModelFAQ,http://nces.sifinfo.org/datamodel/Information/faq.aspx

TSDSWorkingDocument/Phase2December6,20105

TheCDMusesasubsetoftheNEDMassociationlabels,asfollows:
4

HasAssociatedTheobjectentityhasarelationshiptotheassociatedsubjectentity.
HasCausalRelationshipAstrongrelationshipinwhichoneentitycausesachangein
anotherentity.
HasFunctionalComponentReflectstheconstructionofanentitythroughfunctional
componentsrepresentedbyotherentities.
IsDirectProviderOfDirectlyprovidesgoodsorservices.
IsFunctionalComponentOfThisrelationindicatesthatsubjectentitymakesup,inpart
orinwhole,thefunctionoftheobjectentity.
isOrganizationalComponentOfThisrelationisusedtoindicateanorganizational
structureofnonpersonentitiessuchasschools,districts,etc.
ParticipatesInApersontypeentityparticipatesinanactivitytypeentity.
ProvidesServicesToSubjectprovidesservicestotheobject.
ReceivesServicesFromSubjectreceivesservicesfromtheobject.
TheIsAorgeneralizationassociationindicatesthatamore
specializedsubclassisageneralizationofabroadersuper
class.Forexample,acampusisaspecializationofthemore
generaleducationorganization.Theattributesand
associationsdefinedforthesuperclassareinheritedbythe
morespecializedsubclasses.TheNEDMrelationship
isDerivedFromhassimilarsemantics.Generalization
semanticsarecompatiblewithTypeextensionsinXML
schemas.
Statespecificattributesareseparatedintoextension
classes,shownasspecializationsofthemoregenericcore
educationclassesthatencapsulatetheattributesthat
wouldapplyonanationallevel.
TheCDMdescribedinthisdocumentincludestheextensionsfor
Texas;otherstateswilllikelyhaveadifferentset.

4
NationalEducationDataModel,http://nces.sifinfo.org/datamodel/eiebrowser/relationships.aspx

TSDSWorkingDocument/Phase2December6,20106

NotesareincludedintheCDMreferencemodeltoexplainorelaborateon
pointsnotdirectlyinterpretablefromtheUMLmodel.

CDMNamingConventions
ThenamingconventionsapplytoboththeCDMReferenceModelandtheassociatedCDMXML
schema.ConsistentnamingisusedacrosstheCDMandisexpectedtobemaintainedinalluses
oftheCDM(e.g.,logicaldatamodels,datawarehousemodels)totheextentthatitispractical.
ThefollowingnamingconventionsareappliedtotheCDM:
Concatenatedtitlecaseisusedforentities,relationshipsandattributes(e.g.,
CampusId)
Namesusecommonterminologyfortheeducationindustry
DonotendattributenameswithType.IntheXMLrepresentation,theirtypesmaybe
suffixedwithType.
Bydefault,theentity,attribute,andassociationnamesmatchthoseoftheNational
EducationDataModel(NEDM)athttp://nces.sifinfo.org/datamodel/Index.aspx
o UnlessthereisnotananalogousnameintheNEDM;or
o UnlesstheNEDMnamedoesnotreflectcommonterminology
Associationsarenamedbyconcatenatingthetwoentitiestheyrelateandendingwith
Association;forexample:StudentCampusAssociation
Entitynamesarenottobeusedinattributenames.(E.g.,aDistricttableshouldnthave
afieldcalledDistrictName,itshouldjustbeName.)Exceptionsare:
o TheprimaryIdfieldforanobject(e.g.,DistrictIdisokay);or
o Theattributeisanenumerationthatisdifferentfromothersofthesamename
inotherentities;or
o Fieldnamesthatdontmakesenseorareambiguouswithoutthename.
TheconventionsusedforStateSpecificExtensionsareasfollows:
Statespecificattributesareisolatedintostatespecificextensionsofentities,labeledas
<EntityNameorAssociationName>Extension.
Statespecificattributesareprefixedbytheirtwoletterstateabbreviation(e.g.,TX
<AttributeName>
AttributesthatareidentifiedforreworkorlaterretirementareidentifiedasaLegacy
attribute(e.g.,TXLegacy<AttributeName>)
TheexactsamenamingisusedfortheCDMReferenceModelandtheassociatedCDMXML
schema.AllusesoftheCDMshouldcarryforwardthenamingconventions.

TSDSWorkingDocument/Phase2December6,20107

CDMDomains
TheCDMreferencemodelisorganizedintodomainsinresponsetotheprinciplesof
UnderstandabilityandSeparationofConcerns.Domainsservetoprovideoverlappingviewsof
theCDMReferenceModeltoassistinitsunderstandinganditsapplication.The15domainsare
definedasfollows:
Alternative/SupplementalServices
Assessment
BellSchedule
Discipline
EducationOrganization
Enrollment
Finance
Graduation
SchoolCalendar
Staff
StudentAcademicRecord
StudentAttendance
StudentCohort
StudentIdentificationandDemographics
TeachingandLearning
AdditionalsubdomainsareprovidedforspecificcasesofAlternative/SupplementalServices:
Bilingual/ESLPrograms
CareerandTechnicalEducation
FlexibleAttendance
OptionalExtendedYearProgram
SpecialEducation
TitleIPartAServices
CDMDesignRulesandPatterns
ThebuildingblocksoftheCDMreferencemodelareentities(classes),attributes,and
relationships(associations).Evenwithsuchseeminglysimplebuildingblockstherearea
multitudeofdesignchoices.Thissectionexplainsthedesignrulesandpatternsappliedin
creatingtheCDMreferencemodel.
1. Staywithinthedefinedscope.Doestheentity,attribute,orrelationshipexistwithin
thedefinedscope?Isitimportantforaspecificpurpose?Isitavailabletobecollected?
Underwhatscenarioswoulditbeinterchanged?Isitrequiredforvisualizationor
reporting?
2. Considerthenaturalstateandstructureofthedata.Entitiesarenaturallythemost
importantthingsinthedomainthatrequirerepresentationindata.Attributes

TSDSWorkingDocument/Phase2December6,20108

naturallyidentify,describe,characterizeorclassifyentities.Relationshipsbetween
entitiesarenottransientandtypicallypersistovertime.
3. Includeonlygeneralizationsthatcontributecriticalinheritancesandrepresent
importantgeneralizationswithinthedefinedscope.Isthegeneralizationacommonly
usedtermwithinthedomain?Doesthegeneralizedentityhavecommonimportant
attributesthatshouldbeinherited?Doesthegeneralizedentityhaverelationshipsthat
shouldbeinherited?Areallofthespecializedentities(subclasses)ofcommonpurpose
andstructure?TheNEDMmodelhasarichtaxonomyofgeneralizations.However
mostofthesegeneralizationsarenotimportantwhencreatingareferencemodelused
fordatastorage,exchange,andvisualizationandreporting.Forexample,theentities
forTeachingLearningResource,Assessment,andAssessmentResultaresubclassesofthe
generalizedInstructionalArtifact.Notethesubclassesareofdifferentpurpose.Further
examinationwouldrevealthattheydonotsharecommonattributesorrelationships
outsideofperhapsaname,descriptionandID.TeachingLearningResourceisapoor
choiceforareferencemodel.Bycontrast,thegeneralizationEducationOrganizationhas
importantattributesandassociationsthataremeaningfullyinheritedbyCampus,LEA
(district),andregionalESC.Notethatallareofthesamecommonpurposeand
structure.
4. Createclasses(complextypes)toabstractcohesivegroupsofattributes.Toimprove
Understandability,theCDMabstractscollectionsofattributesintoclasses.Thisresults
intheCDMentitieshavingmuchshorterandeasiertounderstandlistsofabstracted
attributes.Forexample,studentnamecouldberepresentedaflatstructureas
attributesofStudent,havingFirstName,MiddleName,LastName,NameSuffix.Insteada
newclass(inXMLanewcomplextype)iscreatedforNamethatincludestheattributes
above.ThisreducesthenumberofattributesdirectlyshownforStudentwithoutlossof
understandability.TheCDMusesthistechniqueforthefollowing:
Address
Name
BirthData
Telephone
ElectronicMail
5. Createclasses(complextypes)togroupattributesthataremultivaluedrecords.
Someattributesareexpressedasmultivaluedrecords.Ratherthancreateaseparate
domainclass,therecordattributesaredefinedasaseparateclass(complextypein
XML),andthenreferencedamultivaluedattribute.Forexample,studentsmayhave
multipledisabilities,eachspecifiedbyadisabilitytype,adescription,andanorderof
severity(primary,secondary,).TheCDMusesthistechniquefor:
AnalyticScore
Disability
EmploymentPeriod
RatingStandardsOutcome

TSDSWorkingDocument/Phase2December6,20109

6. CollapseMultipleBooleanIndicatorsintoaMultiValuedEnumeratedCollection.
TherearecaseswheretherearesetsofrelatedcollectionsofBooleanindicators.For
example,thevariousracecomponentsinastudentsheritagearetypicallyreflectedasa
setofBooleanindicatorcodesforAmericanIndianAlaskanNative,Asian,Black
AfricanAmerican,nativeHawaiianPacificIslander,White.Forextensibility,theCDM
groupedtheseintoamultivaluedenumeratedcollection.TheCDMappliedthis
techniquetothefollowing:
CourseLevelCharacteristics
CTEServices
HomeSituations
LinguisticAccommodations
Race
SpecialAccommodations
SpecialEdServices
TitleIPartAServices
TitleIPartASupportServices
7. Carefullyconsiderthedirectionofassociationsinthecontextofpossibleinterchanges.
Whenassociationsdonothavetheirownattributes,theReferenceTypeembodyingthe
associationiscontainedinthecomplextypeforthesourceEntity.Itisimportantto
considerentityisthesourcefortheassociationbaseditslikelyuseininterchanges.
ConsidertheassociationsfortheAttendanceEventshowninthemodelbelow.
Asshown,theassociationspecifyingthestudentassociatedwiththeattendanceevent
iscontainedinthesourceAttendanceEvent.Itisreasonabletoassumethattherecould
beaninterchangeloadingjustattendanceevents.Notethatisthedirectionofthis
associationwouldbereversedthenloadingattendancewouldneedtoalwaysbe
accompaniedbyaloadofStudents.NotethissamerationaleappliestotheSection
associationfromtheAttendanceEvent.

TSDSWorkingDocument/Phase2December6,201010

8. UserealdatatovalidatetheCDM.Dataprofilingisarecognizedtechniquefor
designingdatabaseschemasanddatawarehousestructures.Similarly,analyzingreal
dataasitishousedindifferentstudentinformationandothereducationsystems
providedsignificantvalidationoftheCDMreferencemodel.

Student
StateUniqueStudentId
LocalId
Name
Sex
BirthData
Address[0..1]
Telephone
ProfileThumbnail[0..1]
ElectronicMail[0..1]
HispanicLatinoEthnicity
OldEthnicity[0..1]
Race
EconomicDisadvantaged
SchoolFoodServicesEligibility[0..1]
HomeSituations
Languages
HomeLanguages
LimitedEnglishProficiency[0..1]
DisplacementStatus[0..1]
Disabilities[0..n]
Section
UniqueSectionCode
Term
EducationalEnvironment
MediumOfInstruction[0..1]
InstructionalAssignment
AvailableCredit[0..1]
AttendanceEvent
EventDate
AttendanceEventDescriptor
AttendanceEventReason[0..1]
EducationalEnvironment[0..1]
Themodelsupportstwostylesofstoringattendance:
1.Oneattendanceeventforeachstudentsection,with
instancesforattendance,absences,andtardies.
2."Exceptiononly"attendanceevents,notincluding
instancesforsectionsattended,butonlythoseabsentor
tardy.TheperiodattributeTotalInstructionalDaysisused
tocomputethenumberofdaysattended.
StudentSectionAssociation
StartDate[0..1]
EndDate[0..1]
HomeroomIndicator
RepeatIdentifier
EducationOrganization
Campus
SchoolCategory
InstructionCategory
CharterCategory[0..1]
0..*
HasAssociated
0..1
1..*
HasAssociated
1
1
HasAssociated
0..*
0
ParticipatesIn
0..*
0..*
HasAssociated
0..*

TSDSWorkingDocument/Phase2December6,201011

CDMXMLSchema
AnXMLschemaiscollectionoftypeandelementdefinitions,usinganXMLformatthatspecifies
therulessurroundingthelogicalstructureofsomecollectiondatatobespecifiedinXML.Based
upontheCDMReferenceModel,theCDMXMLSchemaprovides:
Acoresetofdomain,association,andattributetypesthatdirectlymaptotheCDM
Referencemodel
Amethodandexampleforextendingthecoreschematoaccountforstatespecific,or
eveninterchangespecificdata
Amethodandexamplesofcomposingconcreteinterchange(microformat)schemas,
reusingthetypesdefinedinthecoreandextensionschemas.
CDMXMLSchemaPrinciples
XMLschemasenforcerulesaroundthecontentofXMLinstancedocuments.Howeverthereare
manydifferentwaysandstylesforXMLschemastoaccomplishthesamegoal.TheCDMXML
schemawasdesignedwithconsiderationofthefollowingprinciples:
5

ConsistencyTheXMLschemashouldhaveaconsistentorganizationanddesign
pattern
ExtensibilityTheXMLschemashouldbedesignedtoeasilyallowforcustomizationsto
meetspecificinterchangerequirements.
FlexibilityTheXMLschemashouldbeflexibletosupporttheinterchangeofdifferent
subsetsandcollectionsofeducationdata.
ReuseTheXMLschemashouldbedesignedtofacilitatethereuseoftypesofelements
inconstructingtheconcreteschemas(microformats)usedforinterchange.
CompositionUsingXMLMechanismsThecreationofconcreteinterchangeschemas
fromcoreandextendedschemasshouldbeaccomplishedusingnativeXML
mechanisms,notthroughacutnpasteoperation.
InterchangeSchemaDesignPattern
TheVenetianBlindDesignisoneofseveralpopularanddocumentedXMLschemastyles.It
facilitatesreusewhilealsohidingnamespacecomplexities.
6
Foreachinterchangeschema,the
styledefinesasingleglobalelementthatnestslocalelementsthatusetypes(simpleor
complex)thataredefinedwithintheglobalnamespace.

5
AdaptedfromPESCGuidelinesforXMLArchitectureandDataModeling,Version3.0,Postsecondary
ElectronicStandardsCouncil,April29,2005.
http://federalstudentaid.ed.gov/static/gw/docs/ciolibrary/ECONOPS_Docs/PESCGuidelinesforXML
ArchitectureandDataModelingv3.0.pdf
6
Onesuchreferenceisat:
http://developers.sun.com/jsenterprise/archive/nb_enterprise_pack/reference/techart/design_patterns.
html

TSDSWorkingDocument/Phase2December6,201012

Forexample,considertheinterchangeschemaforstudents,parents,andtheirrelationships,
depictedbelow.
<?xml ver si on=" 1. 0" encodi ng=" UTF- 8" ?>
<xs: schema xml ns: xs=" ht t p: / / www. w3. or g/ 2001/ XMLSchema" xml ns=" ht t p: / / msdf . or g/ t sds"
t ar get Namespace=" ht t p: / / msdf . or g/ t sds" el ement For mDef aul t =" qual i f i ed"
at t r i but eFor mDef aul t =" unqual i f i ed" >
<xs: i ncl ude schemaLocat i on=" . . \ CDM- Cor e. xsd" / >
<xs: el ement name=" I nt er changeSt udent Par ent " >
<xs: compl exType>
<xs: choi ce maxOccur s=" unbounded" >
<xs: el ement name=" St udent " t ype=" St udent " ></ xs: el ement >
<xs: el ement name=" Par ent " t ype=" Par ent " ></ xs: el ement >
<xs: el ement name=" St udent Par ent Associ at i on" t ype=" St udent Par ent Associ at i on" >
</ xs: el ement >
</ xs: choi ce>
</ xs: compl exType>
</ xs: el ement >
</ xs: schema>
AsingleelementInterchangeStudentParentdefinestheinterchange.Thethreeelementsofthe
interchange,Student,ParentandStudentParentAssociation,arenestedwithinthesingle
element,referencingtypesinCDMCore(seetheincludestatementabove).
Notethatwechosetoencapsulatetheelementsoftheinterchangeinanunboundedchoice
statementratherthanasequencetoprovidemaximumflexibilityfortheinterchange.Asaresult
thevariouselementsoftheinterchangeareoptionalandcanbeprovidedinanyorder.
CDMCoreSchemaOrganization
TosupporttheVenetianBlinddesign,theCDMCoreschemaprovidesaflatcompendiumof
XMLtypes.Thetypeswhicharethebuildingblocksofinterchangeschemasare:
Domaintypes,XMLcomplextypesrepresentingthemajorentitiesintheeducation
domain,asmodeledintheCDMreferencemodel.
Associationtypes,XMLcomplextypesrepresentingthoseassociationsbetweenthe
domainentitiesthatrequireattributes.
ThedomainandassociationtypesarecomposedfromasecondtierofXMLsimpleandcomplex
types,organized:
Commontypesusedinthedomain,suchasName,AddressorTelephone.
Enumerationtypesdefinedthecontrolledvaluelistsorcontrolledvocabularyusedfor
manyenumeratedorenumeratedcollectionattributes.
Simplestringtypes,definingspecificconstraints,suchaslength,forthevariousstring
typedattributes.
Extendedreferencetypes,supportingassociationsviaXMLIDREFsorviaalookup
TheCDMXMLschema(withoutanystatespecificextensions)isthefileCDM-Core.xsd.

TSDSWorkingDocument/Phase2December6,201013

DomainTypes
AlldomaintypesareXMLextensionsofthetypeComplexObjectType.Thistypedefinesthe
commonidattributethatholdstheassignmentofanXMLIDREFtoinstancesofthedomaintype
usedininterchangeschemas,asshownbelow.
<xs: compl exType name=" Compl exObj ect Type" abst r act =" t r ue" >
<xs: annot at i on>
<xs: document at i on>Thi s i s t he base t ype f r omwhi ch al l ent i t y el ement s ar e
ext ended. </ xs: document at i on>
</ xs: annot at i on>
<xs: at t r i but e name=" i d" t ype=" xs: I D" / >
</ xs: compl exType>

AssociationTypes
Eachassociationwillhaveareferencetotwoormoredomainentities.Thesereferenceswill
eitherbeof:
ReferenceTypethatdefinesarefattributetoholdtheIDREFofthereferenced
instance,asfollows:
<xs: compl exType name=" Ref er enceType" >
</ xs: annot at i on>
<xs: at t r i but e name=" i d" t ype=" xs: I D" / >
<xs: at t r i but e name=" r ef " t ype=" xs: I DREF" / >
</ xs: compl exType>

Anextendedreferencetypetosupportcaseswhereadatainterchangeschemamust
referenceinstancesofdataalreadyloaded,allowingassociationinstancestobe
specifiedeitherbyanIDREForbyasetofattributestobeusedforlookupbythe
receivingsystem.Forexample,theextendedreferencetypeforaStudentis:
<xs: compl exType name=" St udent Ref er enceType" >
<xs: compl exCont ent >
<xs: ext ensi on base=" Ref er enceType" >
<xs: sequence>
<xs: el ement name=" St udent I dent i t y" t ype=" St udent I dent i t yType"
mi nOccur s=" 0" >
</ xs: el ement >
</ xs: sequence>
</ xs: ext ensi on>
</ xs: compl exCont ent >
</ xs: compl exType>
<xs: compl exType name=" St udent I dent i t yType" >
<xs: sequence>
<xs: el ement name=" St udent Uni queSt at eI d" t ype=" Uni queSt at eI dent i f i er "
mi nOccur s=" 0" >
</ xs: el ement >
<xs: el ement name=" St udent I d" t ype=" St udent I d" mi nOccur s=" 0" >
</ xs: el ement >
<xs: el ement name=" CampusLocal I d" t ype=" CampusLocal I DType"
mi nOccur s=" 0" / >
<xs: el ement name=" Name" t ype=" Name" mi nOccur s=" 0" / >
<xs: el ement name=" Sex" t ype=" SexType" mi nOccur s=" 0" / >
<xs: el ement name=" Bi r t hDat e" t ype=" xs: dat e" mi nOccur s=" 0" / >
</ xs: sequence>
</ xs: compl exType>

TSDSWorkingDocument/Phase2December6,201014

Forexample,notetheStudentParentAssociationhasaStudentReferenceanda
ParentReference.TheParentReferenceisoftypeReferenceType,describedabove.However,
theStudentReferenceisoftypeStudentReferenceTypeanextendedreferencetype.
<xs: compl exType name=" St udent Par ent Associ at i on" >
<xs: sequence>
<xs: el ement name=" St udent Ref er ence" t ype=" St udent Ref er enceType" / ></ xs: el ement >
<xs: el ement name=" Par ent Ref er ence" t ype=" Ref er enceType" / ></ xs: el ement >
<xs: el ement name=" Rel at i on" t ype=" Rel at i onType" mi nOccur s=" 0" ></ xs: el ement >
<xs: el ement name=" Pr i mar yCont act St at us" t ype=" xs: bool ean" mi nOccur s=" 0" ></ xs: el ement >
<xs: el ement name=" Li vesWi t h" t ype=" xs: bool ean" mi nOccur s=" 0" ></ xs: el ement >
<xs: el ement name=" Emer gencyCont act St at us" t ype=" xs: bool ean" mi nOccur s=" 0" ></ xs: el ement >
</ xs: sequence>
</ xs: compl exType>
Generalizations
TheXMLschemaextensionisusedtoreflectgeneralizationsintheCDM.Forexample,
EducationOrganizationisageneralizationofCampus,LocalEducationAgency,and
EducationServiceCenter.
ThecomplextypeEducationOrganizationisidentifiedasanabstracttype.
<xs: compl exType name=" Educat i onOr gani zat i on" abst r act =" t r ue" >
<xs: compl exCont ent >
<xs: ext ensi on base=" Compl exObj ect Type" >
<xs: sequence>
<xs: el ement name=" St at eOr gani zat i onI d" t ype=" St at eOr gani zat i onI d" ></ xs: el ement >
<xs: el ement name=" NCESI d" t ype=" NCESI d" ></ xs: el ement >
<xs: el ement name=" NameOf I nst i t ut i on" t ype=" NameOf I nst i t ut i on" ></ xs: el ement >
<xs: el ement name=" Or gani zat i onCat egor y" t ype=" Or gani zat i onCat egor yType" >
</ xs: el ement >
<xs: el ement name=" Physi cal Addr ess" t ype=" Addr ess" ></ xs: el ement >
<xs: el ement name=" Mai l i ngAddr ess" t ype=" Addr ess" mi nOccur s=" 0" ></ xs: el ement >
<xs: el ement name=" Tel ephone" t ype=" Tel ephone" ></ xs: el ement >
<xs: el ement name=" FaxNumber " t ype=" Tel ephone" mi nOccur s=" 0" ></ xs: el ement >
<xs: el ement name=" WebSi t e" t ype=" WebSi t e" mi nOccur s=" 0" ></ xs: el ement >
</ xs: el ement >
<xs: el ement name=" Account abi l i t yRat i ngs" t ype=" Account abi l i l t yRat i ng"
mi nOccur s=" 0" maxOccur s=" unbounded" >
</ xs: el ement >
<xs: el ement name=" Pr ogr amRef er ence" t ype=" Pr ogr amRef er enceType" mi nOccur s=" 0"
maxOccur s=" unbounded" ></ xs: el ement >
</ xs: sequence>
</ xs: ext ensi on>
</ xs: compl exCont ent >
</ xs: compl exType>


TSDSWorkingDocument/Phase2December6,201015

Specializationsarereflectedasextensionsofthebasetype,asfollows:
<xs: compl exType name=" Campus" >
<xs: compl exCont ent >
<xs: ext ensi on base=" Educat i onOr gani zat i on" >
<xs: sequence>
<xs: el ement name=" Local Educat i onAgencyRef er ence"
t ype=" Educat i onal Or gRef er enceType" >
</ xs: el ement >
<xs: el ement name=" I nst r uct i onal Gr adeLevel s"
t ype=" I nst r uct i onal Gr adeLevel sType" >
</ xs: el ement >
<xs: el ement name=" School Cat egor y" t ype=" School Cat egor yType" >
</ xs: el ement >
<xs: el ement name=" I nst r uct i onCat egor y" t ype=" I nst r uct i onCat egor yType"
mi nOccur s=" 0" >
</ xs: el ement >
<xs: el ement name=" Char t er Cat egor y" t ype=" Char t er Cat egor yType" mi nOccur s=" 0" >
</ xs: el ement >
<xs: el ement name=" Cl assPer i odRef er ence" t ype=" Ref er enceType" mi nOccur s=" 0"
maxOccur s=" unbounded" >
</ xs: el ement >
<xs: el ement name=" Locat i onRef er ence" t ype=" Ref er enceType" mi nOccur s=" 0"
maxOccur s=" unbounded" >
</ xs: el ement >
</ xs: sequence>
</ xs: ext ensi on>
</ xs: compl exCont ent >
</ xs: compl exType>

Enumerations
Singlevaluedenumerationsareshownasrestrictionsofthebasetypexs:token,asillustrated
below:
<xs: si mpl eType name=" Gr aduat i onPl anType" >
<xs: r est r i ct i on base=" xs: t oken" >
<xs: enumer at i on val ue=" Mi ni mum" / >
<xs: enumer at i on val ue=" Recommended" / >
<xs: enumer at i on val ue=" Di st i ngui shed" / >
</ xs: r est r i ct i on>
</ xs: si mpl eType>
EnumeratedCollections
Multivaluedenumeratedcollectionsarecomposedofacomplextypethathasmultiplevalues
ofanenumeration,asillustratedbelow:
<xs: compl exType name=" LanguagesType" >
<xs: sequence>
<xs: el ement name=" Language" t ype=" LanguageI t emType" mi nOccur s=" 0" maxOccur s=" unbounded" / >
</ xs: sequence>
</ xs: compl exType>

<xs: si mpl eType name=" LanguageI t emType" >
<xs: r est r i ct i on base=" xs: t oken" >
<xs: enumer at i on val ue=" Engl i sh" / >
<xs: enumer at i on val ue=" Spani sh" / >
</ xs: r est r i ct i on>
</ xs: si mpl eType>

TSDSWorkingDocument/Phase2December6,201016


ExtensionstotheCDMCore
ExtensionstotheCDMCoretypesareexplicitlysupportedforstatespecificdataoranyother
purpose,includingreasonsspecifictoaninterchange.TheCDMCoretypesmaybeextendedin
aseparateXMLschemafilethathastheincludestatementtotheCDMCoreschema.Within
thisfile,thefollowingtypesofextensionsaresupported:
IfadditionalattributesarerequiredforaCDMCoretype,anewtypemaybedefinedas
anextensionoftheappropriateCDMCoretype.
Newsimpleorcomplextypesrequiredforattributesmaybeadded.
Newdomainorassociationclassesandtheirattributesandreferencesmaybeadded.
TheTexasspecificextensionstosupportthestatesPEIMSaccountabilityreportingbyLEAshave
beendefinedintheXMLschemafileCDM-TX-Extension.xsd.

You might also like