Package org.hl7.fhir.r4.model
Class DeviceDefinition
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.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
The characteristics, operational status and capabilities of a medical-related
component of a medical device.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static class
static class
static class
static class
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionDevice capabilities.protected List
<ContactPoint> Contact details for an organization or a particular human that is responsible for the device.A name given to the device to identify it.protected List
<Identifier> Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<CodeableConcept> Language code for the human-readable text strings produced by the device (all supported).protected Type
A name of the manufacturer.A substance used to create the material(s) of which the device is made.protected StringType
The model number for the device.protected List
<Annotation> Descriptive information, usage information or implantation information that is not captured in an existing element.protected UriType
Access to on-line information about the device.protected Reference
An organization that is responsible for the provision and ongoing maintenance of the device.protected Organization
The actual object that is the target of the reference (An organization that is responsible for the provision and ongoing maintenance of the device.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for parentprotected Reference
The parent device it can be part of.protected DeviceDefinition
The actual object that is the target of the reference (The parent device it can be part of.)protected ProdCharacteristic
Dimensions, color etc.The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.protected Quantity
The quantity of the device present in the packaging (e.g.protected List
<CodeableConcept> Safety characteristics of the device.protected List
<ProductShelfLife> Shelf Life and storage information.static final String
Search parameter: identifierstatic final String
Search parameter: parentstatic final String
Search parameter: typeThe capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.protected CodeableConcept
What kind of device or device system this is.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for typeUnique device identifier (UDI) assigned to device label or package.protected UriType
A network address on which the device may be contacted directly.protected List
<StringType> The available versions of the device, e.g., software versions.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
-
Method Summary
Modifier and TypeMethodDescriptionaddNote()
addVersion
(String value) copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
getOwner()
Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) getUrl()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
hasOwner()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
hasUrl()
boolean
boolean
boolean
hasVersion
(String value) boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCapability
(List<DeviceDefinition.DeviceDefinitionCapabilityComponent> theCapability) setContact
(List<ContactPoint> theContact) setDeviceName
(List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> theDeviceName) setIdentifier
(List<Identifier> theIdentifier) setLanguageCode
(List<CodeableConcept> theLanguageCode) setManufacturer
(Type value) setModelNumber
(String value) setModelNumberElement
(StringType value) setNote
(List<Annotation> theNote) setOnlineInformation
(String value) setOwnerTarget
(Organization value) setParentDevice
(Reference value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(Quantity value) setSafety
(List<CodeableConcept> theSafety) setShelfLifeStorage
(List<ProductShelfLife> theShelfLifeStorage) setSpecialization
(List<DeviceDefinition.DeviceDefinitionSpecializationComponent> theSpecialization) setType
(CodeableConcept value) setUdiDeviceIdentifier
(List<DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent> theUdiDeviceIdentifier) setUrlElement
(UriType value) setVersion
(List<StringType> theVersion) protected DeviceDefinition
Methods inherited from class org.hl7.fhir.r4.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.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, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
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
Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID. -
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. -
manufacturer
A name of the manufacturer. -
deviceName
A name given to the device to identify it. -
modelNumber
The model number for the device. -
type
What kind of device or device system this is. -
specialization
The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. -
version
The available versions of the device, e.g., software versions. -
safety
Safety characteristics of the device. -
shelfLifeStorage
Shelf Life and storage information. -
physicalCharacteristics
Dimensions, color etc. -
languageCode
Language code for the human-readable text strings produced by the device (all supported). -
capability
Device capabilities. -
property
The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. -
owner
An organization that is responsible for the provision and ongoing maintenance of the device. -
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
Contact details for an organization or a particular human that is responsible for the device. -
url
A network address on which the device may be contacted directly. -
onlineInformation
Access to on-line information about the device. -
note
Descriptive information, usage information or implantation information that is not captured in an existing element. -
quantity
The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product). -
parentDevice
The parent device it can be part of. -
parentDeviceTarget
The actual object that is the target of the reference (The parent device it can be part of.) -
material
A substance used to create the material(s) of which the device is made. -
SP_PARENT
Search parameter: parentDescription: The parent DeviceDefinition resource
Type: reference
Path: DeviceDefinition.parentDevice
- See Also:
-
PARENT
Fluent Client search parameter constant for parentDescription: The parent DeviceDefinition resource
Type: reference
Path: DeviceDefinition.parentDevice
-
INCLUDE_PARENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceDefinition:parent". -
SP_IDENTIFIER
Search parameter: identifierDescription: The identifier of the component
Type: token
Path: DeviceDefinition.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identifier of the component
Type: token
Path: DeviceDefinition.identifier
-
SP_TYPE
Search parameter: typeDescription: The device component type
Type: token
Path: DeviceDefinition.type
- See Also:
-
TYPE
Fluent Client search parameter constant for typeDescription: The device component type
Type: token
Path: DeviceDefinition.type
-
-
Constructor Details
-
DeviceDefinition
public DeviceDefinition()Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Unique instance identifiers assigned to a device by the software, manufacturers, other organizations or owners. For example: handle ID.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
addUdiDeviceIdentifier
-
addUdiDeviceIdentifier
-
getUdiDeviceIdentifierFirstRep
public DeviceDefinition.DeviceDefinitionUdiDeviceIdentifierComponent getUdiDeviceIdentifierFirstRep()- Returns:
- The first repetition of repeating field
udiDeviceIdentifier
, creating it if it does not already exist
-
getManufacturer
- Returns:
manufacturer
(A name of the manufacturer.)
-
getManufacturerStringType
- Returns:
manufacturer
(A name of the manufacturer.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasManufacturerStringType
-
getManufacturerReference
- Returns:
manufacturer
(A name of the manufacturer.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasManufacturerReference
-
hasManufacturer
-
setManufacturer
- Parameters:
value
-manufacturer
(A name of the manufacturer.)
-
getDeviceName
- Returns:
deviceName
(A name given to the device to identify it.)
-
setDeviceName
public DeviceDefinition setDeviceName(List<DeviceDefinition.DeviceDefinitionDeviceNameComponent> theDeviceName) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasDeviceName
-
addDeviceName
-
addDeviceName
-
getDeviceNameFirstRep
- Returns:
- The first repetition of repeating field
deviceName
, creating it if it does not already exist
-
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
-
hasModelNumber
-
setModelNumberElement
- 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
- Returns:
- The model number for the device.
-
setModelNumber
- Parameters:
value
- The model number for the device.
-
getType
- Returns:
type
(What kind of device or device system this is.)
-
hasType
-
setType
- Parameters:
value
-type
(What kind of device or device system this is.)
-
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<DeviceDefinition.DeviceDefinitionSpecializationComponent> theSpecialization) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasSpecialization
-
addSpecialization
-
addSpecialization
-
getSpecializationFirstRep
- Returns:
- The first repetition of repeating field
specialization
, creating it if it does not already exist
-
getVersion
- Returns:
version
(The available versions of the device, e.g., software versions.)
-
setVersion
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasVersion
-
addVersionElement
- Returns:
version
(The available versions of the device, e.g., software versions.)
-
addVersion
- Parameters:
value
-version
(The available versions of the device, e.g., software versions.)
-
hasVersion
- Parameters:
value
-version
(The available versions of the device, e.g., software versions.)
-
getSafety
- Returns:
safety
(Safety characteristics of the device.)
-
setSafety
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSafety
-
addSafety
-
addSafety
-
getSafetyFirstRep
- Returns:
- The first repetition of repeating field
safety
, creating it if it does not already exist
-
getShelfLifeStorage
- Returns:
shelfLifeStorage
(Shelf Life and storage information.)
-
setShelfLifeStorage
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasShelfLifeStorage
-
addShelfLifeStorage
-
addShelfLifeStorage
-
getShelfLifeStorageFirstRep
- Returns:
- The first repetition of repeating field
shelfLifeStorage
, creating it if it does not already exist
-
getPhysicalCharacteristics
- Returns:
physicalCharacteristics
(Dimensions, color etc.)
-
hasPhysicalCharacteristics
-
setPhysicalCharacteristics
- Parameters:
value
-physicalCharacteristics
(Dimensions, color etc.)
-
getLanguageCode
- Returns:
languageCode
(Language code for the human-readable text strings produced by the device (all supported).)
-
setLanguageCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLanguageCode
-
addLanguageCode
-
addLanguageCode
-
getLanguageCodeFirstRep
- Returns:
- The first repetition of repeating field
languageCode
, creating it if it does not already exist
-
getCapability
- Returns:
capability
(Device capabilities.)
-
setCapability
public DeviceDefinition setCapability(List<DeviceDefinition.DeviceDefinitionCapabilityComponent> theCapability) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCapability
-
addCapability
-
addCapability
-
getCapabilityFirstRep
- Returns:
- The first repetition of repeating field
capability
, creating it if it does not already exist
-
getProperty
- Returns:
property
(The actual configuration settings of a device as it actually operates, 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
-
addProperty
-
addProperty
-
getPropertyFirstRep
- Returns:
- The first repetition of repeating field
property
, creating it if it does not already exist
-
getOwner
- Returns:
owner
(An organization that is responsible for the provision and ongoing maintenance of the device.)
-
hasOwner
-
setOwner
- Parameters:
value
-owner
(An organization that is responsible for the provision and ongoing maintenance of the device.)
-
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
- 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
- Returns:
contact
(Contact details for an organization or a particular human that is responsible for the device.)
-
setContact
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
-
addContact
-
addContact
-
getContactFirstRep
- Returns:
- The first repetition of repeating field
contact
, creating it if it does not already exist
-
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
-
hasUrl
-
setUrlElement
- 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
- Returns:
- A network address on which the device may be contacted directly.
-
setUrl
- Parameters:
value
- A network address on which the device may be contacted directly.
-
getOnlineInformationElement
- Returns:
onlineInformation
(Access to on-line information about the device.). This is the underlying object with id, value and extensions. The accessor "getOnlineInformation" gives direct access to the value
-
hasOnlineInformationElement
-
hasOnlineInformation
-
setOnlineInformationElement
- Parameters:
value
-onlineInformation
(Access to on-line information about the device.). This is the underlying object with id, value and extensions. The accessor "getOnlineInformation" gives direct access to the value
-
getOnlineInformation
- Returns:
- Access to on-line information about the device.
-
setOnlineInformation
- Parameters:
value
- Access to on-line information about the device.
-
getNote
- Returns:
note
(Descriptive information, usage information or implantation information that is not captured in an existing element.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getQuantity
- Returns:
quantity
(The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product).)
-
getParentDevice
- Returns:
parentDevice
(The parent device it can be part of.)
-
hasParentDevice
-
setParentDevice
- Parameters:
value
-parentDevice
(The parent device it can be part of.)
-
getParentDeviceTarget
- Returns:
parentDevice
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 it can be part of.)
-
setParentDeviceTarget
- Parameters:
value
-parentDevice
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 it can be part of.)
-
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
-
addMaterial
-
addMaterial
-
getMaterialFirstRep
- Returns:
- The first repetition of repeating field
material
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-