Package org.hl7.fhir.r5.model

Class DeviceRequest

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.DeviceRequest

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

Represents a request a device to be provided to a specific patient. The device may be an implantable device to be subsequently implanted, or an external assistive device, such as a walker, to be delivered and subsequently be used.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceRequest.DeviceRequestParameterComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	asNeeded	This status is to indicate whether the request is a PRN or may be given as needed.
protected CodeableConcept	asNeededFor	The reason for using the device.
static final ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORED_ON	Fluent Client search parameter constant for authored-on
protected DateTimeType	authoredOn	When the request transitioned to being actionable.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	Plan/proposal/order fulfilled by this request.
protected CodeableReference	code	The details of the device to be used.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEVICE	Fluent Client search parameter constant for device
protected BooleanType	doNotPerform	If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices.
protected Reference	encounter	An encounter that provides additional context in which this request is made.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
static final ca.uhn.fhir.rest.gclient.DateClientParam	EVENT_DATE	Fluent Client search parameter constant for event-date
static final ca.uhn.fhir.rest.gclient.TokenClientParam	GROUP_IDENTIFIER	Fluent Client search parameter constant for group-identifier
protected Identifier	groupIdentifier	A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author.
protected List<Identifier>	identifier	Identifiers assigned to this order by the orderer or by the receiver.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEVICE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INSTANTIATES_CANONICAL	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_INSURANCE	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PERFORMER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PRIOR_REQUEST	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_REQUESTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INSTANTIATES_CANONICAL	Fluent Client search parameter constant for instantiates-canonical
static final ca.uhn.fhir.rest.gclient.UriClientParam	INSTANTIATES_URI	Fluent Client search parameter constant for instantiates-uri
protected List<CanonicalType>	instantiatesCanonical	The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
protected List<UriType>	instantiatesUri	The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.
protected List<Reference>	insurance	Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	INSURANCE	Fluent Client search parameter constant for insurance
protected Enumeration<Enumerations.RequestIntent>	intent	Whether the request is a proposal, plan, an original order or a reflex order.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INTENT	Fluent Client search parameter constant for intent
protected List<Annotation>	note	Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class.
protected DataType	occurrence	The timing schedule for the use of the device.
protected List<DeviceRequest.DeviceRequestParameterComponent>	parameter	Specific parameters for the ordered item.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected CodeableReference	performer	The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PERFORMER	Fluent Client search parameter constant for performer
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PERFORMER_CODE	Fluent Client search parameter constant for performer-code
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRIOR_REQUEST	Fluent Client search parameter constant for prior-request
protected Enumeration<Enumerations.RequestPriority>	priority	Indicates how quickly the request should be addressed with respect to other requests.
protected IntegerType	quantity	The number of devices to be provided.
protected List<CodeableReference>	reason	Reason or justification for the use of this device.
protected List<Reference>	relevantHistory	Key events in the history of the request.
protected List<Reference>	replaces	The request takes the place of the referenced completed or terminated request(s).
protected Reference	requester	The individual or entity who initiated the request and has responsibility for its activation.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REQUESTER	Fluent Client search parameter constant for requester
static final String	SP_AUTHORED_ON	Search parameter: authored-on
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_CODE	Search parameter: code
static final String	SP_DEVICE	Search parameter: device
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_EVENT_DATE	Search parameter: event-date
static final String	SP_GROUP_IDENTIFIER	Search parameter: group-identifier
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INSTANTIATES_CANONICAL	Search parameter: instantiates-canonical
static final String	SP_INSTANTIATES_URI	Search parameter: instantiates-uri
static final String	SP_INSURANCE	Search parameter: insurance
static final String	SP_INTENT	Search parameter: intent
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERFORMER	Search parameter: performer
static final String	SP_PERFORMER_CODE	Search parameter: performer-code
static final String	SP_PRIOR_REQUEST	Search parameter: prior-request
static final String	SP_REQUESTER	Search parameter: requester
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<Enumerations.RequestStatus>	status	The status of the request.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The patient who will use the device.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected List<Reference>	supportingInfo	Additional clinical information about the patient that may influence the request fulfilment.

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

Fields inherited from class org.hl7.fhir.r5.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
DeviceRequest()	Constructor
DeviceRequest(Enumerations.RequestIntent intent, CodeableReference code, Reference subject)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
DeviceRequest	addBasedOn(Reference t)
Base	addChild(String name)
Identifier	addIdentifier()
DeviceRequest	addIdentifier(Identifier t)
DeviceRequest	addInstantiatesCanonical(String value)
CanonicalType	addInstantiatesCanonicalElement()
DeviceRequest	addInstantiatesUri(String value)
UriType	addInstantiatesUriElement()
Reference	addInsurance()
DeviceRequest	addInsurance(Reference t)
Annotation	addNote()
DeviceRequest	addNote(Annotation t)
DeviceRequest.DeviceRequestParameterComponent	addParameter()
DeviceRequest	addParameter(DeviceRequest.DeviceRequestParameterComponent t)
CodeableReference	addReason()
DeviceRequest	addReason(CodeableReference t)
Reference	addRelevantHistory()
DeviceRequest	addRelevantHistory(Reference t)
Reference	addReplaces()
DeviceRequest	addReplaces(Reference t)
Reference	addSupportingInfo()
DeviceRequest	addSupportingInfo(Reference t)
DeviceRequest	copy()
void	copyValues(DeviceRequest dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getAsNeeded()
BooleanType	getAsNeededElement()
CodeableConcept	getAsNeededFor()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
CodeableReference	getCode()
boolean	getDoNotPerform()
BooleanType	getDoNotPerformElement()
Reference	getEncounter()
Identifier	getGroupIdentifier()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CanonicalType>	getInstantiatesCanonical()
List<UriType>	getInstantiatesUri()
List<Reference>	getInsurance()
Reference	getInsuranceFirstRep()
Enumerations.RequestIntent	getIntent()
Enumeration<Enumerations.RequestIntent>	getIntentElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
DataType	getOccurrence()
DateTimeType	getOccurrenceDateTimeType()
Period	getOccurrencePeriod()
Timing	getOccurrenceTiming()
List<DeviceRequest.DeviceRequestParameterComponent>	getParameter()
DeviceRequest.DeviceRequestParameterComponent	getParameterFirstRep()
CodeableReference	getPerformer()
Enumerations.RequestPriority	getPriority()
Enumeration<Enumerations.RequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
int	getQuantity()
IntegerType	getQuantityElement()
List<CodeableReference>	getReason()
CodeableReference	getReasonFirstRep()
List<Reference>	getRelevantHistory()
Reference	getRelevantHistoryFirstRep()
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
Reference	getRequester()
ResourceType	getResourceType()
Enumerations.RequestStatus	getStatus()
Enumeration<Enumerations.RequestStatus>	getStatusElement()
Reference	getSubject()
List<Reference>	getSupportingInfo()
Reference	getSupportingInfoFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAsNeeded()
boolean	hasAsNeededElement()
boolean	hasAsNeededFor()
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasCode()
boolean	hasDoNotPerform()
boolean	hasDoNotPerformElement()
boolean	hasEncounter()
boolean	hasGroupIdentifier()
boolean	hasIdentifier()
boolean	hasInstantiatesCanonical()
boolean	hasInstantiatesCanonical(String value)
boolean	hasInstantiatesUri()
boolean	hasInstantiatesUri(String value)
boolean	hasInsurance()
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasNote()
boolean	hasOccurrence()
boolean	hasOccurrenceDateTimeType()
boolean	hasOccurrencePeriod()
boolean	hasOccurrenceTiming()
boolean	hasParameter()
boolean	hasPerformer()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasQuantity()
boolean	hasQuantityElement()
boolean	hasReason()
boolean	hasRelevantHistory()
boolean	hasReplaces()
boolean	hasRequester()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSupportingInfo()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
void	removeChild(String name, Base value)
DeviceRequest	setAsNeeded(boolean value)
DeviceRequest	setAsNeededElement(BooleanType value)
DeviceRequest	setAsNeededFor(CodeableConcept value)
DeviceRequest	setAuthoredOn(Date value)
DeviceRequest	setAuthoredOnElement(DateTimeType value)
DeviceRequest	setBasedOn(List<Reference> theBasedOn)
DeviceRequest	setCode(CodeableReference value)
DeviceRequest	setDoNotPerform(boolean value)
DeviceRequest	setDoNotPerformElement(BooleanType value)
DeviceRequest	setEncounter(Reference value)
DeviceRequest	setGroupIdentifier(Identifier value)
DeviceRequest	setIdentifier(List<Identifier> theIdentifier)
DeviceRequest	setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
DeviceRequest	setInstantiatesUri(List<UriType> theInstantiatesUri)
DeviceRequest	setInsurance(List<Reference> theInsurance)
DeviceRequest	setIntent(Enumerations.RequestIntent value)
DeviceRequest	setIntentElement(Enumeration<Enumerations.RequestIntent> value)
DeviceRequest	setNote(List<Annotation> theNote)
DeviceRequest	setOccurrence(DataType value)
DeviceRequest	setParameter(List<DeviceRequest.DeviceRequestParameterComponent> theParameter)
DeviceRequest	setPerformer(CodeableReference value)
DeviceRequest	setPriority(Enumerations.RequestPriority value)
DeviceRequest	setPriorityElement(Enumeration<Enumerations.RequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
DeviceRequest	setQuantity(int value)
DeviceRequest	setQuantityElement(IntegerType value)
DeviceRequest	setReason(List<CodeableReference> theReason)
DeviceRequest	setRelevantHistory(List<Reference> theRelevantHistory)
DeviceRequest	setReplaces(List<Reference> theReplaces)
DeviceRequest	setRequester(Reference value)
DeviceRequest	setStatus(Enumerations.RequestStatus value)
DeviceRequest	setStatusElement(Enumeration<Enumerations.RequestStatus> value)
DeviceRequest	setSubject(Reference value)
DeviceRequest	setSupportingInfo(List<Reference> theSupportingInfo)
protected DeviceRequest	typedCopy()

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

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

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

copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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

protected List<Identifier> identifier

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

instantiatesCanonical

protected List<CanonicalType> instantiatesCanonical

The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

instantiatesUri

protected List<UriType> instantiatesUri

The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.

basedOn

protected List<Reference> basedOn

Plan/proposal/order fulfilled by this request.

replaces

protected List<Reference> replaces

The request takes the place of the referenced completed or terminated request(s).

groupIdentifier

protected Identifier groupIdentifier

A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.

status

protected Enumeration<Enumerations.RequestStatus> status

The status of the request.

intent

protected Enumeration<Enumerations.RequestIntent> intent

Whether the request is a proposal, plan, an original order or a reflex order.

priority

protected Enumeration<Enumerations.RequestPriority> priority

Indicates how quickly the request should be addressed with respect to other requests.

doNotPerform

protected BooleanType doNotPerform

If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

code

protected CodeableReference code

The details of the device to be used.

quantity

protected IntegerType quantity

The number of devices to be provided.

parameter

protected List<DeviceRequest.DeviceRequestParameterComponent> parameter

Specific parameters for the ordered item. For example, the prism value for lenses.

subject

protected Reference subject

The patient who will use the device.

encounter

protected Reference encounter

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

occurrence

protected DataType occurrence

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

authoredOn

protected DateTimeType authoredOn

When the request transitioned to being actionable.

requester

protected Reference requester

The individual or entity who initiated the request and has responsibility for its activation.

performer

protected CodeableReference performer

The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).

reason

protected List<CodeableReference> reason

Reason or justification for the use of this device.

asNeeded

protected BooleanType asNeeded

This status is to indicate whether the request is a PRN or may be given as needed.

asNeededFor

protected CodeableConcept asNeededFor

The reason for using the device.

insurance

protected List<Reference> insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.

supportingInfo

protected List<Reference> supportingInfo

Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).

note

protected List<Annotation> note

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.

relevantHistory

protected List<Reference> relevantHistory

Key events in the history of the request.

SP_AUTHORED_ON

public static final String SP_AUTHORED_ON

Search parameter: authored-on

Description: When the request transitioned to being actionable
Type: date
Path: DeviceRequest.authoredOn

See Also:

• Constant Field Values

AUTHORED_ON

public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED_ON

Fluent Client search parameter constant for authored-on

Description: When the request transitioned to being actionable
Type: date
Path: DeviceRequest.authoredOn

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Plan/proposal/order fulfilled by this request
Type: reference
Path: DeviceRequest.basedOn

See Also:

• Constant Field Values

BASED_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON

Fluent Client search parameter constant for based-on

Description: Plan/proposal/order fulfilled by this request
Type: reference
Path: DeviceRequest.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:based-on".

SP_DEVICE

public static final String SP_DEVICE

Search parameter: device

Description: Reference to resource that is being requested/ordered
Type: reference
Path: DeviceRequest.code.reference

See Also:

• Constant Field Values

DEVICE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEVICE

Fluent Client search parameter constant for device

Description: Reference to resource that is being requested/ordered
Type: reference
Path: DeviceRequest.code.reference

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 "DeviceRequest:device".

SP_EVENT_DATE

public static final String SP_EVENT_DATE

Search parameter: event-date

Description: When service should occur
Type: date
Path: (DeviceRequest.occurrence.ofType(dateTime)) | (DeviceRequest.occurrence.ofType(Period))

See Also:

• Constant Field Values

EVENT_DATE

public static final ca.uhn.fhir.rest.gclient.DateClientParam EVENT_DATE

Fluent Client search parameter constant for event-date

Description: When service should occur
Type: date
Path: (DeviceRequest.occurrence.ofType(dateTime)) | (DeviceRequest.occurrence.ofType(Period))

SP_GROUP_IDENTIFIER

public static final String SP_GROUP_IDENTIFIER

Search parameter: group-identifier

Description: Composite request this is part of
Type: token
Path: DeviceRequest.groupIdentifier

See Also:

• Constant Field Values

GROUP_IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam GROUP_IDENTIFIER

Fluent Client search parameter constant for group-identifier

Description: Composite request this is part of
Type: token
Path: DeviceRequest.groupIdentifier

SP_INSTANTIATES_CANONICAL

public static final String SP_INSTANTIATES_CANONICAL

Search parameter: instantiates-canonical

Description: Instantiates FHIR protocol or definition
Type: reference
Path: DeviceRequest.instantiatesCanonical

See Also:

• Constant Field Values

INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL

Fluent Client search parameter constant for instantiates-canonical

Description: Instantiates FHIR protocol or definition
Type: reference
Path: DeviceRequest.instantiatesCanonical

INCLUDE_INSTANTIATES_CANONICAL

public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:instantiates-canonical".

SP_INSTANTIATES_URI

public static final String SP_INSTANTIATES_URI

Search parameter: instantiates-uri

Description: Instantiates external protocol or definition
Type: uri
Path: DeviceRequest.instantiatesUri

See Also:

• Constant Field Values

INSTANTIATES_URI

public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI

Fluent Client search parameter constant for instantiates-uri

Description: Instantiates external protocol or definition
Type: uri
Path: DeviceRequest.instantiatesUri

SP_INSURANCE

public static final String SP_INSURANCE

Search parameter: insurance

Description: Associated insurance coverage
Type: reference
Path: DeviceRequest.insurance

See Also:

• Constant Field Values

INSURANCE

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSURANCE

Fluent Client search parameter constant for insurance

Description: Associated insurance coverage
Type: reference
Path: DeviceRequest.insurance

INCLUDE_INSURANCE

public static final ca.uhn.fhir.model.api.Include INCLUDE_INSURANCE

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:insurance".

SP_INTENT

public static final String SP_INTENT

Search parameter: intent

Description: proposal | plan | original-order |reflex-order
Type: token
Path: DeviceRequest.intent

See Also:

• Constant Field Values

INTENT

public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT

Fluent Client search parameter constant for intent

Description: proposal | plan | original-order |reflex-order
Type: token
Path: DeviceRequest.intent

SP_PERFORMER_CODE

public static final String SP_PERFORMER_CODE

Search parameter: performer-code

Description: Desired performer for service
Type: token
Path: DeviceRequest.performer.concept

See Also:

• Constant Field Values

PERFORMER_CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam PERFORMER_CODE

