Skip to main content

HS.FHIR.vSTU3.Model.Resource.ProcedureRequest

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A record of a request for diagnostic investigations, treatments, or operations to be performed.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

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

Properties

property asNeededBoolean as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "asNeededBoolean", XMLPROJECTION = "ELEMENT");
Property methods: asNeededBooleanGet(), asNeededBooleanGetSwizzled(), asNeededBooleanIsValid(), asNeededBooleanNewObject(), asNeededBooleanSet()
property asNeededCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "asNeededCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: asNeededCodeableConceptGet(), asNeededCodeableConceptGetSwizzled(), asNeededCodeableConceptIsValid(), asNeededCodeableConceptNewObject(), asNeededCodeableConceptSet()
property authoredOn as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "authoredOn", XMLPROJECTION = "ELEMENT");
When the request transitioned to being actionable.
Property methods: authoredOnGet(), authoredOnGetSwizzled(), authoredOnIsValid(), authoredOnNewObject(), authoredOnSet()
property basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Plan/proposal/order fulfilled by this request.
Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property bodySite as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "bodySite", XMLPROJECTION = "ELEMENT");
Anatomic location where the procedure should be performed. This is the target site.
Property methods: bodySiteBuildValueArray(), bodySiteCollectionToDisplay(), bodySiteCollectionToOdbc(), bodySiteDisplayToCollection(), bodySiteGet(), bodySiteGetObject(), bodySiteGetObjectId(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteOdbcToCollection(), bodySiteSet(), bodySiteSetObject(), bodySiteSetObjectId()
property category as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT") [ Required ];
A code that identifies a particular procedure, diagnostic investigation, or panel of investigations, that have been requested.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
An encounter or episode of care that provides additional information about the healthcare context in which this request is made.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
Protocol or definition followed by this request.
Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property doNotPerform as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "doNotPerform", XMLPROJECTION = "ELEMENT");
Set this to true if the record is saying that the procedure should NOT be performed.
Property methods: doNotPerformGet(), doNotPerformGetSwizzled(), doNotPerformIsValid(), doNotPerformNewObject(), doNotPerformSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property intent as HS.FHIR.vSTU3.Model.Base.RequestIntent (XMLNAME = "intent", XMLPROJECTION = "ELEMENT") [ Required ];
Whether the request is a proposal, plan, an original order or a reflex order.
Property methods: intentGet(), intentGetSwizzled(), intentIsValid(), intentNewObject(), intentSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Any other notes and comments made about the service request. For example, letting provider know that "patient hates needles" or other provider instructions.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property occurrenceDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "occurrenceDateTime", XMLPROJECTION = "ELEMENT");
Property methods: occurrenceDateTimeGet(), occurrenceDateTimeGetSwizzled(), occurrenceDateTimeIsValid(), occurrenceDateTimeNewObject(), occurrenceDateTimeSet()
property occurrencePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "occurrencePeriod", XMLPROJECTION = "ELEMENT");
Property methods: occurrencePeriodGet(), occurrencePeriodGetSwizzled(), occurrencePeriodIsValid(), occurrencePeriodNewObject(), occurrencePeriodSet()
property occurrenceTiming as HS.FHIR.vSTU3.Model.Base.Timing (XMLNAME = "occurrenceTiming", XMLPROJECTION = "ELEMENT");
Property methods: occurrenceTimingGet(), occurrenceTimingGetSwizzled(), occurrenceTimingIsValid(), occurrenceTimingNewObject(), occurrenceTimingSet()
property performer as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
The desired perfomer for doing the diagnostic testing. For example, the surgeon, dermatopathologist, endoscopist, etc.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet(), performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property performerType as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
Desired type of performer for doing the diagnostic testing.
Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priority as HS.FHIR.vSTU3.Model.Base.RequestPriority (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Indicates how quickly the ProcedureRequest should be addressed with respect to other requests.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
An explanation or justification for why this diagnostic investigation is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation.
Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Indicates another resource that provides a justification for why this diagnostic investigation is being requested. May relate to the resources referred to in supportingInformation.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property relevantHistory as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Key events in the history of the request.
Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property replaces as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "replaces", XMLPROJECTION = "ELEMENT");
The request takes the place of the referenced completed or terminated request(s).
Property methods: replacesBuildValueArray(), replacesCollectionToDisplay(), replacesCollectionToOdbc(), replacesDisplayToCollection(), replacesGet(), replacesGetObject(), replacesGetObjectId(), replacesGetSwizzled(), replacesIsValid(), replacesOdbcToCollection(), replacesSet(), replacesSetObject(), replacesSetObjectId()
property requester as HS.FHIR.vSTU3.Model.Resource.ProcedureRequest.Requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
The individual who initiated the request and has responsibility for its activation.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property requisition as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "requisition", XMLPROJECTION = "ELEMENT");
A shared identifier common to all procedure or diagnostic 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 specimen as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "specimen", XMLPROJECTION = "ELEMENT");
One or more specimens that the laboratory procedure will use.
Property methods: specimenBuildValueArray(), specimenCollectionToDisplay(), specimenCollectionToOdbc(), specimenDisplayToCollection(), specimenGet(), specimenGetObject(), specimenGetObjectId(), specimenGetSwizzled(), specimenIsValid(), specimenOdbcToCollection(), specimenSet(), specimenSetObject(), specimenSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.RequestStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The status of the order.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
On whom or what the procedure or diagnostic 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 list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingInfo", XMLPROJECTION = "ELEMENT");
Additional clinical information about the patient or specimen that may influence the procedure or diagnostics 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: supportingInfoBuildValueArray(), supportingInfoCollectionToDisplay(), supportingInfoCollectionToOdbc(), supportingInfoDisplayToCollection(), supportingInfoGet(), supportingInfoGetObject(), supportingInfoGetObjectId(), supportingInfoGetSwizzled(), supportingInfoIsValid(), supportingInfoOdbcToCollection(), supportingInfoSet(), supportingInfoSetObject(), supportingInfoSetObjectId()

Methods

deprecated method SetAsNeededBoolean(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "asNeededBoolean" property.
deprecated method SetAsNeededCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "asNeededCodeableConcept" property.
deprecated method SetAuthoredOn(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "authoredOn" property.
deprecated method SetBasedOn(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "basedOn" property.
deprecated method SetBodySite(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "bodySite" property.
deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "category" property.
deprecated method SetCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "code" property.
deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetDefinition(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "definition" property.
deprecated method SetDoNotPerform(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "doNotPerform" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetIntent(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "intent" property.
deprecated method SetOccurrenceDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "occurrenceDateTime" property.
deprecated method SetOccurrencePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "occurrencePeriod" property.
deprecated method SetPerformer(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "performer" property.
deprecated method SetPerformerType(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "performerType" property.
deprecated method SetPriority(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "priority" property.
deprecated method SetReasonCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonCode" property.
deprecated method SetReasonReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonReference" property.
deprecated method SetRelevantHistory(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "relevantHistory" property.
deprecated method SetReplaces(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "replaces" property.
deprecated method SetRequisition(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "requisition" property.
deprecated method SetSpecimen(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "specimen" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetSupportingInfo(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingInfo" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab