DSTU2

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

B.4.1.4 StructureDefinition: SDC-Questionnaire - Detailed Descriptions

Definitions for the sdc-questionnaire Profile.

Questionnaire(SDC-Questionnaire)
Definition

Sets minimum expectations for questionnaire support for SDC-conformant systems, including a number of extensions around display and behavior.

Control0..*
TypeQuestionnaire
Alternate NamesForm, CRF, Survey
InvariantsDefined on this element
que-2: The link ids for groups and questions must be unique within the questionnaire (xpath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value)))
que-3: If root group must be "required" (xpath: f:group/f:required/@value=true())
Questionnaire.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Questionnaire.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Questionnaire.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Questionnaire.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Questionnaire.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Questionnaire.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Questionnaire.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint)
Definition

The base URL for the server to which questionnaire response associated with this questionnaire should be submitted.

Control0..*
TypeExtension (Extension Type: uri)
Comments

Indicates that the form has been designed with an expectation that it will be submitted to the specified URI. If multiple endpoints are specified, expectation is that answers are submitted to all endpoints.

If no end-point is specified, then the form is not exclusively designed to be submitted to a specific site. If and where the form needs to be submitted or how the form should be internally processed must be inferred from external context or system business rules.

Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred)
Definition

If true, indicates that QuestionnaireResponse instances created against this questionnaire must have an associated Provenance record.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

Systems may choose to require that the QuestionnaireResponse and referencing Provenance instance be submitted together as a single transaction using Bundle.

Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/styleSensitive)
Definition

Indicates that the style extensions in this resource are essential to the interpretation of the styled text and that it cannot be rendered without the style without losing essential information.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If set to true, all systems that claim to support this extension and which render elements of the resource containing this extension SHALL either render the content as required by the style extensions defined by this profile that are present in the resource or shall (if safe to do so based on their own rules), omit entirely the styled content they cannot render in accordance with the extensions.

Questionnaire.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-category)
Definition

A code that identifies the questionnaire as falling into a particular group of like questionnaires; e.g. "Pediatric", "Admissions", "Research", "Demographic", "Opinion Survey", etc.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
Questionnaire.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.identifier
Definition

This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Control0..*
TypeIdentifier
Must Supporttrue
Requirements

Need to allow connection to a wider workflow.

Questionnaire.version
Definition

The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.

Control0..1
Typestring
Must Supporttrue
Requirements

In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).

Alternate NamesN/A - MIF rather than RIM level
Questionnaire.status
Definition

The lifecycle status of the questionnaire as a whole.

Control1..1
BindingLifecycle status of the questionnaire.
The codes SHALL be taken from QuestionnaireStatus
Typecode
Is Modifiertrue
Must Supporttrue
Questionnaire.date
Definition

Identifies when this version of the form was created. Changes whenever the form is updated.

Control1..1
TypedateTime
Must Supporttrue
Alternate NamesDate created, Date published, Date issued, Date updated
Questionnaire.publisher
Definition

Organization or person responsible for developing and maintaining the questionnaire.

Control0..1
Typestring
Must Supporttrue
Requirements

Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's "authority".

Questionnaire.telecom
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactPoint
Questionnaire.subjectType
Definition

Identifies the types of subjects that can be the subject of the questionnaire.

Control0..*
BindingOne of the resource types defined as part of FHIR.
The codes SHALL be taken from ResourceType
Typecode
Must Supporttrue
Comments

If none are specified, then the subject is unlimited.

Questionnaire.group
Definition

A collection of related questions (or further groupings of questions).

Control1..1 This element is affected by the following invariants: que-3
TypeBackboneElement
Must Supporttrue
Requirements

Need to be able to logically group answers to grouped questions.

Alternate NamesSection
Comments

The Questionnaire itself has one "root" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.

InvariantsDefined on this element
que-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question)))
Questionnaire.group.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-label)
Definition

A label for a particular group or question within the questionnaire.

Control0..1
TypeExtension (Extension Type: string)
Comments

These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.

Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-label
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-instruction)
Definition

The text provides instructions intended to be rendered with the element explaining how the content of the element is to be completed. This should be rendered in-line before the question or group.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-instruction
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-security)
Definition

The text describes specific security and/or privacy considerations associated with the element; e.g. retention rules, data access control expectations, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-security
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-help)
Definition

The content is intended for display if a user selects an icon or performs some other action seeking help about the element.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-help
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-tooltip)
Definition

