Package org.hl7.fhir.dstu3.model

Class DeviceUseStatement

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceUseStatement.DeviceUseStatementStatus
static class	DeviceUseStatement.DeviceUseStatementStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected CodeableConcept	bodySite	Indicates the site on the subject's body where the device was used ( i.e.
protected Reference	device	The details of the device used.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEVICE	Fluent Client search parameter constant for device
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.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
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.
protected List<CodeableConcept>	indication	Reason or justification for the use of the device.
protected List<Annotation>	note	Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected DateTimeType	recordedOn	The time at which the statement was made/recorded.
protected Reference	source	Who reported the device was being used by the patient.
protected Resource	sourceTarget	The actual object that is the target of the reference (Who reported the device was being used by the patient.)
static String	SP_DEVICE	Search parameter: device
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_PATIENT	Search parameter: patient
static String	SP_SUBJECT	Search parameter: subject
protected Enumeration<DeviceUseStatement.DeviceUseStatementStatus>	status	A code representing the patient or other source's judgment about the state of the device used that this statement is about.
protected Reference	subject	The patient who used the device.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	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.dstu3.model.DomainResource

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

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	Description
DeviceUseStatement()	Constructor
DeviceUseStatement(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status, Reference subject, Reference device)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
DeviceUseStatement	addIdentifier(Identifier t)
CodeableConcept	addIndication()
DeviceUseStatement	addIndication(CodeableConcept t)
Annotation	addNote()
DeviceUseStatement	addNote(Annotation t)
DeviceUseStatement	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
CodeableConcept	getBodySite()
Reference	getDevice()
Device	getDeviceTarget()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getIndication()
CodeableConcept	getIndicationFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
Date	getRecordedOn()
DateTimeType	getRecordedOnElement()
ResourceType	getResourceType()
Reference	getSource()
Resource	getSourceTarget()
DeviceUseStatement.DeviceUseStatementStatus	getStatus()
Enumeration<DeviceUseStatement.DeviceUseStatementStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
Type	getTiming()
DateTimeType	getTimingDateTimeType()
Period	getTimingPeriod()
Timing	getTimingTiming()
String[]	getTypesForProperty(int hash, String name)
Period	getWhenUsed()
boolean	hasBodySite()
boolean	hasDevice()
boolean	hasIdentifier()
boolean	hasIndication()
boolean	hasNote()
boolean	hasRecordedOn()
boolean	hasRecordedOnElement()
boolean	hasSource()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingPeriod()
boolean	hasTimingTiming()
boolean	hasWhenUsed()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
DeviceUseStatement	setBodySite(CodeableConcept value)
DeviceUseStatement	setDevice(Reference value)
DeviceUseStatement	setDeviceTarget(Device value)
DeviceUseStatement	setIdentifier(List<Identifier> theIdentifier)
DeviceUseStatement	setIndication(List<CodeableConcept> theIndication)
DeviceUseStatement	setNote(List<Annotation> theNote)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DeviceUseStatement	setRecordedOn(Date value)
DeviceUseStatement	setRecordedOnElement(DateTimeType value)
DeviceUseStatement	setSource(Reference value)
DeviceUseStatement	setSourceTarget(Resource value)
DeviceUseStatement	setStatus(DeviceUseStatement.DeviceUseStatementStatus value)
DeviceUseStatement	setStatusElement(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> value)
DeviceUseStatement	setSubject(Reference value)
DeviceUseStatement	setSubjectTarget(Resource value)
DeviceUseStatement	setTiming(Type value)
DeviceUseStatement	setWhenUsed(Period value)
protected DeviceUseStatement	typedCopy()

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

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

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

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

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

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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, setId

Field Details

identifier

protected List<Identifier> identifier

An external identifier for this statement such as an IRI.

status

protected Enumeration<DeviceUseStatement.DeviceUseStatementStatus> 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

protected Reference subject

The patient who used the device.

subjectTarget

protected Resource subjectTarget

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

whenUsed

protected Period whenUsed

The time period over which the device was used.

timing

protected Type timing

How often the device was used.

recordedOn

protected DateTimeType recordedOn

The time at which the statement was made/recorded.

source

protected Reference source

Who reported the device was being used by the patient.

sourceTarget

protected Resource sourceTarget

The actual object that is the target of the reference (Who reported the device was being used by the patient.)

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

indication

protected List<CodeableConcept> indication

Reason or justification for the use of the device.

bodySite

protected CodeableConcept bodySite

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

note

protected List<Annotation> 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

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Search by identifier
Type: token
Path: DeviceUseStatement.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: Search by identifier
Type: token
Path: DeviceUseStatement.identifier

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: 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

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

SP_PATIENT

public static final String SP_PATIENT

Search parameter: 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

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

SP_DEVICE

public static final String SP_DEVICE

Search parameter: 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".

Constructor Details

DeviceUseStatement

public DeviceUseStatement()

Constructor

DeviceUseStatement

public DeviceUseStatement(Enumeration<DeviceUseStatement.DeviceUseStatementStatus> status,
 Reference subject,
 Reference device)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

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

setIdentifier

public DeviceUseStatement setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DeviceUseStatement addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getStatusElement

public Enumeration<DeviceUseStatement.DeviceUseStatementStatus> 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

public boolean hasStatusElement()

hasStatus

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

public DeviceUseStatement.DeviceUseStatementStatus 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

public DeviceUseStatement setStatus(DeviceUseStatement.DeviceUseStatementStatus value)

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

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

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

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)
                             throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

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

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

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.

getSource

public Reference getSource()

Returns:

source (Who reported the device was being used by the patient.)

hasSource

public boolean hasSource()

setSource

public DeviceUseStatement setSource(Reference value)

Parameters:

value - source (Who reported the device was being used by the patient.)

getSourceTarget

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

public DeviceUseStatement setSourceTarget(Resource value)

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

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

getIndication

public List<CodeableConcept> getIndication()

Returns:

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

setIndication

public DeviceUseStatement setIndication(List<CodeableConcept> theIndication)

Returns:

Returns a reference to this for easy method chaining

hasIndication

public boolean hasIndication()

addIndication

public CodeableConcept addIndication()

addIndication

public DeviceUseStatement addIndication(CodeableConcept t)

getIndicationFirstRep

public CodeableConcept getIndicationFirstRep()

Returns:

The first repetition of repeating field indication, creating it if it does not already exist

getBodySite

public CodeableConcept getBodySite()

Returns:

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

hasBodySite

public boolean hasBodySite()

setBodySite

public DeviceUseStatement setBodySite(CodeableConcept value)

Parameters:

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

getNote

public List<Annotation> 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

public DeviceUseStatement setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public DeviceUseStatement addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

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