Package org.hl7.fhir.dstu3.model

Class ProcedureRequest

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.ProcedureRequest

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

A record of a request for diagnostic investigations, treatments, or operations to be performed.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProcedureRequest.ProcedureRequestIntent
static class	ProcedureRequest.ProcedureRequestIntentEnumFactory
static enum	ProcedureRequest.ProcedureRequestPriority
static class	ProcedureRequest.ProcedureRequestPriorityEnumFactory
static class	ProcedureRequest.ProcedureRequestRequesterComponent
static enum	ProcedureRequest.ProcedureRequestStatus
static class	ProcedureRequest.ProcedureRequestStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected Type	asNeeded	If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.
static final ca.uhn.fhir.rest.gclient.DateClientParam	AUTHORED	Fluent Client search parameter constant for authored
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 List<Resource>	basedOnTarget	The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)
static final ca.uhn.fhir.rest.gclient.TokenClientParam	BODY_SITE	Fluent Client search parameter constant for body-site
protected List<CodeableConcept>	bodySite	Anatomic location where the procedure should be performed.
protected List<CodeableConcept>	category	A code that classifies the procedure for searching, sorting and display purposes (e.g.
protected CodeableConcept	code	A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
protected Reference	context	An encounter or episode of care that provides additional information about the healthcare context in which this request is made.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
protected Resource	contextTarget	The actual object that is the target of the reference (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)
protected List<Reference>	definition	Protocol or definition followed by this request.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEFINITION	Fluent Client search parameter constant for definition
protected List<Resource>	definitionTarget	The actual objects that are the target of the reference (Protocol or definition followed by this request.)
protected BooleanType	doNotPerform	Set this to true if the record is saying that the procedure should NOT be performed.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected List<Identifier>	identifier	Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
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_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEFINITION	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_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_REPLACES	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_SPECIMEN	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.
protected Enumeration<ProcedureRequest.ProcedureRequestIntent>	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	Any other notes and comments made about the service request.
protected Type	occurrence	The date/time at which the diagnostic testing should occur.
static final ca.uhn.fhir.rest.gclient.DateClientParam	OCCURRENCE	Fluent Client search parameter constant for occurrence
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected Reference	performer	The desired perfomer for doing the diagnostic testing.
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_TYPE	Fluent Client search parameter constant for performer-type
protected Resource	performerTarget	The actual object that is the target of the reference (The desired perfomer for doing the diagnostic testing.
protected CodeableConcept	performerType	Desired type of performer for doing the diagnostic testing.
protected Enumeration<ProcedureRequest.ProcedureRequestPriority>	priority	Indicates how quickly the ProcedureRequest should be addressed with respect to other requests.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	PRIORITY	Fluent Client search parameter constant for priority
protected List<CodeableConcept>	reasonCode	An explanation or justification for why this diagnostic investigation is being requested in coded or textual form.
protected List<Reference>	reasonReference	Indicates another resource that provides a justification for why this diagnostic investigation is being requested.
protected List<Resource>	reasonReferenceTarget	The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this diagnostic investigation is being requested.
protected List<Reference>	relevantHistory	Key events in the history of the request.
protected List<Provenance>	relevantHistoryTarget	The actual objects that are the target of the reference (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).
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	REPLACES	Fluent Client search parameter constant for replaces
protected List<Resource>	replacesTarget	The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)
protected ProcedureRequest.ProcedureRequestRequesterComponent	requester	The individual 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
protected Identifier	requisition	A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	REQUISITION	Fluent Client search parameter constant for requisition
static final String	SP_AUTHORED	Search parameter: authored
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_BODY_SITE	Search parameter: body-site
static final String	SP_CODE	Search parameter: code
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_DEFINITION	Search parameter: definition
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INTENT	Search parameter: intent
static final String	SP_OCCURRENCE	Search parameter: occurrence
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_PERFORMER	Search parameter: performer
static final String	SP_PERFORMER_TYPE	Search parameter: performer-type
static final String	SP_PRIORITY	Search parameter: priority
static final String	SP_REPLACES	Search parameter: replaces
static final String	SP_REQUESTER	Search parameter: requester
static final String	SP_REQUISITION	Search parameter: requisition
static final String	SP_SPECIMEN	Search parameter: specimen
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected List<Reference>	specimen	One or more specimens that the laboratory procedure will use.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SPECIMEN	Fluent Client search parameter constant for specimen
protected List<Specimen>	specimenTarget	The actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)
protected Enumeration<ProcedureRequest.ProcedureRequestStatus>	status	The status of the order.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	On whom or what the procedure or diagnostic is to be performed.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (On whom or what the procedure or diagnostic is to be performed.
protected List<Reference>	supportingInfo	Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations.
protected List<Resource>	supportingInfoTarget	The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations.

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

contained, extension, modifierExtension, text

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
ProcedureRequest()	Constructor
ProcedureRequest(Enumeration<ProcedureRequest.ProcedureRequestStatus> status, Enumeration<ProcedureRequest.ProcedureRequestIntent> intent, CodeableConcept code, Reference subject)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
ProcedureRequest	addBasedOn(Reference t)
CodeableConcept	addBodySite()
ProcedureRequest	addBodySite(CodeableConcept t)
CodeableConcept	addCategory()
ProcedureRequest	addCategory(CodeableConcept t)
Base	addChild(String name)
Reference	addDefinition()
ProcedureRequest	addDefinition(Reference t)
Identifier	addIdentifier()
ProcedureRequest	addIdentifier(Identifier t)
Annotation	addNote()
ProcedureRequest	addNote(Annotation t)
CodeableConcept	addReasonCode()
ProcedureRequest	addReasonCode(CodeableConcept t)
Reference	addReasonReference()
ProcedureRequest	addReasonReference(Reference t)
Reference	addRelevantHistory()
ProcedureRequest	addRelevantHistory(Reference t)
Provenance	addRelevantHistoryTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addReplaces()
ProcedureRequest	addReplaces(Reference t)
Reference	addSpecimen()
ProcedureRequest	addSpecimen(Reference t)
Specimen	addSpecimenTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Reference	addSupportingInfo()
ProcedureRequest	addSupportingInfo(Reference t)
ProcedureRequest	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Type	getAsNeeded()
BooleanType	getAsNeededBooleanType()
CodeableConcept	getAsNeededCodeableConcept()
Date	getAuthoredOn()
DateTimeType	getAuthoredOnElement()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<Resource>	getBasedOnTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getBodySite()
CodeableConcept	getBodySiteFirstRep()
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
CodeableConcept	getCode()
Reference	getContext()
Resource	getContextTarget()
List<Reference>	getDefinition()
Reference	getDefinitionFirstRep()
List<Resource>	getDefinitionTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
boolean	getDoNotPerform()
BooleanType	getDoNotPerformElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
ProcedureRequest.ProcedureRequestIntent	getIntent()
Enumeration<ProcedureRequest.ProcedureRequestIntent>	getIntentElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
Type	getOccurrence()
DateTimeType	getOccurrenceDateTimeType()
Period	getOccurrencePeriod()
Timing	getOccurrenceTiming()
Reference	getPerformer()
Resource	getPerformerTarget()
CodeableConcept	getPerformerType()
ProcedureRequest.ProcedureRequestPriority	getPriority()
Enumeration<ProcedureRequest.ProcedureRequestPriority>	getPriorityElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReasonCode()
CodeableConcept	getReasonCodeFirstRep()
List<Reference>	getReasonReference()
Reference	getReasonReferenceFirstRep()
List<Resource>	getReasonReferenceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getRelevantHistory()
Reference	getRelevantHistoryFirstRep()
List<Provenance>	getRelevantHistoryTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Reference>	getReplaces()
Reference	getReplacesFirstRep()
List<Resource>	getReplacesTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ProcedureRequest.ProcedureRequestRequesterComponent	getRequester()
Identifier	getRequisition()
ResourceType	getResourceType()
List<Reference>	getSpecimen()
Reference	getSpecimenFirstRep()
List<Specimen>	getSpecimenTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ProcedureRequest.ProcedureRequestStatus	getStatus()
Enumeration<ProcedureRequest.ProcedureRequestStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
List<Reference>	getSupportingInfo()
Reference	getSupportingInfoFirstRep()
List<Resource>	getSupportingInfoTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
String[]	getTypesForProperty(int hash, String name)
boolean	hasAsNeeded()
boolean	hasAsNeededBooleanType()
boolean	hasAsNeededCodeableConcept()
boolean	hasAuthoredOn()
boolean	hasAuthoredOnElement()
boolean	hasBasedOn()
boolean	hasBodySite()
boolean	hasCategory()
boolean	hasCode()
boolean	hasContext()
boolean	hasDefinition()
boolean	hasDoNotPerform()
boolean	hasDoNotPerformElement()
boolean	hasIdentifier()
boolean	hasIntent()
boolean	hasIntentElement()
boolean	hasNote()
boolean	hasOccurrence()
boolean	hasOccurrenceDateTimeType()
boolean	hasOccurrencePeriod()
boolean	hasOccurrenceTiming()
boolean	hasPerformer()
boolean	hasPerformerType()
boolean	hasPriority()
boolean	hasPriorityElement()
boolean	hasReasonCode()
boolean	hasReasonReference()
boolean	hasRelevantHistory()
boolean	hasReplaces()
boolean	hasRequester()
boolean	hasRequisition()
boolean	hasSpecimen()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasSupportingInfo()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
ProcedureRequest	setAsNeeded(Type value)
ProcedureRequest	setAuthoredOn(Date value)
ProcedureRequest	setAuthoredOnElement(DateTimeType value)
ProcedureRequest	setBasedOn(List<Reference> theBasedOn)
ProcedureRequest	setBodySite(List<CodeableConcept> theBodySite)
ProcedureRequest	setCategory(List<CodeableConcept> theCategory)
ProcedureRequest	setCode(CodeableConcept value)
ProcedureRequest	setContext(Reference value)
ProcedureRequest	setContextTarget(Resource value)
ProcedureRequest	setDefinition(List<Reference> theDefinition)
ProcedureRequest	setDoNotPerform(boolean value)
ProcedureRequest	setDoNotPerformElement(BooleanType value)
ProcedureRequest	setIdentifier(List<Identifier> theIdentifier)
ProcedureRequest	setIntent(ProcedureRequest.ProcedureRequestIntent value)
ProcedureRequest	setIntentElement(Enumeration<ProcedureRequest.ProcedureRequestIntent> value)
ProcedureRequest	setNote(List<Annotation> theNote)
ProcedureRequest	setOccurrence(Type value)
ProcedureRequest	setPerformer(Reference value)
ProcedureRequest	setPerformerTarget(Resource value)
ProcedureRequest	setPerformerType(CodeableConcept value)
ProcedureRequest	setPriority(ProcedureRequest.ProcedureRequestPriority value)
ProcedureRequest	setPriorityElement(Enumeration<ProcedureRequest.ProcedureRequestPriority> value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
ProcedureRequest	setReasonCode(List<CodeableConcept> theReasonCode)
ProcedureRequest	setReasonReference(List<Reference> theReasonReference)
ProcedureRequest	setRelevantHistory(List<Reference> theRelevantHistory)
ProcedureRequest	setReplaces(List<Reference> theReplaces)
ProcedureRequest	setRequester(ProcedureRequest.ProcedureRequestRequesterComponent value)
ProcedureRequest	setRequisition(Identifier value)
ProcedureRequest	setSpecimen(List<Reference> theSpecimen)
ProcedureRequest	setStatus(ProcedureRequest.ProcedureRequestStatus value)
ProcedureRequest	setStatusElement(Enumeration<ProcedureRequest.ProcedureRequestStatus> value)
ProcedureRequest	setSubject(Reference value)
ProcedureRequest	setSubjectTarget(Resource value)
ProcedureRequest	setSupportingInfo(List<Reference> theSupportingInfo)
protected ProcedureRequest	typedCopy()

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

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

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

definition

protected List<Reference> definition

Protocol or definition followed by this request.

definitionTarget

protected List<Resource> definitionTarget

The actual objects that are the target of the reference (Protocol or definition followed by this request.)

basedOn

protected List<Reference> basedOn

Plan/proposal/order fulfilled by this request.

basedOnTarget

protected List<Resource> basedOnTarget

The actual objects that are the target of the reference (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).

replacesTarget

protected List<Resource> replacesTarget

The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)

requisition

protected Identifier requisition

A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

status

protected Enumeration<ProcedureRequest.ProcedureRequestStatus> status

The status of the order.

intent

protected Enumeration<ProcedureRequest.ProcedureRequestIntent> intent

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

priority

protected Enumeration<ProcedureRequest.ProcedureRequestPriority> priority

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

doNotPerform

protected BooleanType doNotPerform

Set this to true if the record is saying that the procedure should NOT be performed.

category

protected List<CodeableConcept> category

A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").

code

protected CodeableConcept code

A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.

subject

protected Reference subject

On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

context

protected Reference context

An encounter or episode of care that provides additional information about the healthcare context in which this request is made.

contextTarget

protected Resource contextTarget

The actual object that is the target of the reference (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)

occurrence

protected Type occurrence

The date/time at which the diagnostic testing should occur.

asNeeded

protected Type asNeeded

If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.

authoredOn

protected DateTimeType authoredOn

When the request transitioned to being actionable.

requester

protected ProcedureRequest.ProcedureRequestRequesterComponent requester

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

performerType

protected CodeableConcept performerType

Desired type of performer for doing the diagnostic testing.

performer

protected Reference performer

The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.

performerTarget

protected Resource performerTarget

The actual object that is the target of the reference (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)

reasonCode

protected List<CodeableConcept> reasonCode

An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.

reasonReference

protected List<Reference> reasonReference

Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.

reasonReferenceTarget

protected List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.)

supportingInfo

protected List<Reference> supportingInfo

Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.

supportingInfoTarget

protected List<Resource> supportingInfoTarget

The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)

specimen

protected List<Reference> specimen

One or more specimens that the laboratory procedure will use.

specimenTarget

protected List<Specimen> specimenTarget

The actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)

bodySite

protected List<CodeableConcept> bodySite

Anatomic location where the procedure should be performed. This is the target site.

note

protected List<Annotation> note

Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.

relevantHistory

protected List<Reference> relevantHistory

Key events in the history of the request.

relevantHistoryTarget

protected List<Provenance> relevantHistoryTarget

The actual objects that are the target of the reference (Key events in the history of the request.)

SP_AUTHORED

public static final String SP_AUTHORED

Search parameter: authored

Description: Date request signed
Type: date
Path: ProcedureRequest.authoredOn

See Also:

• Constant Field Values

AUTHORED

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

Fluent Client search parameter constant for authored

Description: Date request signed
Type: date
Path: ProcedureRequest.authoredOn

SP_REQUESTER

public static final String SP_REQUESTER

Search parameter: requester

Description: Individual making the request
Type: reference
Path: ProcedureRequest.requester.agent

See Also:

• Constant Field Values

REQUESTER

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

Fluent Client search parameter constant for requester

Description: Individual making the request
Type: reference
Path: ProcedureRequest.requester.agent

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 "ProcedureRequest:requester".

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Identifiers assigned to this order
Type: token
Path: ProcedureRequest.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: Identifiers assigned to this order
Type: token
Path: ProcedureRequest.identifier

SP_CODE

public static final String SP_CODE

Search parameter: code

Description: What is being requested/ordered
Type: token
Path: ProcedureRequest.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: What is being requested/ordered
Type: token
Path: ProcedureRequest.code

SP_PERFORMER

public static final String SP_PERFORMER

Search parameter: performer

Description: Requested perfomer
Type: reference
Path: ProcedureRequest.performer

See Also:

• Constant Field Values

PERFORMER

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

Fluent Client search parameter constant for performer

Description: Requested perfomer
Type: reference
Path: ProcedureRequest.performer

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 "ProcedureRequest:performer".

SP_REQUISITION

public static final String SP_REQUISITION

Search parameter: requisition

Description: Composite Request ID
Type: token
Path: ProcedureRequest.requisition

See Also:

• Constant Field Values

REQUISITION

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

Fluent Client search parameter constant for requisition

Description: Composite Request ID
Type: token
Path: ProcedureRequest.requisition

SP_REPLACES

public static final String SP_REPLACES