The content is intended for use in a fly-over or similar display mechanism - primarily intended for online form entry.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-tooltip
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-trailing)
Definition

The text should be displayed after all of the other the content of the group or question.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-trailing
Questionnaire.group.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay)
Definition

If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the question from display to the user.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional.

Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-hidden)
Definition

If true, indicates that the containing group or question should not be displayed to the user for data entry.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If a group is hidden, all descendant content of the group is automatically hidden.

Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs)
Definition

The minimum number of times the group must appear or the minimum number of answers for a question - when greater than 1.

Control0..1
TypeExtension (Extension Type: integer)
Comments

Default assumption for "required" elements is minOccurs=1.

InvariantsDefined on this element
inv-1: minOccurs can't be more than one if required is false (xpath: f:valueInteger/@value=0 or parent::*/f:required/@value=true())
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs)
Definition

The maximum number of times the group must appear or the minimum number of answers for a question - when greater than 1 and not unlimited.

Control0..1
TypeExtension (Extension Type: integer)
Comments

Only relevant if the element has repeats=true and there's a need to constrain the number of allowed repetitions.

InvariantsDefined on this element
inv-2: maxOccurs can't be more than one if repeats is false (xpath: f:valueInteger/@value<=1 or parent::*/f:repeats/@value=true())
Questionnaire.group.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-specialGroup)
Definition

If specified, indicates that the group should be rendered as a repeating header or footer on each "page" of the questionnaire.

Control0..1
TypeExtension (Extension Type: code)
Comments

When omitted, sections are presumed to be "regular" sections.

Questionnaire.group.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.group.linkId
Definition

An identifier that is unique within the Questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource.

Control1..1
Typestring
Must Supporttrue
Requirements

QuestionnaireResponse does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.

Comments

May be omitted if there is no expectation to link answers back to a questionnaire. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Questionnaire.group.title
Definition

The human-readable name for this section of the questionnaire.

Control0..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire with the answers, sections may have a section header.

Comments

The title of the "root" group is the title for the questionnaire.

Questionnaire.group.title.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.title.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.title.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.title.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.title.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.concept
Definition

Identifies a how this group of questions is known in a particular terminology such as LOINC.

Control0..1
BindingCodes for groupings of questionnaire questions.
For example codes, see Questionnaire Question Codes
TypeCoding
Must Supporttrue
Requirements

Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.

Comments

The code(s) for the "root" group apply to the questionnaire as a whole.

Questionnaire.group.text
Definition

Additional text for the group, used for display purposes.

Control0..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire, each section may contain additional explanations are background text.

Comments

Common extensions are defined for more specialized types of display text.

Questionnaire.group.text.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.text.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.text.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.text.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.text.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.required
Definition

If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnaire.

Control1..1
Typeboolean
Must Supporttrue
Default Valuefalse
Questionnaire.group.repeats
Definition

Whether the group may occur multiple times in the instance, containing multiple sets of answers.

Control1..1
Typeboolean
Must Supporttrue
Requirements

Groups may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Default Valuefalse
Questionnaire.group.group
Definition

A sub-group within a group. The ordering of groups within this group is relevant.

Control0..* This element is affected by the following invariants: que-1
TypeSee group
Must Supporttrue
Requirements

Reports can consist of complex nested groups.

Questionnaire.group.question
Definition

Set of questions within this group. The order of questions within the group is relevant.

Control0..* This element is affected by the following invariants: que-1
TypeBackboneElement
Must Supporttrue
Requirements

Must register answers to questions.

Alternate NamesResponses, Contents
InvariantsDefined on this element
que-4: A question must use either option or options, not both (xpath: not(f:options and f:option))
Questionnaire.group.question.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs)
Definition

The minimum number of times the group must appear or the minimum number of answers for a question - when greater than 1.

Control0..1
TypeExtension (Extension Type: integer)
Comments

Default assumption for "required" elements is minOccurs=1.

InvariantsDefined on this element
inv-1: minOccurs can't be more than one if required is false (xpath: f:valueInteger/@value=0 or parent::*/f:required/@value=true())
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs)
Definition

The maximum number of times the group must appear or the minimum number of answers for a question - when greater than 1 and not unlimited.

Control0..1
TypeExtension (Extension Type: integer)
Comments

Only relevant if the element has repeats=true and there's a need to constrain the number of allowed repetitions.

