Skip to main content

HS.FHIRModel.R4.ServiceRequest

class HS.FHIRModel.R4.ServiceRequest extends HS.FHIRModel.FHIRClassSuper

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

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_SERVICEREQUEST;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _asNeededBoolean as HS.FHIRModel.R4.Element;
Extensions for asNeededBoolean
Property methods: _asNeededBooleanGet(), _asNeededBooleanGetSwizzled(), _asNeededBooleanIsValid(), _asNeededBooleanNewObject(), _asNeededBooleanSet()
property _authoredOn as HS.FHIRModel.R4.Element;
Extensions for authoredOn
Property methods: _authoredOnGet(), _authoredOnGetSwizzled(), _authoredOnIsValid(), _authoredOnNewObject(), _authoredOnSet()
property _doNotPerform as HS.FHIRModel.R4.Element;
Extensions for doNotPerform
Property methods: _doNotPerformGet(), _doNotPerformGetSwizzled(), _doNotPerformIsValid(), _doNotPerformNewObject(), _doNotPerformSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _intent as HS.FHIRModel.R4.Element;
Extensions for intent
Property methods: _intentGet(), _intentGetSwizzled(), _intentIsValid(), _intentNewObject(), _intentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _occurrenceDateTime as HS.FHIRModel.R4.Element;
Extensions for occurrenceDateTime
Property methods: _occurrenceDateTimeGet(), _occurrenceDateTimeGetSwizzled(), _occurrenceDateTimeIsValid(), _occurrenceDateTimeNewObject(), _occurrenceDateTimeSet()
property _patientInstruction as HS.FHIRModel.R4.Element;
Extensions for patientInstruction
Property methods: _patientInstructionGet(), _patientInstructionGetSwizzled(), _patientInstructionIsValid(), _patientInstructionNewObject(), _patientInstructionSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property asNeededBoolean as %Boolean;
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Property methods: asNeededBooleanDisplayToLogical(), asNeededBooleanGet(), asNeededBooleanIsValid(), asNeededBooleanLogicalToDisplay(), asNeededBooleanLogicalToXSD(), asNeededBooleanNormalize(), asNeededBooleanSet(), asNeededBooleanXSDToLogical()
property asNeededCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc.
Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property authoredOn as %String;
When the request transitioned to being actionable.
Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
Plan/proposal/order fulfilled by this request.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property bodySite as HS.FHIRModel.R4.SeqOfCodeableConcept;
Anatomic location where the procedure should be performed. This is the target site.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property doNotPerform as %Boolean;
Set this to true if the record is saying that the service/procedure should NOT be performed.
Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property encounter as HS.FHIRModel.R4.Reference;
An encounter that provides additional information about the healthcare context in which this request is made.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
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.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property insurance as HS.FHIRModel.R4.SeqOfReference;
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service.
Property methods: insuranceGet(), insuranceGetSwizzled(), insuranceIsValid(), insuranceNewObject(), insuranceSet()
property intent as %String;
Whether the request is a proposal, plan, an original order or a reflex order.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property locationCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
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.
Property methods: locationCodeGet(), locationCodeGetSwizzled(), locationCodeIsValid(), locationCodeNewObject(), locationCodeSet()
property locationReference as HS.FHIRModel.R4.SeqOfReference;
A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center.
Property methods: locationReferenceGet(), locationReferenceGetSwizzled(), locationReferenceIsValid(), locationReferenceNewObject(), locationReferenceSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Any other notes and comments made about the service request. For example, internal billing notes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property occurrenceDateTime as %String;
The date/time at which the requested service should occur.
Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIRModel.R4.Period;
The date/time at which the requested service should occur.
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIRModel.R4.Timing;
The date/time at which the requested service should occur.
Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property orderDetail as HS.FHIRModel.R4.SeqOfCodeableConcept;
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.
Property methods: orderDetailGet(), orderDetailGetSwizzled(), orderDetailIsValid(), orderDetailNewObject(), orderDetailSet()
property patientInstruction as %String;
Instructions in terms that are understood by the patient or consumer.
Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property performer as HS.FHIRModel.R4.SeqOfReference;
The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property performerType as HS.FHIRModel.R4.CodeableConcept;
Desired type of performer for doing the requested service.
Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priority as %String;
Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property quantityQuantity as HS.FHIRModel.R4.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).
Property methods: quantityQuantityGet(), quantityQuantityGetSwizzled(), quantityQuantityIsValid(), quantityQuantityNewObject(), quantityQuantitySet()
property quantityRange as HS.FHIRModel.R4.Range;
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).
Property methods: quantityRangeGet(), quantityRangeGetSwizzled(), quantityRangeIsValid(), quantityRangeNewObject(), quantityRangeSet()
property quantityRatio as HS.FHIRModel.R4.Ratio;
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).
Property methods: quantityRatioGet(), quantityRatioGetSwizzled(), quantityRatioIsValid(), quantityRatioNewObject(), quantityRatioSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
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`.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property relevantHistory as HS.FHIRModel.R4.SeqOfReference;
Key events in the history of the request.
Property methods: relevantHistoryGet(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryNewObject(), relevantHistorySet()
property replaces as HS.FHIRModel.R4.SeqOfReference;
The request takes the place of the referenced completed or terminated request(s).
Property methods: replacesGet(), replacesGetSwizzled(), replacesIsValid(), replacesNewObject(), replacesSet()
property requester as HS.FHIRModel.R4.Reference;
The individual who initiated the request and has responsibility for its activation.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property requisition as HS.FHIRModel.R4.Identifier;
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.
Property methods: requisitionGet(), requisitionGetSwizzled(), requisitionIsValid(), requisitionNewObject(), requisitionSet()
property resourceType as %String [ InitialExpression = "ServiceRequest" , Required ];
This is a ServiceRequest resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property specimen as HS.FHIRModel.R4.SeqOfReference;
One or more specimens that the laboratory procedure will use.
Property methods: specimenGet(), specimenGetSwizzled(), specimenIsValid(), specimenNewObject(), specimenSet()
property status as %String;
The status of the order.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
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).
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInfo as HS.FHIRModel.R4.SeqOfReference;
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.
Property methods: supportingInfoGet(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoNewObject(), supportingInfoSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAsNeededCodeableConcept()
method IncludeBasedOn()
method IncludeBodySite()
method IncludeCategory()
method IncludeCode()
method IncludeContained()
method IncludeEncounter()
method IncludeExtension()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeInsurance()
method IncludeLocationCode()
method IncludeLocationReference()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOccurrencePeriod()
method IncludeOccurrenceTiming()
method IncludeOrderDetail()
method IncludePerformer()
method IncludePerformerType()
method IncludeQuantityQuantity()
method IncludeQuantityRange()
method IncludeQuantityRatio()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRelevantHistory()
method IncludeReplaces()
method IncludeRequester()
method IncludeRequisition()
method IncludeSpecimen()
method IncludeSubject()
method IncludeSupportingInfo()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab