DSTU2 Ballot Source

This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.26.1.6 StructureDefinition: StructuredDataCaptureForm

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/questionnaire-sdc-structureddatacaptureform

Defines how Questionnaire is used to reflect form definitions to be used within the ONC's Structured Data Capture standard.

This profile was published on Mon, Apr 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC)'s Standards and Infrastructure (S&I) Structured Data Capture project.

4.26.1.6.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Questionnaire.

Summary

Mandatory: 9 elements, Must-Support: 53 elements

Extensions

This structure refers to these extensions:

This structure is derived from Questionnaire.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 1..1Questionnaire
... identifier S0..*Identifier
... version S0..1string
... status S1..1codeBinding: QuestionnaireStatus (required)
... date S1..1dateTimeIdentifies when this version of the form was created. Changes whenever the form is updated.
... publisher S0..1string
... group S1..1
.... linkId S1..1string
.... title S0..1string
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... concept S0..1Coding
.... text S0..1string
.... required S1..1boolean
.... repeats S1..1boolean
.... group S0..*
.... question S0..*
..... linkId S1..1string
..... concept 0..*Coding
..... text S1..1string
..... type S1..1code
..... required S0..1boolean
..... repeats S0..1boolean
..... options S0..1ValueSet
..... group S0..*
..... questionnaire-minOccurs 0..1integerMinimum repetitions
..... questionnaire-maxOccurs 0..1integerMaximum repetitions
..... questionnaire-label S0..1stringE.g. "1(a)", "2.5.3"
...... style 0..*stringHtml style value
...... markup 0..1stringString equivalent with html markup
..... questionnaire-enableWhen S0..*(Complex)Only allow data when:
..... questionnaire-sdc-optionalDisplay 0..1booleanCan suppress from display to user
..... questionnaire-hidden S0..1booleanDon't display to user
..... questionnaire-defaultValue S0..1*Initial presumed answer for question
..... questionnaire-defaultAsFixed S0..1booleanTreat default as fixed value?
..... minLength S0..1integerAt least this many characters
..... questionnaire-maxLength S0..1integerNo more than this many characters
..... regex S0..1stringRegular expression pattern
..... entryFormat S0..1stringUser prompt for format
..... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
..... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
..... maxDecimalPlaces S0..1integerMaximum digits after decimal
..... questionnaire-deReference S0..1DataElementImplemented CDE
...... style 0..*stringHtml style value
...... markup 0..1stringString equivalent with html markup
.... questionnaire-label S0..1stringE.g. "1(a)", "2.5.3"
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-instruction S0..*stringHow to populate group or question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-security S0..*stringSecurity/privacy rules governing group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-help S0..*stringText to display if help incoked on group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-tooltip S0..*stringFly-over or equivalent text
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-trailing S0..*stringText to display after group/question content
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
..... questionnaire-sdc-optionalDisplay 0..1booleanCan suppress from display to user
.... questionnaire-hidden S0..1booleanDon't display to user
.... questionnaire-minOccurs S0..1integerMinimum repetitions
.... questionnaire-maxOccurs S0..1integerMaximum repetitions
.... questionnaire-sdc-specialGroup S0..1codeheader | footer
.... questionnaire-instruction S0..*stringHow to populate group or question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-security S0..*stringSecurity/privacy rules governing group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-help S0..*stringText to display if help incoked on group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-tooltip S0..*stringFly-over or equivalent text
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-trailing S0..*stringText to display after group/question content
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-units S0..*stringUnit of measure for question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
... questionnaire-sdc-endpoint S0..*uriWhere to send answers
... styleSensitive S0..1booleanAre styles important for processing?
... questionnaire-category S0..1CodeableConceptWhat kind of questionnaire?
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I1..1QuestionnaireA structured set of questions
que-2: The link ids for groups and questions must be unique within the questionnaire
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... questionnaire-sdc-endpoint S0..*uriExtension
... styleSensitive S0..1booleanExtension
... questionnaire-category S0..1CodeableConceptExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S Σ0..*IdentifierExternal Ids for this questionnaire
... version S Σ0..1stringLogical id for this version of Questionnaire
... status ?! SΣ1..1codedraft | published | retired
Binding: QuestionnaireStatus (required)
... date S Σ1..1dateTimeIdentifies when this version of the form was created. Changes whenever the form is updated.
... publisher S Σ0..1stringOrganization/individual who designed the questionnaire
... telecom Σ0..*ContactPointContact information of the publisher
... group S I1..1Grouped questions
que-1: Groups may either contain questions or groups but not both
.... questionnaire-label S0..1stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-instruction S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-security S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-help S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-tooltip S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-trailing S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... questionnaire-sdc-optionalDisplay 0..1booleanExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-hidden S0..1booleanExtension
.... questionnaire-minOccurs S0..1integerExtension
.... questionnaire-maxOccurs S0..1integerExtension
.... questionnaire-sdc-specialGroup S0..1codeExtension
.... questionnaire-instruction S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-security S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-help S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-tooltip S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-trailing S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-units S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... linkId S1..1stringTo link questionnaire with questionnaire answers
.... title S0..1stringName to be displayed for group
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... value 0..1xs:stringPrimitive value for string
.... concept S0..1CodingConcept that represents this section on a questionnaire
Binding: QuestionnaireGroupConcept (required)
.... text S0..1stringAdditional text for the group
.... required S1..1booleanMust group be included in data results?
.... repeats S1..1booleanWhether the group may repeat
.... group S I0..*Nested questionnaire group
.... question S I0..*Questions in this group
..... questionnaire-minOccurs 0..1integerExtension
..... questionnaire-maxOccurs 0..1integerExtension
..... questionnaire-label S0..1stringExtension
...... style 0..*stringExtension
...... markup 0..1stringExtension
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1*Value of extension
..... questionnaire-enableWhen S0..*(Complex)Extension
..... questionnaire-sdc-optionalDisplay 0..1booleanExtension
..... questionnaire-hidden S0..1booleanExtension
..... questionnaire-defaultValue S0..1*Extension
..... questionnaire-defaultAsFixed S0..1booleanExtension
..... minLength S0..1integerExtension
..... questionnaire-maxLength S0..1integerExtension
..... regex S0..1stringExtension
..... entryFormat S0..1stringExtension
..... minValue S0..1date, dateTime, time, instant, decimal, integerExtension
..... maxValue S0..1date, dateTime, time, instant, decimal, integerExtension
..... maxDecimalPlaces S0..1integerExtension
..... questionnaire-deReference S0..1DataElementExtension
...... style 0..*stringExtension
...... markup 0..1stringExtension
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1*Value of extension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... linkId S1..1stringTo link questionnaire with questionnaire answers
..... concept 0..*CodingConcept that represents this question on a questionnaire
..... text S1..1stringText of the question as it is shown to the user
..... type S1..1codeboolean | decimal | integer | date | dateTime +
Binding: AnswerFormat (required)
..... required S0..1booleanMust question be answered in data results?
..... repeats S0..1booleanCan question have multiple answers?
..... options S0..1ValueSetValueset containing the possible options
..... group S0..*Nested questionnaire group

