Data Model Libraries
    Preparing search index...

    Class DeviceUdiCarrierComponent

    DeviceUdiCarrierComponent Class

    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.
    • Comment: UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device.

    FHIR Device

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    deviceIdentifier? issuer? jurisdiction? carrierAIDC? carrierHRF? udiEntryTypeEnum entryType?

    Methods

    parse getDeviceIdentifierElement setDeviceIdentifierElement hasDeviceIdentifierElement getDeviceIdentifier setDeviceIdentifier hasDeviceIdentifier getIssuerElement setIssuerElement hasIssuerElement getIssuer setIssuer hasIssuer getJurisdictionElement setJurisdictionElement hasJurisdictionElement getJurisdiction setJurisdiction hasJurisdiction getCarrierAIDCElement setCarrierAIDCElement hasCarrierAIDCElement getCarrierAIDC setCarrierAIDC hasCarrierAIDC getCarrierHRFElement setCarrierHRFElement hasCarrierHRFElement getCarrierHRF setCarrierHRF hasCarrierHRF getEntryTypeEnumType setEntryTypeEnumType hasEntryTypeEnumType getEntryTypeElement setEntryTypeElement hasEntryTypeElement getEntryType setEntryType hasEntryType fhirType isEmpty copy toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isRequiredFieldsEmpty isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    deviceIdentifier?: StringType

    Device.udiCarrier.deviceIdentifier Element

    FHIR Specification

    • Short: Mandatory fixed portion of UDI
    • Definition: The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    issuer?: UriType

    Device.udiCarrier.issuer Element

    FHIR Specification

    jurisdiction?: UriType

    Device.udiCarrier.jurisdiction Element

    FHIR Specification

    • Short: Regional UDI authority
    • Definition: The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
    • Requirements: Allows a recipient of a UDI to know which database will contain the UDI-associated metadata.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    carrierAIDC?: Base64BinaryType

    Device.udiCarrier.carrierAIDC Element

    FHIR Specification

    • Short: UDI Machine Readable Barcode String
    • Definition: The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
    • Comment: The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
    • FHIR Type: base64Binary
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    carrierHRF?: StringType

    Device.udiCarrier.carrierHRF Element

    FHIR Specification

    • Short: UDI Human Readable Barcode String
    • Definition: The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
    • Comment: If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    udiEntryTypeEnum: UdiEntryTypeEnum

    FHIR CodeSystem: UdiEntryType

    UdiEntryTypeEnum

    entryType?: EnumCodeType

    Device.udiCarrier.entryType Element

    FHIR Specification

    • Short: barcode | rfid | manual +
    • Definition: A coded entry to indicate how the data was entered.
    • Requirements: Supports a way to distinguish hand entered from machine read data.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: UdiEntryTypeEnum

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR DeviceUdiCarrierComponent

      • OptionaloptSourceField: string

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

      Returns undefined | DeviceUdiCarrierComponent

      DeviceUdiCarrierComponent data model or undefined for DeviceUdiCarrierComponent

      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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetDeviceIdentifierElementsetDeviceIdentifierElementhasDeviceIdentifierElementgetDeviceIdentifiersetDeviceIdentifierhasDeviceIdentifiergetIssuerElementsetIssuerElementhasIssuerElementgetIssuersetIssuerhasIssuergetJurisdictionElementsetJurisdictionElementhasJurisdictionElementgetJurisdictionsetJurisdictionhasJurisdictiongetCarrierAIDCElementsetCarrierAIDCElementhasCarrierAIDCElementgetCarrierAIDCsetCarrierAIDChasCarrierAIDCgetCarrierHRFElementsetCarrierHRFElementhasCarrierHRFElementgetCarrierHRFsetCarrierHRFhasCarrierHRFgetEntryTypeEnumTypesetEntryTypeEnumTypehasEntryTypeEnumTypegetEntryTypeElementsetEntryTypeElementhasEntryTypeElementgetEntryTypesetEntryTypehasEntryTypefhirTypeisEmptycopytoJSONgetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensiongetIdsetIdhasIdgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensionisRequiredFieldsEmptyisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValues