Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.ServiceRequest

class HS.FHIR.DTL.vR4.Model.Resource.ServiceRequest extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A request for a service to be performed.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute.

NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.

parameter XMLNAME = ServiceRequest;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = 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 %Boolean (XMLNAME = "asNeededBoolean", XMLPROJECTION = "ATTRIBUTE");
boolean

Preconditions for service.

Property methods: asNeededBooleanDisplayToLogical(), asNeededBooleanGet(), asNeededBooleanIsValid(), asNeededBooleanLogicalToDisplay(), asNeededBooleanLogicalToXSD(), asNeededBooleanNormalize(), asNeededBooleanSet(), asNeededBooleanXSDToLogical()
property asNeededCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "asNeededCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

Preconditions for service.

any FHIR4 code may be used; medication-as-needed-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property authoredOn as %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date request signed.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

What request fulfills.

CarePlan | ServiceRequest | MedicationRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property bodySite as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
CodeableConcept

Location on Body.

any FHIR4 code may be used; body-site shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: bodySiteBuildValueArray(), bodySiteCollectionToDisplay(), bodySiteCollectionToOdbc(), bodySiteDisplayToCollection(), bodySiteGet(), bodySiteGetObject(), bodySiteGetObjectId(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteOdbcToCollection(), bodySiteSet(), bodySiteSetObject(), bodySiteSetObjectId()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Classification of service.

any FHIR4 code may be used; servicerequest-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

What is being requested/ordered.

any FHIR4 code may be used; procedure-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property doNotPerform as %Boolean (XMLNAME = "doNotPerform", XMLPROJECTION = "ATTRIBUTE");
boolean

True if service/procedure should not be performed.

Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter in which the request was created.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Identifiers assigned to this order.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property instantiatesCanonical as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ELEMENT");
canonical

Instantiates FHIR protocol or definition.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalBuildValueArray(), instantiatesCanonicalCollectionToDisplay(), instantiatesCanonicalCollectionToOdbc(), instantiatesCanonicalDisplayToCollection(), instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalGetObject(), instantiatesCanonicalGetObjectId(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalOdbcToCollection(), instantiatesCanonicalSet(), instantiatesCanonicalSetObject(), instantiatesCanonicalSetObjectId()
property instantiatesUri as list of %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ELEMENT");
uri

Instantiates external protocol or definition.

Property methods: instantiatesUriBuildValueArray(), instantiatesUriCollectionToDisplay(), instantiatesUriCollectionToOdbc(), instantiatesUriDisplayToCollection(), instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriGetObject(), instantiatesUriGetObjectId(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriOdbcToCollection(), instantiatesUriSet(), instantiatesUriSetObject(), instantiatesUriSetObjectId()
property insurance as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
Reference

Associated insurance coverage.

Coverage | ClaimResponse

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option

request-intent|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-intent|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property locationCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "locationCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Requested location.

any FHIR4 code may be used; v3-ServiceDeliveryLocationRoleType shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: locationCodeBuildValueArray(), locationCodeCollectionToDisplay(), locationCodeCollectionToOdbc(), locationCodeDisplayToCollection(), locationCodeGet(), locationCodeGetObject(), locationCodeGetObjectId(), locationCodeGetSwizzled(), locationCodeIsValid(), locationCodeOdbcToCollection(), locationCodeSet(), locationCodeSetObject(), locationCodeSetObjectId()
property locationReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "locationReference", XMLPROJECTION = "ELEMENT");
Reference

Requested location.

Location

Property methods: locationReferenceBuildValueArray(), locationReferenceCollectionToDisplay(), locationReferenceCollectionToOdbc(), locationReferenceDisplayToCollection(), locationReferenceGet(), locationReferenceGetObject(), locationReferenceGetObjectId(), locationReferenceGetSwizzled(), locationReferenceIsValid(), locationReferenceOdbcToCollection(), locationReferenceSet(), locationReferenceSetObject(), locationReferenceSetObjectId()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as %String (MAXLEN = 1000000, XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When service should occur.

Property methods: occurrenceDateTimeDisplayToLogical(), occurrenceDateTimeGet(), occurrenceDateTimeIsValid(), occurrenceDateTimeLogicalToDisplay(), occurrenceDateTimeLogicalToOdbc(), occurrenceDateTimeNormalize(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Period

When service should occur.

Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.DTL.vR4.Model.Datatype.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Timing

When service should occur.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property orderDetail as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "orderDetail", XMLPROJECTION = "ELEMENT");
CodeableConcept

Additional order information.

any FHIR4 code may be used; servicerequest-orderdetail shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: orderDetailBuildValueArray(), orderDetailCollectionToDisplay(), orderDetailCollectionToOdbc(), orderDetailDisplayToCollection(), orderDetailGet(), orderDetailGetObject(), orderDetailGetObjectId(), orderDetailGetSwizzled(), orderDetailIsValid(), orderDetailOdbcToCollection(), orderDetailSet(), orderDetailSetObject(), orderDetailSetObjectId()
property patientInstruction as %String (MAXLEN = 1000000, XMLNAME = "patientInstruction", XMLPROJECTION = "ATTRIBUTE");
string

Patient or consumer-oriented instructions.

Property methods: patientInstructionDisplayToLogical(), patientInstructionGet(), patientInstructionIsValid(), patientInstructionLogicalToDisplay(), patientInstructionLogicalToOdbc(), patientInstructionNormalize(), patientInstructionSet()
property performer as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Requested performer.

Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property performerType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Performer role.

any FHIR4 code may be used; participant-role shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

request-priority|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-priority|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property quantityQuantity as HS.FHIR.DTL.vR4.Model.Datatype.Quantity (XMLNAME = "quantityQuantity", XMLPROJECTION = "ELEMENT");
Quantity

Service amount.

Property methods: quantityQuantityGet(), quantityQuantityGetSwizzled(), quantityQuantityIsValid(), quantityQuantityNewObject(), quantityQuantitySet()
property quantityRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "quantityRange", XMLPROJECTION = "ELEMENT");
Range

Service amount.

Property methods: quantityRangeGet(), quantityRangeGetSwizzled(), quantityRangeIsValid(), quantityRangeNewObject(), quantityRangeSet()
property quantityRatio as HS.FHIR.DTL.vR4.Model.Datatype.Ratio (XMLNAME = "quantityRatio", XMLPROJECTION = "ELEMENT");
Ratio

Service amount.

Property methods: quantityRatioGet(), quantityRatioGetSwizzled(), quantityRatioIsValid(), quantityRatioNewObject(), quantityRatioSet()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Explanation/Justification for procedure or service.

any FHIR4 code may be used; procedure-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Explanation/Justification for service or service.

Condition | Observation | DiagnosticReport | DocumentReference

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relevantHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Reference

Request provenance.

Provenance

Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property replaces as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
Reference

What request replaces.

ServiceRequest

Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property requester as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who/what is requesting service.

Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property requisition as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "requisition", XMLPROJECTION = "ELEMENT");
Identifier

Composite Request ID.

Property methods: requisitionGet(), requisitionGetSwizzled(), requisitionIsValid(), requisitionNewObject(), requisitionSet()
property specimen as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "specimen", XMLPROJECTION = "ELEMENT");
Reference

Procedure Samples.

Specimen

Property methods: specimenBuildValueArray(), specimenCollectionToDisplay(), specimenCollectionToOdbc(), specimenDisplayToCollection(), specimenGet(), specimenGetObject(), specimenGetObjectId(), specimenGetSwizzled(), specimenIsValid(), specimenOdbcToCollection(), specimenSet(), specimenSetObject(), specimenSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | active | on-hold | revoked | completed | entered-in-error | unknown

request-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend request-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Individual or Entity the service is ordered for.

Patient | Group | Location | Device

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInfo as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
Reference

Additional clinical information.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab