Package org.hl7.fhir.dstu2.model

Class DeviceUseStatement

java.lang.Object

org.hl7.fhir.dstu2.model.Base

org.hl7.fhir.dstu2.model.BaseResource

org.hl7.fhir.dstu2.model.Resource

org.hl7.fhir.dstu2.model.DomainResource

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

public class DeviceUseStatement
extends DomainResource

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:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Type	bodySite	Indicates the site on the subject's body where the device was used ( i.e. the target site).
protected Reference	device	The details of the device used.
protected Device	deviceTarget	The actual object that is the target of the reference (The details of the device used.)
protected List<Identifier>	identifier	An external identifier for this statement such as an IRI.
protected List<CodeableConcept>	indication	Reason or justification for the use of the device.
protected List<StringType>	notes	Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class.
protected DateTimeType	recordedOn	The time at which the statement was made/recorded.
static final String	SP_DEVICE
static final String	SP_PATIENT
static final String	SP_SUBJECT
protected Reference	subject	The patient who used the device.
protected Patient	subjectTarget	The actual object that is the target of the reference (The patient who used the device.)
protected Type	timing	How often the device was used.
protected Period	whenUsed	The time period over which the device was used.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

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

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
DeviceUseStatement()
DeviceUseStatement(Reference device, Reference subject)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
DeviceUseStatement	addIdentifier(Identifier t)
CodeableConcept	addIndication()
DeviceUseStatement	addIndication(CodeableConcept t)
DeviceUseStatement	addNotes(String value)
StringType	addNotesElement()
DeviceUseStatement	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Type	getBodySite()
CodeableConcept	getBodySiteCodeableConcept()
Reference	getBodySiteReference()
Reference	getDevice()
Device	getDeviceTarget()
List<Identifier>	getIdentifier()
List<CodeableConcept>	getIndication()
List<StringType>	getNotes()
Date	getRecordedOn()
DateTimeType	getRecordedOnElement()
ResourceType	getResourceType()
Reference	getSubject()
Patient	getSubjectTarget()
Type	getTiming()
DateTimeType	getTimingDateTimeType()
Period	getTimingPeriod()
Timing	getTimingTiming()
Period	getWhenUsed()
boolean	hasBodySite()
boolean	hasBodySiteCodeableConcept()
boolean	hasBodySiteReference()
boolean	hasDevice()
boolean	hasIdentifier()
boolean	hasIndication()
boolean	hasNotes()
boolean	hasNotes(String value)
boolean	hasRecordedOn()
boolean	hasRecordedOnElement()
boolean	hasSubject()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingPeriod()
boolean	hasTimingTiming()
boolean	hasWhenUsed()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
DeviceUseStatement	setBodySite(Type value)
DeviceUseStatement	setDevice(Reference value)
DeviceUseStatement	setDeviceTarget(Device value)
void	setProperty(String name, Base value)
DeviceUseStatement	setRecordedOn(Date value)
DeviceUseStatement	setRecordedOnElement(DateTimeType value)
DeviceUseStatement	setSubject(Reference value)
DeviceUseStatement	setSubjectTarget(Patient value)
DeviceUseStatement	setTiming(Type value)
DeviceUseStatement	setWhenUsed(Period value)
protected DeviceUseStatement	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText

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

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

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

getStructureFhirVersionEnum, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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

bodySite

protected Type bodySite

Indicates the site on the subject's body where the device was used ( i.e. the target site).

whenUsed

protected Period whenUsed

The time period over which the device was used.

device

protected Reference device

The details of the device used.

deviceTarget

protected Device deviceTarget

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

identifier

protected List<Identifier> identifier

An external identifier for this statement such as an IRI.

indication

protected List<CodeableConcept> indication

Reason or justification for the use of the device.

notes

protected List<StringType> notes

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.

recordedOn

protected DateTimeType recordedOn

The time at which the statement was made/recorded.

subject

protected Reference subject

The patient who used the device.

subjectTarget

protected Patient subjectTarget

The actual object that is the target of the reference (The patient who used the device.)

timing

protected Type timing

How often the device was used.

SP_SUBJECT

public static final String SP_SUBJECT

See Also:

• Constant Field Values

SP_PATIENT

public static final String SP_PATIENT

See Also:

• Constant Field Values

SP_DEVICE

public static final String SP_DEVICE

