Data Model Libraries
    Preparing search index...

    Class Questionnaire

    Questionnaire Class

    A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.

    To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. Questionnaires provide greater control over presentation and allow capture of data in a domain-independent way (i.e. capturing information that would otherwise require multiple distinct types of resources).

    FHIR Specification

    • Short: A structured set of questions
    • Definition: A structured set of questions intended to guide the collection of answers from end-users. Questionnaires provide detailed control over order, presentation, phraseology and grouping to allow coherent, consistent data collection.
    • FHIR Version: 4.0.1

    FHIR Questionnaire

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? name? title? derivedFrom? publicationStatusEnum status experimental? resourceTypesEnum subjectType? date? publisher? contact? description? useContext? jurisdiction? purpose? copyright? approvalDate? lastReviewDate? effectivePeriod? code? item?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getDerivedFromElement setDerivedFromElement addDerivedFromElement hasDerivedFromElement getDerivedFrom setDerivedFrom addDerivedFrom hasDerivedFrom getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getSubjectTypeEnumType setSubjectTypeEnumType addSubjectTypeEnumType hasSubjectTypeEnumType getSubjectTypeElement setSubjectTypeElement addSubjectTypeElement hasSubjectTypeElement getSubjectType setSubjectType addSubjectType hasSubjectType getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getApprovalDateElement setApprovalDateElement hasApprovalDateElement getApprovalDate setApprovalDate hasApprovalDate getLastReviewDateElement setLastReviewDateElement hasLastReviewDateElement getLastReviewDate setLastReviewDate hasLastReviewDate getEffectivePeriod setEffectivePeriod hasEffectivePeriod getCode setCode addCode hasCode getItem setItem addItem hasItem fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initDerivedFrom initSubjectType initContact initUseContext initJurisdiction initCode initItem

    Constructors

    Properties

    url?: UriType

    Questionnaire.url Element

    FHIR Specification

    • Short: Canonical identifier for this questionnaire, represented as a URI (globally unique)
    • Definition: An absolute URI that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this questionnaire is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the questionnaire is stored on different servers.
    • Comment: The name of the referenced questionnaire can be conveyed using the http://hl7.org/fhir/StructureDefinition/display extension.
    • Requirements: ... This is the id that will be used to link a QuestionnaireResponse to the Questionnaire the response is for.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    Questionnaire.identifier Element

    FHIR Specification

    • Short: Additional identifier for the questionnaire
    • Definition: A formal identifier that is used to identify this questionnaire when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this questionnaire outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    Questionnaire.version Element

    FHIR Specification

    • Short: Business version of the questionnaire
    • Definition: The identifier that is used to identify this version of the questionnaire when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the questionnaire author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Comment: There may be different questionnaire instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the questionnaire with the format [url]|[version].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    Questionnaire.name Element

    FHIR Specification

    • Short: Name for this questionnaire (computer friendly)
    • Definition: A natural language name identifying the questionnaire. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    Questionnaire.title Element

    FHIR Specification

    • Short: Name for this questionnaire (human friendly)
    • Definition: A short, descriptive, user-friendly title for the questionnaire.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    derivedFrom?: CanonicalType[]

    Questionnaire.derivedFrom Element

    FHIR Specification

    • Short: Instantiates protocol or definition
    • Definition: The URL of a Questionnaire that this Questionnaire is based on.
    • Requirements: Allows a Questionnaire to be created based on another Questionnaire.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    Questionnaire.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this questionnaire. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of questionnaires that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    Questionnaire.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this questionnaire is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of questionnaires that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level questionnaire.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    resourceTypesEnum: ResourceTypesEnum

    FHIR CodeSystem: ResourceTypes

    ResourceTypesEnum

    subjectType?: EnumCodeType[]

    Questionnaire.subjectType Element

    FHIR Specification

    • Short: Resource that can be subject of QuestionnaireResponse
    • Definition: The types of subjects that can be the subject of responses created for the questionnaire.
    • Comment: If none are specified, then the subject is unlimited.
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ResourceTypesEnum

    date?: DateTimeType

    Questionnaire.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the questionnaire was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the questionnaire changes.
    • Comment: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the questionnaire. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    Questionnaire.publisher Element

    FHIR Specification

    • Short: Name of the publisher (organization or individual)
    • Definition: The name of the organization or individual that published the questionnaire.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the questionnaire is the organization or individual primarily responsible for the maintenance and upkeep of the questionnaire. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the questionnaire. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the questionnaire. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    Questionnaire.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    Questionnaire.description Element

    FHIR Specification

    • Short: Natural language description of the questionnaire
    • Definition: A free text natural language description of the questionnaire from a consumer's perspective.
    • Comment: This description can be used to capture details such as why the questionnaire was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the questionnaire as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the questionnaire is presumed to be the predominant language in the place the questionnaire was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    useContext?: UsageContext[]

    Questionnaire.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate questionnaire instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    Questionnaire.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for questionnaire (if applicable)
    • Definition: A legal or geographic region in which the questionnaire is intended to be used.
    • Comment: It may be possible for the questionnaire to be used in jurisdictions other than those for which it was originally designed or intended.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    Questionnaire.purpose Element

    FHIR Specification

    • Short: Why this questionnaire is defined
    • Definition: Explanation of why this questionnaire is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the questionnaire. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this questionnaire.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    copyright?: MarkdownType

    Questionnaire.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the questionnaire and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the questionnaire.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the questionnaire and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    approvalDate?: DateType

    Questionnaire.approvalDate Element

    FHIR Specification

    • Short: When the questionnaire was approved by publisher
    • Definition: The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
    • Comment: The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastReviewDate?: DateType

    Questionnaire.lastReviewDate Element

    FHIR Specification

    • Short: When the questionnaire was last reviewed
    • Definition: The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
    • Comment: If specified, this date follows the original approval date.
    • Requirements: Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    effectivePeriod?: Period

    Questionnaire.effectivePeriod Element

    FHIR Specification

    • Short: When the questionnaire is expected to be used
    • Definition: The period during which the questionnaire content was or is planned to be in active use.
    • Comment: The effective period for a questionnaire determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.
    • Requirements: Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the questionnaire are or are expected to be used instead.
    • FHIR Type: Period
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: Coding[]

    Questionnaire.code Element

    FHIR Specification

    • Short: Concept that represents the overall questionnaire
    • Definition: An identifier for this question or group of questions in a particular terminology such as LOINC.
    • Requirements: Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "panels" of questions to be identified by a code.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    item?: QuestionnaireItemComponent[]

    Questionnaire.item Element

    FHIR Specification

    • Short: Questions and sections within the Questionnaire
    • Definition: A particular question, question grouping or display text that is part of the questionnaire.
    • Comment: The content of the questionnaire is constructed from an ordered, hierarchical collection of items.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided Questionnaire JSON to instantiate the Questionnaire data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR Questionnaire

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Questionnaire

      Returns undefined | Questionnaire

      Questionnaire data model or undefined for Questionnaire

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetDerivedFromElementsetDerivedFromElementaddDerivedFromElementhasDerivedFromElementgetDerivedFromsetDerivedFromaddDerivedFromhasDerivedFromgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetSubjectTypeEnumTypesetSubjectTypeEnumTypeaddSubjectTypeEnumTypehasSubjectTypeEnumTypegetSubjectTypeElementsetSubjectTypeElementaddSubjectTypeElementhasSubjectTypeElementgetSubjectTypesetSubjectTypeaddSubjectTypehasSubjectTypegetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetApprovalDateElementsetApprovalDateElementhasApprovalDateElementgetApprovalDatesetApprovalDatehasApprovalDategetLastReviewDateElementsetLastReviewDateElementhasLastReviewDateElementgetLastReviewDatesetLastReviewDatehasLastReviewDategetEffectivePeriodsetEffectivePeriodhasEffectivePeriodgetCodesetCodeaddCodehasCodegetItemsetItemaddItemhasItemfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitDerivedFrominitSubjectTypeinitContactinitUseContextinitJurisdictioninitCodeinitItem