Data Model Libraries
    Preparing search index...

    Class ClinicalUseDefinition

    ClinicalUseDefinition Class

    A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.

    FHIR Specification

    • Short: A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure
    • Definition: A single issue - either an indication, contraindication, interaction or an undesirable effect for a medicinal product, medication, device or procedure.
    • FHIR Version: 5.0.0

    FHIR ClinicalUseDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    identifier? clinicalUseDefinitionTypeEnum type_ category? subject? status? contraindication? indication? interaction? population? library? undesirableEffect? warning?

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getTypeEnumType setTypeEnumType hasTypeEnumType getTypeElement setTypeElement hasTypeElement getType setType hasType getCategory setCategory addCategory hasCategory getSubject setSubject addSubject hasSubject getStatus setStatus hasStatus getContraindication setContraindication hasContraindication getIndication setIndication hasIndication getInteraction setInteraction hasInteraction getPopulation setPopulation addPopulation hasPopulation getLibraryElement setLibraryElement addLibraryElement hasLibraryElement getLibrary setLibrary addLibrary hasLibrary getUndesirableEffect setUndesirableEffect hasUndesirableEffect getWarning setWarning hasWarning fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initCategory initSubject initPopulation initLibrary

    Constructors

    Properties

    identifier?: Identifier[]

    ClinicalUseDefinition.identifier Element

    FHIR Specification

    • Short: Business identifier for this issue
    • Definition: Business identifier for this issue.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    clinicalUseDefinitionTypeEnum: ClinicalUseDefinitionTypeEnum

    FHIR CodeSystem: ClinicalUseDefinitionType

    ClinicalUseDefinitionTypeEnum

    Privatetype_

    type_: null | EnumCodeType

    ClinicalUseDefinition.type Element

    FHIR Specification

    • Short: indication | contraindication | interaction | undesirable-effect | warning
    • Definition: indication | contraindication | interaction | undesirable-effect | warning.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: ClinicalUseDefinitionTypeEnum

    category?: CodeableConcept[]

    ClinicalUseDefinition.category Element

    FHIR Specification

    • Short: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy", "Overdose"
    • Definition: A categorisation of the issue, primarily for dividing warnings into subject heading areas such as "Pregnancy and Lactation", "Overdose", "Effects on Ability to Drive and Use Machines".
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject?: Reference[]

    ClinicalUseDefinition.subject Element

    FHIR Specification

    status?: CodeableConcept

    ClinicalUseDefinition.status Element

    FHIR Specification

    • Short: Whether this is a current issue or one that has been retired etc
    • Definition: Whether this is a current issue or one that has been retired etc.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contraindication?: ClinicalUseDefinitionContraindicationComponent

    ClinicalUseDefinition.contraindication Element

    FHIR Specification

    • Short: Specifics for when this is a contraindication
    • Definition: Specifics for when this is a contraindication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    indication?: ClinicalUseDefinitionIndicationComponent

    ClinicalUseDefinition.indication Element

    FHIR Specification

    • Short: Specifics for when this is an indication
    • Definition: Specifics for when this is an indication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    interaction?: ClinicalUseDefinitionInteractionComponent

    ClinicalUseDefinition.interaction Element

    FHIR Specification

    • Short: Specifics for when this is an interaction
    • Definition: Specifics for when this is an interaction.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    population?: Reference[]

    ClinicalUseDefinition.population Element

    FHIR Specification

    • Short: The population group to which this applies
    • Definition: The population group to which this applies.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    library?: CanonicalType[]

    ClinicalUseDefinition.library Element

    FHIR Specification

    • Short: Logic used by the clinical use definition
    • Definition: Logic used by the clinical use definition.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    undesirableEffect?: ClinicalUseDefinitionUndesirableEffectComponent

    ClinicalUseDefinition.undesirableEffect Element

    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.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    warning?: ClinicalUseDefinitionWarningComponent

    ClinicalUseDefinition.warning Element

    FHIR Specification

    • Short: Critical environmental, health or physical risks or hazards. For example 'Do not operate heavy machinery', 'May cause drowsiness'
    • Definition: A critical piece of information about environmental, health or physical risks or hazards that serve as caution to the user. For example 'Do not operate heavy machinery', 'May cause drowsiness', or 'Get medical advice/attention if you feel unwell'.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ClinicalUseDefinition

      • OptionaloptSourceField: string

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

      Returns undefined | ClinicalUseDefinition

      ClinicalUseDefinition data model or undefined for ClinicalUseDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Reference array value to the subject property.

      Parameters

      • value: undefined | Reference[]

        the subject array value

      Returns this

      this

      @ReferenceTargets('ClinicalUseDefinition.subject', ['MedicinalProductDefinition','Medication','ActivityDefinition','PlanDefinition','Device','DeviceDefinition','Substance','NutritionProduct','BiologicallyDerivedProduct',])

      InvalidTypeError for invalid data type or reference value

    • Add the provided Reference value to the subject array property.

      Parameters

      • value: undefined | Reference

        the subject value

      Returns this

      this

      @ReferenceTargets('ClinicalUseDefinition.subject', ['MedicinalProductDefinition','Medication','ActivityDefinition','PlanDefinition','Device','DeviceDefinition','Substance','NutritionProduct','BiologicallyDerivedProduct',])

      InvalidTypeError for invalid data type or reference value

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; 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
    parsegetIdentifiersetIdentifieraddIdentifierhasIdentifiergetTypeEnumTypesetTypeEnumTypehasTypeEnumTypegetTypeElementsetTypeElementhasTypeElementgetTypesetTypehasTypegetCategorysetCategoryaddCategoryhasCategorygetSubjectsetSubjectaddSubjecthasSubjectgetStatussetStatushasStatusgetContraindicationsetContraindicationhasContraindicationgetIndicationsetIndicationhasIndicationgetInteractionsetInteractionhasInteractiongetPopulationsetPopulationaddPopulationhasPopulationgetLibraryElementsetLibraryElementaddLibraryElementhasLibraryElementgetLibrarysetLibraryaddLibraryhasLibrarygetUndesirableEffectsetUndesirableEffecthasUndesirableEffectgetWarningsetWarninghasWarningfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitCategoryinitSubjectinitPopulationinitLibrary