See Also:

• Constant Field Values

Constructor Details

DeviceUseStatement

public DeviceUseStatement()

DeviceUseStatement

public DeviceUseStatement(Reference device,
 Reference subject)

Method Details

getBodySite

public Type getBodySite()

Returns:

bodySite (Indicates the site on the subject's body where the device was used ( i.e. the target site).)

getBodySiteCodeableConcept

public CodeableConcept getBodySiteCodeableConcept()
                                           throws org.hl7.fhir.exceptions.FHIRException

Returns:

bodySite (Indicates the site on the subject's body where the device was used ( i.e. the target site).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasBodySiteCodeableConcept

public boolean hasBodySiteCodeableConcept()

getBodySiteReference

public Reference getBodySiteReference()
                               throws org.hl7.fhir.exceptions.FHIRException

Returns:

bodySite (Indicates the site on the subject's body where the device was used ( i.e. the target site).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasBodySiteReference

public boolean hasBodySiteReference()

hasBodySite

public boolean hasBodySite()

setBodySite

public DeviceUseStatement setBodySite(Type value)

Parameters:

value - bodySite (Indicates the site on the subject's body where the device was used ( i.e. the target site).)

getWhenUsed

public Period getWhenUsed()

Returns:

whenUsed (The time period over which the device was used.)

hasWhenUsed

public boolean hasWhenUsed()

setWhenUsed

public DeviceUseStatement setWhenUsed(Period value)

Parameters:

value - whenUsed (The time period over which the device was used.)

getDevice

public Reference getDevice()

Returns:

device (The details of the device used.)

hasDevice

public boolean hasDevice()

setDevice

public DeviceUseStatement setDevice(Reference value)

Parameters:

value - device (The details of the device used.)

getDeviceTarget

public Device 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

public DeviceUseStatement setDeviceTarget(Device value)

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

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (An external identifier for this statement such as an IRI.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (An external identifier for this statement such as an IRI.)

addIdentifier

public DeviceUseStatement addIdentifier(Identifier t)

getIndication

public List<CodeableConcept> getIndication()

Returns:

indication (Reason or justification for the use of the device.)

hasIndication

public boolean hasIndication()

addIndication

public CodeableConcept addIndication()

Returns:

indication (Reason or justification for the use of the device.)

addIndication

public DeviceUseStatement addIndication(CodeableConcept t)

getNotes

public List<StringType> getNotes()

Returns:

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

hasNotes

public boolean hasNotes()

addNotesElement

public StringType addNotesElement()

Returns:

notes (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 value)

Parameters:

value - notes (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.)

hasNotes

public boolean hasNotes(String value)

Parameters:

value - notes (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.)

getRecordedOnElement

public DateTimeType 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

public boolean hasRecordedOnElement()

hasRecordedOn

public boolean hasRecordedOn()

setRecordedOnElement

public DeviceUseStatement setRecordedOnElement(DateTimeType value)

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

public Date getRecordedOn()

Returns:

The time at which the statement was made/recorded.

setRecordedOn

public DeviceUseStatement setRecordedOn(Date value)

Parameters:

value - The time at which the statement was made/recorded.

getSubject

public Reference getSubject()

Returns:

subject (The patient who used the device.)

hasSubject

public boolean hasSubject()

setSubject

public DeviceUseStatement setSubject(Reference value)

Parameters:

value - subject (The patient who used the device.)

getSubjectTarget

public Patient 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

public DeviceUseStatement setSubjectTarget(Patient value)

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

getTiming

public Type getTiming()

Returns:

timing (How often the device was used.)

getTimingTiming

public Timing getTimingTiming()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (How often the device was used.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingTiming

public boolean hasTimingTiming()

getTimingPeriod

public Period getTimingPeriod()
                       throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (How often the device was used.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingPeriod

public boolean hasTimingPeriod()

getTimingDateTimeType

public DateTimeType getTimingDateTimeType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

timing (How often the device was used.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateTimeType

public boolean hasTimingDateTimeType()

hasTiming

public boolean hasTiming()

setTiming

public DeviceUseStatement setTiming(Type value)

Parameters:

value - timing (How often the device was used.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

setProperty

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

Overrides:

setProperty 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 DeviceUseStatement copy()

Specified by:

copy in class DomainResource

typedCopy

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