Skip to main content

Properties

Properties are the blocks inside a form.

A block can be:

  • A section.
  • A question.
  • A repeated list.
  • A coded choice.

Property and node

The backend stores two ideas:

WordMeaning
PropertyThe reusable question definition.
NodeThe position of that property inside a form.

You usually do not need to think about this while editing. But it explains why Tiep can reuse questions and still track where answers came from.

Core fields

FieldMeaning
titleThe label shown to the doctor.
descriptionWhat the AI should extract and why.
typeThe data type: object, string, number, integer, boolean, or array.
requiredWhich child fields must be answered.
examplesSample values that guide the AI.
x-widgetOptional UI control override.
x-concept-set-idLink to a reusable coded catalogue.

Types

TypeUse it forExample answer
objectA section with child fields.{ "reason": "Pain" }
stringText or one coded value."Shoulder pain"
numberDecimal numbers.37.5
integerWhole numbers.3
booleanYes/no.true
arrayA list.["M75.1", "M25.5"]

Constraints

Constraints are rules for good answers.

Examples:

ConstraintMeaning
minLengthText must be long enough.
minimumNumber must not be too small.
maximumNumber must not be too large.
minItemsList must have enough items.
oneOfPick one coded option.
dependenciesIf one field is answered, show or require another.

Example

{
"title": "Visit details",
"type": "object",
"properties": {
"reason": {
"title": "Reason for consultation",
"type": "string",
"description": "Chief complaint in the patient’s own words"
},
"weight": {
"title": "Weight (kg)",
"type": "number",
"minimum": 0,
"maximum": 400,
"examples": [68.5]
}
},
"required": ["reason"]
}

Property types