Data Model Libraries
    Preparing search index...

    Class ClinicalUseDefinitionUndesirableEffectComponent

    ClinicalUseDefinitionUndesirableEffectComponent Class

    FHIR Specification

    • Short: A possible negative outcome from the use of this treatment
    • Definition: Describe the possible undesirable effects (negative outcomes) from the use of the medicinal product as treatment.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    symptomConditionEffect?: CodeableReference

    ClinicalUseDefinition.undesirableEffect.symptomConditionEffect Element

    FHIR Specification

    • Short: The situation in which the undesirable effect may manifest
    • Definition: The situation in which the undesirable effect may manifest.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    classification?: CodeableConcept

    ClinicalUseDefinition.undesirableEffect.classification Element

    FHIR Specification

    • Short: High level classification of the effect
    • Definition: High level classification of the effect.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    frequencyOfOccurrence?: CodeableConcept

    ClinicalUseDefinition.undesirableEffect.frequencyOfOccurrence Element

    FHIR Specification

    • Short: How often the effect is seen
    • Definition: How often the effect is seen.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalUseDefinitionUndesirableEffectComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalUseDefinitionUndesirableEffectComponent

      ClinicalUseDefinitionUndesirableEffectComponent data model or undefined for ClinicalUseDefinitionUndesirableEffectComponent

      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