ServiceRequest class
ServiceRequest A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
- Mixed in types
- Annotations
-
- @freezed
Constructors
-
ServiceRequest({@Default(R5ResourceType.ServiceRequest) @JsonKey(unknownEnumValue: R5ResourceType.ServiceRequest) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<
Resource> ? contained, @JsonKey(name: 'extension') List<FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, List<Identifier> ? identifier, List<FhirCanonical> ? instantiatesCanonical, List<FhirUri> ? instantiatesUri, @JsonKey(name: '_instantiatesUri') List<Element> ? instantiatesUriElement, List<Reference> ? basedOn, List<Reference> ? replaces, Identifier? requisition, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirCode? intent, @JsonKey(name: '_intent') Element? intentElement, List<CodeableConcept> ? category, FhirCode? priority, @JsonKey(name: '_priority') Element? priorityElement, FhirBoolean? doNotPerform, @JsonKey(name: '_doNotPerform') Element? doNotPerformElement, CodeableReference? code, List<ServiceRequestOrderDetail> ? orderDetail, Quantity? quantityQuantity, Ratio? quantityRatio, Range? quantityRange, required Reference subject, List<Reference> ? focus, Reference? encounter, FhirDateTime? occurrenceDateTime, @JsonKey(name: '_occurrenceDateTime') Element? occurrenceDateTimeElement, Period? occurrencePeriod, Timing? occurrenceTiming, FhirBoolean? asNeededBoolean, @JsonKey(name: '_asNeededBoolean') Element? asNeededBooleanElement, CodeableConcept? asNeededCodeableConcept, FhirDateTime? authoredOn, @JsonKey(name: '_authoredOn') Element? authoredOnElement, 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}) -
ServiceRequest A record of a request for service such as diagnostic
investigations, treatments, or operations to be performed.
constfactory
-
ServiceRequest.fromJson(Map<
String, dynamic> json) -
Factory constructor, accepts Map<String, dynamic> as an argument
factory
- ServiceRequest.fromJsonString(String source)
-
Acts like a constructor, returns a ServiceRequest, accepts a
String as an argument, mostly because I got tired of typing it out
factory
- ServiceRequest.fromYaml(dynamic yaml)
-
Factory constructor that accepts a String in YAML format as an argument
factory
Properties
- asNeededBoolean → FhirBoolean?
-
asNeededBoolean If a CodeableConcept is present, it indicates the
pre-condition for performing the service. For example "pain", "on
flare-up", etc.
no setterinherited
- asNeededBooleanElement → Element?
-
asNeededBooleanElement ("_asNeededBoolean") Extensions for
asNeededBoolean
no setterinherited
- asNeededCodeableConcept → CodeableConcept?
-
asNeededCodeableConcept If a CodeableConcept is present, it indicates
the pre-condition for performing the service. For example "pain", "on
flare-up", etc.
no setterinherited
-
authoredOn When the request transitioned to being actionable.
no setterinherited
-
authoredOnElement ("_authoredOn") Extensions for authoredOn
no setterinherited
-
basedOn
→ List<
Reference> ? -
basedOn Plan/proposal/order fulfilled by this request.
no setterinherited
-
bodySite
→ List<
CodeableConcept> ? -
bodySite Anatomic location where the procedure should be performed.
This is the target site.
no setterinherited
- bodyStructure → Reference?
-
bodyStructure Anatomic location where the procedure should be
performed. This is the target site.
no setterinherited
-
category
→ List<
CodeableConcept> ? -
category A code that classifies the service for searching, sorting
and display purposes (e.g. "Surgical Procedure").
no setterinherited
- 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.
no setterinherited
-
contained
→ List<
Resource> ? -
contained These resources do not have an independent existence apart
from the resource that contains them - they cannot be identified
independently, nor can they have their own independent transaction
scope. This is allowed to be a Parameters resource if and only if it
is referenced by a resource that provides context/meaning.
no setterinherited
-
copyWith
→ $ServiceRequestCopyWith<
ServiceRequest> -
no setterinherited
- dbId → int?
-
no setterinherited
- doNotPerform → FhirBoolean?
-
doNotPerform Set this to true if the record is saying that the
service/procedure should NOT be performed.
no setterinherited
- doNotPerformElement → Element?
-
doNotPerformElement ("_doNotPerform") Extensions for doNotPerform
no setterinherited
- encounter → Reference?
-
encounter An encounter that provides additional information about the
healthcare context in which this request is made.
no setterinherited
-
extension_
→ List<
FhirExtension> ? -
extension_ ("extension") 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 managable, 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.
no setterinherited
- fhirId → FhirId?
-
id The logical id of the resource, as used in the URL for the
resource. Once assigned, this value never changes.
no setterinherited
-
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.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
identifier
→ List<
Identifier> ? -
identifier Identifiers assigned to this order instance by the orderer
and/or the receiver and/or order fulfiller.
no setterinherited
- implicitRules → FhirUri?
-
implicitRules 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.
no setterinherited
- implicitRulesElement → Element?
-
implicitRulesElement ("_implicitRules") Extensions for implicitRules
no setterinherited
-
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.
no setterinherited
-
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.
no setterinherited
-
instantiatesUriElement
→ List<
Element> ? -
instantiatesUriElement ("_instantiatesUri") Extensions for
instantiatesUri
no setterinherited
-
insurance
→ List<
Reference> ? -
insurance Insurance plans, coverage extensions, pre-authorizations
and/or pre-determinations that may be needed for delivering the
requested service.
no setterinherited
- intent → FhirCode?
-
intent Whether the request is a proposal, plan, an original order or
a reflex order.
no setterinherited
- intentElement → Element?
-
intentElement ("_intent") Extensions for intent
no setterinherited
- language → FhirCode?
-
language The base language in which the resource is written.
no setterinherited
- languageElement → Element?
-
languageElement ("_language") Extensions for language
no setterinherited
-
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.
no setterinherited
- meta → FhirMeta?
-
meta 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.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
modifierExtension 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's descendants. Usually
modifier elements provide negation or qualification. To make the use
of extensions safe and managable, 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.Modifier extensions SHALL NOT change the
meaning of any elements on Resource or DomainResource (including
cannot change the meaning of modifierExtension itself).
no setterinherited
-
note
→ List<
Annotation> ? -
note Any other notes and comments made about the service request. For
example, internal billing notes.
no setterinherited
- occurrenceDateTime → FhirDateTime?
-
occurrenceDateTime The date/time at which the requested service
should occur.
no setterinherited
- occurrenceDateTimeElement → Element?
-
occurrenceDateTimeElement ("_occurrenceDateTime") Extensions for
occurrenceDateTime
no setterinherited
- occurrencePeriod → Period?
-
occurrencePeriod The date/time at which the requested service should
occur.
no setterinherited
- occurrenceTiming → Timing?
-
occurrenceTiming The date/time at which the requested service should
occur.
no setterinherited
-
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.
no setterinherited
- 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.
no setterinherited
-
performer
→ List<
Reference> ? -
performer The desired performer for doing the requested service. For
example, the surgeon, dermatopathologist, endoscopist, etc.
no setterinherited
- performerType → CodeableConcept?
-
performerType Desired type of performer for doing the requested
service.
no setterinherited
- priority → FhirCode?
-
priority Indicates how quickly the ServiceRequest should be addressed
with respect to other requests.
no setterinherited
- priorityElement → Element?
-
priorityElement ("_priority") Extensions for priority
no setterinherited
- quantityQuantity → Quantity?
-
quantityQuantity 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).
no setterinherited
- quantityRange → Range?
-
quantityRange 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).
no setterinherited
- quantityRatio → Ratio?
-
quantityRatio 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).
no setterinherited
-
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
.no setterinherited -
relevantHistory
→ List<
Reference> ? -
relevantHistory Key events in the history of the request.
no setterinherited
-
replaces
→ List<
Reference> ? -
replaces The request takes the place of the referenced completed or
terminated request(s).
no setterinherited
- requester → Reference?
-
requester The individual who initiated the request and has
responsibility for its activation.
no setterinherited
- 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.
no setterinherited
- resourceType → R5ResourceType
-
resourceType This is a ServiceRequest resource
no setterinherited
- 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.
no setterinherited
- status → FhirCode?
-
status The status of the order.
no setterinherited
- statusElement → Element?
-
statusElement ("_status") Extensions for status
no setterinherited
- 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).
no setterinherited
-
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.
no setterinherited
- text → Narrative?
-
text A human-readable narrative that contains a summary of the
resource and can be used to represent the content of the resource to a
human. The narrative need not encode all the structured data, but is
required to contain sufficient detail to make it "clinically safe" for
a human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
no setterinherited
- thisReference → Reference
-
Convenience method to return a Reference referring to that Resource
no setterinherited
Methods
-
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
-
toDbJson(
) → Map< String, dynamic> -
The normal toJson ignores the dbId, and produces the fhirId as the id
However, if you're going to use this as a database entry, you have to
switch those two ids
inherited
-
toJson(
) → Map< String, dynamic> -
inherited
-
toJsonString(
) → String -
Another convenience method because more and more I'm transmitting FHIR
data as a String and not a Map
override
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Produces a Yaml formatted String version of the object
override
-
updateVersion(
{FhirMeta? oldMeta}) → 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