Package org.hl7.fhir.dstu2.model

Class DeviceUseRequest

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

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 DeviceUseRequest
extends DomainResource

Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DeviceUseRequest.DeviceUseRequestPriority
static class	DeviceUseRequest.DeviceUseRequestPriorityEnumFactory
static enum	DeviceUseRequest.DeviceUseRequestStatus
static class	DeviceUseRequest.DeviceUseRequestStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Type	bodySite	Indicates the site on the subject's body where the device should be used ( i.e. the target site).
protected Reference	device	The details of the device to be used.
protected Device	deviceTarget	The actual object that is the target of the reference (The details of the device to be used.)
protected Reference	encounter	An encounter that provides additional context in which this request is made.
protected Encounter	encounterTarget	The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.)
protected List<Identifier>	identifier	Identifiers assigned to this order by the orderer or by the receiver.
protected List<CodeableConcept>	indication	Reason or justification for the use of this device.
protected List<StringType>	notes	Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class.
protected DateTimeType	orderedOn	The time when the request was made.
protected Enumeration<DeviceUseRequest.DeviceUseRequestPriority>	priority	Characterizes how quickly the use of device must be initiated.
protected List<CodeableConcept>	prnReason	The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.
protected DateTimeType	recordedOn	The time at which the request was made/recorded.
static final String	SP_DEVICE
static final String	SP_PATIENT
static final String	SP_SUBJECT
protected Enumeration<DeviceUseRequest.DeviceUseRequestStatus>	status	The status of the request.
protected Reference	subject	The patient who will use the device.
protected Patient	subjectTarget	The actual object that is the target of the reference (The patient who will use the device.)
protected Type	timing	The timing schedule for the use of the device The Schedule data type allows many different expressions, for example.

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
DeviceUseRequest()
DeviceUseRequest(Reference device, Reference subject)

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	addIdentifier()
DeviceUseRequest	addIdentifier(Identifier t)
CodeableConcept	addIndication()
DeviceUseRequest	addIndication(CodeableConcept t)
DeviceUseRequest	addNotes(String value)
StringType	addNotesElement()
CodeableConcept	addPrnReason()
DeviceUseRequest	addPrnReason(CodeableConcept t)
DeviceUseRequest	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
Type	getBodySite()
CodeableConcept	getBodySiteCodeableConcept()
Reference	getBodySiteReference()
Reference	getDevice()
Device	getDeviceTarget()
Reference	getEncounter()
Encounter	getEncounterTarget()
List<Identifier>	getIdentifier()
List<CodeableConcept>	getIndication()
List<StringType>	getNotes()
Date	getOrderedOn()
DateTimeType	getOrderedOnElement()
DeviceUseRequest.DeviceUseRequestPriority	getPriority()
Enumeration<DeviceUseRequest.DeviceUseRequestPriority>	getPriorityElement()
List<CodeableConcept>	getPrnReason()
Date	getRecordedOn()
DateTimeType	getRecordedOnElement()
ResourceType	getResourceType()
DeviceUseRequest.DeviceUseRequestStatus	getStatus()
Enumeration<DeviceUseRequest.DeviceUseRequestStatus>	getStatusElement()
Reference	getSubject()
Patient	getSubjectTarget()
Type	getTiming()
DateTimeType	getTimingDateTimeType()
Period	getTimingPeriod()
Timing	getTimingTiming()
boolean	hasBodySite()
boolean	hasBodySiteCodeableConcept()
boolean	hasBodySiteReference()
boolean	hasDevice()
boolean	hasEncounter()
boolean	hasIdentifier()
boolean	hasIndication()
boolean	hasNotes()
boolean	hasNotes(String value)
boolean	hasOrderedOn()
boolean	hasOrderedOnElement()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasPrnReason()
boolean	hasRecordedOn()
boolean	hasRecordedOnElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasTiming()
boolean	hasTimingDateTimeType()
boolean	hasTimingPeriod()
boolean	hasTimingTiming()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
DeviceUseRequest	setBodySite(Type value)
DeviceUseRequest	setDevice(Reference value)
DeviceUseRequest	setDeviceTarget(Device value)
DeviceUseRequest	setEncounter(Reference value)
DeviceUseRequest	setEncounterTarget(Encounter value)
DeviceUseRequest	setOrderedOn(Date value)
DeviceUseRequest	setOrderedOnElement(DateTimeType value)
DeviceUseRequest	setPriority(DeviceUseRequest.DeviceUseRequestPriority value)
DeviceUseRequest	setPriorityElement(Enumeration<DeviceUseRequest.DeviceUseRequestPriority> value)
void	setProperty(String name, Base value)
DeviceUseRequest	setRecordedOn(Date value)
DeviceUseRequest	setRecordedOnElement(DateTimeType value)
DeviceUseRequest	setStatus(DeviceUseRequest.DeviceUseRequestStatus value)
DeviceUseRequest	setStatusElement(Enumeration<DeviceUseRequest.DeviceUseRequestStatus> value)
DeviceUseRequest	setSubject(Reference value)
DeviceUseRequest	setSubjectTarget(Patient value)
DeviceUseRequest	setTiming(Type value)
protected DeviceUseRequest	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 should be used ( i.e. the target site).

status

protected Enumeration<DeviceUseRequest.DeviceUseRequestStatus> status

The status of the request.

device

protected Reference device

The details of the device to be used.

deviceTarget

protected Device deviceTarget

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

encounter

protected Reference encounter

An encounter that provides additional context in which this request is made.

encounterTarget

protected Encounter encounterTarget

The actual object that is the target of the reference (An encounter that provides additional context in which this request is made.)

identifier

protected List<Identifier> identifier

Identifiers assigned to this order by the orderer or by the receiver.

indication

protected List<CodeableConcept> indication

Reason or justification for the use of this device.

notes

protected List<StringType> notes

Details about this request 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.

prnReason

protected List<CodeableConcept> prnReason

The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.

orderedOn

protected DateTimeType orderedOn

The time when the request was made.

recordedOn

protected DateTimeType recordedOn

The time at which the request was made/recorded.

subject

protected Reference subject

The patient who will use the device.

subjectTarget

protected Patient subjectTarget

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

timing

protected Type timing

The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".

priority

protected Enumeration<DeviceUseRequest.DeviceUseRequestPriority> priority

Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

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

DeviceUseRequest

public DeviceUseRequest()

DeviceUseRequest

public DeviceUseRequest(Reference device,
 Reference subject)

Method Details

getBodySite

public Type getBodySite()

Returns:

bodySite (Indicates the site on the subject's body where the device should be 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 should be 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 should be used ( i.e. the target site).)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasBodySiteReference

public boolean hasBodySiteReference()

hasBodySite

public boolean hasBodySite()

setBodySite

public DeviceUseRequest setBodySite(Type value)

Parameters:

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

getStatusElement

public Enumeration<DeviceUseRequest.DeviceUseRequestStatus> getStatusElement()

Returns:

status (The status of the request.). 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 DeviceUseRequest setStatusElement(Enumeration<DeviceUseRequest.DeviceUseRequestStatus> value)

Parameters:

value - status (The status of the request.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public DeviceUseRequest.DeviceUseRequestStatus getStatus()

Returns:

The status of the request.

setStatus

public DeviceUseRequest setStatus(DeviceUseRequest.DeviceUseRequestStatus value)

Parameters:

value - The status of the request.

getDevice

public Reference getDevice()

Returns:

device (The details of the device to be used.)

hasDevice

public boolean hasDevice()

setDevice

public DeviceUseRequest setDevice(Reference value)

Parameters:

value - device (The details of the device to be 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 to be used.)

setDeviceTarget

public DeviceUseRequest 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 to be used.)

getEncounter

public Reference getEncounter()

Returns:

encounter (An encounter that provides additional context in which this request is made.)

hasEncounter

public boolean hasEncounter()

setEncounter

public DeviceUseRequest setEncounter(Reference value)

Parameters:

value - encounter (An encounter that provides additional context in which this request is made.)

getEncounterTarget

public Encounter getEncounterTarget()

Returns:

encounter 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 encounter that provides additional context in which this request is made.)

setEncounterTarget

public DeviceUseRequest setEncounterTarget(Encounter value)

Parameters:

value - encounter 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 encounter that provides additional context in which this request is made.)

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this order by the orderer or by the receiver.)

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

Returns:

identifier (Identifiers assigned to this order by the orderer or by the receiver.)

addIdentifier

public DeviceUseRequest addIdentifier(Identifier t)

getIndication

public List<CodeableConcept> getIndication()

Returns:

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

hasIndication

public boolean hasIndication()

addIndication

public CodeableConcept addIndication()

Returns:

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

addIndication

public DeviceUseRequest addIndication(CodeableConcept t)

getNotes

public List<StringType> getNotes()

Returns:

notes (Details about this request 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 this request 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 DeviceUseRequest addNotes(String value)

Parameters:

value - notes (Details about this request 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 this request 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.)

getPrnReason

public List<CodeableConcept> getPrnReason()

Returns:

prnReason (The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.)

hasPrnReason

public boolean hasPrnReason()

addPrnReason

public CodeableConcept addPrnReason()

Returns:

prnReason (The proposed act must be performed if the indicated conditions occur, e.g.., shortness of breath, SpO2 less than x%.)

addPrnReason

public DeviceUseRequest addPrnReason(CodeableConcept t)

getOrderedOnElement

public DateTimeType getOrderedOnElement()

Returns:

orderedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getOrderedOn" gives direct access to the value

hasOrderedOnElement

public boolean hasOrderedOnElement()

hasOrderedOn

public boolean hasOrderedOn()

setOrderedOnElement

public DeviceUseRequest setOrderedOnElement(DateTimeType value)

Parameters:

value - orderedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getOrderedOn" gives direct access to the value

getOrderedOn

public Date getOrderedOn()

Returns:

The time when the request was made.

setOrderedOn

public DeviceUseRequest setOrderedOn(Date value)

Parameters:

value - The time when the request was made.

getRecordedOnElement

public DateTimeType getRecordedOnElement()

Returns:

recordedOn (The time at which the request 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 DeviceUseRequest setRecordedOnElement(DateTimeType value)

Parameters:

value - recordedOn (The time at which the request 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 request was made/recorded.

setRecordedOn

public DeviceUseRequest setRecordedOn(Date value)

Parameters:

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

getSubject

public Reference getSubject()

Returns:

subject (The patient who will use the device.)

hasSubject

public boolean hasSubject()

setSubject

public DeviceUseRequest setSubject(Reference value)

Parameters:

value - subject (The patient who will use 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 will use the device.)

setSubjectTarget

public DeviceUseRequest 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 will use the device.)

getTiming

public Type getTiming()

Returns:

timing (The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)

getTimingTiming

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

Returns:

timing (The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingTiming

public boolean hasTimingTiming()

getTimingPeriod

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

Returns:

timing (The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingPeriod

public boolean hasTimingPeriod()

getTimingDateTimeType

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

Returns:

timing (The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasTimingDateTimeType

public boolean hasTimingDateTimeType()

hasTiming

public boolean hasTiming()

setTiming

public DeviceUseRequest setTiming(Type value)

Parameters:

value - timing (The timing schedule for the use of the device The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".)

getPriorityElement

public Enumeration<DeviceUseRequest.DeviceUseRequestPriority> getPriorityElement()

Returns:

priority (Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

hasPriorityElement

public boolean hasPriorityElement()

hasPriority

public boolean hasPriority()

setPriorityElement

public DeviceUseRequest setPriorityElement(Enumeration<DeviceUseRequest.DeviceUseRequestPriority> value)

Parameters:

value - priority (Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

getPriority

public DeviceUseRequest.DeviceUseRequestPriority getPriority()

Returns:

Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

setPriority

public DeviceUseRequest setPriority(DeviceUseRequest.DeviceUseRequestPriority value)

Parameters:

value - Characterizes how quickly the use of device must be initiated. Includes concepts such as stat, urgent, routine.

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 DeviceUseRequest copy()

Specified by:

copy in class DomainResource

typedCopy

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