Data Model Libraries
    Preparing search index...

    Class ClinicalUseDefinitionInteractionComponent

    ClinicalUseDefinitionInteractionComponent Class

    FHIR Specification

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    ClinicalUseDefinition.interaction.interactant Element

    FHIR Specification

    • Short: The specific medication, food, substance or laboratory test that interacts
    • Definition: The specific medication, food, substance or laboratory test that interacts.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    ClinicalUseDefinition.interaction.type Element

    FHIR Specification

    • Short: The type of the interaction e.g. drug-drug interaction, drug-lab test interaction
    • Definition: The type of the interaction e.g. drug-drug interaction, drug-food interaction, drug-lab test interaction.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ClinicalUseDefinition.interaction.effect Element

    FHIR Specification

    • Short: The effect of the interaction, for example "reduced gastric absorption of primary medication"
    • Definition: The effect of the interaction, for example "reduced gastric absorption of primary medication".
    • FHIR Type: CodeableReference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    incidence?: CodeableConcept

    ClinicalUseDefinition.interaction.incidence Element

    FHIR Specification

    • Short: The incidence of the interaction, e.g. theoretical, observed
    • Definition: The incidence of the interaction, e.g. theoretical, observed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    management?: CodeableConcept[]

    ClinicalUseDefinition.interaction.management Element

    FHIR Specification

    • Short: Actions for managing the interaction
    • Definition: Actions for managing the interaction.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalUseDefinitionInteractionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalUseDefinitionInteractionComponent

      ClinicalUseDefinitionInteractionComponent data model or undefined for ClinicalUseDefinitionInteractionComponent

      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