Schemas

• coding-scheme@iqb-standard@3.3

  Expand all

  object [Coding Scheme]

  uid: coding-scheme@iqb-standard@3.3

  Data structure to specify all processing steps of response data in order to get coded and scored data for analyses.

  version

  required

  string

  must match: ^\d+\.\d+$

  Major and minor of the version of the data structure.

  Examples values:
  • "3.5"
  • "4.10"

  variableCodings

  Expand all

  required

  array<object>

  object

  id

  required

  string

  must match: ^[0-9a-zA-Z_]+$

  Identifier for the variable. In case of a scheme for a base variable, this id is identical with the source variable's id. All ids of a response scheme should be unique.

  alias

  string

  must match: ^[0-9a-zA-Z_]+$

  Alternative identifier for the variable. In case of a scheme for a base variable, this id is identical with the source variable's alternative id. All alternative ids of a response scheme should be unique.

  label

  string

  Some additional info for UI

  sourceType

  required

  string

  Specifies how to derive (concatenate, check uniqueness, sum code etc.).

  Allowed values:
  • "BASE"
  • "BASE_NO_VALUE"
  • "MANUAL"
  • "COPY_VALUE"
  • "CONCAT_CODE"
  • "SUM_CODE"
  • "SUM_SCORE"
  • "UNIQUE_VALUES"
  • "SOLVER"

  sourceParameters

  Expand all

  object

  Parameters to specify the derive method

  solverExpression

  string

  If sourceType 'solver', this expression is evaluated when deriving. Placeholder for variables are in curly brakes.

  Examples values:
  • "${01}*${03}-100"

  processing

  Expand all

  array<string>

  Some options to change value or status

  Items:

  string

  Allowed values:
  • "TO_LOWER_CASE"
  • "TO_NUMBER"
  • "REMOVE_ALL_SPACES"
  • "REMOVE_DISPENSABLE_SPACES"
  • "TAKE_DISPLAYED_AS_VALUE_CHANGED"
  • "TAKE_NOT_REACHED_AS_VALUE_CHANGED"
  • "TAKE_EMPTY_AS_VALID"
  • "SORT"

  Additional properties are NOT allowed.

  deriveSources

  Expand all

  array<string>

  Items:

  string

  must match: ^[0-9a-zA-Z_]+$

  processing

  Expand all

  array<string>

  This parameter defines what (pre)processing should be done.

  Items:

  string

  Allowed values:
  • "IGNORE_CASE"
  • "IGNORE_ALL_SPACES"
  • "IGNORE_DISPENSABLE_SPACES"
  • "SORT_ARRAY"
  • "REPLAY_REQUIRED"
  • "CODER_TRAINING_REQUIRED"
  • "ATTACHMENT"

  fragmenting

  string

  Regular expression to get fragments out of the value if of type string

  manualInstruction

  string

  Instructions for manual coding.

  codeModel

  string

  Info for applications to simplify UI

  Allowed values:
  • "MANUAL_AND_RULES"
  • "RULES_ONLY"
  • "MANUAL_ONLY"

  page

  string

  If the unit supports paging, this property defines the page to be presented to the coder if manually coded.

  codes

  Expand all

  array<object>

  object

  id

  Expand all

  required

  oneOf

  If this code's rules/instructions match, the code and score is taken for the response. If the code id is of type 'string', the status 'INVALID' or 'INTENDED_INCOMPLETE' will be set.

  Adheres to <anonymous-schema-23>:

  integer

  Or to <anonymous-schema-24>:

  string

  Allowed values:
  • "INVALID"
  • "INTENDED_INCOMPLETE"

  type

  string

  To ease some processing and documentation

  Allowed values:
  • "UNSET"
  • "FULL_CREDIT"
  • "PARTIAL_CREDIT"
  • "TO_CHECK"
  • "NO_CREDIT"
  • "RESIDUAL"
  • "RESIDUAL_AUTO"
  • "INTENDED_INCOMPLETE"

  label

  string

  score

  integer

  manualInstruction

  string

  Instructions for manual coding.

  ruleSetOperatorAnd

  boolean

  If true, all rule sets must match to take that code. Otherwise (default: false), one matching rule set will satisfy.

  ruleSets

  Expand all

  array<object>

  object

  valueArrayPos

  Expand all

  anyOf

  Can adhere to <anonymous-schema-33>:

  integer

  Refers to a specific position in the value array [0..n-1].

  Or to <anonymous-schema-34>:

  string

  Refers to any position in the value array, to the sum of all array values or the length of the value array.

  Allowed values:
  • "ANY"
  • "ANY_OPEN"
  • "SUM"
  • "LENGTH"

  ruleOperatorAnd

  boolean

  If true, all rules must match to take that code. Otherwise (default: false), one matching rule will satisfy.

  rules

  Expand all

  required

  array<object>

  object

  fragment

  integer

  Refers to a specific fragment of the value [0..n-1] or to any -1.

  method

  required

  string

  Condition for evaluation

  Allowed values:
  • "MATCH"
  • "MATCH_REGEX"
  • "NUMERIC_MATCH"
  • "NUMERIC_FULL_RANGE"
  • "NUMERIC_RANGE"
  • "NUMERIC_LESS_THAN"
  • "NUMERIC_MORE_THAN"
  • "NUMERIC_MAX"
  • "NUMERIC_MIN"
  • "IS_EMPTY"
  • "IS_NULL"
  • "IS_TRUE"
  • "IS_FALSE"

  parameters

  Expand all

  array<string>

  Depending on the method, additional parameter(s) is needed. See separate documentation

  Items:

  string

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.

  Additional properties are NOT allowed.