ProcedureRequest (HAPI FHIR Structures - DSTU2.1 (2016May) 3.3.0 API)

java.lang.Object
- org.hl7.fhir.dstu2016may.model.Base
- - org.hl7.fhir.dstu2016may.model.BaseResource
  - - org.hl7.fhir.dstu2016may.model.Resource
    - - org.hl7.fhir.dstu2016may.model.DomainResource
      - org.hl7.fhir.dstu2016may.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 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
`protected Type`	`asNeeded` If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.
`protected List<CodeableConcept>`	`bodySite` Indicates the sites on the subject's body where the procedure should be performed (I.e.
`protected CodeableConcept`	`code` The specific procedure that is ordered.
`protected Reference`	`encounter` The encounter within which the procedure proposal or request was created.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ENCOUNTER` Fluent Client search parameter constant for encounter
`protected Encounter`	`encounterTarget` The actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.)
`protected List<Identifier>`	`identifier` Identifiers assigned to this order by the order or by the receiver.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`IDENTIFIER` Fluent Client search parameter constant for identifier
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ENCOUNTER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_ORDERER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_PERFORMER` Constant for fluent queries to be used to add include statements.
`static ca.uhn.fhir.model.api.Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`protected List<Annotation>`	`notes` Any other notes associated with this proposal or order - e.g.
`protected DateTimeType`	`orderedOn` The time when the request was made.
`protected Reference`	`orderer` The healthcare professional responsible for proposing or ordering the procedure.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`ORDERER` Fluent Client search parameter constant for orderer
`protected Resource`	`ordererTarget` The actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.)
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PATIENT` Fluent Client search parameter constant for patient
`protected Reference`	`performer` For example, the surgeon, anaethetist, endoscopist, etc.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`PERFORMER` Fluent Client search parameter constant for performer
`protected Resource`	`performerTarget` The actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.)
`protected Enumeration<ProcedureRequest.ProcedureRequestPriority>`	`priority` The clinical priority associated with this order.
`protected Type`	`reason` The reason why the procedure is being proposed or ordered.
`protected Type`	`scheduled` The timing schedule for the proposed or ordered procedure.
`static String`	`SP_ENCOUNTER` Search parameter: encounter
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_ORDERER` Search parameter: orderer
`static String`	`SP_PATIENT` Search parameter: patient
`static String`	`SP_PERFORMER` Search parameter: performer
`static String`	`SP_SUBJECT` Search parameter: subject
`protected Enumeration<ProcedureRequest.ProcedureRequestStatus>`	`status` The status of the order.
`protected Reference`	`subject` The person, animal or group that should receive the procedure.
`static ca.uhn.fhir.rest.gclient.ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`protected Resource`	`subjectTarget` The actual object that is the target of the reference (The person, animal or group that should receive the procedure.)

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource
id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID, SP_RES_LANGUAGE

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

Constructor Summary

Constructors
Constructor and Description

ProcedureRequest()
Constructor

ProcedureRequest(Reference subject, CodeableConcept code)
Constructor

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodeableConcept`	`addBodySite()`
`ProcedureRequest`	`addBodySite(CodeableConcept t)`
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`ProcedureRequest`	`addIdentifier(Identifier t)`
`Annotation`	`addNotes()`
`ProcedureRequest`	`addNotes(Annotation t)`
`ProcedureRequest`	`copy()`
`boolean`	`equalsDeep(Base other)`
`boolean`	`equalsShallow(Base other)`
`String`	`fhirType()`
`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()`
`Base[]`	`getProperty(int hash, String name, boolean checkValid)`
`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()`
`protected void`	`listChildren(List<Property> childrenList)`
`Base`	`makeProperty(int hash, String name)`
`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)`
`void`	`setProperty(int hash, String name, Base value)`
`void`	`setProperty(String name, Base 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)`
`protected ProcedureRequest`	`typedCopy()`

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

Methods inherited from class org.hl7.fhir.dstu2016may.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.dstu2016may.model.BaseResource
getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base
castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, 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.IBaseResource
getMeta, getStructureFhirVersionEnum, setId

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

- Field Detail
  - identifier
```
protected List<Identifier> identifier
```
    Identifiers assigned to this order by the order or by the receiver.
  - subject
```
protected Reference subject
```
    The person, animal or group that should receive the procedure.
  - subjectTarget
```
protected Resource subjectTarget
```
    The actual object that is the target of the reference (The person, animal or group that should receive the procedure.)
  - code
```
protected CodeableConcept code
```
    The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.
  - bodySite
```
protected List<CodeableConcept> bodySite
```
    Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).
  - reason
```
protected Type reason
```
    The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.
  - scheduled
```
protected Type 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".
  - encounter
```
protected Reference encounter
```
    The encounter within which the procedure proposal or request was created.
  - encounterTarget
```
protected Encounter encounterTarget
```
    The actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.)
  - performer
```
protected Reference performer
```
    For example, the surgeon, anaethetist, endoscopist, etc.
  - performerTarget
```
protected Resource performerTarget
```
    The actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.)
  - status
```
protected Enumeration<ProcedureRequest.ProcedureRequestStatus> status
```
    The status of the order.
  - notes
```
protected List<Annotation> notes
```
    Any other notes associated with this proposal or order - e.g. provider instructions.
  - asNeeded
```
protected Type asNeeded
```
    If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.
  - orderedOn
```
protected DateTimeType orderedOn
```
    The time when the request was made.
  - orderer
```
protected Reference orderer
```
    The healthcare professional responsible for proposing or ordering the procedure.
  - ordererTarget
```
protected Resource ordererTarget
```
    The actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.)
  - priority
```
protected Enumeration<ProcedureRequest.ProcedureRequestPriority> priority
```
    The clinical priority associated with this order.
  - SP_ORDERER
```
public static final String SP_ORDERER
```
    Search parameter: orderer
    Description: Who made request
    Type: reference
    Path: ProcedureRequest.orderer
    
    See Also:
    
    Constant Field Values
  - ORDERER
```
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ORDERER
```
    Fluent Client search parameter constant for orderer
    Description: Who made request
    Type: reference
    Path: ProcedureRequest.orderer
  - INCLUDE_ORDERER
```
public static final ca.uhn.fhir.model.api.Include INCLUDE_ORDERER
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcedureRequest:orderer".
  - 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_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_PERFORMER
```
public static final String SP_PERFORMER
```
    Search parameter: performer
    Description: Who should perform the procedure
    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: Who should perform the procedure
    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_ENCOUNTER
```
public static final String SP_ENCOUNTER
```
    Search parameter: encounter
    Description: Encounter request created during
    Type: reference
    Path: ProcedureRequest.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: Encounter request created during
    Type: reference
    Path: ProcedureRequest.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 "ProcedureRequest:encounter".
  - SP_IDENTIFIER
```
public static final String SP_IDENTIFIER
```
    Search parameter: identifier
    Description: A unique identifier of the Procedure Request
    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: A unique identifier of the Procedure Request
    Type: token
    Path: ProcedureRequest.identifier
- Constructor Detail
  - ProcedureRequest
```
public ProcedureRequest()
```
    Constructor
  - ProcedureRequest
```
public ProcedureRequest(Reference subject,
                        CodeableConcept code)
```
    Constructor
- 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 org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonCodeableConcept
```
public boolean hasReasonCodeableConcept()
```
  - getReasonReference
```
public Reference getReasonReference()
                             throws org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    reason (The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasReasonReference
```
public boolean hasReasonReference()
```
  - 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 org.hl7.fhir.exceptions.FHIRException
```
    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:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasScheduledDateTimeType
```
public boolean hasScheduledDateTimeType()
```
  - getScheduledPeriod
```
public Period getScheduledPeriod()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    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:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasScheduledPeriod
```
public boolean hasScheduledPeriod()
```
  - getScheduledTiming
```
public Timing getScheduledTiming()
                          throws org.hl7.fhir.exceptions.FHIRException
```
    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:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasScheduledTiming
```
public boolean hasScheduledTiming()
```
  - 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 org.hl7.fhir.exceptions.FHIRException
```
    Returns:
    
    asNeeded (If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
    
    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.)
    
    Throws:
    
    org.hl7.fhir.exceptions.FHIRException
  - hasAsNeededCodeableConcept
```
public boolean hasAsNeededCodeableConcept()
```
  - 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.
  - listChildren
```
protected void listChildren(List<Property> childrenList)
```
    Overrides:
    
    listChildren in class DomainResource
  - 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 void 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 void 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
  - 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()
```
    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

Class ProcedureRequest

Nested Class Summary

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class org.hl7.fhir.dstu2016may.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

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

Field Detail

identifier

subject

subjectTarget

code

bodySite

reason

scheduled

encounter

encounterTarget

performer

performerTarget

status

notes

asNeeded

orderedOn

orderer

ordererTarget

priority

SP_ORDERER

ORDERER

INCLUDE_ORDERER

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_PERFORMER

PERFORMER

INCLUDE_PERFORMER

SP_ENCOUNTER

ENCOUNTER

INCLUDE_ENCOUNTER

SP_IDENTIFIER

IDENTIFIER

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