DeviceUseStatement (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 3.6.0 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.dstu2.resource.BaseResource
  - - ca.uhn.fhir.model.dstu2.resource.DeviceUseStatement

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource
```
public class DeviceUseStatement
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
```
HAPI/FHIR DeviceUseStatement Resource (workflow.order)
Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/DeviceUseStatement

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`DEVICE` Fluent Client search parameter constant for device
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_DEVICE` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`static String`	`SP_DEVICE` Search parameter constant for device
`static String`	`SP_PATIENT` Search parameter constant for patient
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor and Description

DeviceUseStatement()

Constructors
Constructor and Description
`DeviceUseStatement()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (id)
`DeviceUseStatement`	`addIdentifier(IdentifierDt theValue)` Adds a given new value for identifier (id)
`CodeableConceptDt`	`addIndication()` Adds and returns a new value for indication (why)
`DeviceUseStatement`	`addIndication(CodeableConceptDt theValue)` Adds a given new value for indication (why)
`ca.uhn.fhir.model.primitive.StringDt`	`addNotes()` Adds and returns a new value for notes ()
`DeviceUseStatement`	`addNotes(String theString)` Adds a new value for notes ()
`DeviceUseStatement`	`addNotes(ca.uhn.fhir.model.primitive.StringDt theValue)` Adds a given new value for notes ()
`<T extends ca.uhn.fhir.model.api.IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`ca.uhn.fhir.model.api.IDatatype`	`getBodySite()` Gets the value(s) for bodySite[x] ().
`ResourceReferenceDt`	`getDevice()` Gets the value(s) for device (who.actor).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (id).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (id), creating it if it does not already exist.
`List<CodeableConceptDt>`	`getIndication()` Gets the value(s) for indication (why).
`CodeableConceptDt`	`getIndicationFirstRep()` Gets the first repetition for indication (why), creating it if it does not already exist.
`List<ca.uhn.fhir.model.primitive.StringDt>`	`getNotes()` Gets the value(s) for notes ().
`ca.uhn.fhir.model.primitive.StringDt`	`getNotesFirstRep()` Gets the first repetition for notes (), creating it if it does not already exist.
`Date`	`getRecordedOn()` Gets the value(s) for recordedOn (when.recorded).
`ca.uhn.fhir.model.primitive.DateTimeDt`	`getRecordedOnElement()` Gets the value(s) for recordedOn (when.recorded).
`String`	`getResourceName()`
`ca.uhn.fhir.context.FhirVersionEnum`	`getStructureFhirVersionEnum()`
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (who.focus).
`ca.uhn.fhir.model.api.IDatatype`	`getTiming()` Gets the value(s) for timing[x] (when.done).
`PeriodDt`	`getWhenUsed()` Gets the value(s) for whenUsed (when.done).
`boolean`	`isEmpty()`
`DeviceUseStatement`	`setBodySite(ca.uhn.fhir.model.api.IDatatype theValue)` Sets the value(s) for bodySite[x] ()
`DeviceUseStatement`	`setDevice(ResourceReferenceDt theValue)` Sets the value(s) for device (who.actor)
`DeviceUseStatement`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (id)
`DeviceUseStatement`	`setIndication(List<CodeableConceptDt> theValue)` Sets the value(s) for indication (why)
`DeviceUseStatement`	`setNotes(List<ca.uhn.fhir.model.primitive.StringDt> theValue)` Sets the value(s) for notes ()
`DeviceUseStatement`	`setRecordedOn(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)` Sets the value for recordedOn (when.recorded)
`DeviceUseStatement`	`setRecordedOn(ca.uhn.fhir.model.primitive.DateTimeDt theValue)` Sets the value(s) for recordedOn (when.recorded)
`DeviceUseStatement`	`setRecordedOnWithSecondsPrecision(Date theDate)` Sets the value for recordedOn (when.recorded)
`DeviceUseStatement`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (who.focus)
`DeviceUseStatement`	`setTiming(ca.uhn.fhir.model.api.IDatatype theValue)` Sets the value(s) for timing[x] (when.done)
`DeviceUseStatement`	`setWhenUsed(PeriodDt theValue)` Sets the value(s) for whenUsed (when.done)

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource
getContained, getId, getIdElement, getLanguage, getMeta, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, hasFormatComment

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getMeta, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

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

- Field Detail
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: Search by subject
    Type: reference
    Path: DeviceUseStatement.subject
    
    See Also:
    
    Constant Field Values
  - SUBJECT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: Search by subject
    Type: reference
    Path: DeviceUseStatement.subject
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    Search parameter constant for patient
    Description: Search by subject - a patient
    Type: reference
    Path: DeviceUseStatement.subject
    
    See Also:
    
    Constant Field Values
  - PATIENT
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
```
    Fluent Client search parameter constant for patient
    Description: Search by subject - a patient
    Type: reference
    Path: DeviceUseStatement.subject
  - SP_DEVICE
```
public static final String SP_DEVICE
```
    Search parameter constant for device
    Description: Search by device
    Type: reference
    Path: DeviceUseStatement.device
    
    See Also:
    
    Constant Field Values
  - DEVICE
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE
```
    Fluent Client search parameter constant for device
    Description: Search by device
    Type: reference
    Path: DeviceUseStatement.device
  - INCLUDE_DEVICE
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEVICE
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:device".
  - INCLUDE_PATIENT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:patient".
  - INCLUDE_SUBJECT
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUseStatement:subject".
- Constructor Detail
  - DeviceUseStatement
```
public DeviceUseStatement()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface org.hl7.fhir.instance.model.api.IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
  - getBodySite
```
public ca.uhn.fhir.model.api.IDatatype getBodySite()
```
    Gets the value(s) for bodySite[x] (). creating it if it does not exist. Will not return null.
    Definition: Indicates the site on the subject's body where the device was used ( i.e. the target site).
  - setBodySite
```
public DeviceUseStatement setBodySite(ca.uhn.fhir.model.api.IDatatype theValue)
```
    Sets the value(s) for bodySite[x] ()
    Definition: Indicates the site on the subject's body where the device was used ( i.e. the target site).
  - getWhenUsed
```
public PeriodDt getWhenUsed()
```
    Gets the value(s) for whenUsed (when.done). creating it if it does not exist. Will not return null.
    Definition: The time period over which the device was used.
  - setWhenUsed
```
public DeviceUseStatement setWhenUsed(PeriodDt theValue)
```
    Sets the value(s) for whenUsed (when.done)
    Definition: The time period over which the device was used.
  - getDevice
```
public ResourceReferenceDt getDevice()
```
    Gets the value(s) for device (who.actor). creating it if it does not exist. Will not return null.
    Definition: The details of the device used.
  - setDevice
```
public DeviceUseStatement setDevice(ResourceReferenceDt theValue)
```
    Sets the value(s) for device (who.actor)
    Definition: The details of the device used.
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (id). creating it if it does not exist. Will not return null.
    Definition: An external identifier for this statement such as an IRI.
  - setIdentifier
```
public DeviceUseStatement setIdentifier(List<IdentifierDt> theValue)
```
    Sets the value(s) for identifier (id)
    Definition: An external identifier for this statement such as an IRI.
  - addIdentifier
```
public IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (id)
    Definition: An external identifier for this statement such as an IRI.
  - addIdentifier
```
public DeviceUseStatement addIdentifier(IdentifierDt theValue)
```
    Adds a given new value for identifier (id)
    Definition: An external identifier for this statement such as an IRI.
    
    Parameters:
    
    theValue - The identifier to add (must not be null)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (id), creating it if it does not already exist.
    Definition: An external identifier for this statement such as an IRI.
  - getIndication
```
public List<CodeableConceptDt> getIndication()
```
    Gets the value(s) for indication (why). creating it if it does not exist. Will not return null.
    Definition: Reason or justification for the use of the device.
  - setIndication
```
public DeviceUseStatement setIndication(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for indication (why)
    Definition: Reason or justification for the use of the device.
  - addIndication
```
public CodeableConceptDt addIndication()
```
    Adds and returns a new value for indication (why)
    Definition: Reason or justification for the use of the device.
  - addIndication
```
public DeviceUseStatement addIndication(CodeableConceptDt theValue)
```
    Adds a given new value for indication (why)
    Definition: Reason or justification for the use of the device.
    
    Parameters:
    
    theValue - The indication to add (must not be null)
  - getIndicationFirstRep
```
public CodeableConceptDt getIndicationFirstRep()
```
    Gets the first repetition for indication (why), creating it if it does not already exist.
    Definition: Reason or justification for the use of the device.
  - getNotes
```
public List<ca.uhn.fhir.model.primitive.StringDt> getNotes()
```
    Gets the value(s) for notes (). creating it if it does not exist. Will not return null.
    Definition: 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.
  - setNotes
```
public DeviceUseStatement setNotes(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
```
    Sets the value(s) for notes ()
    Definition: 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.
  - addNotes
```
public ca.uhn.fhir.model.primitive.StringDt addNotes()
```
    Adds and returns a new value for notes ()
    Definition: 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.
  - addNotes
```
public DeviceUseStatement addNotes(ca.uhn.fhir.model.primitive.StringDt theValue)
```
    Adds a given new value for notes ()
    Definition: 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.
    
    Parameters:
    
    theValue - The notes to add (must not be null)
  - getNotesFirstRep
```
public ca.uhn.fhir.model.primitive.StringDt getNotesFirstRep()
```
    Gets the first repetition for notes (), creating it if it does not already exist.
    Definition: 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.
  - addNotes
```
public DeviceUseStatement addNotes(String theString)
```
    Adds a new value for notes ()
    Definition: 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.
    
    Returns:
    
    Returns a reference to this object, to allow for simple chaining.
  - getRecordedOnElement
```
public ca.uhn.fhir.model.primitive.DateTimeDt getRecordedOnElement()
```
    Gets the value(s) for recordedOn (when.recorded). creating it if it does not exist. Will not return null.
    Definition: The time at which the statement was made/recorded.
  - getRecordedOn
```
public Date getRecordedOn()
```
    Gets the value(s) for recordedOn (when.recorded). creating it if it does not exist. This method may return null.
    Definition: The time at which the statement was made/recorded.
  - setRecordedOn
```
public DeviceUseStatement setRecordedOn(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
```
    Sets the value(s) for recordedOn (when.recorded)
    Definition: The time at which the statement was made/recorded.
  - setRecordedOnWithSecondsPrecision
```
public DeviceUseStatement setRecordedOnWithSecondsPrecision(Date theDate)
```
    Sets the value for recordedOn (when.recorded)
    Definition: The time at which the statement was made/recorded.
  - setRecordedOn
```
public DeviceUseStatement setRecordedOn(Date theDate,
                                        ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
```
    Sets the value for recordedOn (when.recorded)
    Definition: The time at which the statement was made/recorded.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.
    Definition: The patient who used the device.
  - setSubject
```
public DeviceUseStatement setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (who.focus)
    Definition: The patient who used the device.
  - getTiming
```
public ca.uhn.fhir.model.api.IDatatype getTiming()
```
    Gets the value(s) for timing[x] (when.done). creating it if it does not exist. Will not return null.
    Definition: How often the device was used.
  - setTiming
```
public DeviceUseStatement setTiming(ca.uhn.fhir.model.api.IDatatype theValue)
```
    Sets the value(s) for timing[x] (when.done)
    Definition: How often the device was used.
  - getResourceName
```
public String getResourceName()
```
    Specified by:
    
    getResourceName in interface ca.uhn.fhir.model.api.IResource
  - getStructureFhirVersionEnum
```
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
```
    Specified by:
    
    getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource
    
    Specified by:
    
    getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource

Class DeviceUseStatement

Field Summary

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

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

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

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

Field Detail

SP_SUBJECT

SUBJECT

SP_PATIENT

PATIENT

SP_DEVICE

DEVICE

INCLUDE_DEVICE

INCLUDE_PATIENT

INCLUDE_SUBJECT

Constructor Detail

DeviceUseStatement

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getBodySite

setBodySite

getWhenUsed

setWhenUsed

getDevice

setDevice

getIdentifier

setIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getIndication

setIndication

addIndication

addIndication

getIndicationFirstRep

getNotes

setNotes

addNotes

addNotes

getNotesFirstRep

addNotes

getRecordedOnElement

getRecordedOn

setRecordedOn

setRecordedOnWithSecondsPrecision

setRecordedOn

getSubject

setSubject

getTiming

setTiming

getResourceName

getStructureFhirVersionEnum