This page is part of the Structured Data Capture FHIR IG (v1.6: STU 2 Ballot 1) based on FHIR v1.6.0. . For a full list of available versions, see the Directory of published versions
This is a pre-release of a future version of SDC (expected to be STU 2). The current version is STU 2.
For a full list of available versions, see the Directory of published versions .
The official URL for this profile is:
http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Questionnaire
Summary
Mandatory: 4 elements (+2 nested mandatory elements)
Must-Support: 48 elements
Extensions
This structure refers to these extensions:
This structure is derived from Questionnaire
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A structured set of questions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource que-2: The link ids for groups and questions must be unique within the questionnaire | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
sdc-questionnaire-endpoint | SI | 0..* | uri | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | S | 0..1 | ?? http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred |
rendering-styleSensitive | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-deMap | I | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-sourceStructureMap | I | 0..* | Reference(StructureMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..* | ?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S | 1..1 | uri | Globally unique logical identifier for questionnaire |
identifier | S | 0..* | Identifier | External identifiers for this questionnaire |
version | S | 0..1 | string | Logical identifier for this version of Questionnaire |
status | ?!S | 1..1 | code | draft | published | retired Binding: QuestionnaireStatus (required) |
date | S | 1..1 | dateTime | Date this version was authored |
publisher | S | 0..1 | string | Organization/individual who designed the questionnaire |
telecom | ∑ | 0..* | ContactPoint | Contact information of the publisher |
useContext | S | 0..* | CodeableConcept | Questionnaire intends to support these contexts Binding: Context of Use ValueSet (extensible) |
title | S | 1..1 | string | Name for the questionnaire |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
concept | S | 0..1 | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
subjectType | S | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
item | SI | 0..* | BackboneElement | Questions and sections within the Questionnaire que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items que-6: Required and repeat aren't permitted for display items que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-3: Display items cannot have a "concept" asserted que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
questionnaire-minOccurs | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-3: minOccurs can't exist for display items inv-1: minOccurs can't be more than one if required is false |
questionnaire-maxOccurs | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-4: maxOccurs can't exist for display items inv-2: maxOccurs can't be more than one if repeats is false |
sdc-questionnaire-optionalDisplay | I | 0..1 | boolean | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-hidden | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-usageMode | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-itemControl | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: Questionnaire Item UI Control Codes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-choiceOrientation | I | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-6: choiceOrientation can only be present on elements of type "choice" or "open-choice" |
minLength | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
regex | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
entryFormat | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minValue | SI | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxValue | SI | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxDecimalPlaces | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mimeType | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: IETF BCP-13 (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxSize | I | 0..1 | decimal | Extension URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-unit | SI | 0..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-16: Lookup Questionnaire can only be specified for questions with a type of "integer" or "decimal" |
questionnaire-deReference | SI | 0..1 | Reference(DataElement) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-9: Data Element references can't be specified for "display" items |
questionnaire-allowedResource | SI | 0..* | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource Binding: ResourceType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-10: Allowed resource can only be specified for items of type 'reference' |
questionnaire-allowedProfile | I | 0..* | Reference(StructureDefinition) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-17: Allowed profile can only be specified for items of type 'reference' |
questionnaire-referenceFilter | I | 0..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-13: Allowed reference filter can only be specified for items of type 'reference' |
questionnaire-displayCategory | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: Questionnaire Text Categories (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-11: Display category can only be specified for items of type display |
questionnaire-supportLink | I | 0..* | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
linkId | S | 1..1 | string | To link questionnaire with questionnaire response |
concept | SI | 0..1 | Coding | Concept that represents this item within in a questionnaire Binding: Questionnaire Question Codes (example) |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
text | S | 0..1 | string | Primary text for the item |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
type | S | 1..1 | code | group | display | question | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) |
enableWhen | ?!SI | 0..* | BackboneElement | Only allow data when: que-7: enableWhen must contain either an 'answer' or an 'answered' element |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
question | S | 1..1 | string | Question that determines whether item is enabled |
hasAnswer | SI | 0..1 | boolean | Enable when answered or not |
answer[x] | SI | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have |
required | SI | 0..1 | boolean | Whether the item must be included in data results |
repeats | SI | 0..1 | boolean | Whether the item may repeat |
readOnly | SI | 0..1 | boolean | Don't allow human editing |
maxLength | SI | 0..1 | integer | No more than this many characters |
options | SI | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | SI | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
questionnaire-optionPrefix | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) | |
initial[x] | SI | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Initial presumed answer for question |
item | SI | 0..* | Unknown reference to #Questionnaire:sdcquestionnaire.item Nested questionnaire items | |
Documentation for this format |
yet to be done: Xml template
yet to be done: Json template
yet to be done: Turtle template
This structure is derived from Questionnaire
Summary
Mandatory: 4 elements (+2 nested mandatory elements)
Must-Support: 48 elements
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Questionnaire
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | 0..* | A structured set of questions dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource que-2: The link ids for groups and questions must be unique within the questionnaire | |
id | ∑ | 0..1 | id | Logical id of this artifact |
meta | ∑ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!∑ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
sdc-questionnaire-endpoint | SI | 0..* | uri | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | S | 0..1 | ?? http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred |
rendering-styleSensitive | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-deMap | I | 0..1 | Reference(ConceptMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-sourceStructureMap | I | 0..* | Reference(StructureMap) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
extension | 0..* | ?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | S | 1..1 | uri | Globally unique logical identifier for questionnaire |
identifier | S | 0..* | Identifier | External identifiers for this questionnaire |
version | S | 0..1 | string | Logical identifier for this version of Questionnaire |
status | ?!S | 1..1 | code | draft | published | retired Binding: QuestionnaireStatus (required) |
date | S | 1..1 | dateTime | Date this version was authored |
publisher | S | 0..1 | string | Organization/individual who designed the questionnaire |
telecom | ∑ | 0..* | ContactPoint | Contact information of the publisher |
useContext | S | 0..* | CodeableConcept | Questionnaire intends to support these contexts Binding: Context of Use ValueSet (extensible) |
title | S | 1..1 | string | Name for the questionnaire |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
concept | S | 0..1 | Coding | Concept that represents the overall questionnaire Binding: Questionnaire Question Codes (example) |
subjectType | S | 1..1 | code | Resource that can be subject of QuestionnaireResponse Binding: ResourceType (required) |
item | SI | 0..* | BackboneElement | Questions and sections within the Questionnaire que-9: Read-only can't be specified for "display" items que-8: Default values can't be specified for groups or display items que-6: Required and repeat aren't permitted for display items que-5: Only 'choice' items can have options que-4: A question cannot have both option and options que-3: Display items cannot have a "concept" asserted que-10: Maximum length can only be declared for simple question types que-1: Group items must have nested items, display items cannot have nested items |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
questionnaire-minOccurs | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-3: minOccurs can't exist for display items inv-1: minOccurs can't be more than one if required is false |
questionnaire-maxOccurs | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-4: maxOccurs can't exist for display items inv-2: maxOccurs can't be more than one if repeats is false |
sdc-questionnaire-optionalDisplay | I | 0..1 | boolean | Extension URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-hidden | SI | 0..1 | boolean | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-usageMode | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode Binding: QuestionnaireItemUsageMode (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-itemControl | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl Binding: Questionnaire Item UI Control Codes (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-choiceOrientation | I | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation Binding: ChoiceListOrientation (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-6: choiceOrientation can only be present on elements of type "choice" or "open-choice" |
minLength | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minLength ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
regex | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/regex ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
entryFormat | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/entryFormat ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
minValue | SI | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/minValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxValue | SI | 0..1 | date, dateTime, time, instant, decimal, integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxValue ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxDecimalPlaces | SI | 0..1 | integer | Extension URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
mimeType | SI | 0..1 | code | Extension URL: http://hl7.org/fhir/StructureDefinition/mimeType Binding: IETF BCP-13 (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
maxSize | I | 0..1 | decimal | Extension URL: http://hl7.org/fhir/StructureDefinition/maxSize ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
questionnaire-unit | SI | 0..1 | Coding | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-16: Lookup Questionnaire can only be specified for questions with a type of "integer" or "decimal" |
questionnaire-deReference | SI | 0..1 | Reference(DataElement) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deReference ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-9: Data Element references can't be specified for "display" items |
questionnaire-allowedResource | SI | 0..* | code | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource Binding: ResourceType (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-10: Allowed resource can only be specified for items of type 'reference' |
questionnaire-allowedProfile | I | 0..* | Reference(StructureDefinition) | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-17: Allowed profile can only be specified for items of type 'reference' |
questionnaire-referenceFilter | I | 0..* | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-13: Allowed reference filter can only be specified for items of type 'reference' |
questionnaire-displayCategory | SI | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory Binding: Questionnaire Text Categories (extensible) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both inv-11: Display category can only be specified for items of type display |
questionnaire-supportLink | I | 0..* | uri | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
linkId | S | 1..1 | string | To link questionnaire with questionnaire response |
concept | SI | 0..1 | Coding | Concept that represents this item within in a questionnaire Binding: Questionnaire Question Codes (example) |
prefix | S | 0..1 | string | E.g. "1(a)", "2.5.3" |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
text | S | 0..1 | string | Primary text for the item |
id | 0..1 | id | xml:id (or equivalent in JSON) | |
rendering-style | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-style ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
rendering-xhtml | I | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
value | 0..1 | Primitive value for string | ||
type | S | 1..1 | code | group | display | question | boolean | decimal | integer | date | dateTime + Binding: QuestionnaireItemType (required) |
enableWhen | ?!SI | 0..* | BackboneElement | Only allow data when: que-7: enableWhen must contain either an 'answer' or an 'answered' element |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
extension | 0..* | Extension | Additional Content defined by implementations | |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
question | S | 1..1 | string | Question that determines whether item is enabled |
hasAnswer | SI | 0..1 | boolean | Enable when answered or not |
answer[x] | SI | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Value question must have |
required | SI | 0..1 | boolean | Whether the item must be included in data results |
repeats | SI | 0..1 | boolean | Whether the item may repeat |
readOnly | SI | 0..1 | boolean | Don't allow human editing |
maxLength | SI | 0..1 | integer | No more than this many characters |
options | SI | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | SI | 0..* | BackboneElement | Permitted answer |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
questionnaire-optionPrefix | SI | 0..1 | string | Extension URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
modifierExtension | ?!∑ | 0..* | Extension | Extensions that cannot be ignored |
value[x] | 1..1 | integer, date, time, string, Coding | Answer value Binding: Questionnaire Answer Codes (example) | |
initial[x] | SI | 0..1 | boolean, decimal, integer, date, dateTime, instant, time, string, uri, Attachment, Coding, Quantity, Reference(Resource) | Initial presumed answer for question |
item | SI | 0..* | Unknown reference to #Questionnaire:sdcquestionnaire.item Nested questionnaire items | |
Documentation for this format |
XML Template
yet to be done: Xml template
JSON Template
yet to be done: Json template
TTL Template
yet to be done: Turtle template
Other representations of profile: Schematron
Path | Name | Conformance | ValueSet |
Questionnaire.language | Common Languages | extensible | Common Languages |
Questionnaire.status | QuestionnaireStatus | required | QuestionnaireStatus |
Questionnaire.useContext | Context of Use ValueSet | extensible | Context of Use ValueSet |
Questionnaire.concept | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.subjectType | ResourceType | required | ResourceType |
Questionnaire.item.concept | Questionnaire Question Codes | example | Questionnaire Question Codes |
Questionnaire.item.type | QuestionnaireItemType | required | QuestionnaireItemType |
Questionnaire.item.option.value[x] | Questionnaire Answer Codes | example | Questionnaire Answer Codes |
Id | Path | Details | Requirements |
dom-2 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain nested Resources XPath: not(parent::f:contained and f:contained) | |
dom-1 | Questionnaire | If the resource is contained in another resource, it SHALL NOT contain any narrative XPath: not(parent::f:contained and f:text) | |
dom-4 | Questionnaire | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated)) | |
dom-3 | Questionnaire | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))])) | |
que-2 | Questionnaire | The 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)) | |
ele-1 | Questionnaire.title.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.title.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.title.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.title.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.title.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.title.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
que-9 | Questionnaire.item | Read-only can't be specified for "display" items XPath: not(f:type/@value='display' and f:readOnly) | |
que-8 | Questionnaire.item | Default values can't be specified for groups or display items XPath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')]) | |
que-6 | Questionnaire.item | Required and repeat aren't permitted for display items XPath: not(f:type/@value='display' and (f:required or f:repeats)) | |
que-5 | Questionnaire.item | Only 'choice' items can have options XPath: f:type/@value=('choice','open-choice') or not(f:option or f:options) | |
que-4 | Questionnaire.item | A question cannot have both option and options XPath: not(f:options and f:option) | |
que-3 | Questionnaire.item | Display items cannot have a "concept" asserted XPath: not(f:type/@value='display' and f:concept) | |
que-10 | Questionnaire.item | Maximum length can only be declared for simple question types XPath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength) | |
que-1 | Questionnaire.item | Group items must have nested items, display items cannot have nested items XPath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.prefix.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.prefix.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.prefix.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.prefix.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.prefix.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.prefix.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.text.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.text.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.text.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.text.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
ele-1 | Questionnaire.item.text.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.text.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) | |
que-7 | Questionnaire.item.enableWhen | enableWhen must contain either an 'answer' or an 'answered' element XPath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1 | |
ele-1 | Questionnaire.item.option.extension | All FHIR elements must have a @value or children XPath: @value|f:*|h:div | |
ext-1 | Questionnaire.item.option.extension | Must have either extensions or value[x], not both XPath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) |