Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R5_Questionnaire_R3

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-Questionnaire Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R5_Questionnaire_R3

This cross-version profile allows R5 Questionnaire content to be represented via FHIR STU3 Questionnaire resources.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.status Base required PublicationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If 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()
dom-4 error Questionnaire If 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* Questionnaire A structured set of questions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.contact
... subjectType
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subjectType 0..* code R5: subjectType additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:enableBehavior 0..1 code R5: all | any (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableBehavior
Binding: R5QuestionnaireEnableBehaviorForR3 (0.1.0) (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... extension:disabledDisplay 0..1 code R5: hidden | protected (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
Binding: R5QuestionnaireDisabledDisplayForR3 (0.1.0) (required): Defines how disabled elements should be rendered
..... extension:answerConstraint 0..1 code R5: optionsOnly | optionsOrType | optionsOrString (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
Binding: R5QuestionnaireAnswerConstraintForR3 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified
.... enableWhen
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answer 1..1 decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Value for question comparison based on operator additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.answer
..... hasAnswer
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:operator 1..1 code R5: exists | = | != | > | < | >= | <= additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.operator
Binding: R5QuestionnaireEnableOperatorForR3 (0.1.0) (required): The criteria by which a question is enabled.
.... options
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answerValueSet 0..1 uri R5: ValueSet containing permitted answers additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerValueSet
.... option
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.value
...... extension:initialSelected 0..1 boolean R5: Whether option is selected by default (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.initialSelected
.... initialReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Actual value for initializing the question
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this questionnaire (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version Σ 0..1 string Business version of the questionnaire
... name Σ 0..1 string Name for this questionnaire (computer friendly)
... title Σ 0..1 string Name for this questionnaire (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... description 0..1 markdown Natural language description of the questionnaire
... purpose 0..1 markdown Why this questionnaire is defined
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 0..1 Period When the questionnaire is expected to be used
... useContext Σ 0..* UsageContext Context the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... copyright 0..1 markdown Use and/or publishing restrictions
... code Σ 0..* Coding Concept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions
... subjectType Σ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subjectType 0..* code R5: subjectType additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-9, que-8, que-6, que-5, que-4, que-3, que-10, que-1
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:enableBehavior 0..1 code R5: all | any (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableBehavior
Binding: R5QuestionnaireEnableBehaviorForR3 (0.1.0) (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... extension:disabledDisplay 0..1 code R5: hidden | protected (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
Binding: R5QuestionnaireDisabledDisplayForR3 (0.1.0) (required): Defines how disabled elements should be rendered
..... extension:answerConstraint 0..1 code R5: optionsOnly | optionsOrType | optionsOrString (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
Binding: R5QuestionnaireAnswerConstraintForR3 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... linkId 1..1 string Unique id for item in questionnaire
.... definition 0..1 uri ElementDefinition - details for the item
.... code ΣC 0..* Coding Corresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions
.... prefix 0..1 string E.g. "1(a)", "2.5.3"
.... text Σ 0..1 string Primary text for the item
.... type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions
.... enableWhen ?!ΣC 0..* BackboneElement Only allow data when
Constraints: que-7
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answer 1..1 decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Value for question comparison based on operator additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.answer
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... question 1..1 string Question that determines whether item is enabled
..... hasAnswer C 0..1 boolean Enable when answered or not
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:operator 1..1 code R5: exists | = | != | > | < | >= | <= additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.operator
Binding: R5QuestionnaireEnableOperatorForR3 (0.1.0) (required): The criteria by which a question is enabled.
...... value 0..1 boolean Primitive value for boolean
..... answer[x] C 0..1 Value question must have
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerUri uri
...... answerAttachment Attachment
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... required C 0..1 boolean Whether the item must be included in data results
.... repeats C 0..1 boolean Whether the item may repeat
.... readOnly C 0..1 boolean Don't allow human editing
.... maxLength C 0..1 integer No more than this many characters
.... options C 0..1 Reference(ValueSet) Valueset containing permitted answers
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answerValueSet 0..1 uri R5: ValueSet containing permitted answers additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerValueSet
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... option C 0..* BackboneElement Permitted answer
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.value
...... extension:initialSelected 0..1 boolean R5: Whether option is selected by default (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.initialSelected
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... value[x] 1..1 Answer value
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
.... initial[x] C 0..1 Default value when item is first rendered
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
..... initial[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Actual value for initializing the question
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... initialBoolean boolean
..... initialDecimal decimal
..... initialInteger integer
..... initialDate date
..... initialDateTime dateTime
..... initialTime time
..... initialString string
..... initialUri uri
..... initialAttachment Attachment
..... initialCoding Coding
..... initialQuantity Quantity
..... initialReference Reference(Resource)
.... item C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Questionnaire.status Base required PublicationStatus 📍3.0.2 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍3.0.2 FHIR Std.
Questionnaire.subjectType Base required ResourceType . 📍3.0.2 tx.fhir.org
Questionnaire.item.code Base example Questionnaire Question Codes 📍3.0.2 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍3.0.2 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.
Questionnaire.item.option.​value[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.
Questionnaire.item.initial[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If 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()
dom-4 error Questionnaire If 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-1 error Questionnaire.item Group 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item A question cannot have both option and options option.empty() or options.empty()
que-5 error Questionnaire.item Only 'choice' items can have options (type ='choice' or type = 'open-choice') or (options.empty() and option.empty())
que-6 error Questionnaire.item Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen enableWhen must contain either a 'answer' or a 'hasAnswer' element hasAnswer.exists() xor answer.exists()
que-8 error Questionnaire.item Default values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item Maximum length can only be declared for simple question types (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()

This structure is derived from Questionnaire

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-2
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.status Base required PublicationStatus 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If 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()
dom-4 error Questionnaire If 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()

Differential View

This structure is derived from Questionnaire

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire 0..* Questionnaire A structured set of questions
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.contact
... subjectType
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subjectType 0..* code R5: subjectType additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:enableBehavior 0..1 code R5: all | any (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableBehavior
Binding: R5QuestionnaireEnableBehaviorForR3 (0.1.0) (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... extension:disabledDisplay 0..1 code R5: hidden | protected (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
Binding: R5QuestionnaireDisabledDisplayForR3 (0.1.0) (required): Defines how disabled elements should be rendered
..... extension:answerConstraint 0..1 code R5: optionsOnly | optionsOrType | optionsOrString (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
Binding: R5QuestionnaireAnswerConstraintForR3 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified
.... enableWhen
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answer 1..1 decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Value for question comparison based on operator additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.answer
..... hasAnswer
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:operator 1..1 code R5: exists | = | != | > | < | >= | <= additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.operator
Binding: R5QuestionnaireEnableOperatorForR3 (0.1.0) (required): The criteria by which a question is enabled.
.... options
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answerValueSet 0..1 uri R5: ValueSet containing permitted answers additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerValueSet
.... option
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.value
...... extension:initialSelected 0..1 boolean R5: Whether option is selected by default (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.initialSelected
.... initialReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Actual value for initializing the question
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Questionnaire C 0..* Questionnaire A structured set of questions
Constraints: que-2
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages . (extensible): A human language.
Additional BindingsPurpose
All Languages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:versionAlgorithm 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm]] R5: How to compare versions (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
.... extension:derivedFrom 0..* uri R5: Based on Questionnaire (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.derivedFrom
.... extension:copyrightLabel 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel]] R5: Copyright holder and year(s) (new)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Logical URI to reference this questionnaire (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the questionnaire
... version Σ 0..1 string Business version of the questionnaire
... name Σ 0..1 string Name for this questionnaire (computer friendly)
... title Σ 0..1 string Name for this questionnaire (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of a Value Set or Concept Map.
... experimental ?!Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date this was last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... description 0..1 markdown Natural language description of the questionnaire
... purpose 0..1 markdown Why this questionnaire is defined
... approvalDate 0..1 date When the questionnaire was approved by publisher
... lastReviewDate 0..1 date When the questionnaire was last reviewed
... effectivePeriod Σ 0..1 Period When the questionnaire is expected to be used
... useContext Σ 0..* UsageContext Context the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for questionnaire (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use
... contact Σ 0..* ContactDetail Contact details for the publisher
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:contact 0..* (Complex) R5: contact additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.contact
.... name Σ 0..1 string Name of an individual to contact
.... telecom Σ 0..* ContactPoint Contact details for individual or organization
... copyright 0..1 markdown Use and/or publishing restrictions
... code Σ 0..* Coding Concept that represents the overall questionnaire
Binding: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions
... subjectType Σ 0..* code Resource that can be subject of QuestionnaireResponse
Binding: ResourceType . (required): One of the resource types defined as part of FHIR.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subjectType 0..* code R5: subjectType additional codes
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.subjectType
Binding: R5ResourceTypesForR3 (0.1.0) (required): One of the resource types defined as part of this version of FHIR.
.... value 0..1 code Primitive value for code
... item C 0..* BackboneElement Questions and sections within the Questionnaire
Constraints: que-9, que-8, que-6, que-5, que-4, que-3, que-10, que-1
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:enableBehavior 0..1 code R5: all | any (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableBehavior
Binding: R5QuestionnaireEnableBehaviorForR3 (0.1.0) (required): Controls how multiple enableWhen values are interpreted - whether all or any must be true.
..... extension:disabledDisplay 0..1 code R5: hidden | protected (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.disabledDisplay
Binding: R5QuestionnaireDisabledDisplayForR3 (0.1.0) (required): Defines how disabled elements should be rendered
..... extension:answerConstraint 0..1 code R5: optionsOnly | optionsOrType | optionsOrString (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerConstraint
Binding: R5QuestionnaireAnswerConstraintForR3 (0.1.0) (required): Indicates differnt modes for restricting values when options or valueset are specified
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... linkId 1..1 string Unique id for item in questionnaire
.... definition 0..1 uri ElementDefinition - details for the item
.... code ΣC 0..* Coding Corresponding concept for this item in a terminology
Binding: Questionnaire Question Codes (example): Codes for questionnaires, groups and individual questions
.... prefix 0..1 string E.g. "1(a)", "2.5.3"
.... text Σ 0..1 string Primary text for the item
.... type 1..1 code group | display | boolean | decimal | integer | date | dateTime +
Binding: QuestionnaireItemType (required): Distinguishes groups from questions and display text and indicates data type for questions
.... enableWhen ?!ΣC 0..* BackboneElement Only allow data when
Constraints: que-7
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answer 1..1 decimal, integer, date, dateTime, time, string, Coding, Quantity, Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: Value for question comparison based on operator additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.answer
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... question 1..1 string Question that determines whether item is enabled
..... hasAnswer C 0..1 boolean Enable when answered or not
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:operator 1..1 code R5: exists | = | != | > | < | >= | <= additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.enableWhen.operator
Binding: R5QuestionnaireEnableOperatorForR3 (0.1.0) (required): The criteria by which a question is enabled.
...... value 0..1 boolean Primitive value for boolean
..... answer[x] C 0..1 Value question must have
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
...... answerBoolean boolean
...... answerDecimal decimal
...... answerInteger integer
...... answerDate date
...... answerDateTime dateTime
...... answerTime time
...... answerString string
...... answerUri uri
...... answerAttachment Attachment
...... answerCoding Coding
...... answerQuantity Quantity
...... answerReference Reference(Resource)
.... required C 0..1 boolean Whether the item must be included in data results
.... repeats C 0..1 boolean Whether the item may repeat
.... readOnly C 0..1 boolean Don't allow human editing
.... maxLength C 0..1 integer No more than this many characters
.... options C 0..1 Reference(ValueSet) Valueset containing permitted answers
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:answerValueSet 0..1 uri R5: ValueSet containing permitted answers additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerValueSet
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... option C 0..* BackboneElement Permitted answer
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:value 0..1 Reference(Cross-version Profile for R5.Resource for use in FHIR STU3(0.1.0) | Resource) R5: value additional types
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.value
...... extension:initialSelected 0..1 boolean R5: Whether option is selected by default (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Questionnaire.item.answerOption.initialSelected
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... value[x] 1..1 Answer value
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
...... valueInteger integer
...... valueDate date
...... valueTime time
...... valueString string
...... valueCoding Coding
.... initial[x] C 0..1 Default value when item is first rendered
Binding: Questionnaire Answer Codes (example): Allowed values to answer questions.
..... initial[x]All Types Content/Rules for all Types
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R5: Actual value for initializing the question
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... initialBoolean boolean
..... initialDecimal decimal
..... initialInteger integer
..... initialDate date
..... initialDateTime dateTime
..... initialTime time
..... initialString string
..... initialUri uri
..... initialAttachment Attachment
..... initialCoding Coding
..... initialQuantity Quantity
..... initialReference Reference(Resource)
.... item C 0..* See item (Questionnaire) Nested questionnaire items

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Questionnaire.language Base extensible Common Languages . 📍3.0.2 tx.fhir.org
Questionnaire.status Base required PublicationStatus 📍3.0.2 FHIR Std.
Questionnaire.jurisdiction Base extensible Jurisdiction ValueSet 📍3.0.2 FHIR Std.
Questionnaire.code Base example Questionnaire Question Codes 📍3.0.2 FHIR Std.
Questionnaire.subjectType Base required ResourceType . 📍3.0.2 tx.fhir.org
Questionnaire.item.code Base example Questionnaire Question Codes 📍3.0.2 FHIR Std.
Questionnaire.item.type Base required QuestionnaireItemType 📍3.0.2 FHIR Std.
Questionnaire.item.enableWhen.​answer[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.
Questionnaire.item.option.​value[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.
Questionnaire.item.initial[x] Base example Questionnaire Answer Codes 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.empty()
dom-2 error Questionnaire If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Questionnaire If 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()
dom-4 error Questionnaire If 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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
que-1 error Questionnaire.item Group 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-2 error Questionnaire The link ids for groups and questions must be unique within the questionnaire descendants().linkId.isDistinct()
que-3 error Questionnaire.item Display items cannot have a "code" asserted type!='display' or code.empty()
que-4 error Questionnaire.item A question cannot have both option and options option.empty() or options.empty()
que-5 error Questionnaire.item Only 'choice' items can have options (type ='choice' or type = 'open-choice') or (options.empty() and option.empty())
que-6 error Questionnaire.item Required and repeat aren't permitted for display items type!='display' or (required.empty() and repeats.empty())
que-7 error Questionnaire.item.enableWhen enableWhen must contain either a 'answer' or a 'hasAnswer' element hasAnswer.exists() xor answer.exists()
que-8 error Questionnaire.item Default values can't be specified for groups or display items (type!='group' and type!='display') or initial.empty()
que-9 error Questionnaire.item Read-only can't be specified for "display" items type!='display' or readOnly.empty()
que-10 error Questionnaire.item Maximum length can only be declared for simple question types (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty()

This structure is derived from Questionnaire

 

Other representations of profile: CSV, Excel, Schematron