2nd DSTU Draft For Comment

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

Profile Structured Data Capture Questionnaire Design - Definitions

Todo

Definitions for the questionnaire-sdc-structureddatacaptureform Profile.

Questionnaire(StructuredDataCaptureForm)
Definition

A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.

Control1..1
Requirements

To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.

Alternate NamesForm, CRF, Survey
Comments
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)))
Questionnaire.id
Definition

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

Control0..1
Typeid
Requirements
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
Requirements
Comments
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
Requirements
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
Requirements
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
Requirements
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
Requirements
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
Requirements
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/ExtensionDefinition/questionnaire-sdc-endpoint)
Definition

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

Control0..*
Typeuri
Requirements
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.

Questionnaire.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typeboolean
Requirements
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/ExtensionDefinition/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
BindingClassifications for questionnaires. Can include such concepts as "intake form", "opinion survey", "clinical research questionnaire", "pediatric", etc.
TypeCodeableConcept
Requirements
Comments
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
Requirements
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 processed 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.

Comments
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
Comments
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
Requirements
Comments
Questionnaire.date
Definition

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

Control1..1
TypedateTime
Must Supporttrue
Requirements
Alternate NamesDate Created, Date published, Date Issued, Date updated
Comments
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".

Comments
Questionnaire.telecom
Definition

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

Control0..*
TypeContactPoint
Requirements
Comments
Questionnaire.group(group)
Definition

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

Control1..1
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
Requirements
Comments
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
Requirements
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/ExtensionDefinition/questionnaire-label)
Definition

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

Control0..1
Typestring
Requirements
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
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-trailing)
Definition

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

Control0..1
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-sdc-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
Typeboolean
Requirements
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.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-hidden)
Definition

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

Control0..1
Typeboolean
Requirements
Comments

Some questionnaires may have questions that represent calculated values or internal "fixed" metadata. These elements need to be included with the answers, but should not be displayed to the user.

Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typeinteger
Requirements
Comments

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

Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typeinteger
Requirements
Comments

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

Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-sdc-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
Typecode
Requirements
Comments

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

Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-trailing)
Definition

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

Control0..1
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
Questionnaire.group.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-units)
Definition

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

Control0..1
Typestring
Requirements
Comments
Questionnaire.group.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
Questionnaire.group.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
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

Questionnaire.group.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..1
Type*
Requirements
Comments
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
Requirements
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 QuestionnaireAnswers resource.

Control1..1
Typestring
Must Supporttrue
Requirements

QuestionnaireAnswers 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 id (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.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
Requirements
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/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.title.value
Definition

The actual value

Control0..1
Typexsd:string
Requirements
Comments
Questionnaire.group.concept
Definition

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

Control0..1
BindingCodes for questionnaires and groupings of questionnaire questions
TypeCoding
Must Supporttrue
Requirements

Allows linking of groups of questions (and complete questionnaires) 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.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
Requirements
Comments
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.

Comments
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.

Comments
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
Must Supporttrue
Requirements

Must register answers to questions.

Alternate NamesResponses, Contents
Comments
Questionnaire.group.question.id
Definition

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

Control0..1
Typeid
Requirements
Comments
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
Requirements
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/ExtensionDefinition/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
Typeinteger
Requirements
Comments

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

Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typeinteger
Requirements
Comments

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

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

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

Control0..1
Typestring
Requirements
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
Requirements
Comments
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
Requirements
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/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.question.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

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..1
Type*
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/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..*
Requirements
Comments

Allows questionnaires to adapt based on answers to prior questions. E.g. If physical gender is specified as a male, no need to capture pregnancy history.

Questionnaire.group.question.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
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
Requirements
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/ExtensionDefinition/questionnaire-enableWhen#question)
Definition

The linkId for the question whose answer must be present in order for the "enable" to be triggered.

Control1..1
Typestring
Requirements
Comments
Questionnaire.group.question.extension.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-enableWhen#answer)
Definition

If present, then the specified question must match the specified answer for all components present in the enableWhen.answer.

Control0..1
Type*
Requirements
Comments
Questionnaire.group.question.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

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..1
Type*
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-sdc-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
Typeboolean
Requirements
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/ExtensionDefinition/questionnaire-hidden)
Definition

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

Control0..1
Typeboolean
Requirements
Comments

Some questionnaires may have questions that represent calculated values or internal "fixed" metadata. These elements need to be included with the answers, but should not be displayed to the user.

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

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

Control0..1
Type*
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-defaultAsFixed)
Definition

If true, the default value is set as a fixed "answer" for the question.

Control0..1
Typeboolean
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/minLength)
Definition

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

Control0..1
Typeinteger
Requirements
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/ExtensionDefinition/maxLength)
Definition

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

Control0..1
Typeinteger
Requirements
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/ExtensionDefinition/regex)
Definition

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

Control0..1
Typestring
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/minValue)
Definition

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

Control0..1
TypeChoice of: date, dateTime, time, instant, decimal, integer
Requirements
Comments

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

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

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

Control0..1
TypeChoice of: date, dateTime, time, instant, decimal, integer
Requirements
Comments

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

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

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

Control0..1
Typeinteger
Requirements
Comments
Questionnaire.group.question.extension (http://hl7.org/fhir/ExtensionDefinition/questionnaire-deReference)
Definition

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

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/DataElement))
Requirements
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.extension.id
Definition

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

Control0..1
Typeid
Requirements
Comments
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
Requirements
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/ExtensionDefinition/style)
Definition

Identifies how the specified element should be rendered when displayed.

Control0..1
Typestring
Requirements
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.extension (http://hl7.org/fhir/ExtensionDefinition/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
Typestring
Requirements
Comments
Questionnaire.group.question.extension.url
Definition

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

Control1..1
Typeuri
Requirements
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 #.

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..1
Type*
Requirements
Comments
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
Requirements
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 QuestionnaireAnswers resource.

Control1..1
Typestring
Must Supporttrue
Requirements

QuestionnaireAnswers 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 id (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..*
TypeCoding
Requirements

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

Comments
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.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

Additional constraints on the type of answer can be conveyed by extensions.

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
Requirements
Comments
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 valueset containing the possible options.

Control0..1
TypeReference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet))
Must Supporttrue
Requirements
Comments
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.

Comments