Data Model Libraries
    Preparing search index...

    Class QuestionnaireItemAnswerOptionComponent

    QuestionnaireItemAnswerOptionComponent Class

    FHIR Specification

    • Short: Permitted answer
    • Definition: One of the permitted answers for the question.
    • Comment: This element can be used when the value set machinery of answerValueSet is deemed too cumbersome or when there's a need to capture possible answers that are not codes.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    value: null | IDataType

    Questionnaire.item.answerOption.value[x] Element

    @ChoiceDataTypesMeta('Questionnaire.item.answerOption.value[x]', ['integer','date','time','string','Coding','Reference',]

    FHIR Specification

    • Short: Answer value
    • Definition: A potential answer that's allowed as the answer to this question.
    • Comment: The data type of the value must agree with the item.type.
    • FHIR Types: 'integer', 'date', 'time', 'string', 'Coding', 'Reference',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    initialSelected?: BooleanType

    Questionnaire.item.answerOption.initialSelected Element

    FHIR Specification

    • Short: Whether option is selected by default
    • Definition: Indicates whether the answer value is selected when the list of possible answers is initially shown.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR QuestionnaireItemAnswerOptionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | QuestionnaireItemAnswerOptionComponent

      QuestionnaireItemAnswerOptionComponent data model or undefined for QuestionnaireItemAnswerOptionComponent

      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