Data Model Libraries
    Preparing search index...

    DeviceDefinition Class

    The characteristics, operational status and capabilities of a medical-related component of a medical device.

    FHIR Specification

    • Short: An instance of a medical-related component of a medical device
    • Definition: The characteristics, operational status and capabilities of a medical-related component of a medical device.
    • Comment: For the initial scope, this DeviceDefinition resource is only applicable to describe a single node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard and that does not represent a metric. Examples for such a node are MDS, VMD, or Channel.
    • FHIR Version: 4.3.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getUdiDeviceIdentifier setUdiDeviceIdentifier addUdiDeviceIdentifier hasUdiDeviceIdentifier getManufacturer setManufacturer hasManufacturer getManufacturerStringType hasManufacturerStringType getManufacturerReference hasManufacturerReference getDeviceName setDeviceName addDeviceName hasDeviceName getModelNumberElement setModelNumberElement hasModelNumberElement getModelNumber setModelNumber hasModelNumber getType setType hasType getSpecialization setSpecialization addSpecialization hasSpecialization getVersionElement setVersionElement addVersionElement hasVersionElement getVersion setVersion addVersion hasVersion getSafety setSafety addSafety hasSafety getShelfLifeStorage setShelfLifeStorage addShelfLifeStorage hasShelfLifeStorage getPhysicalCharacteristics setPhysicalCharacteristics hasPhysicalCharacteristics getLanguageCode setLanguageCode addLanguageCode hasLanguageCode getCapability setCapability addCapability hasCapability getProperty setProperty addProperty hasProperty getOwner setOwner hasOwner getContact setContact addContact hasContact getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getOnlineInformationElement setOnlineInformationElement hasOnlineInformationElement getOnlineInformation setOnlineInformation hasOnlineInformation getNote setNote addNote hasNote getQuantity setQuantity hasQuantity getParentDevice setParentDevice hasParentDevice getMaterial setMaterial addMaterial hasMaterial fhirType isEmpty 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 isRequiredFieldsEmpty isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initUdiDeviceIdentifier initDeviceName initSpecialization initVersion initSafety initShelfLifeStorage initLanguageCode initCapability initProperty initContact initNote initMaterial

    Constructors

    Properties

    identifier?: Identifier[]

    DeviceDefinition.identifier Element

    FHIR Specification

    • Short: Instance identifier
    • Definition: Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    DeviceDefinition.udiDeviceIdentifier Element

    FHIR Specification

    • Short: Unique Device Identifier (UDI) Barcode string
    • Definition: Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    manufacturer?: IDataType

    DeviceDefinition.manufacturer[x] Element

    @ChoiceDataTypesMeta('DeviceDefinition.manufacturer[x]', ['string','Reference',]

    FHIR Specification

    • Short: Name of device manufacturer
    • Definition: A name of the manufacturer.
    • FHIR Types: 'string', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    DeviceDefinition.deviceName Element

    FHIR Specification

    • Short: A name given to the device to identify it
    • Definition: A name given to the device to identify it.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    modelNumber?: StringType

    DeviceDefinition.modelNumber Element

    FHIR Specification

    • Short: The model number for the device
    • Definition: The model number for the device.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    DeviceDefinition.type Element

    FHIR Specification

    • Short: What kind of device or device system this is
    • Definition: What kind of device or device system this is.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    DeviceDefinition.specialization Element

    FHIR Specification

    • Short: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
    • Definition: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    version?: StringType[]

    DeviceDefinition.version Element

    FHIR Specification

    • Short: Available versions
    • Definition: The available versions of the device, e.g., software versions.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    safety?: CodeableConcept[]

    DeviceDefinition.safety Element

    FHIR Specification

    • Short: Safety characteristics of the device
    • Definition: Safety characteristics of the device.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    shelfLifeStorage?: ProductShelfLife[]

    DeviceDefinition.shelfLifeStorage Element

    FHIR Specification

    • Short: Shelf Life and storage information
    • Definition: Shelf Life and storage information.
    • FHIR Type: ProductShelfLife
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    physicalCharacteristics?: ProdCharacteristic

    DeviceDefinition.physicalCharacteristics Element

    FHIR Specification

    • Short: Dimensions, color etc.
    • Definition: Dimensions, color etc.
    • FHIR Type: ProdCharacteristic
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    languageCode?: CodeableConcept[]

    DeviceDefinition.languageCode Element

    FHIR Specification

    • Short: Language code for the human-readable text strings produced by the device (all supported)
    • Definition: Language code for the human-readable text strings produced by the device (all supported).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    DeviceDefinition.capability Element

    FHIR Specification

    • Short: Device capabilities
    • Definition: Device capabilities.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    DeviceDefinition.property Element

    FHIR Specification

    • Short: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    • Definition: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    owner?: Reference

    DeviceDefinition.owner Element

    FHIR Specification

    • Short: Organization responsible for device
    • Definition: An organization that is responsible for the provision and ongoing maintenance of the device.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    contact?: ContactPoint[]

    DeviceDefinition.contact Element

    FHIR Specification

    • Short: Details for human/organization for support
    • Definition: Contact details for an organization or a particular human that is responsible for the device.
    • Comment: used for troubleshooting etc.
    • FHIR Type: ContactPoint
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    url?: UriType

    DeviceDefinition.url Element

    FHIR Specification

    • Short: Network address to contact device
    • Definition: A network address on which the device may be contacted directly.
    • Comment: If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    onlineInformation?: UriType

    DeviceDefinition.onlineInformation Element

    FHIR Specification

    • Short: Access to on-line information
    • Definition: Access to on-line information about the device.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    DeviceDefinition.note Element

    FHIR Specification

    • Short: Device notes and comments
    • Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    quantity?: Quantity

    DeviceDefinition.quantity Element

    FHIR Specification

    • Short: The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
    • Definition: The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).
    • FHIR Type: Quantity
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    parentDevice?: Reference

    DeviceDefinition.parentDevice Element

    FHIR Specification

    DeviceDefinition.material Element

    FHIR Specification

    • Short: A substance used to create the material(s) of which the device is made
    • Definition: A substance used to create the material(s) of which the device is made.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceDefinition

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceDefinition

      DeviceDefinition data model or undefined for DeviceDefinition

      JsonError if the provided JSON is not a valid JSON object

    • 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 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