ProcedureRequest (HAPI FHIR Structures

java.lang.Object
- org.hl7.fhir.instance.model.Base
- - org.hl7.fhir.instance.model.BaseResource
  - - org.hl7.fhir.instance.model.Resource
    - - org.hl7.fhir.instance.model.DomainResource
      - org.hl7.fhir.instance.model.ProcedureRequest

All Implemented Interfaces:

Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource
```
public class ProcedureRequest
extends DomainResource
```
A request for a procedure to be performed. May be a proposal or an order.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProcedureRequest.ProcedureRequestPriority`
`static class`	`ProcedureRequest.ProcedureRequestPriorityEnumFactory`
`static class`	`ProcedureRequest.ProcedureRequestStatus`
`static class`	`ProcedureRequest.ProcedureRequestStatusEnumFactory`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SP_ENCOUNTER`
`static String`	`SP_IDENTIFIER`
`static String`	`SP_ORDERER`
`static String`	`SP_PATIENT`
`static String`	`SP_PERFORMER`
`static String`	`SP_SUBJECT`

Constructor Summary

Constructors
Constructor and Description

ProcedureRequest()

ProcedureRequest(Reference subject, CodeableConcept code)

Constructors
Constructor and Description
`ProcedureRequest()`
`ProcedureRequest(Reference subject, CodeableConcept code)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addBodySite()`
`ProcedureRequest`	`addBodySite(CodeableConcept t)`
`Identifier`	`addIdentifier()`
`ProcedureRequest`	`addIdentifier(Identifier t)`
`Annotation`	`addNotes()`
`ProcedureRequest`	`addNotes(Annotation t)`
`ProcedureRequest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`Type`	`getAsNeeded()`
`BooleanType`	`getAsNeededBooleanType()`
`CodeableConcept`	`getAsNeededCodeableConcept()`
`List<CodeableConcept>`	`getBodySite()`
`CodeableConcept`	`getCode()`
`Reference`	`getEncounter()`
`Encounter`	`getEncounterTarget()`
`List<Identifier>`	`getIdentifier()`
`List<Annotation>`	`getNotes()`
`Date`	`getOrderedOn()`
`DateTimeType`	`getOrderedOnElement()`
`Reference`	`getOrderer()`
`Resource`	`getOrdererTarget()`
`Reference`	`getPerformer()`
`Resource`	`getPerformerTarget()`
`ProcedureRequest.ProcedureRequestPriority`	`getPriority()`
`Enumeration<ProcedureRequest.ProcedureRequestPriority>`	`getPriorityElement()`
`Type`	`getReason()`
`CodeableConcept`	`getReasonCodeableConcept()`
`Reference`	`getReasonReference()`
`ResourceType`	`getResourceType()`
`Type`	`getScheduled()`
`DateTimeType`	`getScheduledDateTimeType()`
`Period`	`getScheduledPeriod()`
`Timing`	`getScheduledTiming()`
`ProcedureRequest.ProcedureRequestStatus`	`getStatus()`
`Enumeration<ProcedureRequest.ProcedureRequestStatus>`	`getStatusElement()`
`Reference`	`getSubject()`
`Resource`	`getSubjectTarget()`
`boolean`	`hasAsNeeded()`
`boolean`	`hasAsNeededBooleanType()`
`boolean`	`hasAsNeededCodeableConcept()`
`boolean`	`hasBodySite()`
`boolean`	`hasCode()`
`boolean`	`hasEncounter()`
`boolean`	`hasIdentifier()`
`boolean`	`hasNotes()`
`boolean`	`hasOrderedOn()`
`boolean`	`hasOrderedOnElement()`
`boolean`	`hasOrderer()`
`boolean`	`hasPerformer()`
`boolean`	`hasPriority()`
`boolean`	`hasPriorityElement()`
`boolean`	`hasReason()`
`boolean`	`hasReasonCodeableConcept()`
`boolean`	`hasReasonReference()`
`boolean`	`hasScheduled()`
`boolean`	`hasScheduledDateTimeType()`
`boolean`	`hasScheduledPeriod()`
`boolean`	`hasScheduledTiming()`
`boolean`	`hasStatus()`
`boolean`	`hasStatusElement()`
`boolean`	`hasSubject()`
`boolean`	`isEmpty()`
`ProcedureRequest`	`setAsNeeded(Type value)`
`ProcedureRequest`	`setCode(CodeableConcept value)`
`ProcedureRequest`	`setEncounter(Reference value)`
`ProcedureRequest`	`setEncounterTarget(Encounter value)`
`ProcedureRequest`	`setOrderedOn(Date value)`
`ProcedureRequest`	`setOrderedOnElement(DateTimeType value)`
`ProcedureRequest`	`setOrderer(Reference value)`
`ProcedureRequest`	`setOrdererTarget(Resource value)`
`ProcedureRequest`	`setPerformer(Reference value)`
`ProcedureRequest`	`setPerformerTarget(Resource value)`
`ProcedureRequest`	`setPriority(ProcedureRequest.ProcedureRequestPriority value)`
`ProcedureRequest`	`setPriorityElement(Enumeration<ProcedureRequest.ProcedureRequestPriority> value)`
`ProcedureRequest`	`setReason(Type value)`
`ProcedureRequest`	`setScheduled(Type value)`
`ProcedureRequest`	`setStatus(ProcedureRequest.ProcedureRequestStatus value)`
`ProcedureRequest`	`setStatusElement(Enumeration<ProcedureRequest.ProcedureRequestStatus> value)`
`ProcedureRequest`	`setSubject(Reference value)`
`ProcedureRequest`	`setSubjectTarget(Resource value)`

Methods inherited from class org.hl7.fhir.instance.model.DomainResource
addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.instance.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.instance.model.BaseResource
setId

Methods inherited from class org.hl7.fhir.instance.model.Base
children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasUserData, listChildrenByName, setUserData, setUserDataINN

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getMeta, setId

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

- Field Detail
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    See Also:
    
    Constant Field Values
  - SP_PERFORMER
```
public static final String SP_PERFORMER
```
    See Also:
    
    Constant Field Values
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    See Also:
    
    Constant Field Values
  - SP_PATIENT
```
public static final String SP_PATIENT
```
    See Also:
    
    Constant Field Values
  - SP_ORDERER
```
public static final String SP_ORDERER
```
    See Also:
    
    Constant Field Values
  - SP_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ProcedureRequest
```
public ProcedureRequest()
```
  - ProcedureRequest
```
public ProcedureRequest(Reference subject,
                        CodeableConcept code)
```
- Method Detail
  - getIdentifier
```
public List<Identifier> getIdentifier()
```
    Returns:
    
    identifier (Identifiers assigned to this order by the order or by the receiver.)
  - hasIdentifier
```
public boolean hasIdentifier()
```
  - addIdentifier
```
public Identifier addIdentifier()
```
    Returns:
    
    identifier (Identifiers assigned to this order by the order or by the receiver.)
  - addIdentifier
```
public ProcedureRequest addIdentifier(Identifier t)
```
  - getSubject
```
public Reference getSubject()
```
    Returns:
    
    subject (The person, animal or group that should receive the procedure.)
  - hasSubject
```
public boolean hasSubject()
```
  - setSubject
```
public ProcedureRequest setSubject(Reference value)
```
    Parameters:
    
    value - subject (The person, animal or group that should receive the procedure.)
  - getSubjectTarget
```
public Resource getSubjectTarget()
```
    Returns:
    
    subject The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person, animal or group that should receive the procedure.)
  - 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. (The person, animal or group that should receive the procedure.)
  - getCode
```
public CodeableConcept getCode()
```
    Returns:
    
    code (The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.)
  - hasCode
```
public boolean hasCode()
```
  - setCode
```
public ProcedureRequest setCode(CodeableConcept value)
```
    Parameters:
    
    value - code (The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.)
  - getBodySite
```
public List<CodeableConcept> getBodySite()
```
    Returns:
    
    bodySite (Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
  - hasBodySite
```
public boolean hasBodySite()
```
  - addBodySite
```
public CodeableConcept addBodySite()
```
    Returns:
    
    bodySite (Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
  - addBodySite
```
public ProcedureRequest addBodySite(CodeableConcept t)
```
  - getReason
```
public Type getReason()
```
    Returns:
    
    reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
  - getReasonCodeableConcept
```
public CodeableConcept getReasonCodeableConcept()
                                         throws Exception
```
    Returns:
    
    reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
    
    Throws:
    
    Exception
  - hasReasonCodeableConcept
```
public boolean hasReasonCodeableConcept()
                                 throws Exception
```
    Throws:
    
    Exception
  - getReasonReference
```
public Reference getReasonReference()
                             throws Exception
```
    Returns:
    
    reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
    
    Throws:
    
    Exception
  - hasReasonReference
```
public boolean hasReasonReference()
                           throws Exception
```
    Throws:
    
    Exception
  - hasReason
```
public boolean hasReason()
```
  - setReason
```
public ProcedureRequest setReason(Type value)
```
    Parameters:
    
    value - reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
  - getScheduled
```
public Type getScheduled()
```
    Returns:
    
    scheduled (The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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".)
  - getScheduledDateTimeType
```
public DateTimeType getScheduledDateTimeType()
                                      throws Exception
```
    Returns:
    
    scheduled (The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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:
    
    Exception
  - hasScheduledDateTimeType
```
public boolean hasScheduledDateTimeType()
                                 throws Exception
```
    Throws:
    
    Exception
  - getScheduledPeriod
```
public Period getScheduledPeriod()
                          throws Exception
```
    Returns:
    
    scheduled (The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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:
    
    Exception
  - hasScheduledPeriod
```
public boolean hasScheduledPeriod()
                           throws Exception
```
    Throws:
    
    Exception
  - getScheduledTiming
```
public Timing getScheduledTiming()
                          throws Exception
```
    Returns:
    
    scheduled (The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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:
    
    Exception
  - hasScheduledTiming
```
public boolean hasScheduledTiming()
                           throws Exception
```
    Throws:
    
    Exception
  - hasScheduled
```
public boolean hasScheduled()
```
  - setScheduled
```
public ProcedureRequest setScheduled(Type value)
```
    Parameters:
    
    value - scheduled (The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. "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".)
  - getEncounter
```
public Reference getEncounter()
```
    Returns:
    
    encounter (The encounter within which the procedure proposal or request was created.)
  - hasEncounter
```
public boolean hasEncounter()
```
  - setEncounter
```
public ProcedureRequest setEncounter(Reference value)
```
    Parameters:
    
    value - encounter (The encounter within which the procedure proposal or request was created.)
  - getEncounterTarget
```
public Encounter getEncounterTarget()
```
    Returns:
    
    encounter The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter within which the procedure proposal or request was created.)
  - setEncounterTarget
```
public ProcedureRequest setEncounterTarget(Encounter value)
```
    Parameters:
    
    value - encounter The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter within which the procedure proposal or request was created.)
  - getPerformer
```
public Reference getPerformer()
```
    Returns:
    
    performer (For example, the surgeon, anaethetist, endoscopist, etc.)
  - hasPerformer
```
public boolean hasPerformer()
```
  - setPerformer
```
public ProcedureRequest setPerformer(Reference value)
```
    Parameters:
    
    value - performer (For example, the surgeon, anaethetist, 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. (For example, the surgeon, anaethetist, 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. (For example, the surgeon, anaethetist, endoscopist, etc.)
  - 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.
  - getNotes
```
public List<Annotation> getNotes()
```
    Returns:
    
    notes (Any other notes associated with this proposal or order - e.g. provider instructions.)
  - hasNotes
```
public boolean hasNotes()
```
  - addNotes
```
public Annotation addNotes()
```
    Returns:
    
    notes (Any other notes associated with this proposal or order - e.g. provider instructions.)
  - addNotes
```
public ProcedureRequest addNotes(Annotation t)
```
  - getAsNeeded
```
public Type getAsNeeded()
```
    Returns:
    
    asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
  - getAsNeededBooleanType
```
public BooleanType getAsNeededBooleanType()
                                   throws Exception
```
    Returns:
    
    asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
    
    Throws:
    
    Exception
  - hasAsNeededBooleanType
```
public boolean hasAsNeededBooleanType()
                               throws Exception
```
    Throws:
    
    Exception
  - getAsNeededCodeableConcept
```
public CodeableConcept getAsNeededCodeableConcept()
                                           throws Exception
```
    Returns:
    
    asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
    
    Throws:
    
    Exception
  - hasAsNeededCodeableConcept
```
public boolean hasAsNeededCodeableConcept()
                                   throws Exception
```
    Throws:
    
    Exception
  - hasAsNeeded
```
public boolean hasAsNeeded()
```
  - setAsNeeded
```
public ProcedureRequest setAsNeeded(Type value)
```
    Parameters:
    
    value - asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
  - getOrderedOnElement
```
public DateTimeType getOrderedOnElement()
```
    Returns:
    
    orderedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getOrderedOn" gives direct access to the value
  - hasOrderedOnElement
```
public boolean hasOrderedOnElement()
```
  - hasOrderedOn
```
public boolean hasOrderedOn()
```
  - setOrderedOnElement
```
public ProcedureRequest setOrderedOnElement(DateTimeType value)
```
    Parameters:
    
    value - orderedOn (The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getOrderedOn" gives direct access to the value
  - getOrderedOn
```
public Date getOrderedOn()
```
    Returns:
    
    The time when the request was made.
  - setOrderedOn
```
public ProcedureRequest setOrderedOn(Date value)
```
    Parameters:
    
    value - The time when the request was made.
  - getOrderer
```
public Reference getOrderer()
```
    Returns:
    
    orderer (The healthcare professional responsible for proposing or ordering the procedure.)
  - hasOrderer
```
public boolean hasOrderer()
```
  - setOrderer
```
public ProcedureRequest setOrderer(Reference value)
```
    Parameters:
    
    value - orderer (The healthcare professional responsible for proposing or ordering the procedure.)
  - getOrdererTarget
```
public Resource getOrdererTarget()
```
    Returns:
    
    orderer 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 healthcare professional responsible for proposing or ordering the procedure.)
  - setOrdererTarget
```
public ProcedureRequest setOrdererTarget(Resource value)
```
    Parameters:
    
    value - orderer 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 healthcare professional responsible for proposing or ordering the procedure.)
  - getPriorityElement
```
public Enumeration<ProcedureRequest.ProcedureRequestPriority> getPriorityElement()
```
    Returns:
    
    priority (The clinical priority associated with this order.). 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 (The clinical priority associated with this order.). 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:
    
    The clinical priority associated with this order.
  - setPriority
```
public ProcedureRequest setPriority(ProcedureRequest.ProcedureRequestPriority value)
```
    Parameters:
    
    value - The clinical priority associated with this order.
  - copy
```
public ProcedureRequest copy()
```
    Specified by:
    
    copy in class DomainResource
  - 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 IBase
    
    Overrides:
    
    isEmpty in class DomainResource
  - getResourceType
```
public ResourceType getResourceType()
```
    Specified by:
    
    getResourceType in class Resource

Class ProcedureRequest

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

Field Detail

SP_IDENTIFIER

SP_PERFORMER

SP_SUBJECT

SP_PATIENT

SP_ORDERER

SP_ENCOUNTER

Constructor Detail

ProcedureRequest

ProcedureRequest

Method Detail

getIdentifier

hasIdentifier

addIdentifier

addIdentifier

getSubject

hasSubject

setSubject

getSubjectTarget

setSubjectTarget

getCode

hasCode

setCode

getBodySite

hasBodySite

addBodySite

addBodySite

getReason

getReasonCodeableConcept

hasReasonCodeableConcept

getReasonReference

hasReasonReference

hasReason

setReason

getScheduled

getScheduledDateTimeType

hasScheduledDateTimeType

getScheduledPeriod

hasScheduledPeriod

getScheduledTiming

hasScheduledTiming

hasScheduled

setScheduled

getEncounter

hasEncounter

setEncounter

getEncounterTarget

setEncounterTarget

getPerformer

hasPerformer

setPerformer

getPerformerTarget

setPerformerTarget

getStatusElement

hasStatusElement

hasStatus

setStatusElement

getStatus

setStatus

getNotes

hasNotes

addNotes

addNotes

getAsNeeded

getAsNeededBooleanType

hasAsNeededBooleanType

getAsNeededCodeableConcept

hasAsNeededCodeableConcept