Package ca.uhn.fhir.model.dstu2.resource

Class Device

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.Device
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
public class Device extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR Device Resource ()

Definition: This resource identifies an instance 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 includes 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.

Requirements: Allows institutions to track their devices.

Profile Definition: http://hl7.org/fhir/profiles/Device

See Also:
Serialized Form

  • Field Details

    • SP_TYPE

      public static final String SP_TYPE
      Search parameter constant for type

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

      See Also:
      Constant Field Values

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

      public static final String SP_MANUFACTURER
      Search parameter constant for manufacturer

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

      See Also:
      Constant Field Values

    • 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 constant for model

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

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

    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter constant for 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

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for 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 constant for 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

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description: Patient information, if the resource is affixed to a person
      Type: reference
      Path: Device.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.patient

    • SP_UDI

      public static final String SP_UDI
      Search parameter constant for udi

      Description: FDA mandated Unique Device Identifier
      Type: string
      Path: Device.udi

      See Also:
      Constant Field Values

    • UDI

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

      Description: FDA mandated Unique Device Identifier
      Type: string
      Path: Device.udi

    • SP_URL

      public static final String SP_URL
      Search parameter constant for 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

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

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

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

  • Constructor Details

  • Method Details

    • isEmpty

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

    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

    • getIdentifier

      public List<IdentifierDt> getIdentifier()
      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

    • setIdentifier

      public Device setIdentifier​(List<IdentifierDt> theValue)
      Sets the value(s) for identifier ()

      Definition: Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

    • addIdentifier

      public IdentifierDt addIdentifier()
      Adds and returns a new value for identifier ()

      Definition: Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

    • addIdentifier

      public Device addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier ()

      Definition: Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

      Parameters:
      theValue - The identifier to add (must not be null)

    • getIdentifierFirstRep

      public IdentifierDt getIdentifierFirstRep()
      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: Unique instance identifiers assigned to a device by organizations like manufacturers or owners. If the identifier identifies the type of device, Device.type should be used.

    • getType

      public CodeableConceptDt getType()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      Definition: Code or identifier to identify a kind of device.

    • setType

      public Device setType​(CodeableConceptDt theValue)
      Sets the value(s) for type ()

      Definition: Code or identifier to identify a kind of device.

    • getNote

      public List<AnnotationDt> getNote()
      Gets the value(s) for note (). creating it if it does not exist. Will not return null.

      Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.

    • setNote

      public Device setNote​(List<AnnotationDt> theValue)
      Sets the value(s) for note ()

      Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.

    • addNote

      public AnnotationDt addNote()
      Adds and returns a new value for note ()

      Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.

    • addNote

      public Device addNote​(AnnotationDt theValue)
      Adds a given new value for note ()

      Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.

      Parameters:
      theValue - The note to add (must not be null)

    • getNoteFirstRep

      public AnnotationDt getNoteFirstRep()
      Gets the first repetition for note (), creating it if it does not already exist.

      Definition: Descriptive information, usage information or implantation information that is not captured in an existing element.

    • getStatusElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceStatusEnum> getStatusElement()
      Gets the value(s) for status (). creating it if it does not exist. Will not return null.

      Definition: Status of the Device availability.

    • getStatus

      public String getStatus()
      Gets the value(s) for status (). creating it if it does not exist. This method may return null.

      Definition: Status of the Device availability.

    • setStatus

      public Device setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<DeviceStatusEnum> theValue)
      Sets the value(s) for status ()

      Definition: Status of the Device availability.

    • setStatus

      public Device setStatus​(DeviceStatusEnum theValue)
      Sets the value(s) for status ()

      Definition: Status of the Device availability.

    • getManufacturerElement

      public ca.uhn.fhir.model.primitive.StringDt getManufacturerElement()
      Gets the value(s) for manufacturer (). creating it if it does not exist. Will not return null.

      Definition: A name of the manufacturer

    • getManufacturer

      public String getManufacturer()
      Gets the value(s) for manufacturer (). creating it if it does not exist. This method may return null.

      Definition: A name of the manufacturer

    • setManufacturer

      public Device setManufacturer​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for manufacturer ()

      Definition: A name of the manufacturer

    • setManufacturer

      public Device setManufacturer​(String theString)
      Sets the value for manufacturer ()

      Definition: A name of the manufacturer

    • getModelElement

      public ca.uhn.fhir.model.primitive.StringDt getModelElement()
      Gets the value(s) for model (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • getModel

      public String getModel()
      Gets the value(s) for model (). creating it if it does not exist. This method may return null.

      Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for model ()

      Definition: 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 theString)
      Sets the value for model ()

      Definition: 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 ca.uhn.fhir.model.primitive.StringDt getVersionElement()
      Gets the value(s) for version (). creating it if it does not exist. Will not return null.

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

    • getVersion

      public String getVersion()
      Gets the value(s) for version (). creating it if it does not exist. This method may return null.

      Definition: 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​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for version ()

      Definition: 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 theString)
      Sets the value for version ()

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

    • getManufactureDateElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getManufactureDateElement()
      Gets the value(s) for manufactureDate (). creating it if it does not exist. Will not return null.

      Definition: The date and time when the device was manufactured.

    • getManufactureDate

      public Date getManufactureDate()
      Gets the value(s) for manufactureDate (). creating it if it does not exist. This method may return null.

      Definition: The date and time when the device was manufactured.

    • setManufactureDate

      public Device setManufactureDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for manufactureDate ()

      Definition: The date and time when the device was manufactured.

    • setManufactureDate

      public Device setManufactureDate​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for manufactureDate ()

      Definition: The date and time when the device was manufactured.

    • setManufactureDateWithSecondsPrecision

      public Device setManufactureDateWithSecondsPrecision​(Date theDate)
      Sets the value for manufactureDate ()

      Definition: The date and time when the device was manufactured.

    • getExpiryElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getExpiryElement()
      Gets the value(s) for expiry (). creating it if it does not exist. Will not return null.

      Definition: The date and time beyond which this device is no longer valid or should not be used (if applicable)

    • getExpiry

      public Date getExpiry()
      Gets the value(s) for expiry (). creating it if it does not exist. This method may return null.

      Definition: The date and time beyond which this device is no longer valid or should not be used (if applicable)

    • setExpiry

      public Device setExpiry​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for expiry ()

      Definition: The date and time beyond which this device is no longer valid or should not be used (if applicable)

    • setExpiry

      public Device setExpiry​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for expiry ()

      Definition: The date and time beyond which this device is no longer valid or should not be used (if applicable)

    • setExpiryWithSecondsPrecision

      public Device setExpiryWithSecondsPrecision​(Date theDate)
      Sets the value for expiry ()

      Definition: The date and time beyond which this device is no longer valid or should not be used (if applicable)

    • getUdiElement

      public ca.uhn.fhir.model.primitive.StringDt getUdiElement()
      Gets the value(s) for udi (). creating it if it does not exist. Will not return null.

      Definition: United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm

    • getUdi

      public String getUdi()
      Gets the value(s) for udi (). creating it if it does not exist. This method may return null.

      Definition: United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm

    • setUdi

      public Device setUdi​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for udi ()

      Definition: United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm

    • setUdi

      public Device setUdi​(String theString)
      Sets the value for udi ()

      Definition: United States Food and Drug Administration mandated Unique Device Identifier (UDI). Use the human readable information (the content that the user sees, which is sometimes different to the exact syntax represented in the barcode) - see http://www.fda.gov/MedicalDevices/DeviceRegulationandGuidance/UniqueDeviceIdentification/default.htm

    • getLotNumberElement

      public ca.uhn.fhir.model.primitive.StringDt getLotNumberElement()
      Gets the value(s) for lotNumber (). creating it if it does not exist. Will not return null.

      Definition: Lot number assigned by the manufacturer

    • getLotNumber

      public String getLotNumber()
      Gets the value(s) for lotNumber (). creating it if it does not exist. This method may return null.

      Definition: Lot number assigned by the manufacturer

    • setLotNumber

      public Device setLotNumber​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for lotNumber ()

      Definition: Lot number assigned by the manufacturer

    • setLotNumber

      public Device setLotNumber​(String theString)
      Sets the value for lotNumber ()

      Definition: Lot number assigned by the manufacturer

    • getOwner

      public ResourceReferenceDt getOwner()
      Gets the value(s) for owner (). creating it if it does not exist. Will not return null.

      Definition: An organization that is responsible for the provision and ongoing maintenance of the device.

    • setOwner

      public Device setOwner​(ResourceReferenceDt theValue)
      Sets the value(s) for owner ()

      Definition: An organization that is responsible for the provision and ongoing maintenance of the device.

    • getLocation

      public ResourceReferenceDt getLocation()
      Gets the value(s) for location (). creating it if it does not exist. Will not return null.

      Definition: The place where the device can be found.

    • setLocation

      public Device setLocation​(ResourceReferenceDt theValue)
      Sets the value(s) for location ()

      Definition: The place where the device can be found.

    • getPatient

      public ResourceReferenceDt getPatient()
      Gets the value(s) for patient (). creating it if it does not exist. Will not return null.

      Definition: Patient information, if the resource is affixed to a person

    • setPatient

      public Device setPatient​(ResourceReferenceDt theValue)
      Sets the value(s) for patient ()

      Definition: Patient information, if the resource is affixed to a person

    • getContact

      public List<ContactPointDt> getContact()
      Gets the value(s) for contact (). creating it if it does not exist. Will not return null.

      Definition: Contact details for an organization or a particular human that is responsible for the device

    • setContact

      public Device setContact​(List<ContactPointDt> theValue)
      Sets the value(s) for contact ()

      Definition: Contact details for an organization or a particular human that is responsible for the device

    • addContact

      public ContactPointDt addContact()
      Adds and returns a new value for contact ()

      Definition: Contact details for an organization or a particular human that is responsible for the device

    • addContact

      public Device addContact​(ContactPointDt theValue)
      Adds a given new value for contact ()

      Definition: Contact details for an organization or a particular human that is responsible for the device

      Parameters:
      theValue - The contact to add (must not be null)

    • getContactFirstRep

      public ContactPointDt getContactFirstRep()
      Gets the first repetition for contact (), creating it if it does not already exist.

      Definition: Contact details for an organization or a particular human that is responsible for the device

    • getUrlElement

      public ca.uhn.fhir.model.primitive.UriDt getUrlElement()
      Gets the value(s) for url (). creating it if it does not exist. Will not return null.

      Definition: A network address on which the device may be contacted directly

    • getUrl

      public String getUrl()
      Gets the value(s) for url (). creating it if it does not exist. This method may return null.

      Definition: A network address on which the device may be contacted directly

    • setUrl

      public Device setUrl​(ca.uhn.fhir.model.primitive.UriDt theValue)
      Sets the value(s) for url ()

      Definition: A network address on which the device may be contacted directly

    • setUrl

      public Device setUrl​(String theUri)
      Sets the value for url ()

      Definition: A network address on which the device may be contacted directly

    • getResourceName

      public String getResourceName()
      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource

    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource