Data Model Libraries
    Preparing search index...

    DevicePropertyComponent Class

    FHIR Specification

    • Short: Inherent, essentially fixed, characteristics of the device. e.g., time properties, size, material, etc.
    • Definition: Static or essentially fixed characteristics or features of the device (e.g., time or timing attributes, resolution, accuracy, intended use or instructions for use, and physical attributes) that are not otherwise captured in more specific attributes.
    • Comment: Dynamic or current properties, such as settings, of an individual device are described using a Device instance-specific [DeviceMetric] and recorded using [Observation]. Static characteristics of a device could also be documented in an associated [DeviceDefinition] instance. The Device instance's properties, and their values, could be, but need not be, the same as those described in an associated DeviceDefinition.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    type_: null | CodeableConcept

    Device.property.type Element

    FHIR Specification

    • Short: Code that specifies the property being represented
    • Definition: Code that specifies the property, such as resolution, color, size, being represented.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | IDataType

    Device.property.value[x] Element

    @ChoiceDataTypesMeta('Device.property.value[x]', ['Quantity','CodeableConcept','string','boolean','integer','Range','Attachment',]

    FHIR Specification

    • Short: Value of the property
    • Definition: The value of the property specified by the associated property.type code.
    • Comment: The text element in CodeableConcept.text is used for properties which would usually be coded (such as the size of an implant, or a security classification) but for which there is not currently an appropriate concept in the vocabulary (e.g. a custom implant size, or a security classification which depends on configuration). Otherwise the string choice type is used for descriptive properties, or instructions.
    • FHIR Types: 'Quantity', 'CodeableConcept', 'string', 'boolean', 'integer', 'Range', 'Attachment',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DevicePropertyComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DevicePropertyComponent

      DevicePropertyComponent data model or undefined for DevicePropertyComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise