Annex 3: Mapping the microdata schema to the DDI Codebook 2.5

JSON Schema DDI/XML CodeBook 2.5 Title
doc_desc docDscr
doc_desc/title docDscr/citation/titlStmt/titl Document title
doc_desc/idno docDscr/citation/titlStmt/IDNo Unique ID number for the document
doc_desc/producers docDscr/citation/prodStmt/producer Producers
- name . Name
- abbr - abbr Abbreviation
- affiliation - affiliation Affiliation
- role - role Role
doc_desc/prod_date docDscr/citation/prodStmt/prodDate Date of Production
doc_desc/version_statement docDscr/citation/verStmt Version Statement
doc_desc/version_statement/version docDscr/citation/verStmt/version Version
doc_desc/version_statement/version_date Version Date
doc_desc/version_statement/version_resp docDscr/citation/verStmt/verResp Version Responsibility Statement
doc_desc/version_statement/version_notes docDscr/citation/verStmt/notes Version Notes
study_desc stdyDscr
study_desc/title_statement stdyDscr/citation/titlStmt
study_desc/title_statement/idno stdyDscr/citation/titlStmt/IDNo Unique user defined ID
study_desc/title_statement/identifiers Other identifiers
- type Identifier type
- identifier Identifier
study_desc/title_statement/title stdyDscr/citation/titlStmt/titl Survey title
study_desc/title_statement/sub_title stdyDscr/citation/titlStmt/subTitl Survey subtitle
study_desc/title_statement/alternate_title stdyDscr/citation/titlStmt/altTitl Abbreviation or Acronym
study_desc/title_statement/translated_title stdyDscr/citation/titlStmt/parTitl Translated Title
study_desc/authoring_entity stdyDscr/citation/rspStmt/AuthEnty Authoring entity/Primary investigators
- name . Agency Name
- affiliation - affiliation Affiliation
study_desc/oth_id stdyDscr/citation/rspStmt/othId Other Identifications/Acknowledgments
- name . Name
- role - role Role
- affiliation - affiliation Affiliation
study_desc/production_statement stdyDscr/citation/prodStmt Production Statement
study_desc/production_statement/producers stdyDscr/citation/prodStmt/producer Producers
- name . Name
- abbr - abbr Abbreviation
- affiliation - affiliation Affiliation
- role - role Role
study_desc/production_statement/copyright stdyDscr/citation/prodStmt/copyright Copyright
study_desc/production_statement/prod_date stdyDscr/citation/prodStmt/prodDate Production Date
study_desc/production_statement/prod_place stdyDscr/citation/prodStmt/prodPlac Production Place
study_desc/production_statement/funding_agencies stdyDscr/citation/prodStmt/fundAg Funding Agency/Sponsor
- name . Funding Agency/Sponsor
- abbr - abbr Abbreviation
- grant - stdyDscr/citation/prodStmt/fundAg Grant Number
- role - role Role
study_desc/distribution_statement stdyDscr/citation/distStmt Distribution Statement
study_desc/distribution_statement/distributors stdyDscr/citation/distStmt/distrbtr Distributor
- name . Organization name
- abbr - abbr Abbreviation
- affiliation - affiliation Affiliation
- uri - uri URI
study_desc/distribution_statement/contact stdyDscr/citation/distStmt/contact Contact
- name . Name
- affiliation - affiliation Affiliation
- email - email Email
- uri - uri URI
study_desc/distribution_statement/depositor stdyDscr/citation/distStmt/depositr Depositor
- name . Name
- abbr - abbr Abbreviation
- affiliation - affiliation Affiliation
- uri URI
study_desc/distribution_statement/deposit_date stdyDscr/citation/distStmt/depDate Date of Deposit
study_desc/distribution_statement/distribution_date stdyDscr/citation/distStmt/distDate Date of Distribution
study_desc/series_statement stdyDscr/citation/serStmt Series Statement
study_desc/series_statement/series_name stdyDscr/citation/serStmt/serName Series Name
study_desc/series_statement/series_info stdyDscr/citation/serStmt/serInfo Series Information
study_desc/version_statement stdyDscr/citation/verStmt Version Statement
study_desc/version_statement/version stdyDscr/citation/verStmt/version Version
study_desc/version_statement/version_date Version Date
study_desc/version_statement/version_resp stdyDscr/citation/verStmt/verResp Version Responsibility Statement
study_desc/version_statement/version_notes stdyDscr/citation/verStmt/notes Version Notes
study_desc/bib_citation stdyDscr/citation/biblCit Bibliographic Citation
study_desc/bib_citation_format Bibliographic Citation Format
study_desc/holdings stdyDscr/citation/holdings Holdings Information
- name . Name
- location - location Location
- callno - callno Callno
- uri - uri URI
study_desc/study_notes stdyDscr/citation/notes Study notes
study_desc/study_authorization stdyDscr/studyAuthorization Study Authorization
study_desc/study_authorization/date Authorization Date
study_desc/study_authorization/agency stdyDscr/studyAuthorization/authorizingAgency Authorizing Agency
- name . Funding Agency/Sponsor
- affiliation - affiliation Affiliation
- abbr - abbr Abbreviation
study_desc/study_authorization/authorization_statement stdyDscr/studyAuthorization/authorizationStatement Authorization Statement
study_desc/study_info stdyDscr/stdyInfo Study Scope
study_desc/study_info/study_budget stdyDscr/stdyInfo/studyBudget Study Budget
study_desc/study_info/keywords stdyDscr/stdyInfo/subject/keyword
- keyword . Keyword
- vocab - vocab Vocabulary
- uri - vocabURI uri
study_desc/study_info/topics stdyDscr/stdyInfo/subject/topcClas Topic Classification
- topic . Topic
- vocab - vocab Vocab
- uri - vocabURI URI
study_desc/study_info/abstract stdyDscr/stdyInfo/abstract Abstract
study_desc/study_info/time_periods stdyDscr/stdyInfo/sumDscr/timePrd Time periods (YYYY/MM/DD)
- start Start date
- end End date
- cycle Cycle
study_desc/study_info/coll_dates stdyDscr/stdyInfo/sumDscr/collDate Dates of Data Collection (YYYY/MM/DD)
- start Start date
- end End date
- cycle Cycle
study_desc/study_info/nation stdyDscr/stdyInfo/sumDscr/nation Country
- name . Name
- abbreviation - abbr Country code
study_desc/study_info/bbox stdyDscr/sumDscr/geoBndBox Geographic bounding box
- west - westBL West
- east - eastBL East
- south - southBL South
- north - northBL North
study_desc/study_info/bound_poly stdyDscr/sumDscr/boundPoly/polygon/point Geographic Bounding Polygon
- lat gringLat Latitude
- lon gringLon longitude
study_desc/study_info/geog_coverage stdyDscr/stdyInfo/sumDscr/geogCover Geographic Coverage
study_desc/study_info/geog_coverage_notes stdyDscr/sumDscr/geogCover/txt Geographic Coverage notes
study_desc/study_info/geog_unit stdyDscr/stdyInfo/sumDscr/geogUnit Geographic Unit
study_desc/study_info/analysis_unit stdyDscr/stdyInfo/sumDscr/anlyUnit Unit of Analysis
study_desc/study_info/universe stdyDscr/stdyInfo/sumDscr/universe Universe
study_desc/study_info/data_kind stdyDscr/stdyInfo/sumDscr/dataKind Kind of Data
study_desc/study_info/notes stdyDscr/stdyInfo/notes Study notes
study_desc/study_info/quality_statement stdyDscr/stdyInfo/qualityStatement Quality Statement
study_desc/study_info/quality_statement/compliance_description stdyDscr/stdyInfo/qualityStatement/standardsCompliance/complianceDescription Standard compliance description
study_desc/study_info/quality_statement/standards stdyDscr/stdyInfo/qualityStatement/standardsCompliance/standard Standards
- name standardName Name
- producer producer * Producer
study_desc/study_info/quality_statement/other_quality_statement stdyDscr/stdyInfo/qualityStatement/otherQualityStatement Other quality statement
study_desc/study_info/ex_post_evaluation stdyDscr/stdyInfo/exPostEvaluation Ex-Post Evaluation
study_desc/study_info/ex_post_evaluation/completion_date Evaluation completion date
study_desc/study_info/ex_post_evaluation/type Evaluation type
study_desc/study_info/ex_post_evaluation/evaluator stdyDscr/stdyInfo/exPostEvaluation/evaluator Evaluators
- name . Funding Agency/Sponsor
- affiliation - affiliation Affiliation
- abbr - abbr Abbreviation
- role - role Role
study_desc/study_info/ex_post_evaluation/evaluation_process stdyDscr/stdyInfo/exPostEvaluation/evaluationProcess Evaluation process
study_desc/study_info/ex_post_evaluation/outcomes stdyDscr/stdyInfo/exPostEvaluation/outcomes Outcomes
study_desc/study_development stdyDscr/studyDevelopment Study Development
study_desc/study_development/development_activity stdyDscr/studyDevelopment/developmentActivity Development activity
- activity_type . Development activity type
- activity_description - description Development activity description
- participants - participants Participants
- resources - resources Development activity resources
- outcome - outcome Development Activity Outcome
study_desc/method stdyDscr/method Methodology and Processing
study_desc/method/data_collection stdyDscr/method/dataColl Data Collection
study_desc/method/data_collection/time_method stdyDscr/method/dataColl/timeMeth Time Method
study_desc/method/data_collection/data_collectors stdyDscr/method/dataColl/dataCollector Data Collectors
- name . Name
- affiliation Affiliation
- abbr Abbreviation
- role Role
study_desc/method/data_collection/collector_training stdyDscr/method/dataColl/collectorTraining Collector training
- type @type Training type
- training . Training
study_desc/method/data_collection/frequency stdyDscr/method/dataColl/frequenc Frequency of Data Collection
study_desc/method/data_collection/sampling_procedure stdyDscr/method/dataColl/sampProc Sampling Procedure
study_desc/method/data_collection/sample_frame stdyDscr/method/dataColl/sampleFrame Sample Frame
study_desc/method/data_collection/sample_frame/name stdyDscr/method/dataColl/sampleFrame/sampleFrameName Sample frame name
study_desc/method/data_collection/sample_frame/valid_period stdyDscr/method/dataColl/sampleFrame/validPeriod Valid periods (YYYY/MM/DD)
- event Event
- date Date
study_desc/method/data_collection/sample_frame/custodian stdyDscr/method/dataColl/sampleFrame/custodian Custodian
study_desc/method/data_collection/sample_frame/universe stdyDscr/method/dataColl/sampleFrame/universe Universe
study_desc/method/data_collection/sample_frame/frame_unit stdyDscr/method/dataColl/sampleFrame/frameUnit Frame unit
study_desc/method/data_collection/sample_frame/frame_unit/is_primary Is Primary
study_desc/method/data_collection/sample_frame/frame_unit/unit_type stdyDscr/method/dataColl/sampleFrame/frameUnit/unitType Unit Type
study_desc/method/data_collection/sample_frame/frame_unit/num_of_units Number of units
study_desc/method/data_collection/sample_frame/reference_period stdyDscr/method/dataColl/sampleFrame/referencePeriod Reference periods (YYYY/MM/DD)
- event Event
- date Date
study_desc/method/data_collection/sample_frame/update_procedure stdyDscr/method/dataColl/sampleFrame/updateProcedure Update procedure
study_desc/method/data_collection/sampling_deviation stdyDscr/method/dataColl/deviat Deviations from the Sample Design
study_desc/method/data_collection/coll_mode stdyDscr/method/dataColl/collMode Mode of data collection
study_desc/method/data_collection/research_instrument stdyDscr/method/dataColl/resInstru Type of Research Instrument
study_desc/method/data_collection/instru_development stdyDscr/method/dataColl/instrumentDevelopment Instrument development
study_desc/method/data_collection/instru_development_type Instrument development type
study_desc/method/data_collection/sources stdyDscr/method/dataColl/sources Sources
- name Source name
- origin Origin of Source
- characteristics Characteristics of Source Noted
study_desc/method/data_collection/coll_situation stdyDscr/method/dataColl/collSitu Characteristics of Data Collection Situation - Notes on data collection
study_desc/method/data_collection/act_min stdyDscr/method/dataColl/actMin Supervision
study_desc/method/data_collection/control_operations stdyDscr/method/dataColl/ConOps Control Operations
study_desc/method/data_collection/weight stdyDscr/method/dataColl/weight Weighting
study_desc/method/data_collection/cleaning_operations stdyDscr/method/dataColl/cleanOps Cleaning Operations
study_desc/method/method_notes stdyDscr/method/notes Methodology notes
study_desc/method/analysis_info stdyDscr/method/anlyInfo Data Appraisal
study_desc/method/analysis_info/response_rate stdyDscr/method/anlyInfo/respRate Response Rate
study_desc/method/analysis_info/sampling_error_estimates stdyDscr/method/anlyInfo/EstSmpErr Estimates of Sampling Error
study_desc/method/analysis_info/data_appraisal stdyDscr/method/anlyInfo/dataAppr Data Appraisal
study_desc/method/study_class stdyDscr/method/stdyClas Class of the Study
study_desc/method/data_processing stdyDscr/method/dataProcessing Data Processing
- type Data processing type
- description Data processing description
study_desc/method/coding_instructions stdyDscr/method/codingInstructions Coding Instructions
- related_processes Related processes
- type Coding instructions type
- txt Coding instructions text
- command Command
- formal_language Identify the language of the command code
study_desc/data_access stdyDscr/dataAccs/setAvail/dataAccs
study_desc/data_access/dataset_availability stdyDscr/dataAccs/setAvail Data Set Availability
study_desc/data_access/dataset_availability/access_place stdyDscr/dataAccs/setAvail/accsPlac Location of Data Collection
study_desc/data_access/dataset_availability/access_place_url URL for Location of Data Collection
study_desc/data_access/dataset_availability/original_archive stdyDscr/dataAccs/setAvail/origArch Archive where study is originally stored
study_desc/data_access/dataset_availability/status stdyDscr/dataAccs/setAvail/avlStatus Availability Status
study_desc/data_access/dataset_availability/coll_size stdyDscr/dataAccs/setAvail/collSize Extent of Collection
study_desc/data_access/dataset_availability/complete stdyDscr/dataAccs/setAvail/complete Completeness of Study Stored
study_desc/data_access/dataset_availability/file_quantity stdyDscr/dataAccs/setAvail/fileQnty Number of Files
study_desc/data_access/dataset_availability/notes stdyDscr/dataAccs/setAvail/notes Notes
study_desc/data_access/dataset_use stdyDscr/dataAccs/useStmt Data Set Availability
study_desc/data_access/dataset_use/conf_dec stdyDscr/dataAccs/useStmt/confDec Confidentiality Declaration
- txt . Confidentiality declaration text
- required - required Is signing of a confidentiality declaration required?
- form_url - URI Confidentiality declaration form URL
- form_id - formNo Form ID
study_desc/data_access/dataset_use/spec_perm stdyDscr/dataAccs/useStmt/specPerm Special Permissions
- txt Special permissions description
- required - required Indicate if special permissions are required to access a resource
- form_url - URI Form URL
- form_id - formNo Form ID
study_desc/data_access/dataset_use/restrictions stdyDscr/dataAccs/useStmt/restrctn Restrictions
study_desc/data_access/dataset_use/contact stdyDscr/dataAccs/useStmt/contact Contact
- name . Name
- affiliation - affiliation Affiliation
- uri - URI URI
- email - email Email
study_desc/data_access/dataset_use/cit_req stdyDscr/dataAccs/useStmt/citReq Citation requirement
study_desc/data_access/dataset_use/deposit_req stdyDscr/dataAccs/useStmt/deposReq Deposit requirement
study_desc/data_access/dataset_use/conditions stdyDscr/dataAccs/useStmt/conditions Conditions
study_desc/data_access/dataset_use/disclaimer stdyDscr/dataAccs/useStmt/disclaimer Disclaimer
study_desc/data_access/notes stdyDscr/dataAccs/setAvail/notes Notes
data_files
variables
variable_groups Variable groups