ServiceRequest class

ServiceRequest A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Inheritance
Available extensions

Constructors

ServiceRequest({FhirString? id, FhirMeta? meta, FhirUri? implicitRules, AllLanguages? language, Narrative? text, List<Resource>? contained, List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, List<Identifier>? identifier, List<FhirCanonical>? instantiatesCanonical, List<FhirUri>? instantiatesUri, List<Reference>? basedOn, List<Reference>? replaces, Identifier? requisition, required RequestStatus status, required RequestIntent intent, List<CodeableConcept>? category, RequestPriority? priority, FhirBoolean? doNotPerform, CodeableReference? code, List<ServiceRequestOrderDetail>? orderDetail, QuantityXServiceRequest? quantityX, Quantity? quantityQuantity, Ratio? quantityRatio, Range? quantityRange, required Reference subject, List<Reference>? focus, Reference? encounter, OccurrenceXServiceRequest? occurrenceX, FhirDateTime? occurrenceDateTime, Period? occurrencePeriod, Timing? occurrenceTiming, AsNeededXServiceRequest? asNeededX, FhirBoolean? asNeededBoolean, CodeableConcept? asNeededCodeableConcept, FhirDateTime? authoredOn, Reference? requester, CodeableConcept? performerType, List<Reference>? performer, List<CodeableReference>? location, List<CodeableReference>? reason, List<Reference>? insurance, List<CodeableReference>? supportingInfo, List<Reference>? specimen, List<CodeableConcept>? bodySite, Reference? bodyStructure, List<Annotation>? note, List<ServiceRequestPatientInstruction>? patientInstruction, List<Reference>? relevantHistory})
Primary constructor for ServiceRequest
const
ServiceRequest.fromJson(Map<String, dynamic> json)
Factory constructor that accepts Map<String, dynamic> as an argument
factory
ServiceRequest.fromJsonString(String source)
Factory constructor for ServiceRequest that takes in a String Convenience method to avoid the json Encoding/Decoding normally required to get data from a String
factory
ServiceRequest.fromYaml(dynamic yaml)
Deserialize ServiceRequest from a String or YamlMap object
factory

Properties

asNeededBoolean → FhirBoolean?
Getter for asNeededBoolean as a FhirBoolean
no setter
asNeededCodeableConcept → CodeableConcept?
Getter for asNeededCodeableConcept as a CodeableConcept
no setter
asNeededX → AsNeededXServiceRequest?
asNeededX If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
final
authoredOn → FhirDateTime?
authoredOn When the request transitioned to being actionable.
final
basedOn → List<Reference>?
basedOn Plan/proposal/order fulfilled by this request.
final
bodySite → List<CodeableConcept>?
bodySite Anatomic location where the procedure should be performed. This is the target site.
final
bodyStructure → Reference?
bodyStructure Anatomic location where the procedure should be performed. This is the target site.
final
category → List<CodeableConcept>?
category A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
final
code → CodeableReference?
code A code or reference that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
final
contained → List<Resource>?
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope
finalinherited
copyWith → $ServiceRequestCopyWith<ServiceRequest>

Available on ServiceRequest, provided by the ServiceRequestCopyWithExtension extension

no setter
copyWith → $ServiceRequestCopyWith<ServiceRequest>
Copy function for ServiceRequest Returns a copy of the current instance with the provided fields modified. If a field is not provided, it will retain its original value. If a null is provided, this will clearn the field, unless the field is required, in which case it will keep its current value.
no setteroverride
doNotPerform → FhirBoolean?
doNotPerform Set this to true if the record is saying that the service/procedure should NOT be performed.
final
encounter → Reference?
encounter An encounter that provides additional information about the healthcare context in which this request is made.
final
extension_ → List<FhirExtension>?
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
finalinherited
fhirType → String
Returns the FHIR type of the object.
no setteroverride
focus → List<Reference>?
focus The actual focus of a service request when it is not the subject of record representing something or someone associated with the subject such as a spouse, parent, fetus, or donor. The focus of a service request could also be an existing condition, an intervention, the subject's diet, another service request on the subject, or a body structure such as tumor or implanted device.
final
hashCode → int
The hash code for this object.
no setterinherited
hasPrimitiveValue → bool
Checks if the object has a primitive value.
no setterinherited
id → FhirString?
The logical id of the resource, as used in the URL for the resource.
finalinherited
identifier → List<Identifier>?
identifier Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
final
implicitRules → FhirUri?
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
finalinherited
instantiatesCanonical → List<FhirCanonical>?
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.
final
instantiatesUri → List<FhirUri>?
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.
final
insurance → List<Reference>?
insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
final
intent → RequestIntent
intent Whether the request is a proposal, plan, an original order or a reflex order.
final
isMetadataBased → bool
All FhirBases and Resources are NOT metadata based
no setterinherited
isPrimitive → bool
Checks if the object is primitive.
no setterinherited
language → AllLanguages?
The base language in which the resource is written. This should be the language of the text value in the content element when a text value is present.
finalinherited
location → List<CodeableReference>?
location 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.
final
meta → FhirMeta?
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
finalinherited
modifierExtension → List<FhirExtension>?
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element\u0027s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
finalinherited
note → List<Annotation>?
note Any other notes and comments made about the service request. For example, internal billing notes.
final
occurrenceDateTime → FhirDateTime?
Getter for occurrenceDateTime as a FhirDateTime
no setter
occurrencePeriod → Period?
Getter for occurrencePeriod as a Period
no setter
occurrenceTiming → Timing?
Getter for occurrenceTiming as a Timing
no setter
occurrenceX → OccurrenceXServiceRequest?
occurrenceX The date/time at which the requested service should occur.
final
orderDetail → List<ServiceRequestOrderDetail>?
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.
final
path → String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
patientInstruction → List<ServiceRequestPatientInstruction>?
patientInstruction Instructions in terms that are understood by the patient or consumer.
final
performer → List<Reference>?
performer The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
final
performerType → CodeableConcept?
performerType Desired type of performer for doing the requested service.
final
primitiveValue → String?
Retrieves the primitive value of the object.
no setterinherited
priority → RequestPriority?
priority Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
final
quantityQuantity → Quantity?
Getter for quantityQuantity as a Quantity
no setter
quantityRange → Range?
Getter for quantityRange as a Range
no setter
quantityRatio → Ratio?
Getter for quantityRatio as a Ratio
no setter
quantityX → QuantityXServiceRequest?
quantityX 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).
final
reason → List<CodeableReference>?
reason 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.
final
relevantHistory → List<Reference>?
relevantHistory Key events in the history of the request.
final
replaces → List<Reference>?
replaces The request takes the place of the referenced completed or terminated request(s).
final
requester → Reference?
requester The individual who initiated the request and has responsibility for its activation.
final
requisition → 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.
final
resourceType → R5ResourceType
The type of resource
finalinherited
resourceTypeString → String
produce a string of the resourceType
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
specimen → List<Reference>?
specimen One or more specimens that the laboratory procedure will use.
final
status → RequestStatus
status The status of the order.
final
subject → 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).
final
supportingInfo → List<CodeableReference>?
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.
final
text → Narrative?
A human-readable summary of the resource conveying the essential clinical and business information for the resource.",
finalinherited
thisReference → Reference
Convenience method to return a Reference referring to that Resource
no setterinherited

Methods

clone() → ServiceRequest
Subclasses must implement the clone method.
override
compareDeepStrings(String? s1, String? s2, bool allowNull) → bool
Checks if the object is equal to another object.
inherited
equalsDeep(FhirBase? o) → bool
Performs a deep comparison between two instances.
override
getChildByName(String name) → FhirBase?
Retrieves a single field value by its name.
override
getChildrenByName(String fieldName, [bool checkValid = false]) → List<FhirBase>
Retrieves all matching child fields by name. Optionally validates the name.
override
hasType(List<String> names) → bool
Checks if the object has a given type.
inherited
hasValues() → bool
Checks if the object has values.
inherited
isAs<T extends FhirBase>() → T?
Returns an Object cast as a Type if it is that type.
inherited
isEmpty() → bool
Checks if the object is empty.
inherited
listChildrenNames() → List<String>
Lists the JSON keys for the object.
override
newId() → Resource
returns the same resource with a new ID (even if there is already an ID present)
inherited
newIdIfNoId() → Resource
returns the same resource with a new ID if there is no current ID
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
prettyPrint() → String
Converts the object to a pretty JSON string.
inherited
toJson() → Map<String, dynamic>
Returns a Map<String, dynamic> of the DomainResource
override
toJsonString() → String
Converts the object to a JSON string.
inherited
toString() → String
A string representation of this object.
inherited
toYaml() → String
Converts the object to a YAML string.
inherited
updateVersion({FhirMeta? oldMeta, bool versionIdAsTime = false}) → Resource
Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited