Structured Data Capture 2.5.0 - Edition 3(STU), For Comment 2018Sep Ballot

This page is part of the Structured Data Capture FHIR IG (v2.5.0: STU 3 Ballot 1) based on FHIR v3.5.0. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

The official URL for this profile is:

http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-behave

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

This structure is derived from Structured Data Capture Questionnaire Design

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.item.answerOption.value[x] is sliced based on the value of type:$this

This structure is derived from Structured Data Capture Questionnaire Design

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*Advanced Behavior Questionnaire
... questionnaire-constraint 0..*(Complex)Constraint
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
... questionnaire-context 0..*(Complex)Context resources needed for Questionnaire
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-context
... item 1..*BackboneElement
.... 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
.... 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, 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: Mime Types (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-unitOption S0..*CodingUnit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
.... questionnaire-unitValueSet S0..1canonical(ValueSet)Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
.... questionnaire-allowedResource S0..*codeAllowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*canonical(StructureDefinition)Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter 0..1stringFilter to apply when looking up references
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-lookupQuestionnaire 0..1uriQuestionnaire to populate a reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire
.... questionnaire-constraint 0..*(Complex)Constraint
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
.... questionnaire-initialExpression 0..1ExpressionExpression-determined initial value
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression
.... questionnaire-calculatedExpression 0..1ExpressionExpression-determined initial value
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression
.... enableWhen S0..*BackboneElement
..... question S1..1string
..... operator S1..1code
..... answer[x] S1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)
.... enableBehavior S0..1code
.... answerOption 0..*BackboneElement
..... questionnaire-optionExclusive S0..1booleanOption is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
..... value[x] Sinteger, date, time, string, Coding, Reference(Resource)Slice: Unordered, Open by type:$this
​..... value[x] 0..1Coding
​...... questionnaire-ordinalValue S0..1decimalComparison value for ordinal codes
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-ordinalValue

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*Advanced Behavior Questionnaire
... 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 (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... sdc-questionnaire-endpoint SI0..*uriExtension
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
... questionnaire-studyProtocolIdentifier I0..*IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier
... questionnaire-designNote I0..1markdownExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-designNote
... questionnaire-constraint 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension 1..1ExtensionUnique identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"key"
..... valueId 0..1idValue of extension
.... extension 0..1ExtensionWhy needed
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"requirements"
..... valueString 0..1stringValue of extension
.... extension 1..1Extensionerror|warning
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"severity"
..... valueCode 0..1codeValue of extension
Binding: ConstraintSeverity (required)
.... extension 1..1ExtensionFormal rule
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"expression"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionHuman-readable rule
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"human"
..... valueString 0..1stringValue of extension
.... extension 0..*ExtensionRelative path to elements
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"location"
..... valueString 0..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-constraint"
... questionnaire-context 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension 1..1ExtensionVariable name
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"name"
..... valueId 0..1idValue of extension
.... extension 1..1ExtensionResource type
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"type"
..... valueCode 0..1codeValue of extension
Binding: ResourceType (required)
.... extension 0..1ExtensionExplanation of context element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"description"
..... valueString 0..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-context"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣI0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S0..1markdownNatural language description of the questionnaire
... useContext SΣUsageContextThe context that 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)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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..*UsageContextAge context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 age
... useContext SΣ0..*UsageContextFocus context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 focus
Binding: Condition/Problem/DiagnosisCodes (example)
... useContext SΣ0..*UsageContextUser context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 user
Binding: Provider Taxonomy Codes (example)
... useContext SΣ0..*UsageContextWorkflow context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 workflow
Binding: ActEncounterCode (example)
... useContext SΣ0..*UsageContextTask context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 task
Binding: ActTaskCode (example)
... useContext SΣ0..*UsageContextVenue context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 venue
Binding: ServiceDeliveryLocationRoleType (example)
... useContext SΣ0..*UsageContextSpecies context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 species
Binding: Questionnaire Context Species (example)
... jurisdiction SΣ0..1CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this questionnaire is defined
... copyright S0..1markdownUse and/or publishing restrictions
... 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
... code SΣ0..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaire-designNote I0..1markdownExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-designNote
.... questionnaire-minOccurs S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
..... valueInteger 0..1integerValue of extension
.... questionnaire-maxOccurs S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
..... valueInteger 0..1integerValue of extension
.... minLength S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/minLength"
..... valueInteger 0..1integerValue of extension
.... regex S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/regex
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/regex"
..... valueString 0..1stringValue of extension
.... entryFormat S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/entryFormat"
..... valueString 0..1stringValue of extension
.... minValue S0..1date, dateTime, time, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minValue
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/minValue"
..... value[x] 1..1date, dateTime, time, decimal, integerValue of extension
.... maxValue S0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxValue
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxValue"
..... value[x] 1..1date, dateTime, time, instant, decimal, integerValue of extension
.... maxDecimalPlaces S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces"
..... valueInteger 0..1integerValue of extension
.... mimeType S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/mimeType"
..... valueCode 0..1codeValue of extension
Binding: Mime Types (required)
.... maxSize 0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxSize"
..... valueDecimal 0..1decimalValue of extension
.... questionnaire-unit S0..1CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unit"
..... valueCoding 0..1CodingValue of extension
.... questionnaire-unitOption S0..*CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
..... valueCoding 0..1CodingValue of extension
.... questionnaire-unitValueSet S0..1canonical(ValueSet)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet"
..... valueCanonical 0..1canonical(ValueSet)Value of extension
.... questionnaire-allowedResource S0..*codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource"
..... valueCode 0..1codeValue of extension
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*canonical(StructureDefinition)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile"
..... valueCanonical 0..1canonical(StructureDefinition)Value of extension
.... questionnaire-referenceFilter 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter"
..... valueString 0..1stringValue of extension
.... questionnaire-lookupQuestionnaire 0..1uriExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire"
..... valueUri 0..1uriValue of extension
.... questionnaire-constraint 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionUnique identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"key"
...... valueId 0..1idValue of extension
..... extension 0..1ExtensionWhy needed
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"requirements"
...... valueString 0..1stringValue of extension
..... extension 1..1Extensionerror|warning
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"severity"
...... valueCode 0..1codeValue of extension
Binding: ConstraintSeverity (required)
..... extension 1..1ExtensionFormal rule
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"expression"
...... valueString 0..1stringValue of extension
..... extension 1..1ExtensionHuman-readable rule
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"human"
...... valueString 0..1stringValue of extension
..... extension 0..*ExtensionRelative path to elements
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"location"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-constraint"
.... questionnaire-initialExpression 0..1ExpressionExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression"
..... valueExpression 0..1ExpressionValue of extension
.... questionnaire-calculatedExpression 0..1ExpressionExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression"
..... valueExpression 0..1ExpressionValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code I0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!SI0..*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 if unrecognized
..... question S1..1stringQuestion that determines whether item is enabled
..... operator S1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required)
..... answer[x] SI1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
.... enableBehavior SI0..1codeall | any
Binding: EnableWhenBehavior (required)
.... 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
.... answerValueSet SI0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... questionnaire-optionExclusive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... value[x] Sinteger, date, time, string, Coding, Reference(Resource)Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example)
..... valueCoding 0..1CodingAnswer value
Binding: QuestionnaireAnswerCodes (example)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... questionnaire-ordinalValue S0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-ordinalValue
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... initialSelected 0..1booleanWhether option is selected by default
.... initial SI0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

This structure is derived from Structured Data Capture Questionnaire Design

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 21 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Questionnaire.item.answerOption.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Structured Data Capture Questionnaire Design

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire 0..*Advanced Behavior Questionnaire
... questionnaire-constraint 0..*(Complex)Constraint
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
... questionnaire-context 0..*(Complex)Context resources needed for Questionnaire
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-context
... item 1..*BackboneElement
.... 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
.... 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, 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: Mime Types (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-unitOption S0..*CodingUnit choice
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
.... questionnaire-unitValueSet S0..1canonical(ValueSet)Unit choices
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
.... questionnaire-allowedResource S0..*codeAllowed resource for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*canonical(StructureDefinition)Allowed profile for reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
.... questionnaire-referenceFilter 0..1stringFilter to apply when looking up references
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
.... questionnaire-lookupQuestionnaire 0..1uriQuestionnaire to populate a reference
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire
.... questionnaire-constraint 0..*(Complex)Constraint
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
.... questionnaire-initialExpression 0..1ExpressionExpression-determined initial value
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression
.... questionnaire-calculatedExpression 0..1ExpressionExpression-determined initial value
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression
.... enableWhen S0..*BackboneElement
..... question S1..1string
..... operator S1..1code
..... answer[x] S1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)
.... enableBehavior S0..1code
.... answerOption 0..*BackboneElement
..... questionnaire-optionExclusive S0..1booleanOption is exclusive
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
..... value[x] Sinteger, date, time, string, Coding, Reference(Resource)Slice: Unordered, Open by type:$this
​..... value[x] 0..1Coding
​...... questionnaire-ordinalValue S0..1decimalComparison value for ordinal codes
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-ordinalValue

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire I0..*Advanced Behavior Questionnaire
... 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 (preferred)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... sdc-questionnaire-endpoint SI0..*uriExtension
URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-endpoint
... questionnaire-studyProtocolIdentifier I0..*IdentifierExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-studyProtocolIdentifier
... questionnaire-designNote I0..1markdownExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-designNote
... questionnaire-constraint 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension 1..1ExtensionUnique identifier
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"key"
..... valueId 0..1idValue of extension
.... extension 0..1ExtensionWhy needed
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"requirements"
..... valueString 0..1stringValue of extension
.... extension 1..1Extensionerror|warning
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"severity"
..... valueCode 0..1codeValue of extension
Binding: ConstraintSeverity (required)
.... extension 1..1ExtensionFormal rule
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"expression"
..... valueString 0..1stringValue of extension
.... extension 1..1ExtensionHuman-readable rule
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"human"
..... valueString 0..1stringValue of extension
.... extension 0..*ExtensionRelative path to elements
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"location"
..... valueString 0..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-constraint"
... questionnaire-context 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension 1..1ExtensionVariable name
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"name"
..... valueId 0..1idValue of extension
.... extension 1..1ExtensionResource type
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"type"
..... valueCode 0..1codeValue of extension
Binding: ResourceType (required)
.... extension 0..1ExtensionExplanation of context element
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"description"
..... valueString 0..1stringValue of extension
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-context"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... url SΣ1..1uriCanonical identifier for this questionnaire, represented as a URI (globally unique)
... identifier SΣ0..*IdentifierAdditional identifier for the questionnaire
... version SΣ0..1stringBusiness version of the questionnaire
... name ΣI0..1stringName for this questionnaire (computer friendly)
... title SΣ1..1stringName for this questionnaire (human friendly)
... derivedFrom 0..*canonical(Questionnaire)Instantiates protocol or definition
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required)
... experimental SΣ0..1booleanFor testing purposes, not real usage
... subjectType SΣ1..1codeResource that can be subject of QuestionnaireResponse
Binding: ResourceType (required)
... date SΣ1..1dateTimeDate last changed
... publisher SΣ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description S0..1markdownNatural language description of the questionnaire
... useContext SΣUsageContextThe context that 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)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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..*UsageContextAge context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 age
... useContext SΣ0..*UsageContextFocus context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 focus
Binding: Condition/Problem/DiagnosisCodes (example)
... useContext SΣ0..*UsageContextUser context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 user
Binding: Provider Taxonomy Codes (example)
... useContext SΣ0..*UsageContextWorkflow context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 workflow
Binding: ActEncounterCode (example)
... useContext SΣ0..*UsageContextTask context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 task
Binding: ActTaskCode (example)
... useContext SΣ0..*UsageContextVenue context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 venue
Binding: ServiceDeliveryLocationRoleType (example)
... useContext SΣ0..*UsageContextSpecies context
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... code SΣ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/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 species
Binding: Questionnaire Context Species (example)
... jurisdiction SΣ0..1CodeableConceptIntended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible)
... purpose S0..1markdownWhy this questionnaire is defined
... copyright S0..1markdownUse and/or publishing restrictions
... 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
... code SΣ0..1CodingConcept that represents the overall questionnaire
Binding: QuestionnaireQuestionCodes (example)
... item I1..*BackboneElementQuestions and sections within the Questionnaire
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... questionnaire-designNote I0..1markdownExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-designNote
.... questionnaire-minOccurs S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs"
..... valueInteger 0..1integerValue of extension
.... questionnaire-maxOccurs S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs"
..... valueInteger 0..1integerValue of extension
.... minLength S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minLength
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/minLength"
..... valueInteger 0..1integerValue of extension
.... regex S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/regex
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/regex"
..... valueString 0..1stringValue of extension
.... entryFormat S0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/entryFormat
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/entryFormat"
..... valueString 0..1stringValue of extension
.... minValue S0..1date, dateTime, time, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/minValue
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/minValue"
..... value[x] 1..1date, dateTime, time, decimal, integerValue of extension
.... maxValue S0..1date, dateTime, time, instant, decimal, integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxValue
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxValue"
..... value[x] 1..1date, dateTime, time, instant, decimal, integerValue of extension
.... maxDecimalPlaces S0..1integerExtension
URL: http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces"
..... valueInteger 0..1integerValue of extension
.... mimeType S0..1codeExtension
URL: http://hl7.org/fhir/StructureDefinition/mimeType
Binding: Mime Types (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/mimeType"
..... valueCode 0..1codeValue of extension
Binding: Mime Types (required)
.... maxSize 0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/maxSize
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/maxSize"
..... valueDecimal 0..1decimalValue of extension
.... questionnaire-unit S0..1CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unit
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unit"
..... valueCoding 0..1CodingValue of extension
.... questionnaire-unitOption S0..*CodingExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unitOption"
..... valueCoding 0..1CodingValue of extension
.... questionnaire-unitValueSet S0..1canonical(ValueSet)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-unitValueSet"
..... valueCanonical 0..1canonical(ValueSet)Value of extension
.... questionnaire-allowedResource S0..*codeExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource
Binding: ResourceType (required)
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource"
..... valueCode 0..1codeValue of extension
Binding: ResourceType (required)
.... questionnaire-allowedProfile 0..*canonical(StructureDefinition)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-allowedProfile"
..... valueCanonical 0..1canonical(StructureDefinition)Value of extension
.... questionnaire-referenceFilter 0..1stringExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-referenceFilter"
..... valueString 0..1stringValue of extension
.... questionnaire-lookupQuestionnaire 0..1uriExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-lookupQuestionnaire"
..... valueUri 0..1uriValue of extension
.... questionnaire-constraint 0..*(Complex)Extension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-constraint
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... extension 1..1ExtensionUnique identifier
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"key"
...... valueId 0..1idValue of extension
..... extension 0..1ExtensionWhy needed
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"requirements"
...... valueString 0..1stringValue of extension
..... extension 1..1Extensionerror|warning
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"severity"
...... valueCode 0..1codeValue of extension
Binding: ConstraintSeverity (required)
..... extension 1..1ExtensionFormal rule
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"expression"
...... valueString 0..1stringValue of extension
..... extension 1..1ExtensionHuman-readable rule
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"human"
...... valueString 0..1stringValue of extension
..... extension 0..*ExtensionRelative path to elements
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..0
...... url 1..1uri"location"
...... valueString 0..1stringValue of extension
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-constraint"
.... questionnaire-initialExpression 0..1ExpressionExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-initialExpression"
..... valueExpression 0..1ExpressionValue of extension
.... questionnaire-calculatedExpression 0..1ExpressionExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/StructureDefinition/questionnaire-calculatedExpression"
..... valueExpression 0..1ExpressionValue of extension
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
.... linkId S1..1stringUnique id for item in questionnaire
.... definition 0..1uriElementDefinition - details for the item
.... code I0..*CodingCorresponding concept for this item in a terminology
Binding: QuestionnaireQuestionCodes (example)
.... prefix S0..1stringE.g. "1(a)", "2.5.3"
.... text S0..1stringPrimary text for the item
.... type S1..1codegroup | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required)
.... enableWhen ?!SI0..*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 if unrecognized
..... question S1..1stringQuestion that determines whether item is enabled
..... operator S1..1codeexists | = | != | > | < | >= | <=
Binding: QuestionnaireItemOperator (required)
..... answer[x] SI1..1boolean, decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Resource)Value for question comparison based on operator
Binding: QuestionnaireAnswerCodes (example)
.... enableBehavior SI0..1codeall | any
Binding: EnableWhenBehavior (required)
.... 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
.... answerValueSet SI0..1canonical(ValueSet)Valueset containing permitted answers
.... answerOption I0..*BackboneElementPermitted answer
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
..... questionnaire-optionExclusive SI0..1booleanExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-optionExclusive
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... value[x] Sinteger, date, time, string, Coding, Reference(Resource)Answer value
Slice: Unordered, Open by type:$this
Binding: QuestionnaireAnswerCodes (example)
..... valueCoding 0..1CodingAnswer value
Binding: QuestionnaireAnswerCodes (example)
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... questionnaire-ordinalValue S0..1decimalExtension
URL: http://hl7.org/fhir/StructureDefinition/questionnaire-ordinalValue
...... system Σ0..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... initialSelected 0..1booleanWhether option is selected by default
.... initial SI0..*BackboneElementInitial value(s) when item is first rendered
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored if unrecognized
..... value[x] S1..1boolean, decimal, integer, date, dateTime, time, string, uri, Attachment, Coding, Quantity, Reference(Resource)Actual value for initializing the question
Binding: QuestionnaireAnswerCodes (example)
.... item SI0..*Unknown reference to #Questionnaire.item
Nested questionnaire items

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathNameConformanceValueSet
Questionnaire.languageLanguagepreferredCommon Languages
Questionnaire.extension.extension.valueCodeResourceTyperequiredResourceType
Questionnaire.extension.extension.valueCodeResourceTyperequiredResourceType
Questionnaire.statusPublicationStatusrequiredPublicationStatus
Questionnaire.subjectTypeResourceTyperequiredResourceType
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.jurisdictionJurisdictionextensibleJurisdiction ValueSet
Questionnaire.codeQuestionnaire Question CodesexampleQuestionnaireQuestionCodes
Questionnaire.item.extension.valueCodeResourceTyperequiredResourceType
Questionnaire.item.extension.valueCodeResourceTyperequiredResourceType
Questionnaire.item.extension.extension.valueCodeConstraintSeverityrequiredConstraintSeverity
Questionnaire.item.codeQuestionnaire Question CodesexampleQuestionnaireQuestionCodes
Questionnaire.item.typeQuestionnaireItemTyperequiredQuestionnaireItemType
Questionnaire.item.enableWhen.operatorQuestionnaireItemOperatorrequiredQuestionnaireItemOperator
Questionnaire.item.enableWhen.answer[x]Questionnaire Answer CodesexampleQuestionnaireAnswerCodes
Questionnaire.item.enableBehaviorEnableWhenBehaviorrequiredEnableWhenBehavior
Questionnaire.item.answerOption.value[x]Questionnaire Answer CodesexampleQuestionnaireAnswerCodes
Questionnaire.item.answerOption.valueCodingQuestionnaire Answer CodesexampleQuestionnaireAnswerCodes
Questionnaire.item.initial.value[x]Questionnaire Answer CodesexampleQuestionnaireAnswerCodes

