Package org.hl7.fhir.dstu2.model
Class ProcedureRequest
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.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
A request for a procedure to be performed. May be a proposal or an order.
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected Type
If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.protected List
<CodeableConcept> Indicates the sites on the subject's body where the procedure should be performed (I.e.protected CodeableConcept
The specific procedure that is ordered.protected Reference
The encounter within which the procedure proposal or request was created.protected Encounter
The actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.)protected List
<Identifier> Identifiers assigned to this order by the order or by the receiver.protected List
<Annotation> Any other notes associated with this proposal or order - e.g.protected DateTimeType
The time when the request was made.protected Reference
The healthcare professional responsible for proposing or ordering the procedure.protected Resource
The actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.)protected Reference
For example, the surgeon, anaethetist, endoscopist, etc.protected Resource
The actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.)The clinical priority associated with this order.protected Type
The reason why the procedure is being proposed or ordered.protected Type
The timing schedule for the proposed or ordered procedure.static final String
static final String
static final String
static final String
static final String
static final String
The status of the order.protected Reference
The person, animal or group that should receive the procedure.protected Resource
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.dstu2.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddNotes()
copy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getCode()
getNotes()
boolean
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
hasNotes()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setAsNeeded
(Type value) setCode
(CodeableConcept value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setOrderedOn
(Date value) setOrderedOnElement
(DateTimeType value) setOrderer
(Reference value) setOrdererTarget
(Resource value) setPerformer
(Reference value) setPerformerTarget
(Resource value) void
setProperty
(String name, Base value) setScheduled
(Type value) setSubject
(Reference value) setSubjectTarget
(Resource value) protected ProcedureRequest
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINN
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifiers assigned to this order by the order or by the receiver. -
subject
The person, animal or group that should receive the procedure. -
subjectTarget
The actual object that is the target of the reference (The person, animal or group that should receive the procedure.) -
code
The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded. -
bodySite
Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites). -
reason
The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance. -
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
The encounter within which the procedure proposal or request was created. -
encounterTarget
The actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.) -
performer
For example, the surgeon, anaethetist, endoscopist, etc. -
performerTarget
The actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.) -
status
The status of the order. -
notes
Any other notes associated with this proposal or order - e.g. provider instructions. -
asNeeded
If a CodeableConcept is present, it indicates the pre-condition for performing the procedure. -
orderedOn
The time when the request was made. -
orderer
The healthcare professional responsible for proposing or ordering the procedure. -
ordererTarget
The actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.) -
priority
The clinical priority associated with this order. -
SP_IDENTIFIER
- See Also:
-
SP_PERFORMER
- See Also:
-
SP_SUBJECT
- See Also:
-
SP_PATIENT
- See Also:
-
SP_ORDERER
- See Also:
-
SP_ENCOUNTER
- See Also:
-
-
Constructor Details
-
ProcedureRequest
public ProcedureRequest() -
ProcedureRequest
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifiers assigned to this order by the order or by the receiver.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier
(Identifiers assigned to this order by the order or by the receiver.)
-
addIdentifier
-
getSubject
- Returns:
subject
(The person, animal or group that should receive the procedure.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The person, animal or group that should receive the procedure.)
-
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
- 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
- Returns:
code
(The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.)
-
hasCode
-
setCode
- Parameters:
value
-code
(The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.)
-
getBodySite
- Returns:
bodySite
(Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
-
hasBodySite
-
addBodySite
- Returns:
bodySite
(Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).)
-
addBodySite
-
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
- 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
-
getReasonReference
- 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
-
hasReason
-
setReason
- 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
- 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
- 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
-
getScheduledPeriod
- 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
-
getScheduledTiming
- 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
-
hasScheduled
-
setScheduled
- 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
- Returns:
encounter
(The encounter within which the procedure proposal or request was created.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The encounter within which the procedure proposal or request was created.)
-
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
- 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
- Returns:
performer
(For example, the surgeon, anaethetist, endoscopist, etc.)
-
hasPerformer
-
setPerformer
- Parameters:
value
-performer
(For example, the surgeon, anaethetist, endoscopist, etc.)
-
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
- 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
- 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
-
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
- Returns:
- The status of the order.
-
setStatus
- Parameters:
value
- The status of the order.
-
getNotes
- Returns:
notes
(Any other notes associated with this proposal or order - e.g. provider instructions.)
-
hasNotes
-
addNotes
- Returns:
notes
(Any other notes associated with this proposal or order - e.g. provider instructions.)
-
addNotes
-
getAsNeeded
- Returns:
asNeeded
(If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
-
getAsNeededBooleanType
- Returns:
asNeeded
(If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededBooleanType
-
getAsNeededCodeableConcept
- Returns:
asNeeded
(If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededCodeableConcept
-
hasAsNeeded
-
setAsNeeded
- Parameters:
value
-asNeeded
(If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.)
-
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
-
hasOrderedOn
-
setOrderedOnElement
- 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
- Returns:
- The time when the request was made.
-
setOrderedOn
- Parameters:
value
- The time when the request was made.
-
getOrderer
- Returns:
orderer
(The healthcare professional responsible for proposing or ordering the procedure.)
-
hasOrderer
-
setOrderer
- Parameters:
value
-orderer
(The healthcare professional responsible for proposing or ordering the procedure.)
-
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
- 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
- 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
-
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
- Returns:
- The clinical priority associated with this order.
-
setPriority
- Parameters:
value
- The clinical priority associated with this order.
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-