Data Model Libraries
    Preparing search index...

    Class QuestionnaireResponseItemComponent

    QuestionnaireResponseItemComponent Class

    FHIR Specification

    • Short: Groups and questions
    • Definition: A group or question item from the original questionnaire for which answers are provided.
    • Comment: Groups cannot have answers and therefore must nest directly within item. When dealing with questions, nesting must occur within each answer because some questions may have multiple answers (and the nesting occurs for each answer).

    FHIR QuestionnaireResponse

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    linkId definition? text? answer? item?

    Methods

    parse getLinkIdElement setLinkIdElement hasLinkIdElement getLinkId setLinkId hasLinkId getDefinitionElement setDefinitionElement hasDefinitionElement getDefinition setDefinition hasDefinition getTextElement setTextElement hasTextElement getText setText hasText getAnswer setAnswer addAnswer hasAnswer getItem setItem addItem hasItem fhirType isEmpty isRequiredFieldsEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initAnswer initItem

    Constructors

    Properties

    linkId: null | StringType

    QuestionnaireResponse.item.linkId Element

    FHIR Specification

    • Short: Pointer to specific item from Questionnaire
    • Definition: The item from the Questionnaire that corresponds to this item in the QuestionnaireResponse resource.
    • Requirements: Items can repeat in the answers, so a direct 1..1 correspondence by position might not exist - requiring correspondence by identifier.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    definition?: UriType

    QuestionnaireResponse.item.definition Element

    FHIR Specification

    • Short: ElementDefinition - details for the item
    • Definition: A reference to an ElementDefinition that provides the details for the item.
    • Comment: The ElementDefinition must be in a StructureDefinition, and must have a fragment identifier that identifies the specific data element by its id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. There is no need for this element if the item pointed to by the linkId has a definition listed.
    • Requirements: A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Private Optionaltext

    text?: StringType

    QuestionnaireResponse.item.text Element

    FHIR Specification

    • Short: Name for group or question text
    • Definition: Text that is displayed above the contents of the group or as the text of the question being answered.
    • Requirements: Allows the questionnaire response to be read without access to the questionnaire.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    answer?: QuestionnaireResponseItemAnswerComponent[]

    QuestionnaireResponse.item.answer Element

    FHIR Specification

    • Short: The response(s) to the question
    • Definition: The respondent's answer(s) to the question.
    • Comment: The value is nested because we cannot have a repeating structure that has variable type.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    item?: QuestionnaireResponseItemComponent[]

    QuestionnaireResponse.item.item Element

    FHIR Specification

    • Short: Nested questionnaire response items
    • Definition: Questions or sub-groups nested beneath a question or group.
    • Requirements: Reports can consist of complex nested groups.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR QuestionnaireResponseItemComponent

      • OptionaloptSourceField: string

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

      Returns undefined | QuestionnaireResponseItemComponent

      QuestionnaireResponseItemComponent data model or undefined for QuestionnaireResponseItemComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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; 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • 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

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having 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 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

    • Returns boolean

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods