spark_auto_mapper_fhir.resources.service_request

Module Contents

Classes

ServiceRequest

ServiceRequest
class spark_auto_mapper_fhir.resources.service_request.ServiceRequest(*, id_=None, meta=None, implicitRules=None, language=None, text=None, contained=None, extension=None, modifierExtension=None, identifier=None, instantiatesCanonical=None, instantiatesUri=None, basedOn=None, replaces=None, requisition=None, status, intent, category=None, priority=None, doNotPerform=None, code=None, orderDetail=None, quantityQuantity=None, quantityRatio=None, quantityRange=None, subject, encounter=None, occurrenceDateTime=None, occurrencePeriod=None, occurrenceTiming=None, asNeededBoolean=None, asNeededCodeableConcept=None, authoredOn=None, requester=None, performerType=None, performer=None, locationCode=None, locationReference=None, reasonCode=None, reasonReference=None, insurance=None, supportingInfo=None, specimen=None, bodySite=None, note=None, patientInstruction=None, relevantHistory=None)

Bases: spark_auto_mapper_fhir.base_types.fhir_resource_base.FhirResourceBase

ServiceRequest servicerequest.xsd

A record of a request for service such as diagnostic investigations,

treatments, or operations to be performed.

If the element is present, it must have either a @value, an @id, or extensions

A record of a request for service such as diagnostic investigations,

treatments, or operations to be performed.

If the element is present, it must have either a @value, an @id, or extensions

param id_

The logical id of the resource, as used in the URL for the resource. Once

assigned, this value never changes.
param 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.

param 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.

param language

The base language in which the resource is written.

param 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.

param contained

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.

param 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 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.

param 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 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

param identifier

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

and/or order fulfiller.
param 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.
param 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.

param basedOn

Plan/proposal/order fulfilled by this request.

param replaces

The request takes the place of the referenced completed or terminated

request(s).
param 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.

param status

The status of the order.

param intent

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

param category

A code that classifies the service for searching, sorting and display purposes

(e.g. “Surgical Procedure”).
param priority

Indicates how quickly the ServiceRequest should be addressed with respect to

other requests.
param doNotPerform

Set this to true if the record is saying that the service/procedure should NOT

be performed.
param code

A code that identifies a particular service (i.e., procedure, diagnostic

investigation, or panel of investigations) that have been requested.
param 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.

param quantityQuantity

None

param quantityRatio

None

param quantityRange

None

param 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).

param encounter

An encounter that provides additional information about the healthcare context

in which this request is made.
param occurrenceDateTime

None

param occurrencePeriod

None

param occurrenceTiming

None

param asNeededBoolean

None

param asNeededCodeableConcept

None

param authoredOn

When the request transitioned to being actionable.

param requester

The individual who initiated the request and has responsibility for its

activation.
param performerType

Desired type of performer for doing the requested service.

param performer

The desired performer for doing the requested service. For example, the

surgeon, dermatopathologist, endoscopist, etc.
param 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.
param locationReference

A reference to the the preferred location(s) where the procedure should

actually happen. E.g. at home or nursing day care center.
param 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.

param reasonReference

Indicates another resource that provides a justification for why this service

is being requested. May relate to the resources referred to in supportingInfo.

param insurance

Insurance plans, coverage extensions, pre-authorizations and/or pre-

determinations that may be needed for delivering the requested service.
param 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.

param specimen

One or more specimens that the laboratory procedure will use.

param bodySite

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

site.
param note

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

internal billing notes.
param patientInstruction

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

param relevantHistory

Key events in the history of the request.

Parameters
get_schema(self, include_extension)
Parameters

include_extension (bool) –

Return type

Optional[Union[pyspark.sql.types.StructType, pyspark.sql.types.DataType]]