Data Model Libraries
    Preparing search index...

    Class ClinicalUseDefinitionContraindicationComponent

    ClinicalUseDefinitionContraindicationComponent Class

    FHIR Specification

    • Short: Specifics for when this is a contraindication
    • Definition: Specifics for when this is a contraindication.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    diseaseSymptomProcedure?: CodeableReference

    ClinicalUseDefinition.contraindication.diseaseSymptomProcedure Element

    FHIR Specification

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

    ClinicalUseDefinition.contraindication.diseaseStatus Element

    FHIR Specification

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

    ClinicalUseDefinition.contraindication.comorbidity Element

    FHIR Specification

    indication?: Reference[]

    ClinicalUseDefinition.contraindication.indication Element

    FHIR Specification

    ClinicalUseDefinition.contraindication.otherTherapy Element

    FHIR Specification

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

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalUseDefinitionContraindicationComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalUseDefinitionContraindicationComponent

      ClinicalUseDefinitionContraindicationComponent data model or undefined for ClinicalUseDefinitionContraindicationComponent

      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