Data Model Libraries
    Preparing search index...

    Class DeviceDefinitionGuidelineComponent

    DeviceDefinitionGuidelineComponent Class

    FHIR Specification

    • Short: Information aimed at providing directions for the usage of this model of device
    • Definition: Information aimed at providing directions for the usage of this model of device.
    • Comment: For more structured data, a ClinicalUseDefinition that points to the DeviceDefinition can be used.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    useContext?: UsageContext[]

    DeviceDefinition.guideline.useContext Element

    FHIR Specification

    • Short: The circumstances that form the setting for using the device
    • Definition: The circumstances that form the setting for using the device.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    usageInstruction?: MarkdownType

    DeviceDefinition.guideline.usageInstruction Element

    FHIR Specification

    • Short: Detailed written and visual directions for the user on how to use the device
    • Definition: Detailed written and visual directions for the user on how to use the device.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relatedArtifact?: RelatedArtifact[]

    DeviceDefinition.guideline.relatedArtifact Element

    FHIR Specification

    • Short: A source of information or reference for this guideline
    • Definition: A source of information or reference for this guideline.
    • FHIR Type: RelatedArtifact
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    indication?: CodeableConcept[]

    DeviceDefinition.guideline.indication Element

    FHIR Specification

    • Short: A clinical condition for which the device was designed to be used
    • Definition: A clinical condition for which the device was designed to be used.
    • Comment: A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    contraindication?: CodeableConcept[]

    DeviceDefinition.guideline.contraindication Element

    FHIR Specification

    • Short: A specific situation when a device should not be used because it may cause harm
    • Definition: A specific situation when a device should not be used because it may cause harm.
    • Comment: A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    warning?: CodeableConcept[]

    DeviceDefinition.guideline.warning Element

    FHIR Specification

    • Short: Specific hazard alert information that a user needs to know before using the device
    • Definition: Specific hazard alert information that a user needs to know before using the device.
    • Comment: A ClinicalUseDefinition that points to the DeviceDefinition can be used if more structured data is needed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    intendedUse?: StringType

    DeviceDefinition.guideline.intendedUse Element

    FHIR Specification

    • Short: A description of the general purpose or medical use of the device or its function
    • Definition: A description of the general purpose or medical use of the device or its function.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceDefinitionGuidelineComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceDefinitionGuidelineComponent

      DeviceDefinitionGuidelineComponent data model or undefined for DeviceDefinitionGuidelineComponent

      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