todo

This structure is derived from Questionnaire.

Summary

Mandatory: 9 elements, Must-Support: 53 elements

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from Questionnaire.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 1..1Questionnaire
... identifier S0..*Identifier
... version S0..1string
... status S1..1codeBinding: QuestionnaireStatus (required)
... date S1..1dateTimeIdentifies when this version of the form was created. Changes whenever the form is updated.
... publisher S0..1string
... group S1..1
.... linkId S1..1string
.... title S0..1string
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... concept S0..1Coding
.... text S0..1string
.... required S1..1boolean
.... repeats S1..1boolean
.... group S0..*
.... question S0..*
..... linkId S1..1string
..... concept 0..*Coding
..... text S1..1string
..... type S1..1code
..... required S0..1boolean
..... repeats S0..1boolean
..... options S0..1ValueSet
..... group S0..*
..... questionnaire-minOccurs 0..1integerMinimum repetitions
..... questionnaire-maxOccurs 0..1integerMaximum repetitions
..... questionnaire-label S0..1stringE.g. "1(a)", "2.5.3"
...... style 0..*stringHtml style value
...... markup 0..1stringString equivalent with html markup
..... questionnaire-enableWhen S0..*(Complex)Only allow data when:
..... questionnaire-sdc-optionalDisplay 0..1booleanCan suppress from display to user
..... questionnaire-hidden S0..1booleanDon't display to user
..... questionnaire-defaultValue S0..1*Initial presumed answer for question
..... questionnaire-defaultAsFixed S0..1booleanTreat default as fixed value?
..... minLength S0..1integerAt least this many characters
..... questionnaire-maxLength S0..1integerNo more than this many characters
..... regex S0..1stringRegular expression pattern
..... entryFormat S0..1stringUser prompt for format
..... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
..... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
..... maxDecimalPlaces S0..1integerMaximum digits after decimal
..... questionnaire-deReference S0..1DataElementImplemented CDE
...... style 0..*stringHtml style value
...... markup 0..1stringString equivalent with html markup
.... questionnaire-label S0..1stringE.g. "1(a)", "2.5.3"
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-instruction S0..*stringHow to populate group or question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-security S0..*stringSecurity/privacy rules governing group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-help S0..*stringText to display if help incoked on group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-tooltip S0..*stringFly-over or equivalent text
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-trailing S0..*stringText to display after group/question content
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
..... questionnaire-sdc-optionalDisplay 0..1booleanCan suppress from display to user
.... questionnaire-hidden S0..1booleanDon't display to user
.... questionnaire-minOccurs S0..1integerMinimum repetitions
.... questionnaire-maxOccurs S0..1integerMaximum repetitions
.... questionnaire-sdc-specialGroup S0..1codeheader | footer
.... questionnaire-instruction S0..*stringHow to populate group or question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-security S0..*stringSecurity/privacy rules governing group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-help S0..*stringText to display if help incoked on group/question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-tooltip S0..*stringFly-over or equivalent text
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-trailing S0..*stringText to display after group/question content
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
.... questionnaire-units S0..*stringUnit of measure for question
..... style 0..*stringHtml style value
..... markup 0..1stringString equivalent with html markup
... questionnaire-sdc-endpoint S0..*uriWhere to send answers
... styleSensitive S0..1booleanAre styles important for processing?
... questionnaire-category S0..1CodeableConceptWhat kind of questionnaire?

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I1..1QuestionnaireA structured set of questions
que-2: The link ids for groups and questions must be unique within the questionnaire
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... questionnaire-sdc-endpoint S0..*uriExtension
... styleSensitive S0..1booleanExtension
... questionnaire-category S0..1CodeableConceptExtension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S Σ0..*IdentifierExternal Ids for this questionnaire
... version S Σ0..1stringLogical id for this version of Questionnaire
... status ?! SΣ1..1codedraft | published | retired
Binding: QuestionnaireStatus (required)
... date S Σ1..1dateTimeIdentifies when this version of the form was created. Changes whenever the form is updated.
... publisher S Σ0..1stringOrganization/individual who designed the questionnaire
... telecom Σ0..*ContactPointContact information of the publisher
... group S I1..1Grouped questions
que-1: Groups may either contain questions or groups but not both
.... questionnaire-label S0..1stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-instruction S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-security S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-help S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-tooltip S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-trailing S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... questionnaire-sdc-optionalDisplay 0..1booleanExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-hidden S0..1booleanExtension
.... questionnaire-minOccurs S0..1integerExtension
.... questionnaire-maxOccurs S0..1integerExtension
.... questionnaire-sdc-specialGroup S0..1codeExtension
.... questionnaire-instruction S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-security S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-help S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-tooltip S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-trailing S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... questionnaire-units S0..*stringExtension
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... url 1..1uriidentifies the meaning of the extension
..... value[x] 0..1*Value of extension
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... linkId S1..1stringTo link questionnaire with questionnaire answers
.... title S0..1stringName to be displayed for group
..... style 0..*stringExtension
..... markup 0..1stringExtension
..... value 0..1xs:stringPrimitive value for string
.... concept S0..1CodingConcept that represents this section on a questionnaire
Binding: QuestionnaireGroupConcept (required)
.... text S0..1stringAdditional text for the group
.... required S1..1booleanMust group be included in data results?
.... repeats S1..1booleanWhether the group may repeat
.... group S I0..*Nested questionnaire group
.... question S I0..*Questions in this group
..... questionnaire-minOccurs 0..1integerExtension
..... questionnaire-maxOccurs 0..1integerExtension
..... questionnaire-label S0..1stringExtension
...... style 0..*stringExtension
...... markup 0..1stringExtension
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1*Value of extension
..... questionnaire-enableWhen S0..*(Complex)Extension
..... questionnaire-sdc-optionalDisplay 0..1booleanExtension
..... questionnaire-hidden S0..1booleanExtension
..... questionnaire-defaultValue S0..1*Extension
..... questionnaire-defaultAsFixed S0..1booleanExtension
..... minLength S0..1integerExtension
..... questionnaire-maxLength S0..1integerExtension
..... regex S0..1stringExtension
..... entryFormat S0..1stringExtension
..... minValue S0..1date, dateTime, time, instant, decimal, integerExtension
..... maxValue S0..1date, dateTime, time, instant, decimal, integerExtension
..... maxDecimalPlaces S0..1integerExtension
..... questionnaire-deReference S0..1DataElementExtension
...... style 0..*stringExtension
...... markup 0..1stringExtension
...... url 1..1uriidentifies the meaning of the extension
...... value[x] 0..1*Value of extension
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... linkId S1..1stringTo link questionnaire with questionnaire answers
..... concept 0..*CodingConcept that represents this question on a questionnaire
..... text S1..1stringText of the question as it is shown to the user
..... type S1..1codeboolean | decimal | integer | date | dateTime +
Binding: AnswerFormat (required)
..... required S0..1booleanMust question be answered in data results?
..... repeats S0..1booleanCan question have multiple answers?
..... options S0..1ValueSetValueset containing the possible options
..... group S0..*Nested questionnaire group

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

4.26.1.6.2 Terminology Bindings

PathNameConformanceValueSet
Questionnaire.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Questionnaire.statusQuestionnaireStatusrequiredQuestionnaireStatus
Questionnaire.group.conceptQuestionnaireGroupConceptrequired
Questionnaire.group.question.typeAnswerFormatrequiredAnswerFormat

4.26.1.6.3 Constraints

IdPathNameDetails
que-2QuestionnaireUniqueLinkIdsThe link ids for groups and questions must be unique within the questionnaire
XPath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))
que-1Questionnaire.groupGroupHaveSubOrQuestionsGroups may either contain questions or groups but not both
XPath: not(exists(f:group) and exists(f:question))
.