Package org.hl7.fhir.dstu3.model

Class Device

java.lang.Object
org.hl7.fhir.dstu3.model.Base
org.hl7.fhir.dstu3.model.BaseResource
org.hl7.fhir.dstu3.model.Resource
org.hl7.fhir.dstu3.model.DomainResource
org.hl7.fhir.dstu3.model.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 identifies an instance or a type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. Medical devices include durable (reusable) medical equipment, implantable devices, as well as disposable equipment used for diagnostic, treatment, and research for healthcare and public health. Non-medical devices may include items such as a machine, cellphone, computer, application, etc.
See Also:

  • Field Details

    • identifier

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

    • udi

      protected Device.DeviceUdiComponent udi
      [Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.

    • status

      protected Enumeration<Device.FHIRDeviceStatus> status
      Status of the Device availability.

    • type

      protected CodeableConcept type
      Code or identifier to identify a kind of device.

    • lotNumber

      protected StringType lotNumber
      Lot number assigned by the manufacturer.

    • manufacturer

      protected StringType manufacturer
      A name of the manufacturer.

    • manufactureDate

      protected DateTimeType manufactureDate
      The date and time when the device was manufactured.

    • expirationDate

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

    • model

      protected StringType model
      The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

    • version

      protected StringType version
      The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

    • patient

      protected Reference patient
      Patient information, If the device is affixed to a person.

    • patientTarget

      protected Patient patientTarget
      The actual object that is the target of the reference (Patient information, If the device is affixed to a person.)

    • owner

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

    • ownerTarget

      protected Organization ownerTarget
      The actual object that is the target of the reference (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.

    • location

      protected Reference location
      The place where the device can be found.

    • locationTarget

      protected Location locationTarget
      The actual object that is the target of the reference (The place where the device can be found.)

    • url

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

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

    • SP_UDI_DI

      public static final String SP_UDI_DI
      Search parameter: udi-di

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

      See Also:

    • 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.udi.deviceIdentifier

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

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

      public static final String SP_UDI_CARRIER
      Search parameter: udi-carrier

      Description: UDI Barcode (RFID or other technology) string either in HRF format or AIDC format converted to base64 string.
      Type: string
      Path: Device.udi.carrierHRF, Device.udi.carrierAIDC

      See Also:

    • 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 either in HRF format or AIDC format converted to base64 string.
      Type: string
      Path: Device.udi.carrierHRF, Device.udi.carrierAIDC

    • 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 the Device.udi.name or Device.type.coding.display or Device.type.text
      Type: string
      Path: Device.udi.name, Device.type.text, Device.type.coding.display

      See Also:

    • 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 the Device.udi.name or Device.type.coding.display or Device.type.text
      Type: string
      Path: Device.udi.name, Device.type.text, Device.type.coding.display

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

      See Also:

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

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

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

    • SP_MODEL

      public static final String SP_MODEL
      Search parameter: model

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

      See Also:

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

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

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

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter: type

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

      See Also:

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

      public static final String SP_URL
      Search parameter: url

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

      See Also:

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

      public static final String SP_MANUFACTURER
      Search parameter: manufacturer

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

      See Also:

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

      public static final String SP_STATUS
      Search parameter: status

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

      See Also:

    • 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

  • Constructor Details

    • Device

      public Device()
      Constructor

  • Method Details

    • getIdentifier

      public List<Identifier> getIdentifier()
      Returns:
      identifier (Unique instance identifiers assigned to a device by manufacturers other organizations or owners.)

    • setIdentifier

      public Device setIdentifier(List<Identifier> theIdentifier)
      Returns:
      Returns a reference to this for easy method chaining

    • hasIdentifier

      public boolean hasIdentifier()

    • addIdentifier

      public Identifier addIdentifier()

    • addIdentifier

      public Device addIdentifier(Identifier t)

    • getIdentifierFirstRep

      public Identifier getIdentifierFirstRep()
      Returns:
      The first repetition of repeating field identifier, creating it if it does not already exist

    • getUdi

      public Device.DeviceUdiComponent getUdi()
      Returns:
      udi ([Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.)

    • hasUdi

      public boolean hasUdi()

    • setUdi

      public Device setUdi(Device.DeviceUdiComponent value)
      Parameters:
      value - udi ([Unique device identifier (UDI)](device.html#5.11.3.2.2) assigned to device label or package.)

    • getStatusElement

      public Enumeration<Device.FHIRDeviceStatus> getStatusElement()
      Returns:
      status (Status of the Device availability.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public Device setStatusElement(Enumeration<Device.FHIRDeviceStatus> value)
      Parameters:
      value - status (Status of the Device availability.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Device.FHIRDeviceStatus getStatus()
      Returns:
      Status of the Device availability.

    • setStatus

      public Device setStatus(Device.FHIRDeviceStatus value)
      Parameters:
      value - Status of the Device availability.

    • getType

      public CodeableConcept getType()
      Returns:
      type (Code or identifier to identify a kind of device.)

    • hasType

      public boolean hasType()

    • setType

      public Device setType(CodeableConcept value)
      Parameters:
      value - type (Code or identifier to identify a kind of device.)

    • getLotNumberElement

      public StringType getLotNumberElement()
      Returns:
      lotNumber (Lot number assigned by the manufacturer.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value

    • hasLotNumberElement

      public boolean hasLotNumberElement()

    • hasLotNumber

      public boolean hasLotNumber()

    • setLotNumberElement

      public Device setLotNumberElement(StringType value)
      Parameters:
      value - lotNumber (Lot number assigned by the manufacturer.). This is the underlying object with id, value and extensions. The accessor "getLotNumber" gives direct access to the value

    • getLotNumber

      public String getLotNumber()
      Returns:
      Lot number assigned by the manufacturer.

    • setLotNumber

      public Device setLotNumber(String value)
      Parameters:
      value - Lot number assigned by the manufacturer.

    • getManufacturerElement

      public StringType getManufacturerElement()
      Returns:
      manufacturer (A name of the manufacturer.). This is the underlying object with id, value and extensions. The accessor "getManufacturer" gives direct access to the value

    • hasManufacturerElement

      public boolean hasManufacturerElement()

    • hasManufacturer

      public boolean hasManufacturer()

    • setManufacturerElement

      public Device setManufacturerElement(StringType value)
      Parameters:
      value - manufacturer (A name of the manufacturer.). This is the underlying object with id, value and extensions. The accessor "getManufacturer" gives direct access to the value

    • getManufacturer

      public String getManufacturer()
      Returns:
      A name of the manufacturer.

    • setManufacturer

      public Device setManufacturer(String value)
      Parameters:
      value - A name of the manufacturer.

    • getManufactureDateElement

      public DateTimeType getManufactureDateElement()
      Returns:
      manufactureDate (The date and time when the device was manufactured.). This is the underlying object with id, value and extensions. The accessor "getManufactureDate" gives direct access to the value

    • hasManufactureDateElement

      public boolean hasManufactureDateElement()

    • hasManufactureDate

      public boolean hasManufactureDate()

    • setManufactureDateElement

      public Device setManufactureDateElement(DateTimeType value)
      Parameters:
      value - manufactureDate (The date and time when the device was manufactured.). This is the underlying object with id, value and extensions. The accessor "getManufactureDate" gives direct access to the value

    • getManufactureDate

      public Date getManufactureDate()
      Returns:
      The date and time when the device was manufactured.

    • setManufactureDate

      public Device setManufactureDate(Date value)
      Parameters:
      value - The date and time when the device was manufactured.

    • getExpirationDateElement

      public DateTimeType getExpirationDateElement()
      Returns:
      expirationDate (The date and time beyond which this device is no longer valid or should not be used (if applicable).). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value

    • hasExpirationDateElement

      public boolean hasExpirationDateElement()

    • hasExpirationDate

      public boolean hasExpirationDate()

    • setExpirationDateElement

      public Device setExpirationDateElement(DateTimeType value)
      Parameters:
      value - expirationDate (The date and time beyond which this device is no longer valid or should not be used (if applicable).). This is the underlying object with id, value and extensions. The accessor "getExpirationDate" gives direct access to the value

    • getExpirationDate

      public Date getExpirationDate()
      Returns:
      The date and time beyond which this device is no longer valid or should not be used (if applicable).

    • setExpirationDate

      public Device setExpirationDate(Date value)
      Parameters:
      value - The date and time beyond which this device is no longer valid or should not be used (if applicable).

    • getModelElement

      public StringType getModelElement()
      Returns:
      model (The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.). This is the underlying object with id, value and extensions. The accessor "getModel" gives direct access to the value

    • hasModelElement

      public boolean hasModelElement()

    • hasModel

      public boolean hasModel()

    • setModelElement

      public Device setModelElement(StringType value)
      Parameters:
      value - model (The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.). This is the underlying object with id, value and extensions. The accessor "getModel" gives direct access to the value

    • getModel

      public String getModel()
      Returns:
      The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

    • setModel

      public Device setModel(String value)
      Parameters:
      value - The "model" is an identifier assigned by the manufacturer to identify the product by its type. This number is shared by the all devices sold as the same type.

    • getVersionElement

      public StringType getVersionElement()
      Returns:
      version (The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • hasVersionElement

      public boolean hasVersionElement()

    • hasVersion

      public boolean hasVersion()

    • setVersionElement

      public Device setVersionElement(StringType value)
      Parameters:
      value - version (The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

    • getVersion

      public String getVersion()
      Returns:
      The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

    • setVersion

      public Device setVersion(String value)
      Parameters:
      value - The version of the device, if the device has multiple releases under the same model, or if the device is software or carries firmware.

    • getPatient

      public Reference getPatient()
      Returns:
      patient (Patient information, If the device is affixed to a person.)

    • hasPatient

      public boolean hasPatient()

    • setPatient

      public Device setPatient(Reference value)
      Parameters:
      value - patient (Patient information, If the device is affixed to a person.)

    • getPatientTarget

      public Patient getPatientTarget()
      Returns:
      patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Patient information, If the device is affixed to a person.)

    • setPatientTarget

      public Device setPatientTarget(Patient value)
      Parameters:
      value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Patient information, If the device is affixed to a person.)

    • getOwner

      public Reference getOwner()
      Returns:
      owner (An organization that is responsible for the provision and ongoing maintenance of the device.)

    • hasOwner

      public boolean hasOwner()

    • setOwner

      public Device setOwner(Reference value)
      Parameters:
      value - owner (An organization that is responsible for the provision and ongoing maintenance of the device.)

    • getOwnerTarget

      public Organization getOwnerTarget()
      Returns:
      owner The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An organization that is responsible for the provision and ongoing maintenance of the device.)

    • setOwnerTarget

      public Device setOwnerTarget(Organization value)
      Parameters:
      value - owner The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (An organization that is responsible for the provision and ongoing maintenance of the device.)

    • getContact

      public List<ContactPoint> getContact()
      Returns:
      contact (Contact details for an organization or a particular human that is responsible for the device.)

    • setContact

      public Device setContact(List<ContactPoint> theContact)
      Returns:
      Returns a reference to this for easy method chaining

    • hasContact

      public boolean hasContact()

    • addContact

      public ContactPoint addContact()

    • addContact

      public Device addContact(ContactPoint t)

    • getContactFirstRep

      public ContactPoint getContactFirstRep()
      Returns:
      The first repetition of repeating field contact, creating it if it does not already exist

    • getLocation

      public Reference getLocation()
      Returns:
      location (The place where the device can be found.)

    • hasLocation

      public boolean hasLocation()

    • setLocation

      public Device setLocation(Reference value)
      Parameters:
      value - location (The place where the device can be found.)

    • getLocationTarget

      public Location getLocationTarget()
      Returns:
      location The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The place where the device can be found.)

    • setLocationTarget

      public Device setLocationTarget(Location value)
      Parameters:
      value - location The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The place where the device can be found.)

    • getUrlElement

      public UriType getUrlElement()
      Returns:
      url (A network address on which the device may be contacted directly.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public Device setUrlElement(UriType value)
      Parameters:
      value - url (A network address on which the device may be contacted directly.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • getUrl

      public String getUrl()
      Returns:
      A network address on which the device may be contacted directly.

    • setUrl

      public Device setUrl(String value)
      Parameters:
      value - A network address on which the device may be contacted directly.

    • getNote

      public List<Annotation> getNote()
      Returns:
      note (Descriptive information, usage information or implantation information that is not captured in an existing element.)

    • setNote

      public Device setNote(List<Annotation> theNote)
      Returns:
      Returns a reference to this for easy method chaining

    • hasNote

      public boolean hasNote()

    • addNote

      public Annotation addNote()

    • addNote

      public Device addNote(Annotation t)

    • getNoteFirstRep

      public Annotation getNoteFirstRep()
      Returns:
      The first repetition of repeating field note, creating it if it does not already exist

    • getSafety

      public List<CodeableConcept> getSafety()
      Returns:
      safety (Provides additional safety characteristics about a medical device. For example devices containing latex.)

    • setSafety

      public Device setSafety(List<CodeableConcept> theSafety)
      Returns:
      Returns a reference to this for easy method chaining

    • hasSafety

      public boolean hasSafety()

    • addSafety

      public CodeableConcept addSafety()

    • addSafety

      public Device addSafety(CodeableConcept t)

    • getSafetyFirstRep

      public CodeableConcept getSafetyFirstRep()
      Returns:
      The first repetition of repeating field safety, creating it if it does not already exist

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class DomainResource

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getProperty

      public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

      public String fhirType()
      Specified by:
      fhirType in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      fhirType in class DomainResource

    • copy

      public Device copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected Device typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      Overrides:
      isEmpty in class DomainResource

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource