Class ServiceRequest
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.ServiceRequest
-
- 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 ServiceRequest extends DomainResource
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classServiceRequest.ServiceRequestIntentstatic classServiceRequest.ServiceRequestIntentEnumFactorystatic classServiceRequest.ServiceRequestPrioritystatic classServiceRequest.ServiceRequestPriorityEnumFactorystatic classServiceRequest.ServiceRequestStatusstatic classServiceRequest.ServiceRequestStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected TypeasNeededIf a CodeableConcept is present, it indicates the pre-condition for performing the service.static ca.uhn.fhir.rest.gclient.DateClientParamAUTHOREDFluent Client search parameter constant for authoredprotected DateTimeTypeauthoredOnWhen the request transitioned to being actionable.static ca.uhn.fhir.rest.gclient.ReferenceClientParamBASED_ONFluent Client search parameter constant for based-onprotected List<Reference>basedOnPlan/proposal/order fulfilled by this request.protected List<Resource>basedOnTargetThe actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)static ca.uhn.fhir.rest.gclient.TokenClientParamBODY_SITEFluent Client search parameter constant for body-siteprotected List<CodeableConcept>bodySiteAnatomic location where the procedure should be performed.protected List<CodeableConcept>categoryA code that classifies the service for searching, sorting and display purposes (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected CodeableConceptcodeA code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected BooleanTypedoNotPerformSet this to true if the record is saying that the service/procedure should NOT be performed.protected ReferenceencounterAn encounter that provides additional information about the healthcare context in which this request is made.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected EncounterencounterTargetThe actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)protected List<Identifier>identifierIdentifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_BASED_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INSTANTIATES_CANONICALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REPLACESConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REQUESTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SPECIMENConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINSTANTIATES_CANONICALFluent Client search parameter constant for instantiates-canonicalstatic ca.uhn.fhir.rest.gclient.UriClientParamINSTANTIATES_URIFluent Client search parameter constant for instantiates-uriprotected List<CanonicalType>instantiatesCanonicalThe URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.protected List<UriType>instantiatesUriThe URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.protected List<Reference>insuranceInsurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.protected List<Resource>insuranceTargetThe actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.)protected Enumeration<ServiceRequest.ServiceRequestIntent>intentWhether the request is a proposal, plan, an original order or a reflex order.static ca.uhn.fhir.rest.gclient.TokenClientParamINTENTFluent Client search parameter constant for intentprotected List<CodeableConcept>locationCodeThe preferred location(s) where the procedure should actually happen in coded or free text form.protected List<Reference>locationReferenceA reference to the the preferred location(s) where the procedure should actually happen.protected List<Location>locationReferenceTargetThe actual objects that are the target of the reference (A reference to the the preferred location(s) where the procedure should actually happen.protected List<Annotation>noteAny other notes and comments made about the service request.protected TypeoccurrenceThe date/time at which the requested service should occur.static ca.uhn.fhir.rest.gclient.DateClientParamOCCURRENCEFluent Client search parameter constant for occurrenceprotected List<CodeableConcept>orderDetailAdditional details and instructions about the how the services are to be delivered.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected StringTypepatientInstructionInstructions in terms that are understood by the patient or consumer.protected List<Reference>performerThe desired performer for doing the requested service.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerstatic ca.uhn.fhir.rest.gclient.TokenClientParamPERFORMER_TYPEFluent Client search parameter constant for performer-typeprotected List<Resource>performerTargetThe actual objects that are the target of the reference (The desired performer for doing the requested service.protected CodeableConceptperformerTypeDesired type of performer for doing the requested service.protected Enumeration<ServiceRequest.ServiceRequestPriority>priorityIndicates how quickly the ServiceRequest should be addressed with respect to other requests.static ca.uhn.fhir.rest.gclient.TokenClientParamPRIORITYFluent Client search parameter constant for priorityprotected TypequantityAn amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).protected List<CodeableConcept>reasonCodeAn explanation or justification for why this service is being requested in coded or textual form.protected List<Reference>reasonReferenceIndicates another resource that provides a justification for why this service is being requested.protected List<Resource>reasonReferenceTargetThe actual objects that are the target of the reference (Indicates another resource that provides a justification for why this service is being requested.protected List<Reference>relevantHistoryKey events in the history of the request.protected List<Provenance>relevantHistoryTargetThe actual objects that are the target of the reference (Key events in the history of the request.)protected List<Reference>replacesThe request takes the place of the referenced completed or terminated request(s).static ca.uhn.fhir.rest.gclient.ReferenceClientParamREPLACESFluent Client search parameter constant for replacesprotected List<ServiceRequest>replacesTargetThe actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)protected ReferencerequesterThe individual who initiated the request and has responsibility for its activation.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREQUESTERFluent Client search parameter constant for requesterprotected ResourcerequesterTargetThe actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)protected IdentifierrequisitionA shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.static ca.uhn.fhir.rest.gclient.TokenClientParamREQUISITIONFluent Client search parameter constant for requisitionstatic StringSP_AUTHOREDSearch parameter: authoredstatic StringSP_BASED_ONSearch parameter: based-onstatic StringSP_BODY_SITESearch parameter: body-sitestatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CODESearch parameter: codestatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INSTANTIATES_CANONICALSearch parameter: instantiates-canonicalstatic StringSP_INSTANTIATES_URISearch parameter: instantiates-uristatic StringSP_INTENTSearch parameter: intentstatic StringSP_OCCURRENCESearch parameter: occurrencestatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_PERFORMER_TYPESearch parameter: performer-typestatic StringSP_PRIORITYSearch parameter: prioritystatic StringSP_REPLACESSearch parameter: replacesstatic StringSP_REQUESTERSearch parameter: requesterstatic StringSP_REQUISITIONSearch parameter: requisitionstatic StringSP_SPECIMENSearch parameter: specimenstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected List<Reference>specimenOne or more specimens that the laboratory procedure will use.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSPECIMENFluent Client search parameter constant for specimenprotected List<Specimen>specimenTargetThe actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)protected Enumeration<ServiceRequest.ServiceRequestStatus>statusThe status of the order.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectOn whom or what the service is to be performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (On whom or what the service is to be performed.protected List<Reference>supportingInfoAdditional clinical information about the patient or specimen that may influence the services or their interpretations.protected List<Resource>supportingInfoTargetThe actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the services or their interpretations.-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ServiceRequest()ConstructorServiceRequest(Enumeration<ServiceRequest.ServiceRequestStatus> status, Enumeration<ServiceRequest.ServiceRequestIntent> intent, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
-
instantiatesCanonical
protected List<CanonicalType> instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
-
instantiatesUri
protected List<UriType> instantiatesUri
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.
-
basedOnTarget
protected List<Resource> basedOnTarget
The actual objects that are the target of the reference (Plan/proposal/order fulfilled by this request.)
-
replaces
protected List<Reference> replaces
The request takes the place of the referenced completed or terminated request(s).
-
replacesTarget
protected List<ServiceRequest> replacesTarget
The actual objects that are the target of the reference (The request takes the place of the referenced completed or terminated request(s).)
-
requisition
protected Identifier requisition
A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.
-
status
protected Enumeration<ServiceRequest.ServiceRequestStatus> status
The status of the order.
-
intent
protected Enumeration<ServiceRequest.ServiceRequestIntent> intent
Whether the request is a proposal, plan, an original order or a reflex order.
-
category
protected List<CodeableConcept> category
A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
-
priority
protected Enumeration<ServiceRequest.ServiceRequestPriority> priority
Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
-
doNotPerform
protected BooleanType doNotPerform
Set this to true if the record is saying that the service/procedure should NOT be performed.
-
code
protected CodeableConcept code
A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
-
orderDetail
protected List<CodeableConcept> orderDetail
Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
-
quantity
protected Type quantity
An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).
-
subject
protected Reference subject
On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
-
encounter
protected Reference encounter
An encounter that provides additional information about the healthcare context in which this request is made.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (An encounter that provides additional information about the healthcare context in which this request is made.)
-
occurrence
protected Type occurrence
The date/time at which the requested service should occur.
-
asNeeded
protected Type asNeeded
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
-
authoredOn
protected DateTimeType authoredOn
When the request transitioned to being actionable.
-
requester
protected Reference requester
The individual who initiated the request and has responsibility for its activation.
-
requesterTarget
protected Resource requesterTarget
The actual object that is the target of the reference (The individual who initiated the request and has responsibility for its activation.)
-
performerType
protected CodeableConcept performerType
Desired type of performer for doing the requested service.
-
performer
protected List<Reference> performer
The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
-
performerTarget
protected List<Resource> performerTarget
The actual objects that are the target of the reference (The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.)
-
locationCode
protected List<CodeableConcept> locationCode
The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.
-
locationReference
protected List<Reference> locationReference
A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
-
locationReferenceTarget
protected List<Location> locationReferenceTarget
The actual objects that are the target of the reference (A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.)
-
reasonCode
protected List<CodeableConcept> reasonCode
An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.
-
reasonReference
protected List<Reference> reasonReference
Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.)
-
insurance
protected List<Reference> insurance
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
-
insuranceTarget
protected List<Resource> insuranceTarget
The actual objects that are the target of the reference (Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.)
-
supportingInfo
protected List<Reference> supportingInfo
Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
-
supportingInfoTarget
protected List<Resource> supportingInfoTarget
The actual objects that are the target of the reference (Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)
-
specimen
protected List<Reference> specimen
One or more specimens that the laboratory procedure will use.
-
specimenTarget
protected List<Specimen> specimenTarget
The actual objects that are the target of the reference (One or more specimens that the laboratory procedure will use.)
-
bodySite
protected List<CodeableConcept> bodySite
Anatomic location where the procedure should be performed. This is the target site.
-
note
protected List<Annotation> note
Any other notes and comments made about the service request. For example, internal billing notes.
-
patientInstruction
protected StringType patientInstruction
Instructions in terms that are understood by the patient or consumer.
-
relevantHistory
protected List<Reference> relevantHistory
Key events in the history of the request.
-
relevantHistoryTarget
protected List<Provenance> relevantHistoryTarget
The actual objects that are the target of the reference (Key events in the history of the request.)
-
SP_AUTHORED
public static final String SP_AUTHORED
Search parameter: authoredDescription: Date request signed
Type: date
Path: ServiceRequest.authoredOn
- See Also:
- Constant Field Values
-
AUTHORED
public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHORED
Fluent Client search parameter constant for authoredDescription: Date request signed
Type: date
Path: ServiceRequest.authoredOn
-
SP_REQUESTER
public static final String SP_REQUESTER
Search parameter: requesterDescription: Who/what is requesting service
Type: reference
Path: ServiceRequest.requester
- See Also:
- Constant Field Values
-
REQUESTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
Fluent Client search parameter constant for requesterDescription: Who/what is requesting service
Type: reference
Path: ServiceRequest.requester
-
INCLUDE_REQUESTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:requester".
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Identifiers assigned to this order
Type: token
Path: ServiceRequest.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Identifiers assigned to this order
Type: token
Path: ServiceRequest.identifier
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: What is being requested/ordered
Type: token
Path: ServiceRequest.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: What is being requested/ordered
Type: token
Path: ServiceRequest.code
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: Requested performer
Type: reference
Path: ServiceRequest.performer
- See Also:
- Constant Field Values
-
PERFORMER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PERFORMER
Fluent Client search parameter constant for performerDescription: Requested performer
Type: reference
Path: ServiceRequest.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 "ServiceRequest:performer".
-
SP_REQUISITION
public static final String SP_REQUISITION
Search parameter: requisitionDescription: Composite Request ID
Type: token
Path: ServiceRequest.requisition
- See Also:
- Constant Field Values
-
REQUISITION
public static final ca.uhn.fhir.rest.gclient.TokenClientParam REQUISITION
Fluent Client search parameter constant for requisitionDescription: Composite Request ID
Type: token
Path: ServiceRequest.requisition
-
SP_REPLACES
public static final String SP_REPLACES
Search parameter: replacesDescription: What request replaces
Type: reference
Path: ServiceRequest.replaces
- See Also:
- Constant Field Values
-
REPLACES
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPLACES
Fluent Client search parameter constant for replacesDescription: What request replaces
Type: reference
Path: ServiceRequest.replaces
-
INCLUDE_REPLACES
public static final ca.uhn.fhir.model.api.Include INCLUDE_REPLACES
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:replaces".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: Search by subject
Type: reference
Path: ServiceRequest.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: Search by subject
Type: reference
Path: ServiceRequest.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 "ServiceRequest:subject".
-
SP_INSTANTIATES_CANONICAL
public static final String SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: ServiceRequest.instantiatesCanonical
- See Also:
- Constant Field Values
-
INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: ServiceRequest.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:instantiates-canonical".
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: An encounter in which this request is made
Type: reference
Path: ServiceRequest.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: An encounter in which this request is made
Type: reference
Path: ServiceRequest.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 "ServiceRequest:encounter".
-
SP_OCCURRENCE
public static final String SP_OCCURRENCE
Search parameter: occurrenceDescription: When service should occur
Type: date
Path: ServiceRequest.occurrence[x]
- See Also:
- Constant Field Values
-
OCCURRENCE
public static final ca.uhn.fhir.rest.gclient.DateClientParam OCCURRENCE
Fluent Client search parameter constant for occurrenceDescription: When service should occur
Type: date
Path: ServiceRequest.occurrence[x]
-
SP_PRIORITY
public static final String SP_PRIORITY
Search parameter: priorityDescription: routine | urgent | asap | stat
Type: token
Path: ServiceRequest.priority
- See Also:
- Constant Field Values
-
PRIORITY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY
Fluent Client search parameter constant for priorityDescription: routine | urgent | asap | stat
Type: token
Path: ServiceRequest.priority
-
SP_INTENT
public static final String SP_INTENT
Search parameter: intentDescription: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Type: token
Path: ServiceRequest.intent
- See Also:
- Constant Field Values
-
INTENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
Fluent Client search parameter constant for intentDescription: proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Type: token
Path: ServiceRequest.intent
-
SP_PERFORMER_TYPE
public static final String SP_PERFORMER_TYPE
Search parameter: performer-typeDescription: Performer role
Type: token
Path: ServiceRequest.performerType
- See Also:
- Constant Field Values
-
PERFORMER_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PERFORMER_TYPE
Fluent Client search parameter constant for performer-typeDescription: Performer role
Type: token
Path: ServiceRequest.performerType
-
SP_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: What request fulfills
Type: reference
Path: ServiceRequest.basedOn
- See Also:
- Constant Field Values
-
BASED_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
Fluent Client search parameter constant for based-onDescription: What request fulfills
Type: reference
Path: ServiceRequest.basedOn
-
INCLUDE_BASED_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:based-on".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Search by subject - a patient
Type: reference
Path: ServiceRequest.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Search by subject - a patient
Type: reference
Path: ServiceRequest.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 "ServiceRequest:patient".
-
SP_SPECIMEN
public static final String SP_SPECIMEN
Search parameter: specimenDescription: Specimen to be tested
Type: reference
Path: ServiceRequest.specimen
- See Also:
- Constant Field Values
-
SPECIMEN
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SPECIMEN
Fluent Client search parameter constant for specimenDescription: Specimen to be tested
Type: reference
Path: ServiceRequest.specimen
-
INCLUDE_SPECIMEN
public static final ca.uhn.fhir.model.api.Include INCLUDE_SPECIMEN
Constant for fluent queries to be used to add include statements. Specifies the path value of "ServiceRequest:specimen".
-
SP_INSTANTIATES_URI
public static final String SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: ServiceRequest.instantiatesUri
- See Also:
- Constant Field Values
-
INSTANTIATES_URI
public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: ServiceRequest.instantiatesUri
-
SP_BODY_SITE
public static final String SP_BODY_SITE
Search parameter: body-siteDescription: Where procedure is going to be done
Type: token
Path: ServiceRequest.bodySite
- See Also:
- Constant Field Values
-
BODY_SITE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam BODY_SITE
Fluent Client search parameter constant for body-siteDescription: Where procedure is going to be done
Type: token
Path: ServiceRequest.bodySite
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Classification of service
Type: token
Path: ServiceRequest.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Classification of service
Type: token
Path: ServiceRequest.category
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: ServiceRequest.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: ServiceRequest.status
-
-
Constructor Detail
-
ServiceRequest
public ServiceRequest()
Constructor
-
ServiceRequest
public ServiceRequest(Enumeration<ServiceRequest.ServiceRequestStatus> status, Enumeration<ServiceRequest.ServiceRequestIntent> intent, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.)
-
setIdentifier
public ServiceRequest setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ServiceRequest addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getInstantiatesCanonical
public List<CanonicalType> getInstantiatesCanonical()
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
setInstantiatesCanonical
public ServiceRequest setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesCanonical
public boolean hasInstantiatesCanonical()
-
addInstantiatesCanonicalElement
public CanonicalType addInstantiatesCanonicalElement()
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
addInstantiatesCanonical
public ServiceRequest addInstantiatesCanonical(String value)
- Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
hasInstantiatesCanonical
public boolean hasInstantiatesCanonical(String value)
- Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
getInstantiatesUri
public List<UriType> getInstantiatesUri()
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
setInstantiatesUri
public ServiceRequest setInstantiatesUri(List<UriType> theInstantiatesUri)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesUri
public boolean hasInstantiatesUri()
-
addInstantiatesUriElement
public UriType addInstantiatesUriElement()
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
addInstantiatesUri
public ServiceRequest addInstantiatesUri(String value)
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
hasInstantiatesUri
public boolean hasInstantiatesUri(String value)
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest.)
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(Plan/proposal/order fulfilled by this request.)
-
setBasedOn
public ServiceRequest setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public ServiceRequest addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<Resource> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReplaces
public List<Reference> getReplaces()
- Returns:
replaces(The request takes the place of the referenced completed or terminated request(s).)
-
setReplaces
public ServiceRequest setReplaces(List<Reference> theReplaces)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReplaces
public boolean hasReplaces()
-
addReplaces
public Reference addReplaces()
-
addReplaces
public ServiceRequest addReplaces(Reference t)
-
getReplacesFirstRep
public Reference getReplacesFirstRep()
- Returns:
- The first repetition of repeating field
replaces, creating it if it does not already exist
-
getReplacesTarget
@Deprecated public List<ServiceRequest> getReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addReplacesTarget
@Deprecated public ServiceRequest addReplacesTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getRequisition
public Identifier getRequisition()
- Returns:
requisition(A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.)
-
hasRequisition
public boolean hasRequisition()
-
setRequisition
public ServiceRequest setRequisition(Identifier value)
- Parameters:
value-requisition(A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.)
-
getStatusElement
public Enumeration<ServiceRequest.ServiceRequestStatus> 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 ServiceRequest setStatusElement(Enumeration<ServiceRequest.ServiceRequestStatus> 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 ServiceRequest.ServiceRequestStatus getStatus()
- Returns:
- The status of the order.
-
setStatus
public ServiceRequest setStatus(ServiceRequest.ServiceRequestStatus value)
- Parameters:
value- The status of the order.
-
getIntentElement
public Enumeration<ServiceRequest.ServiceRequestIntent> getIntentElement()
- Returns:
intent(Whether the request is a proposal, plan, an original order or a reflex order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
public boolean hasIntentElement()
-
hasIntent
public boolean hasIntent()
-
setIntentElement
public ServiceRequest setIntentElement(Enumeration<ServiceRequest.ServiceRequestIntent> value)
- Parameters:
value-intent(Whether the request is a proposal, plan, an original order or a reflex order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
public ServiceRequest.ServiceRequestIntent getIntent()
- Returns:
- Whether the request is a proposal, plan, an original order or a reflex order.
-
setIntent
public ServiceRequest setIntent(ServiceRequest.ServiceRequestIntent value)
- Parameters:
value- Whether the request is a proposal, plan, an original order or a reflex order.
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").)
-
setCategory
public ServiceRequest setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public ServiceRequest addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist
-
getPriorityElement
public Enumeration<ServiceRequest.ServiceRequestPriority> getPriorityElement()
- Returns:
priority(Indicates how quickly the ServiceRequest should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public ServiceRequest setPriorityElement(Enumeration<ServiceRequest.ServiceRequestPriority> value)
- Parameters:
value-priority(Indicates how quickly the ServiceRequest should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
public ServiceRequest.ServiceRequestPriority getPriority()
- Returns:
- Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
-
setPriority
public ServiceRequest setPriority(ServiceRequest.ServiceRequestPriority value)
- Parameters:
value- Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
-
getDoNotPerformElement
public BooleanType getDoNotPerformElement()
- Returns:
doNotPerform(Set this to true if the record is saying that the service/procedure should NOT be performed.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value
-
hasDoNotPerformElement
public boolean hasDoNotPerformElement()
-
hasDoNotPerform
public boolean hasDoNotPerform()
-
setDoNotPerformElement
public ServiceRequest setDoNotPerformElement(BooleanType value)
- Parameters:
value-doNotPerform(Set this to true if the record is saying that the service/procedure should NOT be performed.). This is the underlying object with id, value and extensions. The accessor "getDoNotPerform" gives direct access to the value
-
getDoNotPerform
public boolean getDoNotPerform()
- Returns:
- Set this to true if the record is saying that the service/procedure should NOT be performed.
-
setDoNotPerform
public ServiceRequest setDoNotPerform(boolean value)
- Parameters:
value- Set this to true if the record is saying that the service/procedure should NOT be performed.
-
getCode
public CodeableConcept getCode()
- Returns:
code(A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.)
-
hasCode
public boolean hasCode()
-
setCode
public ServiceRequest setCode(CodeableConcept value)
- Parameters:
value-code(A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.)
-
getOrderDetail
public List<CodeableConcept> getOrderDetail()
- Returns:
orderDetail(Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.)
-
setOrderDetail
public ServiceRequest setOrderDetail(List<CodeableConcept> theOrderDetail)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasOrderDetail
public boolean hasOrderDetail()
-
addOrderDetail
public CodeableConcept addOrderDetail()
-
addOrderDetail
public ServiceRequest addOrderDetail(CodeableConcept t)
-
getOrderDetailFirstRep
public CodeableConcept getOrderDetailFirstRep()
- Returns:
- The first repetition of repeating field
orderDetail, creating it if it does not already exist
-
getQuantity
public Type getQuantity()
- Returns:
quantity(An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).)
-
getQuantityQuantity
public Quantity getQuantityQuantity() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
quantity(An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasQuantityQuantity
public boolean hasQuantityQuantity()
-
getQuantityRatio
public Ratio getQuantityRatio() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
quantity(An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasQuantityRatio
public boolean hasQuantityRatio()
-
getQuantityRange
public Range getQuantityRange() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
quantity(An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasQuantityRange
public boolean hasQuantityRange()
-
hasQuantity
public boolean hasQuantity()
-
setQuantity
public ServiceRequest setQuantity(Type value)
- Parameters:
value-quantity(An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction).)
-
getSubject
public Reference getSubject()
- Returns:
subject(On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
-
hasSubject
public boolean hasSubject()
-
setSubject
public ServiceRequest setSubject(Reference value)
- Parameters:
value-subject(On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
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. (On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
-
setSubjectTarget
public ServiceRequest 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. (On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public ServiceRequest setEncounter(Reference value)
- Parameters:
value-encounter(An encounter that provides additional information about the healthcare context in which this request is made.)
-
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. (An encounter that provides additional information about the healthcare context in which this request is made.)
-
setEncounterTarget
public ServiceRequest 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. (An encounter that provides additional information about the healthcare context in which this request is made.)
-
getOccurrence
public Type getOccurrence()
- Returns:
occurrence(The date/time at which the requested service should occur.)
-
getOccurrenceDateTimeType
public DateTimeType getOccurrenceDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date/time at which the requested service should occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
public boolean hasOccurrenceDateTimeType()
-
getOccurrencePeriod
public Period getOccurrencePeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date/time at which the requested service should occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrencePeriod
public boolean hasOccurrencePeriod()
-
getOccurrenceTiming
public Timing getOccurrenceTiming() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
occurrence(The date/time at which the requested service should occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceTiming
public boolean hasOccurrenceTiming()
-
hasOccurrence
public boolean hasOccurrence()
-
setOccurrence
public ServiceRequest setOccurrence(Type value)
- Parameters:
value-occurrence(The date/time at which the requested service should occur.)
-
getAsNeeded
public Type getAsNeeded()
- Returns:
asNeeded(If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.)
-
getAsNeededBooleanType
public BooleanType getAsNeededBooleanType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
asNeeded(If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededBooleanType
public boolean hasAsNeededBooleanType()
-
getAsNeededCodeableConcept
public CodeableConcept getAsNeededCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
asNeeded(If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAsNeededCodeableConcept
public boolean hasAsNeededCodeableConcept()
-
hasAsNeeded
public boolean hasAsNeeded()
-
setAsNeeded
public ServiceRequest setAsNeeded(Type value)
- Parameters:
value-asNeeded(If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.)
-
getAuthoredOnElement
public DateTimeType getAuthoredOnElement()
- Returns:
authoredOn(When the request transitioned to being actionable.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
hasAuthoredOnElement
public boolean hasAuthoredOnElement()
-
hasAuthoredOn
public boolean hasAuthoredOn()
-
setAuthoredOnElement
public ServiceRequest setAuthoredOnElement(DateTimeType value)
- Parameters:
value-authoredOn(When the request transitioned to being actionable.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
getAuthoredOn
public Date getAuthoredOn()
- Returns:
- When the request transitioned to being actionable.
-
setAuthoredOn
public ServiceRequest setAuthoredOn(Date value)
- Parameters:
value- When the request transitioned to being actionable.
-
getRequester
public Reference getRequester()
- Returns:
requester(The individual who initiated the request and has responsibility for its activation.)
-
hasRequester
public boolean hasRequester()
-
setRequester
public ServiceRequest setRequester(Reference value)
- Parameters:
value-requester(The individual who initiated the request and has responsibility for its activation.)
-
getRequesterTarget
public Resource getRequesterTarget()
- Returns:
requesterThe 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 individual who initiated the request and has responsibility for its activation.)
-
setRequesterTarget
public ServiceRequest setRequesterTarget(Resource value)
- Parameters:
value-requesterThe 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 individual who initiated the request and has responsibility for its activation.)
-
getPerformerType
public CodeableConcept getPerformerType()
- Returns:
performerType(Desired type of performer for doing the requested service.)
-
hasPerformerType
public boolean hasPerformerType()
-
setPerformerType
public ServiceRequest setPerformerType(CodeableConcept value)
- Parameters:
value-performerType(Desired type of performer for doing the requested service.)
-
getPerformer
public List<Reference> getPerformer()
- Returns:
performer(The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.)
-
setPerformer
public ServiceRequest setPerformer(List<Reference> thePerformer)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public Reference addPerformer()
-
addPerformer
public ServiceRequest addPerformer(Reference t)
-
getPerformerFirstRep
public Reference getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer, creating it if it does not already exist
-
getPerformerTarget
@Deprecated public List<Resource> getPerformerTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getLocationCode
public List<CodeableConcept> getLocationCode()
- Returns:
locationCode(The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center.)
-
setLocationCode
public ServiceRequest setLocationCode(List<CodeableConcept> theLocationCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLocationCode
public boolean hasLocationCode()
-
addLocationCode
public CodeableConcept addLocationCode()
-
addLocationCode
public ServiceRequest addLocationCode(CodeableConcept t)
-
getLocationCodeFirstRep
public CodeableConcept getLocationCodeFirstRep()
- Returns:
- The first repetition of repeating field
locationCode, creating it if it does not already exist
-
getLocationReference
public List<Reference> getLocationReference()
- Returns:
locationReference(A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.)
-
setLocationReference
public ServiceRequest setLocationReference(List<Reference> theLocationReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasLocationReference
public boolean hasLocationReference()
-
addLocationReference
public Reference addLocationReference()
-
addLocationReference
public ServiceRequest addLocationReference(Reference t)
-
getLocationReferenceFirstRep
public Reference getLocationReferenceFirstRep()
- Returns:
- The first repetition of repeating field
locationReference, creating it if it does not already exist
-
getLocationReferenceTarget
@Deprecated public List<Location> getLocationReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addLocationReferenceTarget
@Deprecated public Location addLocationReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode(An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`.)
-
setReasonCode
public ServiceRequest setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public ServiceRequest addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference(Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.)
-
setReasonReference
public ServiceRequest setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public ServiceRequest addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getInsurance
public List<Reference> getInsurance()
- Returns:
insurance(Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.)
-
setInsurance
public ServiceRequest setInsurance(List<Reference> theInsurance)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInsurance
public boolean hasInsurance()
-
addInsurance
public Reference addInsurance()
-
addInsurance
public ServiceRequest addInsurance(Reference t)
-
getInsuranceFirstRep
public Reference getInsuranceFirstRep()
- Returns:
- The first repetition of repeating field
insurance, creating it if it does not already exist
-
getInsuranceTarget
@Deprecated public List<Resource> getInsuranceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getSupportingInfo
public List<Reference> getSupportingInfo()
- Returns:
supportingInfo(Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.)
-
setSupportingInfo
public ServiceRequest setSupportingInfo(List<Reference> theSupportingInfo)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInfo
public boolean hasSupportingInfo()
-
addSupportingInfo
public Reference addSupportingInfo()
-
addSupportingInfo
public ServiceRequest addSupportingInfo(Reference t)
-
getSupportingInfoFirstRep
public Reference getSupportingInfoFirstRep()
- Returns:
- The first repetition of repeating field
supportingInfo, creating it if it does not already exist
-
getSupportingInfoTarget
@Deprecated public List<Resource> getSupportingInfoTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getSpecimen
public List<Reference> getSpecimen()
- Returns:
specimen(One or more specimens that the laboratory procedure will use.)
-
setSpecimen
public ServiceRequest setSpecimen(List<Reference> theSpecimen)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSpecimen
public boolean hasSpecimen()
-
addSpecimen
public Reference addSpecimen()
-
addSpecimen
public ServiceRequest addSpecimen(Reference t)
-
getSpecimenFirstRep
public Reference getSpecimenFirstRep()
- Returns:
- The first repetition of repeating field
specimen, creating it if it does not already exist
-
getSpecimenTarget
@Deprecated public List<Specimen> getSpecimenTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addSpecimenTarget
@Deprecated public Specimen addSpecimenTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBodySite
public List<CodeableConcept> getBodySite()
- Returns:
bodySite(Anatomic location where the procedure should be performed. This is the target site.)
-
setBodySite
public ServiceRequest setBodySite(List<CodeableConcept> theBodySite)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBodySite
public boolean hasBodySite()
-
addBodySite
public CodeableConcept addBodySite()
-
addBodySite
public ServiceRequest addBodySite(CodeableConcept t)
-
getBodySiteFirstRep
public CodeableConcept getBodySiteFirstRep()
- Returns:
- The first repetition of repeating field
bodySite, creating it if it does not already exist
-
getNote
public List<Annotation> getNote()
- Returns:
note(Any other notes and comments made about the service request. For example, internal billing notes.)
-
setNote
public ServiceRequest setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public ServiceRequest addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getPatientInstructionElement
public StringType getPatientInstructionElement()
- Returns:
patientInstruction(Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
hasPatientInstructionElement
public boolean hasPatientInstructionElement()
-
hasPatientInstruction
public boolean hasPatientInstruction()
-
setPatientInstructionElement
public ServiceRequest setPatientInstructionElement(StringType value)
- Parameters:
value-patientInstruction(Instructions in terms that are understood by the patient or consumer.). This is the underlying object with id, value and extensions. The accessor "getPatientInstruction" gives direct access to the value
-
getPatientInstruction
public String getPatientInstruction()
- Returns:
- Instructions in terms that are understood by the patient or consumer.
-
setPatientInstruction
public ServiceRequest setPatientInstruction(String value)
- Parameters:
value- Instructions in terms that are understood by the patient or consumer.
-
getRelevantHistory
public List<Reference> getRelevantHistory()
- Returns:
relevantHistory(Key events in the history of the request.)
-
setRelevantHistory
public ServiceRequest setRelevantHistory(List<Reference> theRelevantHistory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelevantHistory
public boolean hasRelevantHistory()
-
addRelevantHistory
public Reference addRelevantHistory()
-
addRelevantHistory
public ServiceRequest addRelevantHistory(Reference t)
-
getRelevantHistoryFirstRep
public Reference getRelevantHistoryFirstRep()
- Returns:
- The first repetition of repeating field
relevantHistory, creating it if it does not already exist
-
getRelevantHistoryTarget
@Deprecated public List<Provenance> getRelevantHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addRelevantHistoryTarget
@Deprecated public Provenance addRelevantHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin 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 ServiceRequest copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ServiceRequest dst)
-
typedCopy
protected ServiceRequest 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
-
-