Package org.hl7.fhir.r4.model
Class DeviceUseStatement
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.DeviceUseStatement
- 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
A record of a device being used by a patient where the record is the result
of a report from the patient or another clinician.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionA plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.protected List
<ServiceRequest> The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.)protected CodeableConcept
Indicates the anotomic location on the subject's body where the device was used ( i.e.Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.The actual objects that are the target of the reference (Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.)protected Reference
The details of the device used.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for deviceprotected Device
The actual object that is the target of the reference (The details of the device used.)protected List
<Identifier> An external identifier for this statement such as an IRI.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.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Annotation> Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected List
<CodeableConcept> Reason or justification for the use of the device.Indicates another resource whose existence justifies this DeviceUseStatement.The actual objects that are the target of the reference (Indicates another resource whose existence justifies this DeviceUseStatement.)protected DateTimeType
The time at which the statement was made/recorded.protected Reference
Who reported the device was being used by the patient.protected Resource
The actual object that is the target of the reference (Who reported the device was being used by the patient.)static final String
Search parameter: devicestatic final String
Search parameter: identifierstatic final String
Search parameter: patientstatic final String
Search parameter: subjectA code representing the patient or other source's judgment about the state of the device used that this statement is about.protected Reference
The patient who used the device.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (The patient who used the device.)protected Type
How often the device was used.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
ConstructorDescriptionConstructorDeviceUseStatement
(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status, Reference subject, Reference device) Constructor -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use Reference#setResource(IBaseResource) insteadaddNote()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadString[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setBasedOn
(List<Reference> theBasedOn) setBodySite
(CodeableConcept value) setDerivedFrom
(List<Reference> theDerivedFrom) setDeviceTarget
(Device value) setIdentifier
(List<Identifier> theIdentifier) setNote
(List<Annotation> theNote) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRecordedOn
(Date value) setRecordedOnElement
(DateTimeType value) setSourceTarget
(Resource value) setSubject
(Reference value) setSubjectTarget
(Resource value) protected DeviceUseStatement
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
An external identifier for this statement such as an IRI. -
basedOn
A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement. -
basedOnTarget
The actual objects that are the target of the reference (A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.) -
status
A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. -
subject
The patient who used the device. -
subjectTarget
The actual object that is the target of the reference (The patient who used the device.) -
derivedFrom
Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement. -
derivedFromTarget
The actual objects that are the target of the reference (Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.) -
timing
How often the device was used. -
recordedOn
The time at which the statement was made/recorded. -
source
Who reported the device was being used by the patient. -
sourceTarget
The actual object that is the target of the reference (Who reported the device was being used by the patient.) -
device
The details of the device used. -
deviceTarget
The actual object that is the target of the reference (The details of the device used.) -
reasonCode
Reason or justification for the use of the device. -
reasonReference
Indicates another resource whose existence justifies this DeviceUseStatement. -
reasonReferenceTarget
The actual objects that are the target of the reference (Indicates another resource whose existence justifies this DeviceUseStatement.) -
bodySite
Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). -
note
Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. -
SP_IDENTIFIER
Search parameter: identifierDescription: Search by identifier
Type: token
Path: DeviceUseStatement.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Search by identifier
Type: token
Path: DeviceUseStatement.identifier
-
SP_SUBJECT
Search parameter: subjectDescription: Search by subject
Type: reference
Path: DeviceUseStatement.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Search by subject
Type: reference
Path: DeviceUseStatement.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:subject". -
SP_PATIENT
Search parameter: patientDescription: Search by subject - a patient
Type: reference
Path: DeviceUseStatement.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Search by subject - a patient
Type: reference
Path: DeviceUseStatement.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:patient". -
SP_DEVICE
Search parameter: deviceDescription: Search by device
Type: reference
Path: DeviceUseStatement.device
- See Also:
-
DEVICE
Fluent Client search parameter constant for deviceDescription: Search by device
Type: reference
Path: DeviceUseStatement.device
-
INCLUDE_DEVICE
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:device".
-
-
Constructor Details
-
DeviceUseStatement
public DeviceUseStatement()Constructor -
DeviceUseStatement
public DeviceUseStatement(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status, Reference subject, Reference device) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(An external identifier for this statement such as an IRI.)
-
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
-
getBasedOn
- Returns:
basedOn
(A plan, proposal or order that is fulfilled in whole or in part by this DeviceUseStatement.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getStatusElement
- Returns:
status
(A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
public DeviceUseStatement setStatusElement(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> value) - Parameters:
value
-status
(A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
setStatus
- Parameters:
value
- A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
getSubject
- Returns:
subject
(The patient who used the device.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient who used the device.)
-
getSubjectTarget
- Returns:
subject
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 patient who used the device.)
-
setSubjectTarget
- Parameters:
value
-subject
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 patient who used the device.)
-
getDerivedFrom
- Returns:
derivedFrom
(Allows linking the DeviceUseStatement to the underlying Request, or to other information that supports or is used to derive the DeviceUseStatement.)
-
setDerivedFrom
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDerivedFrom
-
addDerivedFrom
-
addDerivedFrom
-
getDerivedFromFirstRep
- Returns:
- The first repetition of repeating field
derivedFrom
, creating it if it does not already exist
-
getDerivedFromTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getTiming
- Returns:
timing
(How often the device was used.)
-
getTimingTiming
- Returns:
timing
(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
-
getTimingPeriod
- Returns:
timing
(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingPeriod
-
getTimingDateTimeType
- Returns:
timing
(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDateTimeType
-
hasTiming
-
setTiming
- Parameters:
value
-timing
(How often the device was used.)
-
getRecordedOnElement
- Returns:
recordedOn
(The time at which the statement was made/recorded.). This is the underlying object with id, value and extensions. The accessor "getRecordedOn" gives direct access to the value
-
hasRecordedOnElement
-
hasRecordedOn
-
setRecordedOnElement
- Parameters:
value
-recordedOn
(The time at which the statement was made/recorded.). This is the underlying object with id, value and extensions. The accessor "getRecordedOn" gives direct access to the value
-
getRecordedOn
- Returns:
- The time at which the statement was made/recorded.
-
setRecordedOn
- Parameters:
value
- The time at which the statement was made/recorded.
-
getSource
- Returns:
source
(Who reported the device was being used by the patient.)
-
hasSource
-
setSource
- Parameters:
value
-source
(Who reported the device was being used by the patient.)
-
getSourceTarget
- Returns:
source
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. (Who reported the device was being used by the patient.)
-
setSourceTarget
- Parameters:
value
-source
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. (Who reported the device was being used by the patient.)
-
getDevice
- Returns:
device
(The details of the device used.)
-
hasDevice
-
setDevice
- Parameters:
value
-device
(The details of the device used.)
-
getDeviceTarget
- Returns:
device
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 details of the device used.)
-
setDeviceTarget
- Parameters:
value
-device
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 details of the device used.)
-
getReasonCode
- Returns:
reasonCode
(Reason or justification for the use of the device.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Indicates another resource whose existence justifies this DeviceUseStatement.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getBodySite
- Returns:
bodySite
(Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).)
-
hasBodySite
-
setBodySite
- Parameters:
value
-bodySite
(Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).)
-
getNote
- Returns:
note
(Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.)
-
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
-
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
-