Search parameter: replaces

Description: What request replaces
Type: reference
Path: ProcedureRequest.replaces

See Also:

• Constant Field Values

REPLACES

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

Fluent Client search parameter constant for replaces

Description: What request replaces
Type: reference
Path: ProcedureRequest.replaces

INCLUDE_REPLACES

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

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

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Search by subject
Type: reference
Path: ProcedureRequest.subject

See Also:

• Constant Field Values

SUBJECT

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

Fluent Client search parameter constant for subject

Description: Search by subject
Type: reference
Path: ProcedureRequest.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 "ProcedureRequest:subject".

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: An encounter in which this request is made
Type: reference
Path: ProcedureRequest.context

See Also:

• Constant Field Values

ENCOUNTER

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

Fluent Client search parameter constant for encounter

Description: An encounter in which this request is made
Type: reference
Path: ProcedureRequest.context

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 "ProcedureRequest:encounter".

SP_OCCURRENCE

public static final String SP_OCCURRENCE

Search parameter: occurrence

Description: When procedure should occur
Type: date
Path: ProcedureRequest.occurrence[x]

See Also:

• Constant Field Values

OCCURRENCE

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

Fluent Client search parameter constant for occurrence

Description: When procedure should occur
Type: date
Path: ProcedureRequest.occurrence[x]

SP_PRIORITY

public static final String SP_PRIORITY

Search parameter: priority

Description: routine | urgent | asap | stat
Type: token
Path: ProcedureRequest.priority

See Also:

• Constant Field Values

PRIORITY

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

Fluent Client search parameter constant for priority

Description: routine | urgent | asap | stat
Type: token
Path: ProcedureRequest.priority

SP_INTENT

public static final String SP_INTENT

Search parameter: intent

Description: proposal | plan | order +
Type: token
Path: ProcedureRequest.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 | order +
Type: token
Path: ProcedureRequest.intent

SP_PERFORMER_TYPE

public static final String SP_PERFORMER_TYPE

Search parameter: performer-type

Description: Performer role
Type: token
Path: ProcedureRequest.performerType

See Also:

• Constant Field Values

PERFORMER_TYPE

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

Fluent Client search parameter constant for performer-type

Description: Performer role
Type: token
Path: ProcedureRequest.performerType

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: What request fulfills
Type: reference
Path: ProcedureRequest.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: What request fulfills
Type: reference
Path: ProcedureRequest.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 "ProcedureRequest:based-on".

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Search by subject - a patient
Type: reference
Path: ProcedureRequest.subject

See Also:

• Constant Field Values

PATIENT

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

Fluent Client search parameter constant for patient

Description: Search by subject - a patient
Type: reference
Path: ProcedureRequest.subject

INCLUDE_PATIENT

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

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

SP_SPECIMEN

public static final String SP_SPECIMEN

Search parameter: specimen

Description: Specimen to be tested
Type: reference
Path: ProcedureRequest.specimen

See Also:

• Constant Field Values

SPECIMEN

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

Fluent Client search parameter constant for specimen

Description: Specimen to be tested
Type: reference
Path: ProcedureRequest.specimen

INCLUDE_SPECIMEN

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

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

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: Encounter or Episode during which request was created
Type: reference
Path: ProcedureRequest.context

See Also:

• Constant Field Values

CONTEXT

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

Fluent Client search parameter constant for context

Description: Encounter or Episode during which request was created
Type: reference
Path: ProcedureRequest.context

INCLUDE_CONTEXT

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

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

SP_DEFINITION

public static final String SP_DEFINITION

Search parameter: definition

Description: Protocol or definition
Type: reference
Path: ProcedureRequest.definition

See Also:

• Constant Field Values

DEFINITION

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

Fluent Client search parameter constant for definition

Description: Protocol or definition
Type: reference
Path: ProcedureRequest.definition

INCLUDE_DEFINITION

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

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

SP_BODY_SITE

public static final String SP_BODY_SITE

Search parameter: body-site

Description: Where procedure is going to be done
Type: token
Path: ProcedureRequest.bodySite

See Also:

• Constant Field Values

BODY_SITE

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

Fluent Client search parameter constant for body-site

Description: Where procedure is going to be done
Type: token
Path: ProcedureRequest.bodySite

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: draft | active | suspended | completed | entered-in-error | cancelled
Type: token
Path: ProcedureRequest.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: draft | active | suspended | completed | entered-in-error | cancelled
Type: token
Path: ProcedureRequest.status

Constructor Details

ProcedureRequest

public ProcedureRequest()

Constructor

ProcedureRequest

public ProcedureRequest(Enumeration<ProcedureRequest.ProcedureRequestStatus> status,
 Enumeration<ProcedureRequest.ProcedureRequestIntent> intent,
 CodeableConcept code,
 Reference subject)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.)

setIdentifier

public ProcedureRequest setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public ProcedureRequest addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getDefinition

public List<Reference> getDefinition()

Returns:

definition (Protocol or definition followed by this request.)

setDefinition

public ProcedureRequest setDefinition(List<Reference> theDefinition)

Returns:

Returns a reference to this for easy method chaining

hasDefinition

public boolean hasDefinition()

addDefinition

public Reference addDefinition()

addDefinition

public ProcedureRequest addDefinition(Reference t)

getDefinitionFirstRep

public Reference getDefinitionFirstRep()

Returns:

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

getDefinitionTarget

@Deprecated
public List<Resource> getDefinitionTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getBasedOn

public List<Reference> getBasedOn()

Returns:

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

setBasedOn

public ProcedureRequest setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public ProcedureRequest addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

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

getBasedOnTarget

@Deprecated
public List<Resource> getBasedOnTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getReplaces

public List<Reference> getReplaces()

Returns:

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

setReplaces

public ProcedureRequest setReplaces(List<Reference> theReplaces)

Returns:

Returns a reference to this for easy method chaining

hasReplaces

public boolean hasReplaces()

addReplaces

public Reference addReplaces()

addReplaces

public ProcedureRequest addReplaces(Reference t)

getReplacesFirstRep

public Reference getReplacesFirstRep()

Returns:

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

getReplacesTarget

@Deprecated
public List<Resource> getReplacesTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getRequisition

public Identifier getRequisition()

Returns:

requisition (A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.)

hasRequisition

public boolean hasRequisition()

setRequisition

public ProcedureRequest setRequisition(Identifier value)

Parameters:

value - requisition (A shared identifier common to all procedure or diagnostic requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.)

getStatusElement

public Enumeration<ProcedureRequest.ProcedureRequestStatus> getStatusElement()

Returns:

status (The status of the order.). 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 ProcedureRequest setStatusElement(Enumeration<ProcedureRequest.ProcedureRequestStatus> value)

Parameters:

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

getStatus

public ProcedureRequest.ProcedureRequestStatus getStatus()

Returns:

The status of the order.

setStatus

public ProcedureRequest setStatus(ProcedureRequest.ProcedureRequestStatus value)

Parameters:

value - The status of the order.

getIntentElement

public Enumeration<ProcedureRequest.ProcedureRequestIntent> 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 ProcedureRequest setIntentElement(Enumeration<ProcedureRequest.ProcedureRequestIntent> 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 ProcedureRequest.ProcedureRequestIntent getIntent()

Returns:

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

setIntent

public ProcedureRequest setIntent(ProcedureRequest.ProcedureRequestIntent value)

Parameters:

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

getPriorityElement

public Enumeration<ProcedureRequest.ProcedureRequestPriority> getPriorityElement()

Returns:

priority (Indicates how quickly the ProcedureRequest 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 ProcedureRequest setPriorityElement(Enumeration<ProcedureRequest.ProcedureRequestPriority> value)

Parameters:

value - priority (Indicates how quickly the ProcedureRequest 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 ProcedureRequest.ProcedureRequestPriority getPriority()

Returns:

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

setPriority

public ProcedureRequest setPriority(ProcedureRequest.ProcedureRequestPriority value)

Parameters:

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

getDoNotPerformElement

public BooleanType getDoNotPerformElement()

Returns:

doNotPerform (Set this to true if the record is saying that the procedure should NOT be performed.). 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 ProcedureRequest setDoNotPerformElement(BooleanType value)

Parameters:

value - doNotPerform (Set this to true if the record is saying that the procedure should NOT be performed.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value

getDoNotPerform

public boolean getDoNotPerform()

Returns:

Set this to true if the record is saying that the procedure should NOT be performed.

setDoNotPerform

public ProcedureRequest setDoNotPerform(boolean value)

Parameters:

value - Set this to true if the record is saying that the procedure should NOT be performed.

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").)

setCategory

public ProcedureRequest setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public ProcedureRequest addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

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

getCode

public CodeableConcept getCode()

Returns:

code (A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.)

hasCode

public boolean hasCode()

setCode

public ProcedureRequest setCode(CodeableConcept value)

Parameters:

value - code (A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.)

getSubject

public Reference getSubject()

Returns:

subject (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

hasSubject

public boolean hasSubject()

setSubject

public ProcedureRequest setSubject(Reference value)

Parameters:

value - subject (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

getSubjectTarget

public Resource getSubjectTarget()

Returns:

subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

setSubjectTarget

public ProcedureRequest setSubjectTarget(Resource value)

Parameters:

value - subject The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (On whom or what the procedure or diagnostic is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)

getContext

public Reference getContext()

Returns:

context (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)

hasContext

public boolean hasContext()

setContext

public ProcedureRequest setContext(Reference value)

Parameters:

value - context (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)

getContextTarget

public Resource getContextTarget()

Returns:

context The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)

setContextTarget

public ProcedureRequest setContextTarget(Resource value)

Parameters:

value - context The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (An encounter or episode of care that provides additional information about the healthcare context in which this request is made.)

getOccurrence

public Type getOccurrence()

Returns:

occurrence (The date/time at which the diagnostic testing should occur.)

getOccurrenceDateTimeType

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

Returns:

occurrence (The date/time at which the diagnostic testing should occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrenceDateTimeType

public boolean hasOccurrenceDateTimeType()

getOccurrencePeriod

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

Returns:

occurrence (The date/time at which the diagnostic testing should occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrencePeriod

public boolean hasOccurrencePeriod()

getOccurrenceTiming

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

Returns:

occurrence (The date/time at which the diagnostic testing should occur.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasOccurrenceTiming

public boolean hasOccurrenceTiming()

hasOccurrence

public boolean hasOccurrence()

setOccurrence

public ProcedureRequest setOccurrence(Type value)
                               throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - occurrence (The date/time at which the diagnostic testing should occur.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

getAsNeeded

public Type getAsNeeded()

Returns:

asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.)

getAsNeededBooleanType

public BooleanType getAsNeededBooleanType()
                                   throws org.hl7.fhir.exceptions.FHIRException

Returns:

asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAsNeededBooleanType

public boolean hasAsNeededBooleanType()

getAsNeededCodeableConcept

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

Returns:

asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasAsNeededCodeableConcept

public boolean hasAsNeededCodeableConcept()

hasAsNeeded

public boolean hasAsNeeded()

setAsNeeded

public ProcedureRequest setAsNeeded(Type value)
                             throws org.hl7.fhir.exceptions.FHIRFormatError

Parameters:

value - asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. For example "pain", "on flare-up", etc.)

Throws:

org.hl7.fhir.exceptions.FHIRFormatError

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 ProcedureRequest 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 ProcedureRequest setAuthoredOn(Date value)

Parameters:

value - When the request transitioned to being actionable.

getRequester

public ProcedureRequest.ProcedureRequestRequesterComponent getRequester()

Returns:

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

hasRequester

public boolean hasRequester()

setRequester

public ProcedureRequest setRequester(ProcedureRequest.ProcedureRequestRequesterComponent value)

Parameters:

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

getPerformerType

public CodeableConcept getPerformerType()

Returns:

performerType (Desired type of performer for doing the diagnostic testing.)

hasPerformerType

public boolean hasPerformerType()

setPerformerType

public ProcedureRequest setPerformerType(CodeableConcept value)

Parameters:

value - performerType (Desired type of performer for doing the diagnostic testing.)

getPerformer

public Reference getPerformer()

Returns:

performer (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)

hasPerformer

public boolean hasPerformer()

setPerformer

public ProcedureRequest setPerformer(Reference value)

Parameters:

value - performer (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)

getPerformerTarget

public Resource getPerformerTarget()

Returns:

performer The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)

setPerformerTarget

public ProcedureRequest setPerformerTarget(Resource value)

Parameters:

value - performer The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.)

getReasonCode

public List<CodeableConcept> getReasonCode()

Returns:

reasonCode (An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.)

setReasonCode

public ProcedureRequest setReasonCode(List<CodeableConcept> theReasonCode)

Returns:

Returns a reference to this for easy method chaining

hasReasonCode

public boolean hasReasonCode()

addReasonCode

public CodeableConcept addReasonCode()

addReasonCode

public ProcedureRequest addReasonCode(CodeableConcept t)

getReasonCodeFirstRep

public CodeableConcept getReasonCodeFirstRep()

Returns:

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

getReasonReference

public List<Reference> getReasonReference()

Returns:

reasonReference (Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.)

setReasonReference

public ProcedureRequest setReasonReference(List<Reference> theReasonReference)

Returns:

Returns a reference to this for easy method chaining

hasReasonReference

public boolean hasReasonReference()

addReasonReference

public Reference addReasonReference()

addReasonReference

public ProcedureRequest addReasonReference(Reference t)

getReasonReferenceFirstRep

public Reference getReasonReferenceFirstRep()

Returns:

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

getReasonReferenceTarget

@Deprecated
public List<Resource> getReasonReferenceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getSupportingInfo

public List<Reference> getSupportingInfo()

Returns:

supportingInfo (Additional clinical information about the patient or specimen that may influence the procedure or diagnostics or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)

setSupportingInfo

public ProcedureRequest setSupportingInfo(List<Reference> theSupportingInfo)

Returns:

Returns a reference to this for easy method chaining

hasSupportingInfo

public boolean hasSupportingInfo()

addSupportingInfo

public Reference addSupportingInfo()

addSupportingInfo

public ProcedureRequest addSupportingInfo(Reference t)

getSupportingInfoFirstRep

public Reference getSupportingInfoFirstRep()

Returns:

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

getSupportingInfoTarget

@Deprecated
public List<Resource> getSupportingInfoTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getSpecimen

public List<Reference> getSpecimen()

Returns:

specimen (One or more specimens that the laboratory procedure will use.)

setSpecimen

public ProcedureRequest setSpecimen(List<Reference> theSpecimen)

Returns:

Returns a reference to this for easy method chaining

hasSpecimen

public boolean hasSpecimen()

addSpecimen

public Reference addSpecimen()

addSpecimen

public ProcedureRequest addSpecimen(Reference t)

getSpecimenFirstRep

public Reference getSpecimenFirstRep()

Returns:

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

getSpecimenTarget

@Deprecated
public List<Specimen> getSpecimenTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addSpecimenTarget

@Deprecated
public Specimen addSpecimenTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getBodySite

public List<CodeableConcept> getBodySite()

Returns:

bodySite (Anatomic location where the procedure should be performed. This is the target site.)

setBodySite

public ProcedureRequest setBodySite(List<CodeableConcept> theBodySite)

Returns:

Returns a reference to this for easy method chaining

hasBodySite

public boolean hasBodySite()

addBodySite

public CodeableConcept addBodySite()

addBodySite

public ProcedureRequest addBodySite(CodeableConcept t)

getBodySiteFirstRep

public CodeableConcept getBodySiteFirstRep()

Returns:

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

getNote

public List<Annotation> getNote()

Returns:

note (Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.)

setNote

public ProcedureRequest setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public ProcedureRequest addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

getRelevantHistory

public List<Reference> getRelevantHistory()

Returns:

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

setRelevantHistory

public ProcedureRequest setRelevantHistory(List<Reference> theRelevantHistory)

Returns:

Returns a reference to this for easy method chaining

hasRelevantHistory

public boolean hasRelevantHistory()

addRelevantHistory

public Reference addRelevantHistory()

addRelevantHistory

public ProcedureRequest addRelevantHistory(Reference t)

getRelevantHistoryFirstRep

public Reference getRelevantHistoryFirstRep()

Returns:

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

getRelevantHistoryTarget

@Deprecated
public List<Provenance> getRelevantHistoryTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

addRelevantHistoryTarget

@Deprecated
public Provenance addRelevantHistoryTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public ProcedureRequest copy()

Specified by:

copy in class DomainResource

typedCopy

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