Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.Procedure

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

An action that is being or was performed on a patient.

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

Person who asserts this procedure.

Patient | RelatedPerson | Practitioner | PractitionerRole

Property methods: asserterGet(), asserterGetSwizzled(), asserterIsValid(), asserterNewObject(), asserterSet()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

A request for this procedure.

CarePlan | ServiceRequest

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

Target body sites.

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

Classification of the procedure.

any FHIR4 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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Identification of the procedure.

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

Complication following the procedure.

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

Encounter created as part of.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property focalDevice as list of HS.FHIR.DTL.vR4.Model.Element.Procedure.focalDevice (XMLNAME = "focalDevice", XMLPROJECTION = "ELEMENT");
BackboneElement

Manipulated, implanted, or removed device.

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

Instructions for follow up.

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

Where the procedure happened.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property note as list of HS.FHIR.DTL.vR4.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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
CodeableConcept

The result of procedure.

any FHIR4 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.vR4.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 performedAge as HS.FHIR.DTL.vR4.Model.Datatype.Age (XMLNAME = "performedAge", XMLPROJECTION = "ELEMENT");
Age

When the procedure was performed.

Property methods: performedAgeGet(), performedAgeGetSwizzled(), performedAgeIsValid(), performedAgeNewObject(), performedAgeSet()
property performedDateTime as %String (MAXLEN = 1000000, XMLNAME = "performedDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the procedure was performed.

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

When the procedure was performed.

Property methods: performedPeriodGet(), performedPeriodGetSwizzled(), performedPeriodIsValid(), performedPeriodNewObject(), performedPeriodSet()
property performedRange as HS.FHIR.DTL.vR4.Model.Datatype.Range (XMLNAME = "performedRange", XMLPROJECTION = "ELEMENT");
Range

When the procedure was performed.

Property methods: performedRangeGet(), performedRangeGetSwizzled(), performedRangeIsValid(), performedRangeNewObject(), performedRangeSet()
property performedString as %String (MAXLEN = 1000000, XMLNAME = "performedString", XMLPROJECTION = "ATTRIBUTE");
string

When the procedure was performed.

Property methods: performedStringDisplayToLogical(), performedStringGet(), performedStringIsValid(), performedStringLogicalToDisplay(), performedStringLogicalToOdbc(), performedStringNormalize(), performedStringSet()
property performer as list of HS.FHIR.DTL.vR4.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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Coded reason procedure performed.

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

The justification that the procedure was performed.

Condition | Observation | Procedure | DiagnosticReport | DocumentReference

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

Who recorded the procedure.

Patient | RelatedPerson | Practitioner | PractitionerRole

Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property report as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "report", XMLPROJECTION = "ELEMENT");
Reference

Any report resulting from the procedure.

DiagnosticReport | DocumentReference | Composition

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 | not-done | on-hold | stopped | completed | entered-in-error | unknown

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

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

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIR.DTL.vR4.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.vR4.Model.Datatype.CodeableConcept (XMLNAME = "usedCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Coded items used during the procedure.

any FHIR4 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.vR4.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