ServiceRequest class

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

Implemented types

• DomainResource

Annotations

• @freezed

Constructors

ServiceRequest.new({@Default(R5ResourceType.ServiceRequest) @JsonKey(unknownEnumValue: R5ResourceType.ServiceRequest) R5ResourceType resourceType, FhirId? id, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') PrimitiveElement? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') PrimitiveElement? 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<PrimitiveElement>? instantiatesUriElement, List<Reference>? basedOn, List<Reference>? replaces, Identifier? requisition, FhirCode? status, @JsonKey(name: '_status') PrimitiveElement? statusElement, FhirCode? intent, @JsonKey(name: '_intent') PrimitiveElement? intentElement, List<CodeableConcept>? category, FhirCode? priority, @JsonKey(name: '_priority') PrimitiveElement? priorityElement, FhirBoolean? doNotPerform, @JsonKey(name: '_doNotPerform') PrimitiveElement? 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') PrimitiveElement? occurrenceDateTimeElement, Period? occurrencePeriod, Timing? occurrenceTiming, FhirBoolean? asNeededBoolean, @JsonKey(name: '_asNeededBoolean') PrimitiveElement? asNeededBooleanElement, CodeableConcept? asNeededCodeableConcept, FhirDateTime? authoredOn, @JsonKey(name: '_authoredOn') PrimitiveElement? 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.

const

factory

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 setter, inherited

asNeededBooleanElement → PrimitiveElement?

asNeededBooleanElement ("_asNeededBoolean") Extensions for asNeededBoolean

no setter, inherited

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 setter, inherited

authoredOn → FhirDateTime?

authoredOn When the request transitioned to being actionable.

no setter, inherited

authoredOnElement → PrimitiveElement?

authoredOnElement ("_authoredOn") Extensions for authoredOn

no setter, inherited

basedOn → List<Reference>?

basedOn Plan/proposal/order fulfilled by this request.

no setter, inherited

bodySite → List<CodeableConcept>?

bodySite Anatomic location where the procedure should be performed. This is the target site.

no setter, inherited

bodyStructure → Reference?

bodyStructure Anatomic location where the procedure should be performed. This is the target site.

no setter, inherited

category → List<CodeableConcept>?

category A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

no setter, inherited

children → List<FhirBase>

no setter, inherited

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 setter, inherited

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 setter, inherited

copyWith → $ServiceRequestCopyWith<ServiceRequest>

no setter, inherited

doNotPerform → FhirBoolean?

doNotPerform Set this to true if the record is saying that the service/procedure should NOT be performed.

no setter, inherited

doNotPerformElement → PrimitiveElement?

doNotPerformElement ("_doNotPerform") Extensions for doNotPerform

no setter, inherited

encounter → Reference?

encounter An encounter that provides additional information about the healthcare context in which this request is made.

no setter, inherited

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 setter, inherited

fhirType → String

no setter, override

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 setter, inherited

formatCommentsPost → List<String>

no setter, inherited

formatCommentsPre → List<String>

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → FhirId?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

identifier → List<Identifier>?

identifier Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

no setter, inherited

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 setter, inherited

implicitRulesElement → PrimitiveElement?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

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 setter, inherited

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 setter, inherited

instantiatesUriElement → List<PrimitiveElement>?

instantiatesUriElement ("_instantiatesUri") Extensions for instantiatesUri

no setter, inherited

insurance → List<Reference>?

insurance Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.

no setter, inherited

intent → FhirCode?

intent Whether the request is a proposal, plan, an original order or a reflex order.

no setter, inherited

intentElement → PrimitiveElement?

intentElement ("_intent") Extensions for intent

no setter, inherited

isPrimitive → bool

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → PrimitiveElement?

languageElement ("_language") Extensions for language

no setter, inherited

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 setter, inherited

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 setter, inherited

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 setter, inherited

namedChildren → Map<String, FhirBase>

no setter, inherited

note → List<Annotation>?

note Any other notes and comments made about the service request. For example, internal billing notes.

no setter, inherited

occurrenceDateTime → FhirDateTime?

occurrenceDateTime The date/time at which the requested service should occur.

no setter, inherited

occurrenceDateTimeElement → PrimitiveElement?

occurrenceDateTimeElement ("_occurrenceDateTime") Extensions for occurrenceDateTime

no setter, inherited

occurrencePeriod → Period?

occurrencePeriod The date/time at which the requested service should occur.

no setter, inherited

occurrenceTiming → Timing?

occurrenceTiming The date/time at which the requested service should occur.

no setter, inherited

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 setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, override

patientInstruction → List<ServiceRequestPatientInstruction>?

patientInstruction Instructions in terms that are understood by the patient or consumer.

no setter, inherited

performer → List<Reference>?

performer The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.

no setter, inherited

performerType → CodeableConcept?

performerType Desired type of performer for doing the requested service.

no setter, inherited

priority → FhirCode?

priority Indicates how quickly the ServiceRequest should be addressed with respect to other requests.

no setter, inherited

priorityElement → PrimitiveElement?

priorityElement ("_priority") Extensions for priority

no setter, inherited

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 setter, inherited

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 setter, inherited

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 setter, inherited

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 setter, inherited

relevantHistory → List<Reference>?

relevantHistory Key events in the history of the request.

no setter, inherited

replaces → List<Reference>?

replaces The request takes the place of the referenced completed or terminated request(s).

no setter, inherited

requester → Reference?

requester The individual who initiated the request and has responsibility for its activation.

no setter, inherited

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 setter, inherited

resourceType → R5ResourceType

resourceType This is a ServiceRequest resource

no setter, inherited

resourceTypeString → String

produce a string of the resourceType

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

specimen → List<Reference>?

specimen One or more specimens that the laboratory procedure will use.

no setter, inherited

status → FhirCode?

status The status of the order.

no setter, inherited

statusElement → PrimitiveElement?

statusElement ("_status") Extensions for status

no setter, inherited

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 setter, inherited

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 setter, inherited

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 setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, override

Methods

addAnnotation(dynamic annotation) → void

inherited

addPropertyChangedListener(String property, void listener()) → void

inherited

annotations(Type type) → Iterable

inherited

clearUserData(String name) → void

inherited

clone() → FhirBase

inherited

deepCopy() → FhirBase

inherited

getUserData(String name) → dynamic

inherited

getUserInt(String name) → int

inherited

getUserString(String name) → String?

inherited

hasFormatComment() → bool

inherited

hasUserData(String name) → bool

inherited

isEmpty() → bool

inherited

isExactly(FhirBase other) → bool

inherited

matches(FhirBase other) → bool

inherited

newId() → Resource

returns the same resource with a new ID (even if there is already an ID present)

override

newIdIfNoId() → Resource

returns the same resource with a new ID if there is no current ID

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyPropertyChanged(String property) → void

inherited

primitiveValue() → String?

inherited

removeAnnotations(Type type) → void

inherited

removePropertyChangedListener(String property, void listener()) → void

inherited

setUserData(String name, dynamic value) → void

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

toJsonWithType() → dynamic

inherited

toString() → String

A string representation of this object.

inherited

toYaml() → String

Produces a Yaml formatted String version of the object

override

tryGetValue(String key, dynamic value) → bool

inherited

updateVersion({FhirMeta? oldMeta}) → Resource

Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number

override

validate() → List<String>

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited