Class Device
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.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 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
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDevice.DeviceAssociationStatusComponentstatic classDevice.DeviceDeviceNameComponentstatic classDevice.DeviceLinkComponentstatic classDevice.DeviceOperationalStatusComponentstatic classDevice.DevicePropertyComponentstatic classDevice.DeviceUdiCarrierComponentstatic classDevice.DeviceVersionComponentstatic classDevice.FHIRDeviceStatusstatic classDevice.FHIRDeviceStatusEnumFactorystatic classDevice.UDIEntryTypestatic classDevice.UDIEntryTypeEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected Device.DeviceAssociationStatusComponentassociationStatusThe state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.static ca.uhn.fhir.rest.gclient.TokenClientParamBIOLOGICAL_SOURCEFluent Client search parameter constant for biological-sourceprotected IdentifierbiologicalSourceAn identifier that supports traceability to the biological entity that is the source of biological material in the product.protected List<ContactPoint>contactContact details for an organization or a particular human that is responsible for the device.protected CodeableReferencedefinitionThe reference to the definition for the device.static ca.uhn.fhir.rest.gclient.ReferenceClientParamDEFINITIONFluent Client search parameter constant for definitionstatic ca.uhn.fhir.rest.gclient.StringClientParamDEVICE_NAMEFluent Client search parameter constant for device-nameprotected List<Device.DeviceDeviceNameComponent>deviceNameThis represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device.static ca.uhn.fhir.rest.gclient.TokenClientParamDINFluent Client search parameter constant for dinprotected StringTypedisplayNameThe name used to display by default when the device is referenced.protected List<Reference>endpointTechnical endpoints providing access to services provided by the device defined at this resource.static ca.uhn.fhir.rest.gclient.DateClientParamEXPIRATION_DATEFluent Client search parameter constant for expiration-dateprotected DateTimeTypeexpirationDateThe date and time beyond which this device is no longer valid or should not be used (if applicable).protected List<Identifier>identifierUnique instance identifiers assigned to a device by manufacturers other organizations or owners.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_DEFINITIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_LOCATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ORGANIZATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PARENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected List<Device.DeviceLinkComponent>linkAn associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.protected ReferencelocationThe place where the device can be found.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLOCATIONFluent Client search parameter constant for locationstatic ca.uhn.fhir.rest.gclient.StringClientParamLOT_NUMBERFluent Client search parameter constant for lot-numberprotected StringTypelotNumberLot number assigned by the manufacturer.static ca.uhn.fhir.rest.gclient.DateClientParamMANUFACTURE_DATEFluent Client search parameter constant for manufacture-dateprotected DateTimeTypemanufactureDateThe date and time when the device was manufactured.protected StringTypemanufacturerA name of the manufacturer or entity legally responsible for the device.static ca.uhn.fhir.rest.gclient.StringClientParamMANUFACTURERFluent Client search parameter constant for manufacturerstatic ca.uhn.fhir.rest.gclient.StringClientParamMODELFluent Client search parameter constant for modelprotected StringTypemodelNumberThe manufacturer's model number for the device.protected List<Annotation>noteDescriptive information, usage information or implantation information that is not captured in an existing element.protected Device.DeviceOperationalStatusComponentoperationalStatusThe status of the device itself - whether it is switched on, or activated, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParamORGANIZATIONFluent Client search parameter constant for organizationprotected ReferenceownerAn organization that is responsible for the provision and ongoing maintenance of the device.protected ReferenceparentThe device that this device is attached to or is part of.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPARENTFluent Client search parameter constant for parentprotected StringTypepartNumberThe part number or catalog number of the device.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected List<Device.DevicePropertyComponent>propertyThe actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.protected List<CodeableConcept>safetyProvides additional safety characteristics about a medical device.static ca.uhn.fhir.rest.gclient.StringClientParamSERIAL_NUMBERFluent Client search parameter constant for serial-numberprotected StringTypeserialNumberThe serial number assigned by the organization when the device was manufactured.static StringSP_BIOLOGICAL_SOURCESearch parameter: biological-sourcestatic StringSP_DEFINITIONSearch parameter: definitionstatic StringSP_DEVICE_NAMESearch parameter: device-namestatic StringSP_DINSearch parameter: dinstatic StringSP_EXPIRATION_DATESearch parameter: expiration-datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_LOT_NUMBERSearch parameter: lot-numberstatic StringSP_MANUFACTURE_DATESearch parameter: manufacture-datestatic StringSP_MANUFACTURERSearch parameter: manufacturerstatic StringSP_MODELSearch parameter: modelstatic StringSP_ORGANIZATIONSearch parameter: organizationstatic StringSP_PARENTSearch parameter: parentstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SERIAL_NUMBERSearch parameter: serial-numberstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TYPESearch parameter: typestatic StringSP_UDI_CARRIERSearch parameter: udi-carrierstatic StringSP_UDI_DISearch parameter: udi-distatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Device.FHIRDeviceStatus>statusStatus of the Device record.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected List<CodeableConcept>statusReasonReason for the status of the Device record.protected ReferencesubjectPatient 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.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected List<CodeableConcept>typeThe kind or type of device.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typestatic ca.uhn.fhir.rest.gclient.StringClientParamUDI_CARRIERFluent Client search parameter constant for udi-carrierstatic ca.uhn.fhir.rest.gclient.StringClientParamUDI_DIFluent Client search parameter constant for udi-diprotected List<Device.DeviceUdiCarrierComponent>udiCarrierUnique device identifier (UDI) assigned to device label or package.protected UriTypeurlA network address on which the device may be contacted directly.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected List<Device.DeviceVersionComponent>versionThe actual design of the device or software version running on the device.static ca.uhn.fhir.rest.gclient.StringClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Device()Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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.
-
definition
protected CodeableReference definition
The reference to the definition for the device.
-
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.
-
status
protected Enumeration<Device.FHIRDeviceStatus> status
Status of the Device record. This is not the status of the device like availability.
-
statusReason
protected List<CodeableConcept> statusReason
Reason for the status of the Device record. For example, why is the record not active.
-
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.
-
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).
-
lotNumber
protected StringType lotNumber
Lot number assigned by the manufacturer.
-
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.
-
modelNumber
protected StringType modelNumber
The manufacturer's model number for the device.
-
partNumber
protected StringType partNumber
The part number or catalog number of the device.
-
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.
-
version
protected List<Device.DeviceVersionComponent> version
The actual design of the device or software version running on the device.
-
property
protected List<Device.DevicePropertyComponent> property
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
-
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.
-
operationalStatus
protected Device.DeviceOperationalStatusComponent operationalStatus
The status of the device itself - whether it is switched on, or activated, etc.
-
associationStatus
protected Device.DeviceAssociationStatusComponent associationStatus
The state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.
-
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.
-
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.
-
SP_BIOLOGICAL_SOURCE
public static final String SP_BIOLOGICAL_SOURCE
Search parameter: biological-sourceDescription: The biological source for the device
Type: token
Path: Device.biologicalSource
- See Also:
- Constant Field Values
-
BIOLOGICAL_SOURCE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BIOLOGICAL_SOURCE
Fluent Client search parameter constant for biological-sourceDescription: The biological source for the device
Type: token
Path: Device.biologicalSource
-
SP_DEFINITION
public static final String SP_DEFINITION
Search parameter: definitionDescription: 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 definitionDescription: 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-nameDescription: 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-nameDescription: 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
-
SP_EXPIRATION_DATE
public static final String SP_EXPIRATION_DATE
Search parameter: expiration-dateDescription: The expiration date of the device
Type: date
Path: Device.expirationDate
- See Also:
- Constant Field Values
-
EXPIRATION_DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam EXPIRATION_DATE
Fluent Client search parameter constant for expiration-dateDescription: The expiration date of the device
Type: date
Path: Device.expirationDate
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: Instance id from manufacturer, owner, and others
Type: token
Path: Device.identifier
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: 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 locationDescription: 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_LOT_NUMBER
public static final String SP_LOT_NUMBER
Search parameter: lot-numberDescription: The lot number of the device
Type: string
Path: Device.lotNumber
- See Also:
- Constant Field Values
-
LOT_NUMBER
public static final ca.uhn.fhir.rest.gclient.StringClientParam LOT_NUMBER
Fluent Client search parameter constant for lot-numberDescription: The lot number of the device
Type: string
Path: Device.lotNumber
-
SP_MANUFACTURE_DATE
public static final String SP_MANUFACTURE_DATE
Search parameter: manufacture-dateDescription: The manufacture date of the device
Type: date
Path: Device.manufactureDate
- See Also:
- Constant Field Values
-
MANUFACTURE_DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam MANUFACTURE_DATE
Fluent Client search parameter constant for manufacture-dateDescription: The manufacture date of the device
Type: date
Path: Device.manufactureDate
-
SP_MANUFACTURER
public static final String SP_MANUFACTURER
Search parameter: manufacturerDescription: 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 manufacturerDescription: The manufacturer of the device
Type: string
Path: Device.manufacturer
-
SP_MODEL
public static final String SP_MODEL
Search parameter: modelDescription: 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 modelDescription: The model of the device
Type: string
Path: Device.modelNumber
-
SP_ORGANIZATION
public static final String SP_ORGANIZATION
Search parameter: organizationDescription: 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 organizationDescription: 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_PARENT
public static final String SP_PARENT
Search parameter: parentDescription: The parent device
Type: reference
Path: Device.parent
- See Also:
- Constant Field Values
-
PARENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PARENT
Fluent Client search parameter constant for parentDescription: 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: patientDescription: 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 patientDescription: 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".
-
SP_SERIAL_NUMBER
public static final String SP_SERIAL_NUMBER
Search parameter: serial-numberDescription: The serial number of the device
Type: string
Path: Device.serialNumber
- See Also:
- Constant Field Values
-
SERIAL_NUMBER
public static final ca.uhn.fhir.rest.gclient.StringClientParam SERIAL_NUMBER
Fluent Client search parameter constant for serial-numberDescription: The serial number of the device
Type: string
Path: Device.serialNumber
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: active | inactive | entered-in-error | unknown
Type: token
Path: Device.status
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: 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".
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: The type of the device
Type: token
Path: Device.type
-
SP_UDI_CARRIER
public static final String SP_UDI_CARRIER
Search parameter: udi-carrierDescription: 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-carrierDescription: 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-diDescription: 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-diDescription: The udi Device Identifier (DI)
Type: string
Path: Device.udiCarrier.deviceIdentifier
-
SP_URL
public static final String SP_URL
Search parameter: urlDescription: 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 urlDescription: Network address to contact device
Type: uri
Path: Device.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: 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 versionDescription: The specific version of the device
Type: string
Path: Device.version.value
-
SP_DIN
public static final String SP_DIN
Search parameter: dinDescription: 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 dinDescription: 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
-
-
Method Detail
-
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
thisfor 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 {3}
-
getDisplayNameElement
public StringType getDisplayNameElement()
- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getDisplayName" gives direct access to the value
-
hasDisplayNameElement
public boolean hasDisplayNameElement()
-
hasDisplayName
public boolean hasDisplayName()
-
setDisplayNameElement
public Device setDisplayNameElement(StringType value)
- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getDisplayName" gives direct access to the value
-
getDisplayName
public String getDisplayName()
- Returns:
- 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.
-
setDisplayName
public Device setDisplayName(String value)
- Parameters:
value- 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.
-
getDefinition
public CodeableReference getDefinition()
- Returns:
definition(The reference to the definition for the device.)
-
hasDefinition
public boolean hasDefinition()
-
setDefinition
public Device setDefinition(CodeableReference value)
- Parameters:
value-definition(The reference to the definition for the device.)
-
getUdiCarrier
public List<Device.DeviceUdiCarrierComponent> getUdiCarrier()
- Returns:
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.)
-
setUdiCarrier
public Device setUdiCarrier(List<Device.DeviceUdiCarrierComponent> theUdiCarrier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUdiCarrier
public boolean hasUdiCarrier()
-
addUdiCarrier
public Device.DeviceUdiCarrierComponent addUdiCarrier()
-
addUdiCarrier
public Device addUdiCarrier(Device.DeviceUdiCarrierComponent t)
-
getUdiCarrierFirstRep
public Device.DeviceUdiCarrierComponent getUdiCarrierFirstRep()
- Returns:
- The first repetition of repeating field
udiCarrier, creating it if it does not already exist {3}
-
getStatusElement
public Enumeration<Device.FHIRDeviceStatus> getStatusElement()
- Returns:
status(Status of the Device record. This is not the status of the device like 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 record. This is not the status of the device like 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 record. This is not the status of the device like availability.
-
setStatus
public Device setStatus(Device.FHIRDeviceStatus value)
- Parameters:
value- Status of the Device record. This is not the status of the device like availability.
-
getStatusReason
public List<CodeableConcept> getStatusReason()
- Returns:
statusReason(Reason for the status of the Device record. For example, why is the record not active.)
-
setStatusReason
public Device setStatusReason(List<CodeableConcept> theStatusReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasStatusReason
public boolean hasStatusReason()
-
addStatusReason
public CodeableConcept addStatusReason()
-
addStatusReason
public Device addStatusReason(CodeableConcept t)
-
getStatusReasonFirstRep
public CodeableConcept getStatusReasonFirstRep()
- Returns:
- The first repetition of repeating field
statusReason, creating it if it does not already exist {3}
-
getBiologicalSource
public Identifier getBiologicalSource()
- Returns:
biologicalSource(An identifier that supports traceability to the biological entity that is the source of biological material in the product.)
-
hasBiologicalSource
public boolean hasBiologicalSource()
-
setBiologicalSource
public Device setBiologicalSource(Identifier value)
- Parameters:
value-biologicalSource(An identifier that supports traceability to the biological entity that is the source of biological material in the product.)
-
getManufacturerElement
public StringType getManufacturerElement()
- Returns:
manufacturer(A name of the manufacturer or entity legally responsible for the device.). 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 or entity legally responsible for the device.). 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 or entity legally responsible for the device.
-
setManufacturer
public Device setManufacturer(String value)
- Parameters:
value- A name of the manufacturer or entity legally responsible for the device.
-
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).
-
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.
-
getSerialNumberElement
public StringType getSerialNumberElement()
- Returns:
serialNumber(The serial number assigned by the organization when the device was manufactured.). This is the underlying object with id, value and extensions. The accessor "getSerialNumber" gives direct access to the value
-
hasSerialNumberElement
public boolean hasSerialNumberElement()
-
hasSerialNumber
public boolean hasSerialNumber()
-
setSerialNumberElement
public Device setSerialNumberElement(StringType value)
- Parameters:
value-serialNumber(The serial number assigned by the organization when the device was manufactured.). This is the underlying object with id, value and extensions. The accessor "getSerialNumber" gives direct access to the value
-
getSerialNumber
public String getSerialNumber()
- Returns:
- The serial number assigned by the organization when the device was manufactured.
-
setSerialNumber
public Device setSerialNumber(String value)
- Parameters:
value- The serial number assigned by the organization when the device was manufactured.
-
getDeviceName
public List<Device.DeviceDeviceNameComponent> getDeviceName()
- Returns:
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.)
-
setDeviceName
public Device setDeviceName(List<Device.DeviceDeviceNameComponent> theDeviceName)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDeviceName
public boolean hasDeviceName()
-
addDeviceName
public Device.DeviceDeviceNameComponent addDeviceName()
-
addDeviceName
public Device addDeviceName(Device.DeviceDeviceNameComponent t)
-
getDeviceNameFirstRep
public Device.DeviceDeviceNameComponent getDeviceNameFirstRep()
- Returns:
- The first repetition of repeating field
deviceName, creating it if it does not already exist {3}
-
getModelNumberElement
public StringType getModelNumberElement()
- Returns:
modelNumber(The manufacturer's model number for the device.). This is the underlying object with id, value and extensions. The accessor "getModelNumber" gives direct access to the value
-
hasModelNumberElement
public boolean hasModelNumberElement()
-
hasModelNumber
public boolean hasModelNumber()
-
setModelNumberElement
public Device setModelNumberElement(StringType value)
- Parameters:
value-modelNumber(The manufacturer's model number for the device.). This is the underlying object with id, value and extensions. The accessor "getModelNumber" gives direct access to the value
-
getModelNumber
public String getModelNumber()
- Returns:
- The manufacturer's model number for the device.
-
setModelNumber
public Device setModelNumber(String value)
- Parameters:
value- The manufacturer's model number for the device.
-
getPartNumberElement
public StringType getPartNumberElement()
- Returns:
partNumber(The part number or catalog number of the device.). This is the underlying object with id, value and extensions. The accessor "getPartNumber" gives direct access to the value
-
hasPartNumberElement
public boolean hasPartNumberElement()
-
hasPartNumber
public boolean hasPartNumber()
-
setPartNumberElement
public Device setPartNumberElement(StringType value)
- Parameters:
value-partNumber(The part number or catalog number of the device.). This is the underlying object with id, value and extensions. The accessor "getPartNumber" gives direct access to the value
-
getPartNumber
public String getPartNumber()
- Returns:
- The part number or catalog number of the device.
-
setPartNumber
public Device setPartNumber(String value)
- Parameters:
value- The part number or catalog number of the device.
-
getType
public List<CodeableConcept> getType()
- Returns:
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.)
-
setType
public Device setType(List<CodeableConcept> theType)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasType
public boolean hasType()
-
addType
public CodeableConcept addType()
-
addType
public Device addType(CodeableConcept t)
-
getTypeFirstRep
public CodeableConcept getTypeFirstRep()
- Returns:
- The first repetition of repeating field
type, creating it if it does not already exist {3}
-
getVersion
public List<Device.DeviceVersionComponent> getVersion()
- Returns:
version(The actual design of the device or software version running on the device.)
-
setVersion
public Device setVersion(List<Device.DeviceVersionComponent> theVersion)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasVersion
public boolean hasVersion()
-
addVersion
public Device.DeviceVersionComponent addVersion()
-
addVersion
public Device addVersion(Device.DeviceVersionComponent t)
-
getVersionFirstRep
public Device.DeviceVersionComponent getVersionFirstRep()
- Returns:
- The first repetition of repeating field
version, creating it if it does not already exist {3}
-
getProperty
public List<Device.DevicePropertyComponent> getProperty()
- Returns:
property(The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.)
-
setProperty
public Device setProperty(List<Device.DevicePropertyComponent> theProperty)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasProperty
public boolean hasProperty()
-
addProperty
public Device.DevicePropertyComponent addProperty()
-
addProperty
public Device addProperty(Device.DevicePropertyComponent t)
-
getPropertyFirstRep
public Device.DevicePropertyComponent getPropertyFirstRep()
- Returns:
- The first repetition of repeating field
property, creating it if it does not already exist {3}
-
getSubject
public Reference getSubject()
- Returns:
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.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public Device setSubject(Reference value)
- Parameters:
value-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.)
-
getOperationalStatus
public Device.DeviceOperationalStatusComponent getOperationalStatus()
- Returns:
operationalStatus(The status of the device itself - whether it is switched on, or activated, etc.)
-
hasOperationalStatus
public boolean hasOperationalStatus()
-
setOperationalStatus
public Device setOperationalStatus(Device.DeviceOperationalStatusComponent value)
- Parameters:
value-operationalStatus(The status of the device itself - whether it is switched on, or activated, etc.)
-
getAssociationStatus
public Device.DeviceAssociationStatusComponent getAssociationStatus()
- Returns:
associationStatus(The state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.)
-
hasAssociationStatus
public boolean hasAssociationStatus()
-
setAssociationStatus
public Device setAssociationStatus(Device.DeviceAssociationStatusComponent value)
- Parameters:
value-associationStatus(The state of the usage or application of the device - whether the device is implanted, or explanted, or attached to the patient.)
-
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.)
-
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
thisfor 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 {3}
-
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.)
-
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.
-
getEndpoint
public List<Reference> getEndpoint()
- Returns:
endpoint(Technical endpoints providing access to services provided by the device defined at this resource.)
-
setEndpoint
public Device setEndpoint(List<Reference> theEndpoint)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndpoint
public boolean hasEndpoint()
-
addEndpoint
public Reference addEndpoint()
-
addEndpoint
public Device addEndpoint(Reference t)
-
getEndpointFirstRep
public Reference getEndpointFirstRep()
- Returns:
- The first repetition of repeating field
endpoint, creating it if it does not already exist {3}
-
getLink
public List<Device.DeviceLinkComponent> getLink()
- Returns:
link(An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.)
-
setLink
public Device setLink(List<Device.DeviceLinkComponent> theLink)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLink
public boolean hasLink()
-
addLink
public Device.DeviceLinkComponent addLink()
-
addLink
public Device addLink(Device.DeviceLinkComponent t)
-
getLinkFirstRep
public Device.DeviceLinkComponent getLinkFirstRep()
- Returns:
- The first repetition of repeating field
link, creating it if it does not already exist {3}
-
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
thisfor 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 {3}
-
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
thisfor 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 {3}
-
getParent
public Reference getParent()
- Returns:
parent(The device that this device is attached to or is part of.)
-
hasParent
public boolean hasParent()
-
setParent
public Device setParent(Reference value)
- Parameters:
value-parent(The device that this device is attached to or is part of.)
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Device copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Device dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-