Skip to main content

HS.FHIR.DTL.vSTU3.Model.Resource.Procedure

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

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.

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 = 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 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 = Procedure;
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 basedOn as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

A request for this procedure.

CarePlan | ProcedureRequest | ReferralRequest

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

Target body sites.

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

Classification of the procedure.

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

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property code as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Identification of the procedure.

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 complication as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "complication", XMLPROJECTION = "ELEMENT");
CodeableConcept

Complication following the procedure.

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

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

A condition that is a result of the procedure.

Condition

Property methods: complicationDetailBuildValueArray(), complicationDetailCollectionToDisplay(), complicationDetailCollectionToOdbc(), complicationDetailDisplayToCollection(), complicationDetailGet(), complicationDetailGetObject(), complicationDetailGetObjectId(), complicationDetailGetSwizzled(), complicationDetailIsValid(), complicationDetailOdbcToCollection(), complicationDetailSet(), complicationDetailSetObject(), complicationDetailSetObjectId()
property context as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter or episode associated with the procedure.

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

Instantiates protocol or definition.

PlanDefinition | ActivityDefinition | HealthcareService

Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property focalDevice as list of HS.FHIR.DTL.vSTU3.Model.Element.Procedure.focalDevice (XMLNAME = "focalDevice", XMLPROJECTION = "ELEMENT");
BackboneElement

Device changed in procedure.

Property methods: focalDeviceBuildValueArray(), focalDeviceCollectionToDisplay(), focalDeviceCollectionToOdbc(), focalDeviceDisplayToCollection(), focalDeviceGet(), focalDeviceGetObject(), focalDeviceGetObjectId(), focalDeviceGetSwizzled(), focalDeviceIsValid(), focalDeviceOdbcToCollection(), focalDeviceSet(), focalDeviceSetObject(), focalDeviceSetObjectId()
property followUp as list of HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "followUp", XMLPROJECTION = "ELEMENT");
CodeableConcept

Instructions for follow up.

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

Property methods: followUpBuildValueArray(), followUpCollectionToDisplay(), followUpCollectionToOdbc(), followUpDisplayToCollection(), followUpGet(), followUpGetObject(), followUpGetObjectId(), followUpGetSwizzled(), followUpIsValid(), followUpOdbcToCollection(), followUpSet(), followUpSetObject(), followUpSetObjectId()
property identifier as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Identifiers for this procedure.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property location as HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where the procedure happened.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property notDone as %Boolean (XMLNAME = "notDone", XMLPROJECTION = "ATTRIBUTE");
boolean

True if procedure was not performed as scheduled.

Property methods: notDoneDisplayToLogical(), notDoneGet(), notDoneIsValid(), notDoneLogicalToDisplay(), notDoneLogicalToXSD(), notDoneNormalize(), notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet(), notDoneSet(), notDoneXSDToLogical()
property notDoneReason as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "notDoneReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason procedure was not performed.

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

Property methods: notDoneReasonGet(), notDoneReasonGetSwizzled(), notDoneReasonIsValid(), notDoneReasonNewObject(), notDoneReasonSet()
property note as list of HS.FHIR.DTL.vSTU3.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Additional information about the procedure.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property outcome as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
CodeableConcept

The result of procedure.

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

Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property partOf as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of referenced event.

Procedure | Observation | MedicationAdministration

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performedDateTime as %String (MAXLEN = 1000000, XMLNAME = "performedDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

Date/Period the procedure was performed.

Property methods: performedDateTimeDisplayToLogical(), performedDateTimeGet(), performedDateTimeIsValid(), performedDateTimeLogicalToDisplay(), performedDateTimeLogicalToOdbc(), performedDateTimeNormalize(), performedDateTimeSet()
property performedPeriod as HS.FHIR.DTL.vSTU3.Model.Datatype.Period (XMLNAME = "performedPeriod", XMLPROJECTION = "ELEMENT");
Period

Date/Period the procedure was performed.

Property methods: performedPeriodGet(), performedPeriodGetSwizzled(), performedPeriodIsValid(), performedPeriodNewObject(), performedPeriodSet()
property performer as list of HS.FHIR.DTL.vSTU3.Model.Element.Procedure.performer (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
BackboneElement

The people who performed the procedure.

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

Coded reason procedure performed.

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

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

Condition that is the reason the procedure performed.

Condition | Observation

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

Any report resulting from the procedure.

DiagnosticReport

Property methods: reportBuildValueArray(), reportCollectionToDisplay(), reportCollectionToOdbc(), reportDisplayToCollection(), reportGet(), reportGetObject(), reportGetObjectId(), reportGetSwizzled(), reportIsValid(), reportOdbcToCollection(), reportSet(), reportSetObject(), reportSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown

event-status is the REQUIRED FHIR3 ValueSet for codes; you may NOT extend event-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

Who the procedure was performed on.

Patient | Group

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

Coded items used during the procedure.

any FHIR3 code may be used; device-kind shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: usedCodeBuildValueArray(), usedCodeCollectionToDisplay(), usedCodeCollectionToOdbc(), usedCodeDisplayToCollection(), usedCodeGet(), usedCodeGetObject(), usedCodeGetObjectId(), usedCodeGetSwizzled(), usedCodeIsValid(), usedCodeOdbcToCollection(), usedCodeSet(), usedCodeSetObject(), usedCodeSetObjectId()
property usedReference as list of HS.FHIR.DTL.vSTU3.Model.Base.Reference (XMLNAME = "usedReference", XMLPROJECTION = "ELEMENT");
Reference

Items used during procedure.

Device | Medication | Substance

Property methods: usedReferenceBuildValueArray(), usedReferenceCollectionToDisplay(), usedReferenceCollectionToOdbc(), usedReferenceDisplayToCollection(), usedReferenceGet(), usedReferenceGetObject(), usedReferenceGetObjectId(), usedReferenceGetSwizzled(), usedReferenceIsValid(), usedReferenceOdbcToCollection(), usedReferenceSet(), usedReferenceSetObject(), usedReferenceSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab