Package org.hl7.fhir.r5.model

Class DeviceDefinition

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

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 DeviceDefinition
extends DomainResource

This is a specialized resource that defines the characteristics and capabilities of a device.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DeviceDefinition.DeviceCorrectiveActionScope
static class	DeviceDefinition.DeviceCorrectiveActionScopeEnumFactory
static class	DeviceDefinition.DeviceDefinitionChargeItemComponent
static class	DeviceDefinition.DeviceDefinitionClassificationComponent
static class	DeviceDefinition.DeviceDefinitionCorrectiveActionComponent
static class	DeviceDefinition.DeviceDefinitionDeviceNameComponent
static class	DeviceDefinition.DeviceDefinitionGuidelineComponent
static class	DeviceDefinition.DeviceDefinitionHasPartComponent
static class	DeviceDefinition.DeviceDefinitionLinkComponent
static class	DeviceDefinition.DeviceDefinitionMaterialComponent
static class	DeviceDefinition.DeviceDefinitionPackagingComponent
static class	DeviceDefinition.DeviceDefinitionPropertyComponent
static class	DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent
static enum	DeviceDefinition.DeviceDefinitionRegulatoryIdentifierType
static class	DeviceDefinition.DeviceDefinitionRegulatoryIdentifierTypeEnumFactory
static class	DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent
static class	DeviceDefinition.DeviceDefinitionVersionComponent
static enum	DeviceDefinition.DeviceProductionIdentifierInUDI
static class	DeviceDefinition.DeviceProductionIdentifierInUDIEnumFactory
static class	DeviceDefinition.PackagingDistributorComponent
static class	DeviceDefinition.UdiDeviceIdentifierMarketDistributionComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected List<DeviceDefinition.DeviceDefinitionChargeItemComponent>	chargeItem	Billing code or reference associated with the device.
protected List<DeviceDefinition.DeviceDefinitionClassificationComponent>	classification	What kind of device or device system this is.
protected List<ContactPoint>	contact	Contact details for an organization or a particular human that is responsible for the device.
protected DeviceDefinition.DeviceDefinitionCorrectiveActionComponent	correctiveAction	Tracking of latest field safety corrective action.
protected MarkdownType	description	Additional information to describe the device.
protected List<DeviceDefinition.DeviceDefinitionDeviceNameComponent>	deviceName	The name or names of the device as given by the manufacturer.
protected DeviceDefinition.DeviceDefinitionGuidelineComponent	guideline	Information aimed at providing directions for the usage of this model of device.
protected List<DeviceDefinition.DeviceDefinitionHasPartComponent>	hasPart	A device that is part (for example a component) of the present device.
protected List<Identifier>	identifier	Unique instance identifiers assigned to a device by the software, 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_PARENT	Constant for fluent queries to be used to add include statements.
protected List<CodeableConcept>	languageCode	Language code for the human-readable text strings produced by the device (all supported).
protected List<DeviceDefinition.DeviceDefinitionLinkComponent>	link	An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device.
protected Reference	manufacturer	A name of the manufacturer or legal representative e.g.
protected List<DeviceDefinition.DeviceDefinitionMaterialComponent>	material	A substance used to create the material(s) of which the device is made.
protected StringType	modelNumber	The model number for the device for example as defined by the manufacturer or labeler, or other agency.
protected List<Annotation>	note	Descriptive information, usage information or implantation information that is not captured in an existing element.
protected Reference	owner	An organization that is responsible for the provision and ongoing maintenance of the device.
protected List<DeviceDefinition.DeviceDefinitionPackagingComponent>	packaging	Information about the packaging of the device, i.e.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PARENT	Fluent Client search parameter constant for parent
protected Reference	parentDevice	The parent device it can be part of.
protected StringType	partNumber	The part number or catalog number of the device.
protected List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>>	productionIdentifierInUDI	Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.
protected List<DeviceDefinition.DeviceDefinitionPropertyComponent>	property	The potential, valid configuration settings of a device, e.g., regulation status, time properties.
protected List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent>	regulatoryIdentifier	Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics.
protected List<CodeableConcept>	safety	Safety characteristics of the device.
protected List<ProductShelfLife>	shelfLifeStorage	Shelf Life and storage information.
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_PARENT	Search parameter: parent
static final String	SP_TYPE	Search parameter: type
protected List<RelatedArtifact>	specialization	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	TYPE	Fluent Client search parameter constant for type
protected List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent>	udiDeviceIdentifier	Unique device identifier (UDI) assigned to device label or package.
protected List<DeviceDefinition.DeviceDefinitionVersionComponent>	version	The version of the device or software.

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

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DeviceDefinition()	Constructor

Method Summary

Modifier and Type	Method	Description
DeviceDefinition.DeviceDefinitionChargeItemComponent	addChargeItem()
DeviceDefinition	addChargeItem(DeviceDefinition.DeviceDefinitionChargeItemComponent t)
Base	addChild(String name)
DeviceDefinition.DeviceDefinitionClassificationComponent	addClassification()
DeviceDefinition	addClassification(DeviceDefinition.DeviceDefinitionClassificationComponent t)
ContactPoint	addContact()
DeviceDefinition	addContact(ContactPoint t)
DeviceDefinition.DeviceDefinitionDeviceNameComponent	addDeviceName()
DeviceDefinition	addDeviceName(DeviceDefinition.DeviceDefinitionDeviceNameComponent t)
DeviceDefinition.DeviceDefinitionHasPartComponent	addHasPart()
DeviceDefinition	addHasPart(DeviceDefinition.DeviceDefinitionHasPartComponent t)
Identifier	addIdentifier()
DeviceDefinition	addIdentifier(Identifier t)
CodeableConcept	addLanguageCode()
DeviceDefinition	addLanguageCode(CodeableConcept t)
DeviceDefinition.DeviceDefinitionLinkComponent	addLink()
DeviceDefinition	addLink(DeviceDefinition.DeviceDefinitionLinkComponent t)
DeviceDefinition.DeviceDefinitionMaterialComponent	addMaterial()
DeviceDefinition	addMaterial(DeviceDefinition.DeviceDefinitionMaterialComponent t)
Annotation	addNote()
DeviceDefinition	addNote(Annotation t)
DeviceDefinition.DeviceDefinitionPackagingComponent	addPackaging()
DeviceDefinition	addPackaging(DeviceDefinition.DeviceDefinitionPackagingComponent t)
DeviceDefinition	addProductionIdentifierInUDI(DeviceDefinition.DeviceProductionIdentifierInUDI value)
Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>	addProductionIdentifierInUDIElement()
DeviceDefinition.DeviceDefinitionPropertyComponent	addProperty()
DeviceDefinition	addProperty(DeviceDefinition.DeviceDefinitionPropertyComponent t)
DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent	addRegulatoryIdentifier()
DeviceDefinition	addRegulatoryIdentifier(DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent t)
CodeableConcept	addSafety()
DeviceDefinition	addSafety(CodeableConcept t)
ProductShelfLife	addShelfLifeStorage()
DeviceDefinition	addShelfLifeStorage(ProductShelfLife t)
RelatedArtifact	addSpecialization()
DeviceDefinition	addSpecialization(RelatedArtifact t)
DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent	addUdiDeviceIdentifier()
DeviceDefinition	addUdiDeviceIdentifier(DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent t)
DeviceDefinition.DeviceDefinitionVersionComponent	addVersion()
DeviceDefinition	addVersion(DeviceDefinition.DeviceDefinitionVersionComponent t)
DeviceDefinition	copy()
void	copyValues(DeviceDefinition dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<DeviceDefinition.DeviceDefinitionChargeItemComponent>	getChargeItem()
DeviceDefinition.DeviceDefinitionChargeItemComponent	getChargeItemFirstRep()
List<DeviceDefinition.DeviceDefinitionClassificationComponent>	getClassification()
DeviceDefinition.DeviceDefinitionClassificationComponent	getClassificationFirstRep()
List<ContactPoint>	getContact()
ContactPoint	getContactFirstRep()
DeviceDefinition.DeviceDefinitionCorrectiveActionComponent	getCorrectiveAction()
String	getDescription()
MarkdownType	getDescriptionElement()
List<DeviceDefinition.DeviceDefinitionDeviceNameComponent>	getDeviceName()
DeviceDefinition.DeviceDefinitionDeviceNameComponent	getDeviceNameFirstRep()
DeviceDefinition.DeviceDefinitionGuidelineComponent	getGuideline()
List<DeviceDefinition.DeviceDefinitionHasPartComponent>	getHasPart()
DeviceDefinition.DeviceDefinitionHasPartComponent	getHasPartFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getLanguageCode()
CodeableConcept	getLanguageCodeFirstRep()
List<DeviceDefinition.DeviceDefinitionLinkComponent>	getLink()
DeviceDefinition.DeviceDefinitionLinkComponent	getLinkFirstRep()
Reference	getManufacturer()
List<DeviceDefinition.DeviceDefinitionMaterialComponent>	getMaterial()
DeviceDefinition.DeviceDefinitionMaterialComponent	getMaterialFirstRep()
String	getModelNumber()
StringType	getModelNumberElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Reference	getOwner()
List<DeviceDefinition.DeviceDefinitionPackagingComponent>	getPackaging()
DeviceDefinition.DeviceDefinitionPackagingComponent	getPackagingFirstRep()
Reference	getParentDevice()
String	getPartNumber()
StringType	getPartNumberElement()
List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>>	getProductionIdentifierInUDI()
List<DeviceDefinition.DeviceDefinitionPropertyComponent>	getProperty()
Base[]	getProperty(int hash, String name, boolean checkValid)
DeviceDefinition.DeviceDefinitionPropertyComponent	getPropertyFirstRep()
List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent>	getRegulatoryIdentifier()
DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent	getRegulatoryIdentifierFirstRep()
ResourceType	getResourceType()
List<CodeableConcept>	getSafety()
CodeableConcept	getSafetyFirstRep()
List<ProductShelfLife>	getShelfLifeStorage()
ProductShelfLife	getShelfLifeStorageFirstRep()
List<RelatedArtifact>	getSpecialization()
RelatedArtifact	getSpecializationFirstRep()
String[]	getTypesForProperty(int hash, String name)
List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent>	getUdiDeviceIdentifier()
DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent	getUdiDeviceIdentifierFirstRep()
List<DeviceDefinition.DeviceDefinitionVersionComponent>	getVersion()
DeviceDefinition.DeviceDefinitionVersionComponent	getVersionFirstRep()
boolean	hasChargeItem()
boolean	hasClassification()
boolean	hasContact()
boolean	hasCorrectiveAction()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasDeviceName()
boolean	hasGuideline()
boolean	hasHasPart()
boolean	hasIdentifier()
boolean	hasLanguageCode()
boolean	hasLink()
boolean	hasManufacturer()
boolean	hasMaterial()
boolean	hasModelNumber()
boolean	hasModelNumberElement()
boolean	hasNote()
boolean	hasOwner()
boolean	hasPackaging()
boolean	hasParentDevice()
boolean	hasPartNumber()
boolean	hasPartNumberElement()
boolean	hasProductionIdentifierInUDI()
boolean	hasProductionIdentifierInUDI(DeviceDefinition.DeviceProductionIdentifierInUDI value)
boolean	hasProperty()
boolean	hasRegulatoryIdentifier()
boolean	hasSafety()
boolean	hasShelfLifeStorage()
boolean	hasSpecialization()
boolean	hasUdiDeviceIdentifier()
boolean	hasVersion()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DeviceDefinition	setChargeItem(List<DeviceDefinition.DeviceDefinitionChargeItemComponent> theChargeItem)
DeviceDefinition	setClassification(List<DeviceDefinition.DeviceDefinitionClassificationComponent> theClassification)
DeviceDefinition	setContact(List<ContactPoint> theContact)
DeviceDefinition	setCorrectiveAction(DeviceDefinition.DeviceDefinitionCorrectiveActionComponent value)
DeviceDefinition	setDescription(String value)
DeviceDefinition	setDescriptionElement(MarkdownType value)
DeviceDefinition	setDeviceName(List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> theDeviceName)
DeviceDefinition	setGuideline(DeviceDefinition.DeviceDefinitionGuidelineComponent value)
DeviceDefinition	setHasPart(List<DeviceDefinition.DeviceDefinitionHasPartComponent> theHasPart)
DeviceDefinition	setIdentifier(List<Identifier> theIdentifier)
DeviceDefinition	setLanguageCode(List<CodeableConcept> theLanguageCode)
DeviceDefinition	setLink(List<DeviceDefinition.DeviceDefinitionLinkComponent> theLink)
DeviceDefinition	setManufacturer(Reference value)
DeviceDefinition	setMaterial(List<DeviceDefinition.DeviceDefinitionMaterialComponent> theMaterial)
DeviceDefinition	setModelNumber(String value)
DeviceDefinition	setModelNumberElement(StringType value)
DeviceDefinition	setNote(List<Annotation> theNote)
DeviceDefinition	setOwner(Reference value)
DeviceDefinition	setPackaging(List<DeviceDefinition.DeviceDefinitionPackagingComponent> thePackaging)
DeviceDefinition	setParentDevice(Reference value)
DeviceDefinition	setPartNumber(String value)
DeviceDefinition	setPartNumberElement(StringType value)
DeviceDefinition	setProductionIdentifierInUDI(List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>> theProductionIdentifierInUDI)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DeviceDefinition	setProperty(List<DeviceDefinition.DeviceDefinitionPropertyComponent> theProperty)
DeviceDefinition	setRegulatoryIdentifier(List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent> theRegulatoryIdentifier)
DeviceDefinition	setSafety(List<CodeableConcept> theSafety)
DeviceDefinition	setShelfLifeStorage(List<ProductShelfLife> theShelfLifeStorage)
DeviceDefinition	setSpecialization(List<RelatedArtifact> theSpecialization)
DeviceDefinition	setUdiDeviceIdentifier(List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> theUdiDeviceIdentifier)
DeviceDefinition	setVersion(List<DeviceDefinition.DeviceDefinitionVersionComponent> theVersion)
protected DeviceDefinition	typedCopy()

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, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage

Methods inherited from class org.hl7.fhir.r5.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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

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, setId

Field Details

description

protected MarkdownType description

Additional information to describe the device.

identifier

protected List<Identifier> identifier

Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.

udiDeviceIdentifier

protected List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> udiDeviceIdentifier

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.

regulatoryIdentifier

protected List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent> regulatoryIdentifier

Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe.

partNumber

protected StringType partNumber

The part number or catalog number of the device.

manufacturer

protected Reference manufacturer

A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.

deviceName

protected List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> deviceName

The name or names of the device as given by the manufacturer.

modelNumber

protected StringType modelNumber

The model number for the device for example as defined by the manufacturer or labeler, or other agency.

classification

protected List<DeviceDefinition.DeviceDefinitionClassificationComponent> classification

What kind of device or device system this is.

specialization

protected List<RelatedArtifact> specialization

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

hasPart

protected List<DeviceDefinition.DeviceDefinitionHasPartComponent> hasPart

A device that is part (for example a component) of the present device.

packaging

protected List<DeviceDefinition.DeviceDefinitionPackagingComponent> packaging

Information about the packaging of the device, i.e. how the device is packaged.

version

protected List<DeviceDefinition.DeviceDefinitionVersionComponent> version

The version of the device or software.

safety

protected List<CodeableConcept> safety

Safety characteristics of the device.

shelfLifeStorage

protected List<ProductShelfLife> shelfLifeStorage

Shelf Life and storage information.

languageCode

protected List<CodeableConcept> languageCode

Language code for the human-readable text strings produced by the device (all supported).

property

protected List<DeviceDefinition.DeviceDefinitionPropertyComponent> property

The potential, valid configuration settings of a device, e.g., regulation status, time properties.

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.

link

protected List<DeviceDefinition.DeviceDefinitionLinkComponent> 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.

parentDevice

protected Reference parentDevice

The parent device it can be part of.

material

protected List<DeviceDefinition.DeviceDefinitionMaterialComponent> material

A substance used to create the material(s) of which the device is made.

productionIdentifierInUDI

protected List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>> productionIdentifierInUDI

Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.

guideline

protected DeviceDefinition.DeviceDefinitionGuidelineComponent guideline

Information aimed at providing directions for the usage of this model of device.

correctiveAction

protected DeviceDefinition.DeviceDefinitionCorrectiveActionComponent correctiveAction

Tracking of latest field safety corrective action.

chargeItem

protected List<DeviceDefinition.DeviceDefinitionChargeItemComponent> chargeItem

Billing code or reference associated with the device.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: The identifier of the component
Type: token
Path: DeviceDefinition.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: The identifier of the component
Type: token
Path: DeviceDefinition.identifier

SP_PARENT

public static final String SP_PARENT

Search parameter: parent

Description: The parent DeviceDefinition resource
Type: reference
Path: DeviceDefinition.parentDevice

See Also:

• Constant Field Values

PARENT

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

Fluent Client search parameter constant for parent

Description: The parent DeviceDefinition resource
Type: reference
Path: DeviceDefinition.parentDevice

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 "DeviceDefinition:parent".

SP_TYPE

public static final String SP_TYPE

Search parameter: type

Description: The device component type
Type: token
Path: DeviceDefinition.classification.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 device component type
Type: token
Path: DeviceDefinition.classification.type

Constructor Details

DeviceDefinition

public DeviceDefinition()

Constructor

Method Details

getDescriptionElement

public MarkdownType getDescriptionElement()

Returns:

description (Additional information to describe the device.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public DeviceDefinition setDescriptionElement(MarkdownType value)

Parameters:

value - description (Additional information to describe the device.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

Additional information to describe the device.

setDescription

public DeviceDefinition setDescription(String value)

Parameters:

value - Additional information to describe the device.

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. The identifier is typically valued if the udiDeviceIdentifier, partNumber or modelNumber is not valued and represents a different type of identifier. However, it is permissible to still include those identifiers in DeviceDefinition.identifier with the appropriate identifier.type.)

setIdentifier

public DeviceDefinition setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DeviceDefinition addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist {3}

getUdiDeviceIdentifier

public List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> getUdiDeviceIdentifier()

Returns:

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

setUdiDeviceIdentifier

public DeviceDefinition setUdiDeviceIdentifier(List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> theUdiDeviceIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasUdiDeviceIdentifier

public boolean hasUdiDeviceIdentifier()

addUdiDeviceIdentifier

public DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent addUdiDeviceIdentifier()

addUdiDeviceIdentifier

public DeviceDefinition addUdiDeviceIdentifier(DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent t)

getUdiDeviceIdentifierFirstRep

public DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent getUdiDeviceIdentifierFirstRep()

Returns:

The first repetition of repeating field udiDeviceIdentifier, creating it if it does not already exist {3}

getRegulatoryIdentifier

public List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent> getRegulatoryIdentifier()

Returns:

regulatoryIdentifier (Identifier associated with the regulatory documentation (certificates, technical documentation, post-market surveillance documentation and reports) of a set of device models sharing the same intended purpose, risk class and essential design and manufacturing characteristics. One example is the Basic UDI-DI in Europe.)

setRegulatoryIdentifier

public DeviceDefinition setRegulatoryIdentifier(List<DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent> theRegulatoryIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasRegulatoryIdentifier

public boolean hasRegulatoryIdentifier()

addRegulatoryIdentifier

public DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent addRegulatoryIdentifier()

addRegulatoryIdentifier

public DeviceDefinition addRegulatoryIdentifier(DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent t)

getRegulatoryIdentifierFirstRep

public DeviceDefinition.DeviceDefinitionRegulatoryIdentifierComponent getRegulatoryIdentifierFirstRep()

Returns:

The first repetition of repeating field regulatoryIdentifier, creating it if it does not already exist {3}

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 DeviceDefinition 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 DeviceDefinition setPartNumber(String value)

Parameters:

value - The part number or catalog number of the device.

getManufacturer

public Reference getManufacturer()

Returns:

manufacturer (A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.)

hasManufacturer

public boolean hasManufacturer()

setManufacturer

public DeviceDefinition setManufacturer(Reference value)

Parameters:

value - manufacturer (A name of the manufacturer or legal representative e.g. labeler. Whether this is the actual manufacturer or the labeler or responsible depends on implementation and jurisdiction.)

getDeviceName

public List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> getDeviceName()

Returns:

deviceName (The name or names of the device as given by the manufacturer.)

setDeviceName

public DeviceDefinition setDeviceName(List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> theDeviceName)

Returns:

Returns a reference to this for easy method chaining

hasDeviceName

public boolean hasDeviceName()

addDeviceName

public DeviceDefinition.DeviceDefinitionDeviceNameComponent addDeviceName()

addDeviceName

public DeviceDefinition addDeviceName(DeviceDefinition.DeviceDefinitionDeviceNameComponent t)

getDeviceNameFirstRep

public DeviceDefinition.DeviceDefinitionDeviceNameComponent 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 model number for the device for example as defined by the manufacturer or labeler, or other agency.). 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 DeviceDefinition setModelNumberElement(StringType value)

Parameters:

value - modelNumber (The model number for the device for example as defined by the manufacturer or labeler, or other agency.). 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 for example as defined by the manufacturer or labeler, or other agency.

setModelNumber

public DeviceDefinition setModelNumber(String value)

Parameters:

value - The model number for the device for example as defined by the manufacturer or labeler, or other agency.

getClassification

public List<DeviceDefinition.DeviceDefinitionClassificationComponent> getClassification()

Returns:

classification (What kind of device or device system this is.)

setClassification

public DeviceDefinition setClassification(List<DeviceDefinition.DeviceDefinitionClassificationComponent> theClassification)

Returns:

Returns a reference to this for easy method chaining

hasClassification

public boolean hasClassification()

addClassification

public DeviceDefinition.DeviceDefinitionClassificationComponent addClassification()

addClassification

public DeviceDefinition addClassification(DeviceDefinition.DeviceDefinitionClassificationComponent t)

getClassificationFirstRep

public DeviceDefinition.DeviceDefinitionClassificationComponent getClassificationFirstRep()

Returns:

The first repetition of repeating field classification, creating it if it does not already exist {3}

getSpecialization

public List<RelatedArtifact> 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 DeviceDefinition setSpecialization(List<RelatedArtifact> theSpecialization)

Returns:

Returns a reference to this for easy method chaining

hasSpecialization

public boolean hasSpecialization()

addSpecialization

public RelatedArtifact addSpecialization()

addSpecialization

public DeviceDefinition addSpecialization(RelatedArtifact t)

getSpecializationFirstRep

public RelatedArtifact getSpecializationFirstRep()

Returns:

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

getHasPart

public List<DeviceDefinition.DeviceDefinitionHasPartComponent> getHasPart()

Returns:

hasPart (A device that is part (for example a component) of the present device.)

setHasPart

public DeviceDefinition setHasPart(List<DeviceDefinition.DeviceDefinitionHasPartComponent> theHasPart)

Returns:

Returns a reference to this for easy method chaining

hasHasPart

public boolean hasHasPart()

addHasPart

public DeviceDefinition.DeviceDefinitionHasPartComponent addHasPart()

addHasPart

public DeviceDefinition addHasPart(DeviceDefinition.DeviceDefinitionHasPartComponent t)

getHasPartFirstRep

public DeviceDefinition.DeviceDefinitionHasPartComponent getHasPartFirstRep()

Returns:

The first repetition of repeating field hasPart, creating it if it does not already exist {3}

getPackaging

public List<DeviceDefinition.DeviceDefinitionPackagingComponent> getPackaging()

Returns:

packaging (Information about the packaging of the device, i.e. how the device is packaged.)

setPackaging

public DeviceDefinition setPackaging(List<DeviceDefinition.DeviceDefinitionPackagingComponent> thePackaging)

Returns:

Returns a reference to this for easy method chaining

hasPackaging

public boolean hasPackaging()

addPackaging

public DeviceDefinition.DeviceDefinitionPackagingComponent addPackaging()

addPackaging

public DeviceDefinition addPackaging(DeviceDefinition.DeviceDefinitionPackagingComponent t)

getPackagingFirstRep

public DeviceDefinition.DeviceDefinitionPackagingComponent getPackagingFirstRep()

Returns:

The first repetition of repeating field packaging, creating it if it does not already exist {3}

getVersion

public List<DeviceDefinition.DeviceDefinitionVersionComponent> getVersion()

Returns:

version (The version of the device or software.)

setVersion

public DeviceDefinition setVersion(List<DeviceDefinition.DeviceDefinitionVersionComponent> theVersion)

Returns:

Returns a reference to this for easy method chaining

hasVersion

public boolean hasVersion()

addVersion

public DeviceDefinition.DeviceDefinitionVersionComponent addVersion()

addVersion

public DeviceDefinition addVersion(DeviceDefinition.DeviceDefinitionVersionComponent t)

getVersionFirstRep

public DeviceDefinition.DeviceDefinitionVersionComponent getVersionFirstRep()

Returns:

The first repetition of repeating field version, creating it if it does not already exist {3}

getSafety

public List<CodeableConcept> getSafety()

Returns:

safety (Safety characteristics of the device.)

setSafety

public DeviceDefinition setSafety(List<CodeableConcept> theSafety)

Returns:

Returns a reference to this for easy method chaining

hasSafety

public boolean hasSafety()

addSafety

public CodeableConcept addSafety()

addSafety

public DeviceDefinition addSafety(CodeableConcept t)

getSafetyFirstRep

public CodeableConcept getSafetyFirstRep()

Returns:

The first repetition of repeating field safety, creating it if it does not already exist {3}

getShelfLifeStorage

public List<ProductShelfLife> getShelfLifeStorage()

Returns:

shelfLifeStorage (Shelf Life and storage information.)

setShelfLifeStorage

public DeviceDefinition setShelfLifeStorage(List<ProductShelfLife> theShelfLifeStorage)

Returns:

Returns a reference to this for easy method chaining

hasShelfLifeStorage

public boolean hasShelfLifeStorage()

addShelfLifeStorage

public ProductShelfLife addShelfLifeStorage()

addShelfLifeStorage

public DeviceDefinition addShelfLifeStorage(ProductShelfLife t)

getShelfLifeStorageFirstRep

public ProductShelfLife getShelfLifeStorageFirstRep()

Returns:

The first repetition of repeating field shelfLifeStorage, creating it if it does not already exist {3}

getLanguageCode

public List<CodeableConcept> getLanguageCode()

Returns:

languageCode (Language code for the human-readable text strings produced by the device (all supported).)

setLanguageCode

public DeviceDefinition setLanguageCode(List<CodeableConcept> theLanguageCode)

Returns:

Returns a reference to this for easy method chaining

hasLanguageCode

public boolean hasLanguageCode()

addLanguageCode

public CodeableConcept addLanguageCode()

addLanguageCode

public DeviceDefinition addLanguageCode(CodeableConcept t)

getLanguageCodeFirstRep

public CodeableConcept getLanguageCodeFirstRep()

Returns:

The first repetition of repeating field languageCode, creating it if it does not already exist {3}

getProperty

public List<DeviceDefinition.DeviceDefinitionPropertyComponent> getProperty()

Returns:

property (The potential, valid configuration settings of a device, e.g., regulation status, time properties.)

setProperty

public DeviceDefinition setProperty(List<DeviceDefinition.DeviceDefinitionPropertyComponent> theProperty)

Returns:

Returns a reference to this for easy method chaining

hasProperty

public boolean hasProperty()

addProperty

public DeviceDefinition.DeviceDefinitionPropertyComponent addProperty()

addProperty

public DeviceDefinition addProperty(DeviceDefinition.DeviceDefinitionPropertyComponent t)

getPropertyFirstRep

public DeviceDefinition.DeviceDefinitionPropertyComponent getPropertyFirstRep()

Returns:

The first repetition of repeating field property, creating it if it does not already exist {3}

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 DeviceDefinition 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 DeviceDefinition setContact(List<ContactPoint> theContact)

Returns:

Returns a reference to this for easy method chaining

hasContact

public boolean hasContact()

addContact

public ContactPoint addContact()

addContact

public DeviceDefinition addContact(ContactPoint t)

getContactFirstRep

public ContactPoint getContactFirstRep()

Returns:

The first repetition of repeating field contact, creating it if it does not already exist {3}

getLink

public List<DeviceDefinition.DeviceDefinitionLinkComponent> 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 DeviceDefinition setLink(List<DeviceDefinition.DeviceDefinitionLinkComponent> theLink)

Returns:

Returns a reference to this for easy method chaining

hasLink

public boolean hasLink()

addLink

public DeviceDefinition.DeviceDefinitionLinkComponent addLink()

addLink

public DeviceDefinition addLink(DeviceDefinition.DeviceDefinitionLinkComponent t)

getLinkFirstRep

public DeviceDefinition.DeviceDefinitionLinkComponent 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 DeviceDefinition setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public DeviceDefinition addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

The first repetition of repeating field note, creating it if it does not already exist {3}

getParentDevice

public Reference getParentDevice()

Returns:

parentDevice (The parent device it can be part of.)

hasParentDevice

public boolean hasParentDevice()

setParentDevice

public DeviceDefinition setParentDevice(Reference value)

Parameters:

value - parentDevice (The parent device it can be part of.)

getMaterial

public List<DeviceDefinition.DeviceDefinitionMaterialComponent> getMaterial()

Returns:

material (A substance used to create the material(s) of which the device is made.)

setMaterial

public DeviceDefinition setMaterial(List<DeviceDefinition.DeviceDefinitionMaterialComponent> theMaterial)

Returns:

Returns a reference to this for easy method chaining

hasMaterial

public boolean hasMaterial()

addMaterial

public DeviceDefinition.DeviceDefinitionMaterialComponent addMaterial()

addMaterial

public DeviceDefinition addMaterial(DeviceDefinition.DeviceDefinitionMaterialComponent t)

getMaterialFirstRep

public DeviceDefinition.DeviceDefinitionMaterialComponent getMaterialFirstRep()

Returns:

The first repetition of repeating field material, creating it if it does not already exist {3}

getProductionIdentifierInUDI

public List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>> getProductionIdentifierInUDI()

Returns:

productionIdentifierInUDI (Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.)

setProductionIdentifierInUDI

public DeviceDefinition setProductionIdentifierInUDI(List<Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI>> theProductionIdentifierInUDI)

Returns:

Returns a reference to this for easy method chaining

hasProductionIdentifierInUDI

public boolean hasProductionIdentifierInUDI()

addProductionIdentifierInUDIElement

public Enumeration<DeviceDefinition.DeviceProductionIdentifierInUDI> addProductionIdentifierInUDIElement()

Returns:

productionIdentifierInUDI (Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.)

addProductionIdentifierInUDI

public DeviceDefinition addProductionIdentifierInUDI(DeviceDefinition.DeviceProductionIdentifierInUDI value)

Parameters:

value - productionIdentifierInUDI (Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.)

hasProductionIdentifierInUDI

public boolean hasProductionIdentifierInUDI(DeviceDefinition.DeviceProductionIdentifierInUDI value)

Parameters:

value - productionIdentifierInUDI (Indicates the production identifier(s) that are expected to appear in the UDI carrier on the device label.)

getGuideline

public DeviceDefinition.DeviceDefinitionGuidelineComponent getGuideline()

Returns:

guideline (Information aimed at providing directions for the usage of this model of device.)

hasGuideline

public boolean hasGuideline()

setGuideline

public DeviceDefinition setGuideline(DeviceDefinition.DeviceDefinitionGuidelineComponent value)

Parameters:

value - guideline (Information aimed at providing directions for the usage of this model of device.)

getCorrectiveAction

public DeviceDefinition.DeviceDefinitionCorrectiveActionComponent getCorrectiveAction()

Returns:

correctiveAction (Tracking of latest field safety corrective action.)

hasCorrectiveAction

public boolean hasCorrectiveAction()

setCorrectiveAction

public DeviceDefinition setCorrectiveAction(DeviceDefinition.DeviceDefinitionCorrectiveActionComponent value)

Parameters:

value - correctiveAction (Tracking of latest field safety corrective action.)

getChargeItem

public List<DeviceDefinition.DeviceDefinitionChargeItemComponent> getChargeItem()

Returns:

chargeItem (Billing code or reference associated with the device.)

setChargeItem

public DeviceDefinition setChargeItem(List<DeviceDefinition.DeviceDefinitionChargeItemComponent> theChargeItem)

Returns:

Returns a reference to this for easy method chaining

hasChargeItem

public boolean hasChargeItem()

addChargeItem

public DeviceDefinition.DeviceDefinitionChargeItemComponent addChargeItem()

addChargeItem

public DeviceDefinition addChargeItem(DeviceDefinition.DeviceDefinitionChargeItemComponent t)

getChargeItemFirstRep

public DeviceDefinition.DeviceDefinitionChargeItemComponent getChargeItemFirstRep()

Returns:

The first repetition of repeating field chargeItem, creating it if it does not already exist {3}

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public DeviceDefinition copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(DeviceDefinition dst)

typedCopy

protected DeviceDefinition 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