InvariantsDefined on this element
inv-2: maxOccurs can't be more than one if repeats is false (xpath: f:valueInteger/@value<=1 or parent::*/f:repeats/@value=true())
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-label)
Definition

A label for a particular group or question within the questionnaire.

Control0..1
TypeExtension (Extension Type: string)
Comments

These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.

Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-label
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-instruction)
Definition

The text provides instructions intended to be rendered with the element explaining how the content of the element is to be completed. This should be rendered in-line before the question or group.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-instruction
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-security)
Definition

The text describes specific security and/or privacy considerations associated with the element; e.g. retention rules, data access control expectations, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-security
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-help)
Definition

The content is intended for display if a user selects an icon or performs some other action seeking help about the element.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-help
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-tooltip)
Definition

The content is intended for use in a fly-over or similar display mechanism - primarily intended for online form entry.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-tooltip
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-trailing)
Definition

The text should be displayed after all of the other the content of the group or question.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-trailing
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-units)
Definition

Identifies the units in which the question's answer should be captured.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-units
Questionnaire.group.question.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.valueString.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.extension.valueString.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.extension.valueString.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension.valueString.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen)
Definition

If present, indicates that the group or question containing the extension should only be enabled (allow an answer to be present and, in most circumstances, even be visible to the user) when the specified condition is true.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Comments

If multiple repetitions of this extension are present, the question or group should be displayed when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

Questionnaire.group.question.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.extension.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#question)
Definition

If present, indicates that the group or question containing the extension should only be enabled (allow an answer to be present and, in most circumstances, even be visible to the user) when the specified condition is true.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Comments

If multiple repetitions of this extension are present, the question or group should be displayed when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

Questionnaire.group.question.extension.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuequestion
Questionnaire.group.question.extension.extension.valueString
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typestring
Questionnaire.group.question.extension.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answered)
Definition

If present, indicates that the group or question containing the extension should only be enabled (allow an answer to be present and, in most circumstances, even be visible to the user) when the specified condition is true.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Comments

If multiple repetitions of this extension are present, the question or group should be displayed when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

Questionnaire.group.question.extension.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valueanswered
Questionnaire.group.question.extension.extension.valueBoolean
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
Typeboolean
Questionnaire.group.question.extension.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answer)
Definition

If present, indicates that the group or question containing the extension should only be enabled (allow an answer to be present and, in most circumstances, even be visible to the user) when the specified condition is true.

Control0..*
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Comments

If multiple repetitions of this extension are present, the question or group should be displayed when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

Questionnaire.group.question.extension.extension.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Questionnaire.group.question.extension.extension.extension(extension)
Definition

An Extension

Control0..0
TypeExtension
Questionnaire.group.question.extension.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valueanswer
Questionnaire.group.question.extension.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Questionnaire.group.question.extension.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen
Questionnaire.group.question.extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control0..0
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay)
Definition

If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the question from display to the user.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If a group or question that contains other groups or questions is marked as "optional", all of its contents are automatically also treated as optional.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-hidden)
Definition

If true, indicates that the containing group or question should not be displayed to the user for data entry.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

If a group is hidden, all descendant content of the group is automatically hidden.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-questionControl)
Definition

The type of data entry control that should be exposed to the user when capturing the answer to the question.

Control0..1
TypeExtension (Extension Type: CodeableConcept)
Comments

Different controls may be appropriate for different question data types. It is up to the system rendering a questionnaire as to what controls it will support and for which data types.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation)
Definition

Identifies the desired orientation when rendering a list of choices (typically radio-box or check-box lists).

Control0..1
TypeExtension (Extension Type: code)
Comments

Systems may choose to wrap answers rather than attempting to display them all in one row or column. Language conventions may determine the order in which the choices are listed (left-to-right or right-to-left, etc.).

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-defaultValue)
Definition

This is the value that should be pre-populated when rendering the questionnaire for user input.

Control0..1
TypeExtension (Extension Type: Choice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta)
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-readOnly)
Definition

If true, the value cannot be changed by a human respondent to the Questionnaire.

Control0..1
TypeExtension (Extension Type: boolean)
Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/minLength)
Definition

The minimum number of characters that must be present in the simple data type to be considered a "valid" instance.

Control0..1
TypeExtension (Extension Type: integer)
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-maxLength)
Definition

The maximum number of characters that must be present in the simple data type to be considered a "valid" instance.

