Skip to main content

HS.FHIR.vSTU3.Model.Resource.Procedure

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.
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 = Procedure;
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 basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
A reference to a resource that contains details of the request for this procedure.
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");
Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
Property methods: bodySiteBuildValueArray(), bodySiteCollectionToDisplay(), bodySiteCollectionToOdbc(), bodySiteDisplayToCollection(), bodySiteGet(), bodySiteGetObject(), bodySiteGetObjectId(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteOdbcToCollection(), bodySiteSet(), bodySiteSetObject(), bodySiteSetObjectId()
property category as 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: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property complication as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "complication", XMLPROJECTION = "ELEMENT");
Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues.
Property methods: complicationBuildValueArray(), complicationCollectionToDisplay(), complicationCollectionToOdbc(), complicationDetailBuildValueArray(), complicationDetailCollectionToDisplay(), complicationDetailCollectionToOdbc(), complicationDetailDisplayToCollection(), complicationDetailGet(), complicationDetailGetObject(), complicationDetailGetObjectId(), complicationDetailGetSwizzled(), complicationDetailIsValid(), complicationDetailOdbcToCollection(), complicationDetailSet(), complicationDetailSetObject(), complicationDetailSetObjectId(), complicationDisplayToCollection(), complicationGet(), complicationGetObject(), complicationGetObjectId(), complicationGetSwizzled(), complicationIsValid(), complicationOdbcToCollection(), complicationSet(), complicationSetObject(), complicationSetObjectId()
property complicationDetail as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "complicationDetail", XMLPROJECTION = "ELEMENT");
Any complications that occurred during the procedure, or in the immediate post-performance period.
Property methods: complicationDetailBuildValueArray(), complicationDetailCollectionToDisplay(), complicationDetailCollectionToOdbc(), complicationDetailDisplayToCollection(), complicationDetailGet(), complicationDetailGetObject(), complicationDetailGetObjectId(), complicationDetailGetSwizzled(), complicationDetailIsValid(), complicationDetailOdbcToCollection(), complicationDetailSet(), complicationDetailSetObject(), complicationDetailSetObjectId()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The encounter during which the procedure was performed.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property focalDevice as list of HS.FHIR.vSTU3.Model.Resource.Procedure.FocalDevice (XMLNAME = "focalDevice", XMLPROJECTION = "ELEMENT");
A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.
Property methods: focalDeviceBuildValueArray(), focalDeviceCollectionToDisplay(), focalDeviceCollectionToOdbc(), focalDeviceDisplayToCollection(), focalDeviceGet(), focalDeviceGetObject(), focalDeviceGetObjectId(), focalDeviceGetSwizzled(), focalDeviceIsValid(), focalDeviceOdbcToCollection(), focalDeviceSet(), focalDeviceSetObject(), focalDeviceSetObjectId()
property followUp as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "followUp", XMLPROJECTION = "ELEMENT");
If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used.
Property methods: followUpBuildValueArray(), followUpCollectionToDisplay(), followUpCollectionToOdbc(), followUpDisplayToCollection(), followUpGet(), followUpGetObject(), followUpGetObjectId(), followUpGetSwizzled(), followUpIsValid(), followUpOdbcToCollection(), followUpSet(), followUpSetObject(), followUpSetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property notDone as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "notDone", XMLPROJECTION = "ELEMENT");
Set this to true if the record is saying that the procedure was NOT performed.
Property methods: notDoneGet(), notDoneGetSwizzled(), notDoneIsValid(), notDoneNewObject(), notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet(), notDoneSet()
property notDoneReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "notDoneReason", XMLPROJECTION = "ELEMENT");
A code indicating why the procedure was not performed.
Property methods: notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Any other notes about the procedure. E.g. the operative notes.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property outcome as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
The outcome of the procedure - did it resolve reasons for the procedure being performed?
Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property partOf as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
A larger event of which this particular procedure is a component or step.
Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performedDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "performedDateTime", XMLPROJECTION = "ELEMENT");
Property methods: performedDateTimeGet(), performedDateTimeGetSwizzled(), performedDateTimeIsValid(), performedDateTimeNewObject(), performedDateTimeSet()
property performedPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "performedPeriod", XMLPROJECTION = "ELEMENT");
Property methods: performedPeriodGet(), performedPeriodGetSwizzled(), performedPeriodIsValid(), performedPeriodNewObject(), performedPeriodSet()
property performer as list of HS.FHIR.vSTU3.Model.Resource.Procedure.Performer (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
Limited to 'real' people rather than equipment.
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
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");
The condition that is the reason why the procedure was performed.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property report as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "report", XMLPROJECTION = "ELEMENT");
This could be a histology result, pathology report, surgical report, etc..
Property methods: reportBuildValueArray(), reportCollectionToDisplay(), reportCollectionToOdbc(), reportDisplayToCollection(), reportGet(), reportGetObject(), reportGetObjectId(), reportGetSwizzled(), reportIsValid(), reportOdbcToCollection(), reportSet(), reportSetObject(), reportSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.EventStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
A code specifying the state of the procedure. Generally this will be in-progress or completed state.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
The person, animal or group on which the procedure was performed.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property usedCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "usedCode", XMLPROJECTION = "ELEMENT");
Identifies coded items that were used as part of the procedure.
Property methods: usedCodeBuildValueArray(), usedCodeCollectionToDisplay(), usedCodeCollectionToOdbc(), usedCodeDisplayToCollection(), usedCodeGet(), usedCodeGetObject(), usedCodeGetObjectId(), usedCodeGetSwizzled(), usedCodeIsValid(), usedCodeOdbcToCollection(), usedCodeSet(), usedCodeSetObject(), usedCodeSetObjectId()
property usedReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "usedReference", XMLPROJECTION = "ELEMENT");
Identifies medications, devices and any other substance used as part of the procedure.
Property methods: usedReferenceBuildValueArray(), usedReferenceCollectionToDisplay(), usedReferenceCollectionToOdbc(), usedReferenceDisplayToCollection(), usedReferenceGet(), usedReferenceGetObject(), usedReferenceGetObjectId(), usedReferenceGetSwizzled(), usedReferenceIsValid(), usedReferenceOdbcToCollection(), usedReferenceSet(), usedReferenceSetObject(), usedReferenceSetObjectId()

Methods

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.
Set 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 SetComplication(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 "complication" property.
deprecated method SetComplicationDetail(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 "complicationDetail" 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 SetFollowUp(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 "followUp" 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 SetLocation(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 "location" property.
deprecated method SetNotDone(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 "notDone" property.
deprecated method SetNotDoneReason(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 "notDoneReason" property.
deprecated method SetOutcome(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 "outcome" property.
deprecated method SetPartOf(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 "partOf" property.
deprecated method SetPerformedDateTime(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 "performedDateTime" property.
deprecated method SetPerformedPeriod(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 "performedPeriod" 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 SetReport(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 "report" 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 SetUsedCode(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 "usedCode" property.
deprecated method SetUsedReference(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 "usedReference" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab