Data Model Libraries
    Preparing search index...

    Class QuestionnaireResponseItemAnswerComponent

    QuestionnaireResponseItemAnswerComponent Class

    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.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    value?: IDataType

    QuestionnaireResponse.item.answer.value[x] Element

    @ChoiceDataTypesMeta('QuestionnaireResponse.item.answer.value[x]', ['boolean','decimal','integer','date','dateTime','time','string','uri','Attachment','Coding','Quantity','Reference',]

    FHIR Specification

    • Short: Single-valued answer to the question
    • Definition: The answer (or one of the answers) provided by the respondent to the question.
    • Comment: More complex structures (Attachment, Resource and Quantity) will typically be limited to electronic forms that can expose an appropriate user interface to capture the components and enforce the constraints of a complex data type. Additional complex types can be introduced through extensions. Must match the datatype specified by Questionnaire.item.type in the corresponding Questionnaire.
    • Requirements: Ability to retain a single-valued answer to a question.
    • FHIR Types: 'boolean', 'decimal', 'integer', 'date', 'dateTime', 'time', 'string', 'uri', 'Attachment', 'Coding', 'Quantity', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    QuestionnaireResponse.item.answer.item Element

    FHIR Specification

    • Short: Nested groups and questions
    • Definition: Nested groups and/or questions found within this particular answer.
    • Requirements: It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR QuestionnaireResponseItemAnswerComponent

      • OptionaloptSourceField: string

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

      Returns undefined | QuestionnaireResponseItemAnswerComponent

      QuestionnaireResponseItemAnswerComponent data model or undefined for QuestionnaireResponseItemAnswerComponent

      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 and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

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