HS.FHIRModel.R4.Procedure
class HS.FHIRModel.R4.Procedure extends HS.FHIRModel.FHIRClassSuper
******************************************* Procedure generated class schema
*****************************************
An action that is or was performed on or for a patient. This can be a physical intervention like an operation, or less invasive like long term services, counseling, or hypnotherapy.
Property Inventory
- _implicitRules
- _instantiatesUri
- _language
- _performedDateTime
- _performedString
- _status
- asserter
- basedOn
- bodySite
- category
- code
- complication
- complicationDetail
- contained
- encounter
- extension
- fhirID
- focalDevice
- followUp
- identifier
- implicitRules
- instantiatesCanonical
- instantiatesUri
- language
- location
- meta
- modifierExtension
- note
- outcome
- partOf
- performedAge
- performedDateTime
- performedPeriod
- performedRange
- performedString
- performer
- reasonCode
- reasonReference
- recorder
- report
- resourceType
- status
- statusReason
- subject
- text
- usedCode
- usedReference
Method Inventory
- IncludeAsserter()
- IncludeBasedOn()
- IncludeBodySite()
- IncludeCategory()
- IncludeCode()
- IncludeComplication()
- IncludeComplicationDetail()
- IncludeContained()
- IncludeEncounter()
- IncludeExtension()
- IncludeFocalDevice()
- IncludeFollowUp()
- IncludeIdentifier()
- IncludeInstantiatesCanonical()
- IncludeInstantiatesUri()
- IncludeLocation()
- IncludeMeta()
- IncludeModifierExtension()
- IncludeNote()
- IncludeOutcome()
- IncludePartOf()
- IncludePerformedAge()
- IncludePerformedPeriod()
- IncludePerformedRange()
- IncludePerformer()
- IncludeReasonCode()
- IncludeReasonReference()
- IncludeRecorder()
- IncludeReport()
- IncludeStatusReason()
- IncludeSubject()
- IncludeText()
- IncludeUsedCode()
- IncludeUsedReference()
- _getProperties()
- fromDao()
- toDao()
Parameters
parameter XMLTYPE = R4_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 _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _performedDateTime as HS.FHIRModel.R4.Element;
Extensions for performedDateTime
Property methods: _performedDateTimeGet(), _performedDateTimeGetSwizzled(), _performedDateTimeIsValid(), _performedDateTimeNewObject(), _performedDateTimeSet()
property _performedString as HS.FHIRModel.R4.Element;
Extensions for performedString
Property methods: _performedStringGet(), _performedStringGetSwizzled(), _performedStringIsValid(), _performedStringNewObject(), _performedStringSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property asserter as HS.FHIRModel.R4.Reference;
Individual who is making the procedure statement.
Property methods: asserterGet(), asserterGetSwizzled(), asserterIsValid(), asserterNewObject(), asserterSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
A reference to a resource that contains details of the request for
this procedure.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property bodySite as HS.FHIRModel.R4.SeqOfCodeableConcept;
Detailed and structured anatomical location information. Multiple
locations are allowed - e.g. multiple punch biopsies of a lesion.
Property methods: bodySiteGet(), bodySiteGetSwizzled(), bodySiteIsValid(), bodySiteNewObject(), bodySiteSet()
property category as HS.FHIRModel.R4.CodeableConcept;
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.FHIRModel.R4.CodeableConcept;
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 HS.FHIRModel.R4.SeqOfCodeableConcept;
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: complicationGet(), complicationGetSwizzled(), complicationIsValid(), complicationNewObject(), complicationSet()
property complicationDetail as HS.FHIRModel.R4.SeqOfReference;
Any complications that occurred during the procedure, or in the immediate
post-performance period.
Property methods: complicationDetailGet(), complicationDetailGetSwizzled(), complicationDetailIsValid(), complicationDetailNewObject(), complicationDetailSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the
resource that contains them - they cannot be identified independently,
and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property encounter as HS.FHIRModel.R4.Reference;
The Encounter during which this Procedure was created or performed
or to which the creation of this record is tightly associated.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource. To make the use of extensions
safe and manageable, there is a strict set of governance applied
to the definition and use of extensions. Though any implementer
can define an extension, there is a set of requirements that SHALL
be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource.
Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property focalDevice as HS.FHIRModel.R4.ProcedureX.SeqOfProcedureXFocalDevice;
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: focalDeviceGet(), focalDeviceGetSwizzled(), focalDeviceIsValid(), focalDeviceNewObject(), focalDeviceSet()
property followUp as HS.FHIRModel.R4.SeqOfCodeableConcept;
If the procedure required specific follow up - e.g. removal of sutures.
The follow up may be represented as a simple note or could potentially
be more complex, in which case the CarePlan resource can be used.
Property methods: followUpGet(), followUpGetSwizzled(), followUpIsValid(), followUpNewObject(), followUpSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Business identifiers assigned to this procedure by the performer
or other systems which remain constant as the resource is updated
and is propagated from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource
was constructed, and which must be understood when processing the
content. Often, this is a reference to an implementation guide that
defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiatesCanonical as HS.FHIRModel.R4.SeqOfString;
The URL pointing to a FHIR-defined protocol, guideline, order set
or other definition that is adhered to in whole or in part by this
Procedure.
Property methods: instantiatesCanonicalGet(), instantiatesCanonicalGetSwizzled(), instantiatesCanonicalIsValid(), instantiatesCanonicalNewObject(), instantiatesCanonicalSet()
property instantiatesUri as HS.FHIRModel.R4.SeqOfString;
The URL pointing to an externally maintained protocol, guideline,
order set or other definition that is adhered to in whole or in
part by this Procedure.
Property methods: instantiatesUriGet(), instantiatesUriGetSwizzled(), instantiatesUriIsValid(), instantiatesUriNewObject(), instantiatesUriSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property location as HS.FHIRModel.R4.Reference;
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 meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained
by the infrastructure. Changes to the content might not always be
associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part
of the basic definition of the resource and that modifies the understanding
of the element that contains it and/or the understanding of the
containing element's descendants. Usually modifier elements provide
negation or qualification. To make the use of extensions safe and
manageable, there is a strict set of governance applied to the definition
and use of extensions. Though any implementer is allowed to define
an extension, there is a set of requirements that SHALL be met as
part of the definition of the extension. Applications processing
a resource are required to check for modifier extensions. Modifier
extensions SHALL NOT change the meaning of any elements on Resource
or DomainResource (including cannot change the meaning of modifierExtension
itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
property note as HS.FHIRModel.R4.SeqOfAnnotation;
Any other notes and comments about the procedure.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property outcome as HS.FHIRModel.R4.CodeableConcept;
The outcome of the procedure - did it resolve the reasons for the
procedure being performed?
Property methods: outcomeGet(), outcomeGetSwizzled(), outcomeIsValid(), outcomeNewObject(), outcomeSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger event of which this particular procedure is a component
or step.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property performedAge as HS.FHIRModel.R4.Age;
Estimated or actual date, date-time, period, or age when the procedure
was performed. Allows a period to support complex procedures that
span more than one date, and also allows for the length of the procedure
to be captured.
Property methods: performedAgeGet(), performedAgeGetSwizzled(), performedAgeIsValid(), performedAgeNewObject(), performedAgeSet()
property performedDateTime as %String;
Estimated or actual date, date-time, period, or age when the procedure
was performed. Allows a period to support complex procedures that
span more than one date, and also allows for the length of the procedure
to be captured.
Property methods: performedDateTimeDisplayToLogical(), performedDateTimeGet(), performedDateTimeIsValid(), performedDateTimeLogicalToDisplay(), performedDateTimeLogicalToOdbc(), performedDateTimeNormalize(), performedDateTimeSet()
property performedPeriod as HS.FHIRModel.R4.Period;
Estimated or actual date, date-time, period, or age when the procedure
was performed. Allows a period to support complex procedures that
span more than one date, and also allows for the length of the procedure
to be captured.
Property methods: performedPeriodGet(), performedPeriodGetSwizzled(), performedPeriodIsValid(), performedPeriodNewObject(), performedPeriodSet()
property performedRange as HS.FHIRModel.R4.Range;
Estimated or actual date, date-time, period, or age when the procedure
was performed. Allows a period to support complex procedures that
span more than one date, and also allows for the length of the procedure
to be captured.
Property methods: performedRangeGet(), performedRangeGetSwizzled(), performedRangeIsValid(), performedRangeNewObject(), performedRangeSet()
property performedString as %String;
Estimated or actual date, date-time, period, or age when the procedure
was performed. Allows a period to support complex procedures that
span more than one date, and also allows for the length of the procedure
to be captured.
Property methods: performedStringDisplayToLogical(), performedStringGet(), performedStringIsValid(), performedStringLogicalToDisplay(), performedStringLogicalToOdbc(), performedStringNormalize(), performedStringSet()
property performer as HS.FHIRModel.R4.ProcedureX.SeqOfProcedureXPerformer;
Limited to "real" people rather than equipment.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
The coded reason why the procedure was performed. This may be a coded
entity of some type, or may simply be present as text.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
The justification of why the procedure was performed.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property recorder as HS.FHIRModel.R4.Reference;
Individual who recorded the record and takes responsibility for its
content.
Property methods: recorderGet(), recorderGetSwizzled(), recorderIsValid(), recorderNewObject(), recorderSet()
property report as HS.FHIRModel.R4.SeqOfReference;
This could be a histology result, pathology report, surgical report,
etc.
Property methods: reportGet(), reportGetSwizzled(), reportIsValid(), reportNewObject(), reportSet()
property resourceType as %String [ InitialExpression = "Procedure" , Required ];
This is a Procedure resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
A code specifying the state of the procedure. Generally, this will
be the in-progress or completed state.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
Captures the reason for the current state of the procedure.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
The person, animal or group on which the procedure was performed.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource
and can be used to represent the content of the resource to a human.
The narrative need not encode all the structured data, but is required
to contain sufficient detail to make it "clinically safe" for a
human to just read the narrative. Resource definitions may define
what content should be represented in the narrative to ensure clinical
safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()
property usedCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Identifies coded items that were used as part of the procedure.
Property methods: usedCodeGet(), usedCodeGetSwizzled(), usedCodeIsValid(), usedCodeNewObject(), usedCodeSet()
property usedReference as HS.FHIRModel.R4.SeqOfReference;
Identifies medications, devices and any other substance used as part
of the procedure.
Property methods: usedReferenceGet(), usedReferenceGetSwizzled(), usedReferenceIsValid(), usedReferenceNewObject(), usedReferenceSet()
Methods
method IncludeAsserter()
method IncludeBasedOn()
method IncludeBodySite()
method IncludeCategory()
method IncludeCode()
method IncludeComplication()
method IncludeComplicationDetail()
method IncludeContained()
method IncludeEncounter()
method IncludeExtension()
method IncludeFocalDevice()
method IncludeFollowUp()
method IncludeIdentifier()
method IncludeInstantiatesCanonical()
method IncludeInstantiatesUri()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOutcome()
method IncludePartOf()
method IncludePerformedAge()
method IncludePerformedPeriod()
method IncludePerformedRange()
method IncludePerformer()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRecorder()
method IncludeReport()
method IncludeStatusReason()
method IncludeSubject()
method IncludeText()
method IncludeUsedCode()
method IncludeUsedReference()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class
in the definition order that they were discovered in the
the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Procedure
method toDao() as %DynamicAbstractObject
Inherited description: >
The toDao() method casts the set to a DAO.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- add()
- addAll()
- apply()
- clear()
- contains()
- containsAll()
- get()
- iterator()
- put()
- putAll()
- putAllIfAbsent()
- putIfAbsent()
- remove()
- removeAll()
- removeIf()
- rename()
- replace()
- replaceAll()
- size()
- toString()