Data Model Libraries
    Preparing search index...

    Class ClinicalUseDefinitionIndicationComponent

    ClinicalUseDefinitionIndicationComponent Class

    FHIR Specification

    • Short: Specifics for when this is an indication
    • Definition: Specifics for when this is an indication.

    FHIR ClinicalUseDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    diseaseSymptomProcedure? diseaseStatus? comorbidity? intendedEffect? duration? undesirableEffect? applicability? otherTherapy?

    Methods

    parse getDiseaseSymptomProcedure setDiseaseSymptomProcedure hasDiseaseSymptomProcedure getDiseaseStatus setDiseaseStatus hasDiseaseStatus getComorbidity setComorbidity addComorbidity hasComorbidity getIntendedEffect setIntendedEffect hasIntendedEffect getDuration setDuration hasDuration getDurationRange hasDurationRange getDurationStringType hasDurationStringType getUndesirableEffect setUndesirableEffect addUndesirableEffect hasUndesirableEffect getApplicability setApplicability hasApplicability getOtherTherapy setOtherTherapy addOtherTherapy hasOtherTherapy fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initComorbidity initUndesirableEffect initOtherTherapy

    Constructors

    Properties

    diseaseSymptomProcedure?: CodeableReference

    ClinicalUseDefinition.indication.diseaseSymptomProcedure Element

    FHIR Specification

    • Short: The situation that is being documented as an indicaton for this item
    • Definition: The situation that is being documented as an indicaton for this item.
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    diseaseStatus?: CodeableReference

    ClinicalUseDefinition.indication.diseaseStatus Element

    FHIR Specification

    • Short: The status of the disease or symptom for the indication
    • Definition: The status of the disease or symptom for the indication, for example "chronic" or "metastatic".
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comorbidity?: CodeableReference[]

    ClinicalUseDefinition.indication.comorbidity Element

    FHIR Specification

    • Short: A comorbidity or coinfection as part of the indication
    • Definition: A comorbidity (concurrent condition) or coinfection as part of the indication.
    • FHIR Type: CodeableReference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    intendedEffect?: CodeableReference

    ClinicalUseDefinition.indication.intendedEffect Element

    FHIR Specification

    duration?: IDataType

    ClinicalUseDefinition.indication.duration[x] Element

    @ChoiceDataTypesMeta('ClinicalUseDefinition.indication.duration[x]', ['Range','string',]

    FHIR Specification

    • Short: Timing or duration information
    • Definition: Timing or duration information, that may be associated with use with the indicated condition e.g. Adult patients suffering from myocardial infarction (from a few days until less than 35 days), ischaemic stroke (from 7 days until less than 6 months).
    • FHIR Types: 'Range', 'string',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    undesirableEffect?: Reference[]

    ClinicalUseDefinition.indication.undesirableEffect Element

    FHIR Specification

    • Short: An unwanted side effect or negative outcome of the subject of this resource when being used for this indication
    • Definition: An unwanted side effect or negative outcome that may happen if you use the drug (or other subject of this resource) for this indication.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    applicability?: Expression

    ClinicalUseDefinition.indication.applicability Element

    FHIR Specification

    • Short: An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements
    • Definition: An expression that returns true or false, indicating whether the indication is applicable or not, after having applied its other elements.
    • Comment: The expression may be inlined or may be a reference to a named expression within a logic library referenced by the library element.
    • FHIR Type: Expression
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    otherTherapy?: ClinicalUseDefinitionContraindicationOtherTherapyComponent[]

    ClinicalUseDefinition.indication.otherTherapy Element

    FHIR Specification

    • Short: The use of the medicinal product in relation to other therapies described as part of the indication
    • Definition: Information about the use of the medicinal product in relation to other therapies described as part of the indication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalUseDefinitionIndicationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalUseDefinitionIndicationComponent

      ClinicalUseDefinitionIndicationComponent data model or undefined for ClinicalUseDefinitionIndicationComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetDiseaseSymptomProceduresetDiseaseSymptomProcedurehasDiseaseSymptomProceduregetDiseaseStatussetDiseaseStatushasDiseaseStatusgetComorbiditysetComorbidityaddComorbidityhasComorbiditygetIntendedEffectsetIntendedEffecthasIntendedEffectgetDurationsetDurationhasDurationgetDurationRangehasDurationRangegetDurationStringTypehasDurationStringTypegetUndesirableEffectsetUndesirableEffectaddUndesirableEffecthasUndesirableEffectgetApplicabilitysetApplicabilityhasApplicabilitygetOtherTherapysetOtherTherapyaddOtherTherapyhasOtherTherapyfhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitComorbidityinitUndesirableEffectinitOtherTherapy