Package org.hl7.fhir.r4.model

Class Device

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.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

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.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Device.DeviceDeviceNameComponent
static enum	Device.DeviceNameType
static class	Device.DeviceNameTypeEnumFactory
static class	Device.DevicePropertyComponent
static class	Device.DeviceSpecializationComponent
static class	Device.DeviceUdiCarrierComponent
static class	Device.DeviceVersionComponent
static enum	Device.FHIRDeviceStatus
static class	Device.FHIRDeviceStatusEnumFactory
static enum	Device.UDIEntryType
static class	Device.UDIEntryTypeEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected List<ContactPoint>	contact	Contact details for an organization or a particular human that is responsible for the device.
protected Reference	definition	The reference to the definition for the device.
protected DeviceDefinition	definitionTarget	The actual object that is the target of the reference (The reference to the definition for the device.)
static final ca.uhn.fhir.rest.gclient.StringClientParam	DEVICE_NAME	Fluent Client search parameter constant for device-name
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.
protected StringType	distinctIdentifier	The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
protected DateTimeType	expirationDate	The date and time beyond which this device is no longer valid or should not be used (if applicable).
protected List<Identifier>	identifier	Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_LOCATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ORGANIZATION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
protected Reference	location	The place where the device can be found.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	LOCATION	Fluent Client search parameter constant for location
protected Location	locationTarget	The actual object that is the target of the reference (The place where the device can be found.)
protected StringType	lotNumber	Lot number assigned by the manufacturer.
protected DateTimeType	manufactureDate	The date and time when the device was manufactured.
protected StringType	manufacturer	A name of the manufacturer.
static final ca.uhn.fhir.rest.gclient.StringClientParam	MANUFACTURER	Fluent Client search parameter constant for manufacturer
static final ca.uhn.fhir.rest.gclient.StringClientParam	MODEL	Fluent Client search parameter constant for model
protected StringType	modelNumber	The model number for the device.
protected List<Annotation>	note	Descriptive information, usage information or implantation information that is not captured in an existing element.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ORGANIZATION	Fluent Client search parameter constant for organization
protected Reference	owner	An organization that is responsible for the provision and ongoing maintenance of the device.
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.)
protected Reference	parent	The parent device.
protected Device	parentTarget	The actual object that is the target of the reference (The parent device.)
protected StringType	partNumber	The part number of the device.
protected Reference	patient	Patient information, If the device is affixed to a person.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Patient	patientTarget	The actual object that is the target of the reference (Patient information, If the device is affixed to a person.)
protected List<Device.DevicePropertyComponent>	property	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
protected List<CodeableConcept>	safety	Provides additional safety characteristics about a medical device.
protected StringType	serialNumber	The serial number assigned by the organization when the device was manufactured.
static final String	SP_DEVICE_NAME	Search parameter: device-name
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_LOCATION	Search parameter: location
static final String	SP_MANUFACTURER	Search parameter: manufacturer
static final String	SP_MODEL	Search parameter: model
static final String	SP_ORGANIZATION	Search parameter: organization
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_STATUS	Search parameter: status
static final String	SP_TYPE	Search parameter: type
static final String	SP_UDI_CARRIER	Search parameter: udi-carrier
static final String	SP_UDI_DI	Search parameter: udi-di
static final String	SP_URL	Search parameter: url
protected List<Device.DeviceSpecializationComponent>	specialization	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
protected Enumeration<Device.FHIRDeviceStatus>	status	Status of the Device availability.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected List<CodeableConcept>	statusReason	Reason for the dtatus of the Device availability.
protected CodeableConcept	type	The kind or type of device.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
static final ca.uhn.fhir.rest.gclient.StringClientParam	UDI_CARRIER	Fluent Client search parameter constant for udi-carrier
static final ca.uhn.fhir.rest.gclient.StringClientParam	UDI_DI	Fluent Client search parameter constant for udi-di
protected List<Device.DeviceUdiCarrierComponent>	udiCarrier	Unique device identifier (UDI) assigned to device label or package.
protected UriType	url	A network address on which the device may be contacted directly.
static final ca.uhn.fhir.rest.gclient.UriClientParam	URL	Fluent Client search parameter constant for url
protected List<Device.DeviceVersionComponent>	version	The actual design of the device or software version running on the device.

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Device()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
ContactPoint	addContact()
Device	addContact(ContactPoint t)
Device.DeviceDeviceNameComponent	addDeviceName()
Device	addDeviceName(Device.DeviceDeviceNameComponent t)
Identifier	addIdentifier()
Device	addIdentifier(Identifier t)
Annotation	addNote()
Device	addNote(Annotation t)
Device.DevicePropertyComponent	addProperty()
Device	addProperty(Device.DevicePropertyComponent t)
CodeableConcept	addSafety()
Device	addSafety(CodeableConcept t)
Device.DeviceSpecializationComponent	addSpecialization()
Device	addSpecialization(Device.DeviceSpecializationComponent t)
CodeableConcept	addStatusReason()
Device	addStatusReason(CodeableConcept t)
Device.DeviceUdiCarrierComponent	addUdiCarrier()
Device	addUdiCarrier(Device.DeviceUdiCarrierComponent t)
Device.DeviceVersionComponent	addVersion()
Device	addVersion(Device.DeviceVersionComponent t)
Device	copy()
void	copyValues(Device dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<ContactPoint>	getContact()
ContactPoint	getContactFirstRep()
Reference	getDefinition()
DeviceDefinition	getDefinitionTarget()
List<Device.DeviceDeviceNameComponent>	getDeviceName()
Device.DeviceDeviceNameComponent	getDeviceNameFirstRep()
String	getDistinctIdentifier()
StringType	getDistinctIdentifierElement()
Date	getExpirationDate()
DateTimeType	getExpirationDateElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Reference	getLocation()
Location	getLocationTarget()
String	getLotNumber()
StringType	getLotNumberElement()
Date	getManufactureDate()
DateTimeType	getManufactureDateElement()
String	getManufacturer()
StringType	getManufacturerElement()
String	getModelNumber()
StringType	getModelNumberElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Reference	getOwner()
Organization	getOwnerTarget()
Reference	getParent()
Device	getParentTarget()
String	getPartNumber()
StringType	getPartNumberElement()
Reference	getPatient()
Patient	getPatientTarget()
List<Device.DevicePropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
Device.DevicePropertyComponent	getPropertyFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getSafety()
CodeableConcept	getSafetyFirstRep()
String	getSerialNumber()
StringType	getSerialNumberElement()
List<Device.DeviceSpecializationComponent>	getSpecialization()
Device.DeviceSpecializationComponent	getSpecializationFirstRep()
Device.FHIRDeviceStatus	getStatus()
Enumeration<Device.FHIRDeviceStatus>	getStatusElement()
List<CodeableConcept>	getStatusReason()
CodeableConcept	getStatusReasonFirstRep()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
List<Device.DeviceUdiCarrierComponent>	getUdiCarrier()
Device.DeviceUdiCarrierComponent	getUdiCarrierFirstRep()
String	getUrl()
UriType	getUrlElement()
List<Device.DeviceVersionComponent>	getVersion()
Device.DeviceVersionComponent	getVersionFirstRep()
boolean	hasContact()
boolean	hasDefinition()
boolean	hasDeviceName()
boolean	hasDistinctIdentifier()
boolean	hasDistinctIdentifierElement()
boolean	hasExpirationDate()
boolean	hasExpirationDateElement()
boolean	hasIdentifier()
boolean	hasLocation()
boolean	hasLotNumber()
boolean	hasLotNumberElement()
boolean	hasManufactureDate()
boolean	hasManufactureDateElement()
boolean	hasManufacturer()
boolean	hasManufacturerElement()
boolean	hasModelNumber()
boolean	hasModelNumberElement()
boolean	hasNote()
boolean	hasOwner()
boolean	hasParent()
boolean	hasPartNumber()
boolean	hasPartNumberElement()
boolean	hasPatient()
boolean	hasProperty()
boolean	hasSafety()
boolean	hasSerialNumber()
boolean	hasSerialNumberElement()
boolean	hasSpecialization()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasStatusReason()
boolean	hasType()
boolean	hasUdiCarrier()
boolean	hasUrl()
boolean	hasUrlElement()
boolean	hasVersion()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
Device	setContact(List<ContactPoint> theContact)
Device	setDefinition(Reference value)
Device	setDefinitionTarget(DeviceDefinition value)
Device	setDeviceName(List<Device.DeviceDeviceNameComponent> theDeviceName)
Device	setDistinctIdentifier(String value)
Device	setDistinctIdentifierElement(StringType value)
Device	setExpirationDate(Date value)
Device	setExpirationDateElement(DateTimeType value)
Device	setIdentifier(List<Identifier> theIdentifier)
Device	setLocation(Reference value)
Device	setLocationTarget(Location value)
Device	setLotNumber(String value)
Device	setLotNumberElement(StringType value)
Device	setManufactureDate(Date value)
Device	setManufactureDateElement(DateTimeType value)
Device	setManufacturer(String value)
Device	setManufacturerElement(StringType value)
Device	setModelNumber(String value)
Device	setModelNumberElement(StringType value)
Device	setNote(List<Annotation> theNote)
Device	setOwner(Reference value)
Device	setOwnerTarget(Organization value)
Device	setParent(Reference value)
Device	setParentTarget(Device value)
Device	setPartNumber(String value)
Device	setPartNumberElement(StringType value)
Device	setPatient(Reference value)
Device	setPatientTarget(Patient value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Device	setProperty(List<Device.DevicePropertyComponent> theProperty)
Device	setSafety(List<CodeableConcept> theSafety)
Device	setSerialNumber(String value)
Device	setSerialNumberElement(StringType value)
Device	setSpecialization(List<Device.DeviceSpecializationComponent> theSpecialization)
Device	setStatus(Device.FHIRDeviceStatus value)
Device	setStatusElement(Enumeration<Device.FHIRDeviceStatus> value)
Device	setStatusReason(List<CodeableConcept> theStatusReason)
Device	setType(CodeableConcept value)
Device	setUdiCarrier(List<Device.DeviceUdiCarrierComponent> theUdiCarrier)
Device	setUrl(String value)
Device	setUrlElement(UriType value)
Device	setVersion(List<Device.DeviceVersionComponent> theVersion)
protected Device	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN, setXhtml

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

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Unique instance identifiers assigned to a device by manufacturers other organizations or owners.

definition

protected Reference definition

The reference to the definition for the device.

definitionTarget

protected DeviceDefinition definitionTarget

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

statusReason

protected List<CodeableConcept> statusReason

Reason for the dtatus of the Device availability.

distinctIdentifier

protected StringType distinctIdentifier

The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

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

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 model number for the device.

partNumber

protected StringType partNumber

The part number of the device.

type

protected CodeableConcept type

The kind or type of device.

specialization

protected List<Device.DeviceSpecializationComponent> specialization

The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.

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.

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.

parent

protected Reference parent

The parent device.

parentTarget

protected Device parentTarget

The actual object that is the target of the reference (The parent device.)

SP_UDI_DI

public static final String SP_UDI_DI

Search parameter: udi-di

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

See Also:

• Constant Field Values

UDI_DI

public static final ca.uhn.fhir.rest.gclient.StringClientParam UDI_DI

Fluent Client search parameter constant for udi-di

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

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

SP_UDI_CARRIER

public static final String SP_UDI_CARRIER

Search parameter: udi-carrier

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

See Also:

• Constant Field Values

UDI_CARRIER

public static final ca.uhn.fhir.rest.gclient.StringClientParam UDI_CARRIER

Fluent Client search parameter constant for udi-carrier

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

SP_DEVICE_NAME

public static final String SP_DEVICE_NAME

Search parameter: device-name

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

See Also:

• Constant Field Values

DEVICE_NAME

public static final ca.uhn.fhir.rest.gclient.StringClientParam DEVICE_NAME

Fluent Client search parameter constant for device-name

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

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:

• 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

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:

• Constant Field Values

ORGANIZATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORGANIZATION

Fluent Client search parameter constant for organization

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

INCLUDE_ORGANIZATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:organization".

SP_MODEL

public static final String SP_MODEL

Search parameter: model

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

See Also:

• Constant Field Values

MODEL

public static final ca.uhn.fhir.rest.gclient.StringClientParam MODEL

Fluent Client search parameter constant for model

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

SP_LOCATION

public static final String SP_LOCATION

Search parameter: location

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

See Also:

• Constant Field Values

LOCATION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam LOCATION

Fluent Client search parameter constant for location

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

INCLUDE_LOCATION

public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION

Constant for fluent queries to be used to add include statements. Specifies the path value of "Device:location".

SP_TYPE

public static final String SP_TYPE

Search parameter: 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_URL

public static final String SP_URL

Search parameter: url

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

See Also:

• Constant Field Values

URL

public static final ca.uhn.fhir.rest.gclient.UriClientParam URL

Fluent Client search parameter constant for url

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

SP_MANUFACTURER

public static final String SP_MANUFACTURER

Search parameter: 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_STATUS

public static final String SP_STATUS

Search parameter: status

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

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

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

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

getDefinition

public Reference getDefinition()

Returns:

definition (The reference to the definition for the device.)

hasDefinition

public boolean hasDefinition()

setDefinition

public Device setDefinition(Reference value)

Parameters:

value - definition (The reference to the definition for the device.)

getDefinitionTarget

public DeviceDefinition getDefinitionTarget()

Returns:

definition 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 reference to the definition for the device.)

setDefinitionTarget

public Device setDefinitionTarget(DeviceDefinition value)

Parameters:

value - definition 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 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 this for 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

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.

getStatusReason

public List<CodeableConcept> getStatusReason()

Returns:

statusReason (Reason for the dtatus of the Device availability.)

setStatusReason

public Device setStatusReason(List<CodeableConcept> theStatusReason)

Returns:

Returns a reference to this for 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

getDistinctIdentifierElement

public StringType getDistinctIdentifierElement()

Returns:

distinctIdentifier (The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.). This is the underlying object with id, value and extensions. The accessor "getDistinctIdentifier" gives direct access to the value

hasDistinctIdentifierElement

public boolean hasDistinctIdentifierElement()

hasDistinctIdentifier

public boolean hasDistinctIdentifier()

setDistinctIdentifierElement

public Device setDistinctIdentifierElement(StringType value)

Parameters:

value - distinctIdentifier (The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.). This is the underlying object with id, value and extensions. The accessor "getDistinctIdentifier" gives direct access to the value

getDistinctIdentifier

public String getDistinctIdentifier()

Returns:

The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

setDistinctIdentifier

public Device setDistinctIdentifier(String value)

Parameters:

value - The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

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

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 this for 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

getModelNumberElement

public StringType getModelNumberElement()

Returns:

modelNumber (The 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 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 model number for the device.

setModelNumber

public Device setModelNumber(String value)

Parameters:

value - The model number for the device.

getPartNumberElement

public StringType getPartNumberElement()

Returns:

partNumber (The part 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 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 of the device.

setPartNumber

public Device setPartNumber(String value)

Parameters:

value - The part number of the device.

getType

public CodeableConcept getType()

Returns:

type (The kind or type of device.)

hasType

public boolean hasType()

setType

public Device setType(CodeableConcept value)

Parameters:

value - type (The kind or type of device.)

getSpecialization

public List<Device.DeviceSpecializationComponent> getSpecialization()

Returns:

specialization (The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.)

setSpecialization

public Device setSpecialization(List<Device.DeviceSpecializationComponent> theSpecialization)

Returns:

Returns a reference to this for easy method chaining

hasSpecialization

public boolean hasSpecialization()

addSpecialization

public Device.DeviceSpecializationComponent addSpecialization()

addSpecialization

public Device addSpecialization(Device.DeviceSpecializationComponent t)

getSpecializationFirstRep

public Device.DeviceSpecializationComponent getSpecializationFirstRep()

Returns:

The first repetition of repeating field specialization, creating it if it does not already exist

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 this for 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

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 this for 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

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

getParent

public Reference getParent()

Returns:

parent (The parent device.)

hasParent

public boolean hasParent()

setParent

public Device setParent(Reference value)

Parameters:

value - parent (The parent device.)

getParentTarget

public Device getParentTarget()

Returns:

parent 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 parent device.)

setParentTarget

public Device setParentTarget(Device value)

Parameters:

value - parent 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 parent device.)

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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

copyValues

public void copyValues(Device dst)

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