Fluent Client search parameter constant for performer-code

Description: Desired performer for service
Type: token
Path: DeviceRequest.performer.concept

SP_PERFORMER

public static final String SP_PERFORMER

Search parameter: performer

Description: Desired performer for service
Type: reference
Path: DeviceRequest.performer.reference

See Also:

• Constant Field Values

PERFORMER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER

Fluent Client search parameter constant for performer

Description: Desired performer for service
Type: reference
Path: DeviceRequest.performer.reference

INCLUDE_PERFORMER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:performer".

SP_PRIOR_REQUEST

public static final String SP_PRIOR_REQUEST

Search parameter: prior-request

Description: Request takes the place of referenced completed or terminated requests
Type: reference
Path: DeviceRequest.replaces

See Also:

• Constant Field Values

PRIOR_REQUEST

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRIOR_REQUEST

Fluent Client search parameter constant for prior-request

Description: Request takes the place of referenced completed or terminated requests
Type: reference
Path: DeviceRequest.replaces

INCLUDE_PRIOR_REQUEST

public static final ca.uhn.fhir.model.api.Include INCLUDE_PRIOR_REQUEST

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:prior-request".

SP_REQUESTER

public static final String SP_REQUESTER

Search parameter: requester

Description: Who/what is requesting service
Type: reference
Path: DeviceRequest.requester

See Also:

• Constant Field Values

REQUESTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER

Fluent Client search parameter constant for requester

Description: Who/what is requesting service
Type: reference
Path: DeviceRequest.requester

INCLUDE_REQUESTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:requester".

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: entered-in-error | draft | active |suspended | completed
Type: token
Path: DeviceRequest.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: entered-in-error | draft | active |suspended | completed
Type: token
Path: DeviceRequest.status

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Individual the service is ordered for
Type: reference
Path: DeviceRequest.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: Individual the service is ordered for
Type: reference
Path: DeviceRequest.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 "DeviceRequest:subject".

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [ImagingSelection](imagingselection.html): The imaging selection status [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

See Also:

• Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: Multiple Resources: [AdverseEvent](adverseevent.html): Event or incident that occurred or was averted [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [AuditEvent](auditevent.html): More specific code for the event [Basic](basic.html): Kind of Resource [ChargeItem](chargeitem.html): A code that identifies the charge, like a billing code [Condition](condition.html): Code for the condition [DetectedIssue](detectedissue.html): Issue Type, e.g. drug-drug, duplicate therapy, etc. [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [ImagingSelection](imagingselection.html): The imaging selection status [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationStatement](medicationstatement.html): Return statements of this medication code [NutritionIntake](nutritionintake.html): Returns statements of this code of NutritionIntake [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [RequestOrchestration](requestorchestration.html): The code of the request orchestration [Task](task.html): Search by task code
Type: token
Path: AdverseEvent.code | AllergyIntolerance.code | AllergyIntolerance.reaction.substance | AuditEvent.code | Basic.code | ChargeItem.code | Condition.code | DetectedIssue.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | ImagingSelection.status | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationStatement.medication.concept | NutritionIntake.code | Observation.code | Procedure.code | RequestOrchestration.code | Task.code

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceRequest:encounter".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.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: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationStatement](medicationstatement.html): Return statements with this external identifier [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationStatement](medicationstatement.html): Returns statements for a specific patient. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationStatement.subject.where(resolve() is Patient) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient

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 "DeviceRequest:patient".

Constructor Details

DeviceRequest

public DeviceRequest()

Constructor

DeviceRequest

public DeviceRequest(Enumerations.RequestIntent intent,
 CodeableReference code,
 Reference subject)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

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

setIdentifier

public DeviceRequest setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public DeviceRequest addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getInstantiatesCanonical

public List<CanonicalType> getInstantiatesCanonical()

Returns:

instantiatesCanonical (The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

setInstantiatesCanonical

public DeviceRequest setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical()

addInstantiatesCanonicalElement

public CanonicalType addInstantiatesCanonicalElement()

Returns:

instantiatesCanonical (The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

addInstantiatesCanonical

public DeviceRequest addInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

hasInstantiatesCanonical

public boolean hasInstantiatesCanonical(String value)

Parameters:

value - instantiatesCanonical (The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

getInstantiatesUri

public List<UriType> getInstantiatesUri()

Returns:

instantiatesUri (The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

setInstantiatesUri

public DeviceRequest setInstantiatesUri(List<UriType> theInstantiatesUri)

Returns:

Returns a reference to this for easy method chaining

hasInstantiatesUri

public boolean hasInstantiatesUri()

addInstantiatesUriElement

public UriType addInstantiatesUriElement()

Returns:

instantiatesUri (The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

addInstantiatesUri

public DeviceRequest addInstantiatesUri(String value)

Parameters:

value - instantiatesUri (The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

hasInstantiatesUri

public boolean hasInstantiatesUri(String value)

Parameters:

value - instantiatesUri (The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.)

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (Plan/proposal/order fulfilled by this request.)

setBasedOn

public DeviceRequest setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public DeviceRequest addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

The first repetition of repeating field basedOn, creating it if it does not already exist {3}

getReplaces

public List<Reference> getReplaces()

Returns:

replaces (The request takes the place of the referenced completed or terminated request(s).)

setReplaces

public DeviceRequest setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public DeviceRequest addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

The first repetition of repeating field replaces, creating it if it does not already exist {3}

getGroupIdentifier

public Identifier getGroupIdentifier()

Returns:

groupIdentifier (A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.)

hasGroupIdentifier

public boolean hasGroupIdentifier()

setGroupIdentifier

public DeviceRequest setGroupIdentifier(Identifier value)

Parameters:

value - groupIdentifier (A shared identifier common to multiple independent Request instances that were activated/authorized more or less simultaneously by a single author. The presence of the same identifier on each request ties those requests together and may have business ramifications in terms of reporting of results, billing, etc. E.g. a requisition number shared by a set of lab tests ordered together, or a prescription number shared by all meds ordered at one time.)

getStatusElement

public Enumeration<Enumerations.RequestStatus> 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 DeviceRequest setStatusElement(Enumeration<Enumerations.RequestStatus> 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 Enumerations.RequestStatus getStatus()

Returns:

The status of the request.

setStatus

public DeviceRequest setStatus(Enumerations.RequestStatus value)

Parameters:

value - The status of the request.

getIntentElement

public Enumeration<Enumerations.RequestIntent> getIntentElement()

Returns:

intent (Whether the request is a proposal, plan, an original order or a reflex order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

hasIntentElement

public boolean hasIntentElement()

hasIntent

public boolean hasIntent()

setIntentElement

public DeviceRequest setIntentElement(Enumeration<Enumerations.RequestIntent> value)

Parameters:

value - intent (Whether the request is a proposal, plan, an original order or a reflex order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value

getIntent

public Enumerations.RequestIntent getIntent()

Returns:

Whether the request is a proposal, plan, an original order or a reflex order.

setIntent

public DeviceRequest setIntent(Enumerations.RequestIntent value)

Parameters:

value - Whether the request is a proposal, plan, an original order or a reflex order.

getPriorityElement

public Enumeration<Enumerations.RequestPriority> getPriorityElement()

Returns:

priority (Indicates how quickly the request should be addressed with respect to other requests.). 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 DeviceRequest setPriorityElement(Enumeration<Enumerations.RequestPriority> value)

Parameters:

value - priority (Indicates how quickly the request should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value

getPriority

public Enumerations.RequestPriority getPriority()

Returns:

Indicates how quickly the request should be addressed with respect to other requests.

setPriority

public DeviceRequest setPriority(Enumerations.RequestPriority value)

Parameters:

value - Indicates how quickly the request should be addressed with respect to other requests.

getDoNotPerformElement

public BooleanType getDoNotPerformElement()

Returns:

doNotPerform (If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value

hasDoNotPerformElement

public boolean hasDoNotPerformElement()

hasDoNotPerform

public boolean hasDoNotPerform()

setDoNotPerformElement

public DeviceRequest setDoNotPerformElement(BooleanType value)

Parameters:

value - doNotPerform (If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value

getDoNotPerform

public boolean getDoNotPerform()

Returns:

If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

setDoNotPerform

public DeviceRequest setDoNotPerform(boolean value)

Parameters:

value - If true, indicates that the provider is asking for the patient to either stop using or to not start using the specified device or category of devices. For example, the patient has undergone surgery and the provider is indicating that the patient should not wear contact lenses.

getCode

public CodeableReference getCode()

Returns:

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

hasCode

public boolean hasCode()

setCode

public DeviceRequest setCode(CodeableReference value)

Parameters:

value - code (The details of the device to be used.)

getQuantityElement

public IntegerType getQuantityElement()

Returns:

quantity (The number of devices to be provided.). This is the underlying object with id, value and extensions. The accessor "getQuantity" gives direct access to the value

hasQuantityElement

public boolean hasQuantityElement()

hasQuantity

public boolean hasQuantity()

setQuantityElement

public DeviceRequest setQuantityElement(IntegerType value)

Parameters:

value - quantity (The number of devices to be provided.). This is the underlying object with id, value and extensions. The accessor "getQuantity" gives direct access to the value

getQuantity

public int getQuantity()

Returns:

The number of devices to be provided.

setQuantity

public DeviceRequest setQuantity(int value)

Parameters:

value - The number of devices to be provided.

getParameter

public List<DeviceRequest.DeviceRequestParameterComponent> getParameter()

Returns:

parameter (Specific parameters for the ordered item. For example, the prism value for lenses.)

setParameter

public DeviceRequest setParameter(List<DeviceRequest.DeviceRequestParameterComponent> theParameter)

Returns:

Returns a reference to this for easy method chaining

hasParameter

public boolean hasParameter()

addParameter

public DeviceRequest.DeviceRequestParameterComponent addParameter()

addParameter

public DeviceRequest addParameter(DeviceRequest.DeviceRequestParameterComponent t)

getParameterFirstRep

public DeviceRequest.DeviceRequestParameterComponent getParameterFirstRep()

Returns:

The first repetition of repeating field parameter, creating it if it does not already exist {3}

getSubject

public Reference getSubject()

Returns:

subject (The patient who will use the device.)

hasSubject

public boolean hasSubject()

setSubject

public DeviceRequest setSubject(Reference value)

Parameters:

value - subject (The patient who will use the device.)

getEncounter

public Reference getEncounter()

Returns:

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

hasEncounter

public boolean hasEncounter()

setEncounter

public DeviceRequest setEncounter(Reference value)

Parameters:

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

getOccurrence

public DataType getOccurrence()

Returns:

occurrence (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".)

getOccurrenceDateTimeType

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

Returns:

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

hasOccurrenceDateTimeType

public boolean hasOccurrenceDateTimeType()

getOccurrencePeriod

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

Returns:

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

hasOccurrencePeriod

public boolean hasOccurrencePeriod()

getOccurrenceTiming

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

Returns:

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

hasOccurrenceTiming

public boolean hasOccurrenceTiming()

hasOccurrence

public boolean hasOccurrence()

setOccurrence

public DeviceRequest setOccurrence(DataType value)

Parameters:

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

getAuthoredOnElement

public DateTimeType getAuthoredOnElement()

Returns:

authoredOn (When the request transitioned to being actionable.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

hasAuthoredOnElement

public boolean hasAuthoredOnElement()

hasAuthoredOn

public boolean hasAuthoredOn()

setAuthoredOnElement

public DeviceRequest setAuthoredOnElement(DateTimeType value)

Parameters:

value - authoredOn (When the request transitioned to being actionable.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value

getAuthoredOn

public Date getAuthoredOn()

Returns:

When the request transitioned to being actionable.

setAuthoredOn

public DeviceRequest setAuthoredOn(Date value)

Parameters:

value - When the request transitioned to being actionable.

getRequester

public Reference getRequester()

Returns:

requester (The individual or entity who initiated the request and has responsibility for its activation.)

hasRequester

public boolean hasRequester()

setRequester

public DeviceRequest setRequester(Reference value)

Parameters:

value - requester (The individual or entity who initiated the request and has responsibility for its activation.)

getPerformer

public CodeableReference getPerformer()

Returns:

performer (The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).)

hasPerformer

public boolean hasPerformer()

setPerformer

public DeviceRequest setPerformer(CodeableReference value)

Parameters:

value - performer (The desired individual or entity to provide the device to the subject of the request (e.g., patient, location).)

getReason

public List<CodeableReference> getReason()

Returns:

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

setReason

public DeviceRequest setReason(List<CodeableReference> theReason)

Returns:

Returns a reference to this for easy method chaining

hasReason

public boolean hasReason()

addReason

public CodeableReference addReason()

addReason

public DeviceRequest addReason(CodeableReference t)

getReasonFirstRep

public CodeableReference getReasonFirstRep()

Returns:

The first repetition of repeating field reason, creating it if it does not already exist {3}

getAsNeededElement

public BooleanType getAsNeededElement()

Returns:

asNeeded (This status is to indicate whether the request is a PRN or may be given as needed.). This is the underlying object with id, value and extensions. The accessor "getAsNeeded" gives direct access to the value

hasAsNeededElement

public boolean hasAsNeededElement()

hasAsNeeded

public boolean hasAsNeeded()

setAsNeededElement

public DeviceRequest setAsNeededElement(BooleanType value)

Parameters:

value - asNeeded (This status is to indicate whether the request is a PRN or may be given as needed.). This is the underlying object with id, value and extensions. The accessor "getAsNeeded" gives direct access to the value

getAsNeeded

public boolean getAsNeeded()

Returns:

This status is to indicate whether the request is a PRN or may be given as needed.

setAsNeeded

public DeviceRequest setAsNeeded(boolean value)

Parameters:

value - This status is to indicate whether the request is a PRN or may be given as needed.

getAsNeededFor

public CodeableConcept getAsNeededFor()

Returns:

asNeededFor (The reason for using the device.)

hasAsNeededFor

public boolean hasAsNeededFor()

setAsNeededFor

public DeviceRequest setAsNeededFor(CodeableConcept value)

Parameters:

value - asNeededFor (The reason for using the device.)

getInsurance

public List<Reference> getInsurance()

Returns:

insurance (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.)

setInsurance

public DeviceRequest setInsurance(List<Reference> theInsurance)

Returns:

Returns a reference to this for easy method chaining

hasInsurance

public boolean hasInsurance()

addInsurance

public Reference addInsurance()

addInsurance

public DeviceRequest addInsurance(Reference t)

getInsuranceFirstRep

public Reference getInsuranceFirstRep()

Returns:

The first repetition of repeating field insurance, creating it if it does not already exist {3}

getSupportingInfo

public List<Reference> getSupportingInfo()

Returns:

supportingInfo (Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).)

setSupportingInfo

public DeviceRequest setSupportingInfo(List<Reference> theSupportingInfo)

Returns:

Returns a reference to this for easy method chaining

hasSupportingInfo

public boolean hasSupportingInfo()

addSupportingInfo

public Reference addSupportingInfo()

addSupportingInfo

public DeviceRequest addSupportingInfo(Reference t)

getSupportingInfoFirstRep

public Reference getSupportingInfoFirstRep()

Returns:

The first repetition of repeating field supportingInfo, creating it if it does not already exist {3}

getNote

public List<Annotation> getNote()

Returns:

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

setNote

public DeviceRequest setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public DeviceRequest addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getRelevantHistory

public List<Reference> getRelevantHistory()

Returns:

relevantHistory (Key events in the history of the request.)

setRelevantHistory

public DeviceRequest setRelevantHistory(List<Reference> theRelevantHistory)

Returns:

Returns a reference to this for easy method chaining

hasRelevantHistory

public boolean hasRelevantHistory()

addRelevantHistory

public Reference addRelevantHistory()

addRelevantHistory

public DeviceRequest addRelevantHistory(Reference t)

getRelevantHistoryFirstRep

public Reference getRelevantHistoryFirstRep()

Returns:

The first repetition of repeating field relevantHistory, creating it if it does not already exist {3}

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

removeChild

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

Overrides:

removeChild 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

Returns:

the FHIR type name of the instance (not the java class name)

copy

public DeviceRequest copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(DeviceRequest dst)

typedCopy

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