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

HS.FHIR.DTL.vSTU3.Model.Resource.ProcedureRequest

class HS.FHIR.DTL.vSTU3.Model.Resource.ProcedureRequest extends HS.FHIR.DTL.vSTU3.Model.Base.DomainResource

A record of a request for diagnostic investigations, treatments, or operations 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 = ProcedureRequest;
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 = ProcedureRequest;
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 procedure or diagnostic.

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

Preconditions for procedure or diagnostic.

any FHIR3 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.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

What request fulfills.

Any FHIR3 Resource may be indicated by this Reference

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

Location on Body.

any FHIR3 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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Classification of procedure.

any FHIR3 code may be used; procedure-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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What is being requested/ordered.

any FHIR3 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 context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter or Episode during which request was created.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Reference

Protocol or definition.

ActivityDefinition | PlanDefinition

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property doNotPerform as %Boolean (XMLNAME = "doNotPerform", XMLPROJECTION = "ATTRIBUTE");
boolean

True if procedure should not be performed.

Property methods: doNotPerformDisplayToLogical(), doNotPerformGet(), doNotPerformIsValid(), doNotPerformLogicalToDisplay(), doNotPerformLogicalToXSD(), doNotPerformNormalize(), doNotPerformSet(), doNotPerformXSDToLogical()
property identifier as list of HS.FHIR.DTL.vSTU3.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 intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

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

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

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property note as list of HS.FHIR.DTL.vSTU3.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 procedure should occur.

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

When procedure should occur.

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

When procedure should occur.

Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property performer as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Reference

Requested perfomer.

Practitioner | Organization | Patient | Device | RelatedPerson | HealthcareService

Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property performerType as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Performer role.

any FHIR3 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 is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend request-priority and you may NOT use codes from other ValueSets.

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Explanation/Justification for test.

any FHIR3 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.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Explanation/Justification for test.

Condition | Observation

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relevantHistory as list of HS.FHIR.DTL.vSTU3.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.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
Reference

What request replaces.

Any FHIR3 Resource may be indicated by this Reference

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

Who/what is requesting procedure or diagnostic.

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property requisition as HS.FHIR.DTL.vSTU3.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.vSTU3.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 | suspended | completed | entered-in-error | cancelled

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

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

Individual the service is ordered for.

Patient | Group | Location | Device

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

Additional clinical information.

Any FHIR3 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