Constraints

IdPathDetailsRequirements
dom-2QuestionnaireIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.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 or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6QuestionnaireA resource should have narrative for robust management
: text.div.exists()
dom-5QuestionnaireIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
que-2QuestionnaireThe link ids for groups and questions must be unique within the questionnaire
: descendants().linkId.isDistinct()
que-0QuestionnaireName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
ele-1Questionnaire.itemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
que-9Questionnaire.itemRead-only can't be specified for "display" items
: type!='display' or readOnly.empty()
que-8Questionnaire.itemInitial 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 answerValueSet
: (type ='choice' or type = 'open-choice' or type = 'decimal' or type = 'integer' or type = 'date' or type = 'dateTime' or type = 'time' or type = 'string' or type = 'quantity') or (answerValueSet.empty() and answerOption.empty())
que-4Questionnaire.itemA question cannot have both answerOption and answerValueSet
: answerOption.empty() or answerValueSet.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' | 'open-choice')) 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())
que-13Questionnaire.itemCan only have multiple initial values for repeating items
: repeats=true or initial.count() <= 1
que-11Questionnaire.itemIf one or more answerOption is present, initial[x] must be missing
: answerOption.empty() or initial.empty()
que-12Questionnaire.itemIf there are more than one enableWhen, enableBehavior must be specified
: enableWhen.count() > 2 implies enableBehavior.exists()
ele-1Questionnaire.item.enableWhenAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
que-7Questionnaire.item.enableWhenIf the operator is 'exists', the value must be a boolean
: operator = 'exists' implies (answer is Boolean)
ele-1Questionnaire.item.answerOptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Questionnaire.item.answerOption.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.answerOption.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.answerOption.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Questionnaire.item.answerOption.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Questionnaire.item.initialAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())