Class Device

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

    public class Device
    extends DomainResource
    This resource describes the properties (regulated, has real time clock, etc.), adminstrative (manufacturer name, model number, serial number, firmware, etc), and type (knee replacement, blood pressure cuff, MRI, etc.) of a physical unit (these values do not change much within a given module, for example the serail number, manufacturer name, and model number). An actual unit may consist of several modules in a distinct hierarchy and these are represented by multiple Device resources and bound through the 'parent' element.
    See Also:
    Serialized Form
    • Field Detail

      • identifier

        protected List<Identifier> identifier
        Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
      • displayName

        protected StringType displayName
        The name used to display by default when the device is referenced. Based on intent of use by the resource creator, this may reflect one of the names in Device.deviceName, or may be another simple name.
      • udiCarrier

        protected List<Device.DeviceUdiCarrierComponent> udiCarrier
        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.
      • biologicalSource

        protected Identifier biologicalSource
        An identifier that supports traceability to the biological entity that is the source of biological material in the product.
      • manufacturer

        protected StringType manufacturer
        A name of the manufacturer or entity legally responsible for the device.
      • expirationDate

        protected DateTimeType expirationDate
        The date and time beyond which this device is no longer valid or should not be used (if applicable).
      • serialNumber

        protected StringType serialNumber
        The serial number assigned by the organization when the device was manufactured.
      • deviceName

        protected List<Device.DeviceDeviceNameComponent> deviceName
        This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
      • type

        protected List<CodeableConcept> type
        The kind or type of device. A device instance may have more than one type - in which case those are the types that apply to the specific instance of the device.
      • subject

        protected Reference subject
        Patient information, if the device is affixed to, or associated to a patient for their specific use, irrespective of the procedure, use, observation, or other activity that the device is involved in.
      • owner

        protected Reference owner
        An organization that is responsible for the provision and ongoing maintenance of the device.
      • contact

        protected List<ContactPoint> contact
        Contact details for an organization or a particular human that is responsible for the device.
      • url

        protected UriType url
        A network address on which the device may be contacted directly.
      • endpoint

        protected List<Reference> endpoint
        Technical endpoints providing access to services provided by the device defined at this resource.
      • link

        protected List<Device.DeviceLinkComponent> link
        An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.
      • note

        protected List<Annotation> note
        Descriptive information, usage information or implantation information that is not captured in an existing element.
      • safety

        protected List<CodeableConcept> safety
        Provides additional safety characteristics about a medical device. For example devices containing latex.
      • parent

        protected Reference parent
        The device that this device is attached to or is part of.
      • BIOLOGICAL_SOURCE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam BIOLOGICAL_SOURCE
        Fluent Client search parameter constant for biological-source

        Description: The biological source for the device
        Type: token
        Path: Device.biologicalSource

      • SP_DEFINITION

        public static final String SP_DEFINITION
        Search parameter: definition

        Description: The definition / type of the device
        Type: reference
        Path: Device.definition.reference

        See Also:
        Constant Field Values
      • DEFINITION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION
        Fluent Client search parameter constant for definition

        Description: The definition / type of the device
        Type: reference
        Path: Device.definition.reference

      • INCLUDE_DEFINITION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:definition".
      • SP_DEVICE_NAME

        public static final String SP_DEVICE_NAME
        Search parameter: device-name

        Description: A server defined search that may match any of the string fields in Device.deviceName or Device.type.
        Type: string
        Path: Device.deviceName.name | Device.type.coding.display | Device.type.text

        See Also:
        Constant Field Values
      • DEVICE_NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DEVICE_NAME
        Fluent Client search parameter constant for device-name

        Description: A server defined search that may match any of the string fields in Device.deviceName or Device.type.
        Type: string
        Path: Device.deviceName.name | Device.type.coding.display | Device.type.text

      • EXPIRATION_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam EXPIRATION_DATE
        Fluent Client search parameter constant for expiration-date

        Description: The expiration date of the device
        Type: date
        Path: Device.expirationDate

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: Instance id from manufacturer, owner, and others
        Type: token
        Path: Device.identifier

        See Also:
        Constant Field Values
      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: Instance id from manufacturer, owner, and others
        Type: token
        Path: Device.identifier

      • SP_LOCATION

        public static final String SP_LOCATION
        Search parameter: location

        Description: A location, where the resource is found
        Type: reference
        Path: Device.location

        See Also:
        Constant Field Values
      • LOCATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION
        Fluent Client search parameter constant for location

        Description: A location, where the resource is found
        Type: reference
        Path: Device.location

      • INCLUDE_LOCATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:location".
      • LOT_NUMBER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam LOT_NUMBER
        Fluent Client search parameter constant for lot-number

        Description: The lot number of the device
        Type: string
        Path: Device.lotNumber

      • MANUFACTURE_DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam MANUFACTURE_DATE
        Fluent Client search parameter constant for manufacture-date

        Description: The manufacture date of the device
        Type: date
        Path: Device.manufactureDate

      • MANUFACTURER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam MANUFACTURER
        Fluent Client search parameter constant for manufacturer

        Description: The manufacturer of the device
        Type: string
        Path: Device.manufacturer

      • SP_MODEL

        public static final String SP_MODEL
        Search parameter: model

        Description: The model of the device
        Type: string
        Path: Device.modelNumber

        See Also:
        Constant Field Values
      • MODEL

        public static final ca.uhn.fhir.rest.gclient.StringClientParam MODEL
        Fluent Client search parameter constant for model

        Description: The model of the device
        Type: string
        Path: Device.modelNumber

      • SP_ORGANIZATION

        public static final String SP_ORGANIZATION
        Search parameter: organization

        Description: The organization responsible for the device
        Type: reference
        Path: Device.owner

        See Also:
        Constant Field Values
      • ORGANIZATION

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION
        Fluent Client search parameter constant for organization

        Description: The organization responsible for the device
        Type: reference
        Path: Device.owner

      • INCLUDE_ORGANIZATION

        public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:organization".
      • PARENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
        Fluent Client search parameter constant for parent

        Description: The parent device
        Type: reference
        Path: Device.parent

      • INCLUDE_PARENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PARENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:parent".
      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter: patient

        Description: Patient information, if the resource is affixed to a person
        Type: reference
        Path: Device.subject.where(resolve() is Patient)

        See Also:
        Constant Field Values
      • PATIENT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
        Fluent Client search parameter constant for patient

        Description: Patient information, if the resource is affixed to a person
        Type: reference
        Path: Device.subject.where(resolve() is Patient)

      • INCLUDE_PATIENT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:patient".
      • SERIAL_NUMBER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam SERIAL_NUMBER
        Fluent Client search parameter constant for serial-number

        Description: The serial number of the device
        Type: string
        Path: Device.serialNumber

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: active | inactive | entered-in-error | unknown
        Type: token
        Path: Device.status

        See Also:
        Constant Field Values
      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: active | inactive | entered-in-error | unknown
        Type: token
        Path: Device.status

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter: subject

        Description: Subject information, to which the device is associated of affixed
        Type: reference
        Path: Device.subject

        See Also:
        Constant Field Values
      • SUBJECT

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
        Fluent Client search parameter constant for subject

        Description: Subject information, to which the device is associated of affixed
        Type: reference
        Path: Device.subject

      • INCLUDE_SUBJECT

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:subject".
      • TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam TYPE
        Fluent Client search parameter constant for type

        Description: The type of the device
        Type: token
        Path: Device.type

      • SP_UDI_CARRIER

        public static final String SP_UDI_CARRIER
        Search parameter: udi-carrier

        Description: UDI Barcode (RFID or other technology) string in *HRF* format.
        Type: string
        Path: Device.udiCarrier.carrierHRF

        See Also:
        Constant Field Values
      • UDI_CARRIER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam UDI_CARRIER
        Fluent Client search parameter constant for udi-carrier

        Description: UDI Barcode (RFID or other technology) string in *HRF* format.
        Type: string
        Path: Device.udiCarrier.carrierHRF

      • SP_UDI_DI

        public static final String SP_UDI_DI
        Search parameter: udi-di

        Description: The udi Device Identifier (DI)
        Type: string
        Path: Device.udiCarrier.deviceIdentifier

        See Also:
        Constant Field Values
      • UDI_DI

        public static final ca.uhn.fhir.rest.gclient.StringClientParam UDI_DI
        Fluent Client search parameter constant for udi-di

        Description: The udi Device Identifier (DI)
        Type: string
        Path: Device.udiCarrier.deviceIdentifier

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: Network address to contact device
        Type: uri
        Path: Device.url

        See Also:
        Constant Field Values
      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: Network address to contact device
        Type: uri
        Path: Device.url

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The specific version of the device
        Type: string
        Path: Device.version.value

        See Also:
        Constant Field Values
      • VERSION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam VERSION
        Fluent Client search parameter constant for version

        Description: The specific version of the device
        Type: string
        Path: Device.version.value

      • SP_DIN

        public static final String SP_DIN
        Search parameter: din

        Description: The donation identification number (DIN)
        Type: token
        Path: Device.extension('http://hl7.org/fhir/SearchParameter/device-extensions-Device-din')

        See Also:
        Constant Field Values
      • DIN

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam DIN
        Fluent Client search parameter constant for din

        Description: The donation identification number (DIN)
        Type: token
        Path: Device.extension('http://hl7.org/fhir/SearchParameter/device-extensions-Device-din')

    • Constructor Detail

      • Device

        public Device()
        Constructor