Data Model Libraries
    Preparing search index...

    Class InventoryItemCharacteristicComponent

    InventoryItemCharacteristicComponent Class

    FHIR Specification

    • Short: Characteristic of the item
    • Definition: The descriptive or identifying characteristics of the item.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    characteristicType: null | CodeableConcept

    InventoryItem.characteristic.characteristicType Element

    FHIR Specification

    • Short: The characteristic that is being defined
    • Definition: The type of characteristic that is being defined.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false
    value: null | IDataType

    InventoryItem.characteristic.value[x] Element

    @ChoiceDataTypesMeta('InventoryItem.characteristic.value[x]', ['string','integer','decimal','boolean','url','dateTime','Quantity','Range','Ratio','Annotation','Address','Duration','CodeableConcept',]

    FHIR Specification

    • Short: The value of the attribute
    • Definition: The value of the attribute.
    • Comment: The string value is used for characteristics that are descriptive and not codeable information. CodeableConcept.text is used when the characteristic is discrete and could otherwise be coded but for which there is no code available.
    • FHIR Types: 'string', 'integer', 'decimal', 'boolean', 'url', 'dateTime', 'Quantity', 'Range', 'Ratio', 'Annotation', 'Address', 'Duration', 'CodeableConcept',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR InventoryItemCharacteristicComponent

      • OptionaloptSourceField: string

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

      Returns undefined | InventoryItemCharacteristicComponent

      InventoryItemCharacteristicComponent data model or undefined for InventoryItemCharacteristicComponent

      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