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
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 Description static classProcedureRequest.ProcedureRequestPrioritystatic classProcedureRequest.ProcedureRequestPriorityEnumFactorystatic classProcedureRequest.ProcedureRequestStatusstatic classProcedureRequest.ProcedureRequestStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected TypeasNeededIf a CodeableConcept is present, it indicates the pre-condition for performing the procedure.protected List<CodeableConcept>bodySiteIndicates the sites on the subject's body where the procedure should be performed (I.e.protected CodeableConceptcodeThe specific procedure that is ordered.protected ReferenceencounterThe encounter within which the procedure proposal or request was created.protected EncounterencounterTargetThe actual object that is the target of the reference (The encounter within which the procedure proposal or request was created.)protected List<Identifier>identifierIdentifiers assigned to this order by the order or by the receiver.protected List<Annotation>notesAny other notes associated with this proposal or order - e.g.protected DateTimeTypeorderedOnThe time when the request was made.protected ReferenceordererThe healthcare professional responsible for proposing or ordering the procedure.protected ResourceordererTargetThe actual object that is the target of the reference (The healthcare professional responsible for proposing or ordering the procedure.)protected ReferenceperformerFor example, the surgeon, anaethetist, endoscopist, etc.protected ResourceperformerTargetThe actual object that is the target of the reference (For example, the surgeon, anaethetist, endoscopist, etc.)protected Enumeration<ProcedureRequest.ProcedureRequestPriority>priorityThe clinical priority associated with this order.protected TypereasonThe reason why the procedure is being proposed or ordered.protected TypescheduledThe timing schedule for the proposed or ordered procedure.static StringSP_ENCOUNTERstatic StringSP_IDENTIFIERstatic StringSP_ORDERERstatic StringSP_PATIENTstatic StringSP_PERFORMERstatic StringSP_SUBJECTprotected Enumeration<ProcedureRequest.ProcedureRequestStatus>statusThe status of the order.protected ReferencesubjectThe person, animal or group that should receive the procedure.protected ResourcesubjectTargetThe 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
-
-
Constructor Summary
Constructors Constructor Description ProcedureRequest()ProcedureRequest(Reference subject, CodeableConcept code)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers assigned to this order by the order or by the receiver.
-
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.)
-
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_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:
subjectThe 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-subjectThe 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:
encounterThe 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-encounterThe 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:
performerThe 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-performerThe 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:
ordererThe 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-ordererThe 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:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public ProcedureRequest copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected ProcedureRequest typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-