Control0..1
TypeExtension (Extension Type: integer)
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/regex)
Definition

A regular expression that defines the syntax for the data element to be considered valid.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/entryFormat)
Definition

A syntax intended for display to the user to guide their input (i.e. a human readable version of a regular expression). For example "nnn-nnn-nnn".

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/minValue)
Definition

The inclusive lower bound on the range of allowed values for the data element.

Control0..1
TypeExtension (Extension Type: Choice of: date, dateTime, time, instant, decimal, integer)
Comments

Data type specified must be the same as the data type for the data element.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/maxValue)
Definition

The inclusive upper bound on the range of allowed values for the data element.

Control0..1
TypeExtension (Extension Type: Choice of: date, dateTime, time, instant, decimal, integer)
Comments

Data type specified must be the same as the data type for the data element.

Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces)
Definition

Identifies the maximum number of decimal places that may be specified for the data element.

Control0..1
TypeExtension (Extension Type: integer)
Questionnaire.group.question.extension (http://hl7.org/fhir/StructureDefinition/questionnaire-deReference)
Definition

A reference to the Data Element that corresponds to the question text and answer constraints for this question.

Control0..1
TypeExtension (Extension Type: Reference(DataElement))
Comments

If a code applies to a question, that code should still be conveyed on the question, even if the same code is also referenced as a DataElement.code in the referenced data element. This extension must not be used in place of specifying the Questionnaire.group.question.concept element.

Questionnaire.group.question.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Questionnaire.group.question.linkId
Definition

An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resource.

Control1..1
Typestring
Must Supporttrue
Requirements

QuestionnaireResponse does not require omitted groups to be included and may have some groups that repeat, so linkage based on position alone is not sufficient.

Comments

May be omitted if there is no expectation to link answers back to a questionnaire. This can be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Questionnaire.group.question.concept
Definition

Identifies a how this question is known in a particular terminology such as LOINC.

Control0..*
BindingCodes corresponding to individual questions.
For example codes, see Questionnaire Question Codes
TypeCoding
Requirements

Allows linking of questions (and their answers) to formal terminologies.

Questionnaire.group.question.text
Definition

The actual question as shown to the user to prompt them for an answer.

Control1..1
Typestring
Must Supporttrue
Requirements

When including text for the questionnaire, each question may contain its actual question display text.

Alternate NamesQuestion
Comments

Common extensions are defined for more specialized types of display text.

Questionnaire.group.question.text.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typeid
Questionnaire.group.question.text.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Questionnaire.group.question.text.extension (http://hl7.org/fhir/StructureDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
TypeExtension (Extension Type: string)
Comments

This extension would be equivalent to setting the HTML "style" attribute on the root element for the element containing the extension.

Questionnaire.group.question.text.extension (http://hl7.org/fhir/StructureDefinition/markup)
Definition

This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc.

Control0..1
TypeExtension (Extension Type: string)
Questionnaire.group.question.text.value
Definition

The actual value

Control0..1
Max Length1048576
Questionnaire.group.question.type
Definition

The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.

Control1..1
BindingThe expected format of an answer.
The codes SHALL be taken from AnswerFormat
Typecode
Must Supporttrue
Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Time is handled using "string". File is handled using Attachment. (Content can be sent as a contained binary).

Questionnaire.group.question.required
Definition

If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnaire.

Control0..1
Typeboolean
Must Supporttrue
Default Valuefalse
Questionnaire.group.question.repeats
Definition

If true, the question may have more than one answer.

Control0..1
Typeboolean
Must Supporttrue
Requirements

Used for "check all that apply" types of questions or "list your top 3", etc.

Comments

Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.

Default Valuefalse
Questionnaire.group.question.options
Definition

Reference to a value set containing a list of codes representing permitted answers for the question.

Control0..1 This element is affected by the following invariants: que-4
TypeReference(ValueSet)
Must Supporttrue
Comments

LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists.

Questionnaire.group.question.option
Definition

For a "choice" question, identifies one of the permitted answers for the question.

Control0..* This element is affected by the following invariants: que-4
BindingAllowed values to answer questions.
For example codes, see Questionnaire Answer Codes
TypeCoding
Must Supporttrue
Questionnaire.group.question.group
Definition

Nested group, containing nested question for this question. The order of groups within the question is relevant.

Control0..*
TypeSee group
Must Supporttrue
Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.