Structured Data Capture 2.0 (STU2)

The official URL for this profile is:

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

This profile sets expectations for use of the Questionnaire resource within the Structured Data Capture implementation guide. This includes identifying which core elements and extensions must be supported.

For the purposes of this profile, Supported means that clients SHALL be capable of processing the element/extension and use the information to control the display and information capture associated with the Questionnaire. It means that servers SHALL be capable of persisting those elements and returning them in response to requests.

This profile relies on the use of a number of other profiles, some required, others available for use "when necessary":

  • questionnaire-extensions which defines a number of less common properties for questionnaire, group and question, several of which are mandated for this profile.
  • element-extensions which defines extensions describing constraints on the values for data elements. There are used here to constrain the allowed values for questions.
  • general-extensions provides an extension for strings allowing the conveying of translations, which may be relevant in some environment
  • rendering-extensions which defines properties to give fine-grained control over how questions, labels and other strings are rendered

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

This structure is derived from Questionnaire

Summary

Mandatory: 4 elements (34 nested mandatory elements)
Must-Support: 93 elements
Fixed Value: 16 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.useContext is sliced based on the value of value:code.code

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*
... url S1..1uri
... identifier S0..*Identifier
... version S0..1string
... title S1..1string
.... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status S1..1code
... experimental S0..1boolean
... date S1..1dateTime
... publisher S0..1string
... description S0..1markdown
... purpose S0..1markdown
... approvalDate S0..1date
... lastReviewDate S0..1date
... effectivePeriod S0..1Period
... useContext SUsageContextSlice: Unordered, Open by value:code.code
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: gender
.... value[x] S1..1CodeableConceptApplies to gender
Binding: AdministrativeGender (required)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: age
.... value[x] S1..1RangeApplies to gender
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: focus
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Condition/Problem/Diagnosis Codes (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: user
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Provider Taxonomy Codes (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: workflow
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ActEncounterCode (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: task
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ActTaskCode (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: venue
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ServiceDeliveryLocationRoleType (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: species
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Questionnaire Context Species (example)
... code S0..1Coding
... subjectType S1..1code
... item S0..*BackboneElement
.... linkId S1..1string
.... code S0..1Coding
.... prefix S0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text S0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... type S1..1code
.... enableWhen S0..*BackboneElement
..... question S1..1string
..... hasAnswer S0..1boolean
..... answer[x] S0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
.... required S0..1boolean
.... repeats S0..1boolean
.... readOnly S0..1boolean
.... maxLength S0..1integer
.... options S0..1Reference(ValueSet)
.... option S0..*BackboneElement
..... questionnaire-optionPrefix S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
.... initial[x] S0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
.... item S0..*
.... questionnaire-minOccurs S0..1integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
.... questionnaire-maxOccurs S0..1integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-usageMode S0..1codecapture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required)
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: Questionnaire Item UI Control Codes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
.... mimeType S0..1codeType of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: IETF BCP-13 (required)
.... maxSize 0..1decimalMax size in MB
URL: http://hl7.org/fhir/StructureDefinition/maxSize
.... questionnaire-unit S0..1CodingUnit for numeric answer
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
.... questionnaire-allowedResource S0..*codeAllowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*Reference(StructureDefinition)Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter 0..*stringFilter to apply when looking up references
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: Questionnaire Text Categories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
... sdc-questionnaire-endpoint S0..*uriWhere to send answers
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint
... sdc-questionnaire-provenanceSignatureRequired S0..1booleanIs associated Provenance needed?
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... questionnaire-deMap 0..1Reference(ConceptMap)Map linking questions to DataElements
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap
... questionnaire-sourceStructureMap 0..*Reference(StructureMap)Map that can populate this questionnaire
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap
... extension 0..*?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifierURL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A structured set of questions
... id Σ0..1idLogical id of this artifact
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... sdc-questionnaire-endpoint SI0..*uriExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint
... sdc-questionnaire-provenanceSignatureRequired SI0..1booleanExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired
... rendering-styleSensitive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... questionnaire-deMap I0..1Reference(ConceptMap)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap
... questionnaire-sourceStructureMap I0..*Reference(StructureMap)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap
... extension 0..*?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this questionnaire (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringName for this questionnaire (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1Primitive value for string
Max Length: 1048576
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!SΣ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... description S0..1markdownNatural language description of the questionnaire
... purpose S0..1markdownWhy this questionnaire is defined
... approvalDate S0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate S0..1dateWhen the questionnaire was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the questionnaire is expected to be used
... useContext SΣUsageContextContext the content is intended to support
Slice: Unordered, Open by value:code.code
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: gender
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: AdministrativeGender (required)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: age
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueRange SΣ1..1RangeApplies to gender
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Condition/Problem/Diagnosis Codes (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: user
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Provider Taxonomy Codes (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: workflow
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ActEncounterCode (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: task
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ActTaskCode (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: venue
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ServiceDeliveryLocationRoleType (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: species
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Questionnaire Context Species (example)
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code SΣ0..1CodingConcept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example)
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item SI0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... questionnaire-minOccurs SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
.... questionnaire-maxOccurs SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
.... sdc-questionnaire-optionalDisplay I0..1booleanExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-usageMode SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required)
.... questionnaire-itemControl SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: Questionnaire Item UI Control Codes (extensible)
.... questionnaire-choiceOrientation I0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... minLength SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... minValue SI0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue SI0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... maxDecimalPlaces SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
.... mimeType SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: IETF BCP-13 (required)
.... maxSize I0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/maxSize
.... questionnaire-unit SI0..1CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
.... questionnaire-allowedResource SI0..*codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile I0..*Reference(StructureDefinition)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter I0..*stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-displayCategory SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: Questionnaire Text Categories (extensible)
.... questionnaire-supportLink I0..*uriExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code SΣI0..1CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
..... id 0..1stringxml:id (or equivalent in JSON)
..... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... text SΣ0..1stringPrimary text for the item
..... id 0..1stringxml:id (or equivalent in JSON)
..... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!SΣI0..*BackboneElementOnly allow data when
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question S1..1stringQuestion that determines whether item is enabled
..... hasAnswer SI0..1booleanEnable when answered or not
..... answer[x] SI0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Value question must have
Binding: Questionnaire Answer Codes (example)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly SI0..1booleanDon't allow human editing
.... maxLength SI0..1integerNo more than this many characters
.... options SI0..1Reference(ValueSet)Valueset containing permitted answers
.... option SI0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... questionnaire-optionPrefix SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1integer, date, time, string, CodingAnswer value
Binding: Questionnaire Answer Codes (example)
.... initial[x] SI0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
.... item SI0..*Unknown reference to #Questionnaire:sdcquestionnaire.item
Nested questionnaire items

doco Documentation for this format

This structure is derived from Questionnaire

Summary

Mandatory: 4 elements (34 nested mandatory elements)
Must-Support: 93 elements
Fixed Value: 16 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.useContext is sliced based on the value of value:code.code

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*
... url S1..1uri
... identifier S0..*Identifier
... version S0..1string
... title S1..1string
.... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
... status S1..1code
... experimental S0..1boolean
... date S1..1dateTime
... publisher S0..1string
... description S0..1markdown
... purpose S0..1markdown
... approvalDate S0..1date
... lastReviewDate S0..1date
... effectivePeriod S0..1Period
... useContext SUsageContextSlice: Unordered, Open by value:code.code
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: gender
.... value[x] S1..1CodeableConceptApplies to gender
Binding: AdministrativeGender (required)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: age
.... value[x] S1..1RangeApplies to gender
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: focus
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Condition/Problem/Diagnosis Codes (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: user
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Provider Taxonomy Codes (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: workflow
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ActEncounterCode (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: task
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ActTaskCode (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: venue
.... value[x] S1..1CodeableConceptApplies to gender
Binding: ServiceDeliveryLocationRoleType (example)
... useContext S0..*UsageContextGender context
.... code S1..1Coding
..... system S1..1uriFixed Value: http://hl7.org/fhir/usage-context-type
..... code S1..1codeFixed Value: species
.... value[x] S1..1CodeableConceptApplies to gender
Binding: Questionnaire Context Species (example)
... code S0..1Coding
... subjectType S1..1code
... item S0..*BackboneElement
.... linkId S1..1string
.... code S0..1Coding
.... prefix S0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... text S0..1string
..... rendering-style 0..1stringHtml style value
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml 0..1stringString equivalent with html markup
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... type S1..1code
.... enableWhen S0..*BackboneElement
..... question S1..1string
..... hasAnswer S0..1boolean
..... answer[x] S0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
.... required S0..1boolean
.... repeats S0..1boolean
.... readOnly S0..1boolean
.... maxLength S0..1integer
.... options S0..1Reference(ValueSet)
.... option S0..*BackboneElement
..... questionnaire-optionPrefix S0..1stringE.g. "(a)", "1.", etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
.... initial[x] S0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)
.... item S0..*
.... questionnaire-minOccurs S0..1integerMinimum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
.... questionnaire-maxOccurs S0..1integerMaximum repetitions
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
.... sdc-questionnaire-optionalDisplay 0..1booleanCan suppress from display to user
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden S0..1booleanDon't display to user
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-usageMode S0..1codecapture | display | display-non-empty | capture-display | capture-display-non-empty
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required)
.... questionnaire-itemControl S0..1CodeableConceptE.g. Fly-over, Table, Checkbox, Combo-box, Lookup, etc.
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: Questionnaire Item UI Control Codes (extensible)
.... questionnaire-choiceOrientation 0..1codehorizontal | vertical
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... minLength S0..1integerAt least this many characters
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex S0..1stringRegular expression pattern
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat S0..1stringUser prompt for format
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... minValue S0..1date, dateTime, time, instant, decimal, integerMust be >= this value
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue S0..1date, dateTime, time, instant, decimal, integerMust be <= this value
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... maxDecimalPlaces S0..1integerMaximum digits after decimal
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
.... mimeType S0..1codeType of attachment
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: IETF BCP-13 (required)
.... maxSize 0..1decimalMax size in MB
URL: http://hl7.org/fhir/StructureDefinition/maxSize
.... questionnaire-unit S0..1CodingUnit for numeric answer
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
.... questionnaire-allowedResource S0..*codeAllowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*Reference(StructureDefinition)Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter 0..*stringFilter to apply when looking up references
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-displayCategory S0..1CodeableConceptPurpose of rendered text
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: Questionnaire Text Categories (extensible)
.... questionnaire-supportLink 0..*uriSupporting information
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
... sdc-questionnaire-endpoint S0..*uriWhere to send answers
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint
... sdc-questionnaire-provenanceSignatureRequired S0..1booleanIs associated Provenance needed?
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired
... rendering-styleSensitive S0..1booleanAre styles important for processing?
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... questionnaire-deMap 0..1Reference(ConceptMap)Map linking questions to DataElements
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap
... questionnaire-sourceStructureMap 0..*Reference(StructureMap)Map that can populate this questionnaire
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap
... extension 0..*?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifierURL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*A structured set of questions
... id Σ0..1idLogical id of this artifact
... 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: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... sdc-questionnaire-endpoint SI0..*uriExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-endpoint
... sdc-questionnaire-provenanceSignatureRequired SI0..1booleanExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-provenanceSignatureRequired
... rendering-styleSensitive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-styleSensitive
... questionnaire-deMap I0..1Reference(ConceptMap)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-deMap
... questionnaire-sourceStructureMap I0..*Reference(StructureMap)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-sourceStructureMap
... extension 0..*?? http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriLogical URI to reference this questionnaire (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name Σ0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringName for this questionnaire (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
.... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
.... value 0..1Primitive value for string
Max Length: 1048576
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental ?!SΣ0..1booleanFor testing purposes, not real usage
... date SΣ1..1dateTimeDate this was last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... description S0..1markdownNatural language description of the questionnaire
... purpose S0..1markdownWhy this questionnaire is defined
... approvalDate S0..1dateWhen the questionnaire was approved by publisher
... lastReviewDate S0..1dateWhen the questionnaire was last reviewed
... effectivePeriod SΣ0..1PeriodWhen the questionnaire is expected to be used
... useContext SΣUsageContextContext the content is intended to support
Slice: Unordered, Open by value:code.code
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: gender
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: AdministrativeGender (required)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: age
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueRange SΣ1..1RangeApplies to gender
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Condition/Problem/Diagnosis Codes (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: user
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Provider Taxonomy Codes (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: workflow
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ActEncounterCode (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: task
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ActTaskCode (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: venue
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: ServiceDeliveryLocationRoleType (example)
... useContext SΣ0..*UsageContextGender context
.... id 0..1stringxml:id (or equivalent in JSON)
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/usage-context-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: species
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... valueCodeableConcept SΣ1..1CodeableConceptApplies to gender
Binding: Questionnaire Context Species (example)
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... contact Σ0..*ContactDetailContact details for the publisher
... copyright 0..1markdownUse and/or publishing restrictions
... code SΣ0..1CodingConcept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example)
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... item SI0..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... questionnaire-minOccurs SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
.... questionnaire-maxOccurs SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
.... sdc-questionnaire-optionalDisplay I0..1booleanExtension
URL: http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay
.... questionnaire-hidden SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-hidden
.... questionnaire-usageMode SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-usageMode
Binding: QuestionnaireItemUsageMode (required)
.... questionnaire-itemControl SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl
Binding: Questionnaire Item UI Control Codes (extensible)
.... questionnaire-choiceOrientation I0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation
Binding: ChoiceListOrientation (required)
.... minLength SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minLength
.... regex SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/regex
.... entryFormat SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
.... minValue SI0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minValue
.... maxValue SI0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxValue
.... maxDecimalPlaces SI0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
.... mimeType SI0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: IETF BCP-13 (required)
.... maxSize I0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/maxSize
.... questionnaire-unit SI0..1CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
.... questionnaire-allowedResource SI0..*codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile I0..*Reference(StructureDefinition)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter I0..*stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-displayCategory SI0..1CodeableConceptExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory
Binding: Questionnaire Text Categories (extensible)
.... questionnaire-supportLink I0..*uriExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-supportLink
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code SΣI0..1CodingCorresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example)
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
..... id 0..1stringxml:id (or equivalent in JSON)
..... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... text SΣ0..1stringPrimary text for the item
..... id 0..1stringxml:id (or equivalent in JSON)
..... rendering-style I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-style
..... rendering-xhtml I0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/rendering-xhtml
..... value 0..1Primitive value for string
Max Length: 1048576
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!SΣI0..*BackboneElementOnly allow data when
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... question S1..1stringQuestion that determines whether item is enabled
..... hasAnswer SI0..1booleanEnable when answered or not
..... answer[x] SI0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Value question must have
Binding: Questionnaire Answer Codes (example)
.... required SI0..1booleanWhether the item must be included in data results
.... repeats SI0..1booleanWhether the item may repeat
.... readOnly SI0..1booleanDon't allow human editing
.... maxLength SI0..1integerNo more than this many characters
.... options SI0..1Reference(ValueSet)Valueset containing permitted answers
.... option SI0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... questionnaire-optionPrefix SI0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionPrefix
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... value[x] 1..1integer, date, time, string, CodingAnswer value
Binding: Questionnaire Answer Codes (example)
.... initial[x] SI0..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Default value when item is first rendered
Binding: Questionnaire Answer Codes (example)
.... item SI0..*Unknown reference to #Questionnaire:sdcquestionnaire.item
Nested questionnaire items

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Questionnaire.languageCommon LanguagesextensibleCommon Languages
Questionnaire.statusPublicationStatusrequiredPublicationStatus
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.useContext.codeUsageContextTypeextensibleUsageContextType
Questionnaire.useContext.valueCodeableConceptQuestionnaire Context SpeciesexampleQuestionnaire Context Species
Questionnaire.jurisdictionJurisdiction ValueSetextensibleJurisdiction ValueSet
Questionnaire.codeQuestionnaire Question CodesexampleQuestionnaire Question Codes
Questionnaire.subjectTypeResourceTyperequiredResourceType
Questionnaire.item.codeQuestionnaire Question CodesexampleQuestionnaire Question Codes
Questionnaire.item.typeQuestionnaireItemTyperequiredQuestionnaireItemType
Questionnaire.item.enableWhen.answer[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes
Questionnaire.item.option.value[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes
Questionnaire.item.initial[x]Questionnaire Answer CodesexampleQuestionnaire Answer Codes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4QuestionnaireIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3QuestionnaireIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
que-2QuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.title.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.title.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.itemAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-9Questionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-8Questionnaire.itemDefault values can't be specified for groups or display items
: (type!='group' and type!='display') or initial.empty()
que-6Questionnaire.itemRequired and repeat aren't permitted for display items
: type!='display' or (required.empty() and repeats.empty())
que-5Questionnaire.itemOnly 'choice' items can have options
: (type ='choice' or type = 'open-choice') or (options.empty() and option.empty())
que-4Questionnaire.itemA question cannot have both option and options
: option.empty() or options.empty()
que-3Questionnaire.itemDisplay items cannot have a "code" asserted
: type!='display' or code.empty()
que-10Questionnaire.itemMaximum length can only be declared for simple question types
: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()
que-1Questionnaire.itemGroup items must have nested items, display items cannot have nested items
: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty())
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.prefix.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.prefix.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.text.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.text.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.enableWhenAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
que-7Questionnaire.item.enableWhenenableWhen must contain either a 'answer' or a 'hasAnswer' element
: hasAnswer.exists() xor answer.exists()
ele-1Questionnaire.item.optionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Questionnaire.item.option.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.option.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.option.extensionAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Questionnaire.item.option.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()

In some environments, it may be necessary for a questionnaire to support multiple languages. The rendering tool would select the appropriate language based on a configuration setting, or perhaps would display all available languages and the user would read the one they are familiar with. Systems MAY choose to provide support for identifying language and translations. If they do, they MAY do so using the generic language and translation extensions FHIR defines based on the ISO21090 data type specification:

  • iso21090-st-language allows the language of a particular (or any other data type) to be identified
  • iso21090-st-translation allows additional repetitions in alternate languages to be communicated. (The language for each translation would be communicated using the above #language extension)

These extensions can be used on absolutely any string element on Questionnaire, ValueSet, or any other resource. The base string should be the primary language of the questionnaire. It is what will be rendered by systems that do not support the translation extension or by systems whose language preference is other than one of the languages provided.

The ISO 19763 specification permits declaring language on questionnaire titles, descriptions, display names for codes and many other strings. It also supports capturing multiple variants of these strings with distinct languages. These capabilities can be mirrored using the above extensions.

An alternative is to define an extension to the Questionnaire providing a pointer to an externally maintained set of extensions. This approach allows the translations to be maintained independently of the resource which has both positive and negative impacts, particularly with respect to resource signature.

Open Issue: Should this profile define such an extension and/or a resource for managing such translations?