| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
An action that is or was performed on a patient (e.g., a surgical procedure) or on behalf of a patient (e.g., a laboratory procedure). Note that this class contains a flag that indicates whether the procedure was completed; if it was not completed, the nonCompletionTimeFrame attribtue would contain the time that the procedure was originally scheduled to be completed. CIMI has a separate NonCompletionContext subclass, which the FHIM combines with the PerformanceContext in order to avoid multiple inheritance problems."An Act whose immediate and primary outcome (post-condition) is the alteration of the physical condition of the subject." - HL7 V3."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." - HL7 FHIR, Procedure
Attributes | ||
ActionProposed | basedOn |
"The proposal that is partly or wholly fulfilled by the performance of this act." - HL7 CIMI, Performance.basedOn"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn"A reference to a resource that contains details of the request for this procedure." - HL7 FHIR, Procedure.basedOn |
«CS» Code | bodySite |
"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion." - HL7 FHIR, Procedure.bodySite |
«CS» Code | complication |
"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." - HL7 FHIR, Procedure.complication |
HealthConcern | complicationDetail |
"Any complications that occurred during the procedure, or in the immediate post-performance period." - HL7 FHIR, Procedure.complicationDetail |
«PQ» TimeQuantity | duration |
The amount of time over which a long-term activity occurred. This optional property is only used for longer-duration activities, such as an hour-long counselling session."The duration of time the action was performed." - HL7 CIMI, Performance.duration |
ActionPlanned | enactsPlan |
"The plan that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Performance.enactsPlan"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn |
FocalDevice | focalDevice |
"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." - HL7 FHIR, Procedure.focalDevice |
«CS» Code | followUp |
"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." - HL7 FHIR, Procedure.followUp |
Order | fulfillsOrder |
"The order that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Performance.fulfillsOrder"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn"The original request, instruction or authority to perform the administration." - HL7 FHIR, MedicationAdministration.request"Indicates the medication order that is being dispensed against." - HL7 FHIR, MedicationDispense.authorizingPrescription"A reference to a resource that contains details of the request for this procedure." - HL7 FHIR, Procedure.basedOnPointer to the order which requested the surgical procedure. [FileMan 130,100] |
Promise | fulfillsPromise |
The "promise" that is partly or wholly enacted by the performance of this Act. Points to the Promise made in response to a Request (an Order) from an authorized entity (usually a doctor), which resulted in this Action Performed (aka Procedure). A Promise is an intent to perform a service that has the strength of a commitment, i.e., other parties may rely on the originator of such promise that said originator will see to it that the promised act will be fulfilled. The Promise can be looked at as the Order from the point of view of the entity performing the Action. In other words, the Promise is the Order from the filler's point of view."A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn |
«TS» PointInTime | nonCompletionTimeframe |
"The original scheduled time for the action planned for execution." - HL7 CIMI, NonCompletion.nonCompletionTimeframe |
«CS» Code | outcome |
"The outcome of the procedure - did it resolve the reasons for the procedure being performed?" - HL7 FHIR, Procedure.outcome |
ActionPerformed | partOf |
"A larger action of which this particular action is a component or step." - HL7 CIMI, Performance.partOf"A larger event of which this particular [Event sub-type] is a component or step." - HL7 FHIR, Event.partOf pattern."Part of this action." - HL7 FHIR, Communication.partOf"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationAdministration.partOf"The procedure that trigger the dispense." - HL7 FHIR, MedicationDispense.partOf"A larger event of which this particular procedure is a component or step." - HL7 FHIR, Procedure.partOf |
«IVL_TS» Period | performancePeriod |
The date/time or period over which the procedure was performed. For Specimen collection events, this is the date and time during which the specimen was taken from the source (e.g., the patient, or other entity such as a sample of pond water). This property is of type Period in order to handle collections that take place over a period of time. Note that FHIR uses a choice of dateTime, Period, string, Age, or Range for its datatype, while FHIM currently only handles dateTime or Period. Further elaboration will be needed to handle string, Age, or Range in other fields.The date that the surgical procedure was performed. [FileMan 130,.09]"The clinically relevant date/time of the observation. In the case of observations taken directly from a subject, it is the actual date and time the observation was obtained. In the case of a specimen associated study, this field shall represent the date and time the specimen was collected or obtained." - HL7 Version 2.8, OBR-7."Contains the end date and time of a study or timed specimen collection." - HL7 Version 2.8, OBR-8."This field is required in two circumstances. The first is when the observations reported beneath one report header have different dates/times. This could occur in the case of queries, timed test sequences, or clearance studies where one measurement within a battery may have a different time than another measurement.... The observation date-time is the physiologically relevant date-time or the closest approximation to that date-time. In the case of tests performed on specimens, the relevant date-time is the specimen’s collection date-time. In the case of observations taken directly on the patient (e.g., X-ray images, history and physical), the observation date-time is the date-time that the observation was performed." - HL7 Version 2.8, OBX-14."The date and time when the specimen was acquired from the source. The use of the Date Range data type allows for description of specimens collected over a period of time, for example, 24-hour urine collection. For specimens collected at a point in time, only the first component (start date/time) will be populated." - HL7 Version 2.8, SPM-17."Time of product collection." - HL7 FHIR, BiologicallyDerivedProduct.collection.collected[x]"The date, period or timing when the [Event sub-type] did occur or is occurring." - HL7 FHIR, Event.occurrence[x] pattern."Date vaccine administered or was to be administered." - HL7 FHIR, Immunization.date"A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate." - HL7 FHIR, MedicationAdministration.effective[x]"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." - HL7 FHIR, Procedure.performed[x]. Note that in FHIR, this property can be a dateTime, Period, string, Age, or Range; in the FHIM this is currently modeled only as a Period (which can handle dateTime)."Time when specimen was collected from subject - the physiologically relevant time." - HL7 FHIR, Specimen.collection.collected[x] |
Participation | performer |
Identifies the Entity that was principally responsible for the performance of the activity. In many cases this will be a clinician, but in other cases it may be the patient, a non-clinician care giver (e.g., the patient’s spouse), or an automated device."Identifies the person, department, or facility that collected the specimen." - HL7 Version 2.8, OBR-10"This field identifies the performing technician." - HL7 Version 2.8, OBR-34"This field contains the identifier of the individual directly responsible for the observation (i.e., the person who either performed or verified it). In a nursing service, the observer is usually the professional who performed the observation (e.g., took the blood pressure). In a laboratory, the observer is the technician who performed or verified the analysis...." - HL7 Version 2.8, OBX.16"Contains the provider ID of the person administering the pharmaceutical/treatment." - HL7 Version 2.8, RXA-10"The party that performed the action." - HL7 CIMI, Performance.performed"Healthcare professional who is performing the collection." - HL7 FHIR, BiologicallyDerivedProduct.collection.collector"Indicates who or what performed the event." - HL7 FHIR, Immunization.practitioner"Indicates who or what performed the medication administration and how they were involved." - HL7 FHIR, MedicationAdministration.performer"Limited to "real" people rather than equipment." - HL7 FHIR, Procedure.performer"Person who collected the specimen." - HL7 FHIR, Specimen.collection.collectorThe person who performs the major portion of the principal non-OR procedure. [FileMan 130,123] |
«CS» Code | procedureModifier |
Contains an optional modifier to further describe the procedure. Some coding systems employ combinations of procedure codes and modifiers, while others do not. This property accomodates those systems which do permit the use of a modifier.The Current Procedural Terminology (CPT) code modifier(s) corresponding with the principal surgical procedure. [FileMan 130,28] |
ClinicalDocument | report |
"This could be a histology result, pathology report, surgical report, etc." - HL7 FHIR, Procedure.report |
ResearchStudy | researchStudy |
"Indicates that this [Event sub-type] is relevant to the specified research study(ies)." - HL7 FHIR, Event.researchStudy pattern.This property is included for compatibility to FHIR. |
«CS» Code | status |
"A code specifying the state of the procedure. Generally, this will be the in-progress or completed state." Possible values are: Preparation; In Progress; Not Done; On Hold; Stopped; Completed; Entered in Error; Unknown - HL7 FHIR, Procedure.statusNote: In previous version of the FHIM, this class did not have a status, as logically the recordStatus property inherited from ClinicalStatement was considered to convey the concept of state. However, the value sets that represent the possible states are different, so this property has been re-introduced. It may eventually re-define the ClinicalStatement recordStatus property, or, more likely, the ClinicalStatement recordStatus property will be removed in favor of specific flavors of status in the various subtypes. |
«CS» Code | statusReason |
"Captures the reason for the current state of the [Event sub-type]." - HL7 FHIR, Event.statusReason pattern."Captures the reason for the current state of the [Request sub-type]." - HL7 FHIR, Request.statusReason pattern."Indicates the reason the immunization event was not performed." - HL7 FHIR, Immunization.statusReason"A code indicating why the administration was not performed." - HL7 FHIR, MedicationAdministration.statusReason"Captures the reason for the current state of the procedure." - HL7 FHIR, Procedure.statusReason |
Integer | timesPerformed |
Indicates the number of times this procedure was performed for the patient at one setting. Most procedures are only performed (and recorded) once; this property allows for the recording of multiple procedures in order to remove the necessity to record the same procedure multiple times. |
«CS» Code | topicCode |
This property exists to show that the Action (generally a procedure) that has been performed is handled using the topicCode property inherited from ClinicalStatement. This property is marked as derived in that it will generally not be implemented, or if it is, it would be re-defined such that the allowable set of values that this property can reference is limited to procedures.Contains a code indicating a procedure or a non-procedural event involving the patient. This code could come from various coding systems; typically the Common Procedure Terminology (CPT) is used, but other coding systems might be employed, especially to capture workload-related data."A code that identifies the specific service or action that was or is being performed." - HL7 FHIR, Event.code pattern."The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy")." - HL7 FHIR, Procedure.codeThe name of the principal procedure for this surgical case. All cases must have a principal procedure. [FileMan 130,26]The Current Procedural Terminology (CPT) code corresponding with the planned principal surgical procedure. [FileMan 130,27]"Procedure code." - PCORnet Common Data Model, Procedures_PX."Procedure code type." - PCORnet Common Data Model, Procedures_PX_Type. Possible values include: ICD-9-CM; ICD-10-PCS; ICD-11-PCS; CPT; HCPCS; LOINC; NDC; Revenue; No information; Unknown; Other. Note that in the FHIM, this is built in to the Code data type. |
«CS» Code | usedCode |
"Identifies coded items that were used as part of the procedure." - HL7 FHIR, Procedure.usedCode |
«ANY» Any | usedReference |
"Identifies medications, devices and any other substance used as part of the procedure." - HL7 FHIR, Procedure.usedReference |
Boolean | wasCompleted |
Attributes inherited from FHIM::Common::InformationEntry | ||
identifier |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | ActionPerformed |
Name Expression | |
Namespace | Common |
Owned Template Signature | |
Owner | Common |
Owning Template Parameter | |
Package | Common |
Qualified Name | FHIM::Common::ActionPerformed |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
Public ActionProposed basedOn
"The proposal that is partly or wholly fulfilled by the performance of this act." - HL7 CIMI, Performance.basedOn"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn"A reference to a resource that contains details of the request for this procedure." - HL7 FHIR, Procedure.basedOn
Aggregation | None |
Alias | |
Association | actionPerformed_basedOn |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | basedOn |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::basedOn |
Stereotype | |
Template Parameter | |
Type | ActionProposed |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code bodySite
"Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion." - HL7 FHIR, Procedure.bodySite
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | bodySite |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::bodySite |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code complication
"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." - HL7 FHIR, Procedure.complication
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | complication |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::complication |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public HealthConcern complicationDetail
"Any complications that occurred during the procedure, or in the immediate post-performance period." - HL7 FHIR, Procedure.complicationDetail
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | complicationDetail |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::complicationDetail |
Stereotype | |
Template Parameter | |
Type | HealthConcern |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «PQ» TimeQuantity duration
The amount of time over which a long-term activity occurred. This optional property is only used for longer-duration activities, such as an hour-long counselling session."The duration of time the action was performed." - HL7 CIMI, Performance.duration
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | duration |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::duration |
Stereotype | |
Template Parameter | |
Type | «PQ» TimeQuantity |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ActionPlanned enactsPlan
"The plan that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Performance.enactsPlan"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn
Aggregation | None |
Alias | |
Association | actionPerformed_enactsPlan |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | enactsPlan |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::enactsPlan |
Stereotype | |
Template Parameter | |
Type | ActionPlanned |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public FocalDevice focalDevice
"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." - HL7 FHIR, Procedure.focalDevice
Aggregation | None |
Alias | |
Association | actionPerformed_focalDevice |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | focalDevice |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::focalDevice |
Stereotype | |
Template Parameter | |
Type | FocalDevice |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code followUp
"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." - HL7 FHIR, Procedure.followUp
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | followUp |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::followUp |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Order fulfillsOrder
"The order that is partly or wholly enacted by the performance of this act." - HL7 CIMI, Performance.fulfillsOrder"A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn"The original request, instruction or authority to perform the administration." - HL7 FHIR, MedicationAdministration.request"Indicates the medication order that is being dispensed against." - HL7 FHIR, MedicationDispense.authorizingPrescription"A reference to a resource that contains details of the request for this procedure." - HL7 FHIR, Procedure.basedOnPointer to the order which requested the surgical procedure. [FileMan 130,100]
Aggregation | None |
Alias | |
Association | actionPerformed_fulfillsOrder |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | fulfillsOrder |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::fulfillsOrder |
Stereotype | |
Template Parameter | |
Type | Order |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Promise fulfillsPromise
The "promise" that is partly or wholly enacted by the performance of this Act. Points to the Promise made in response to a Request (an Order) from an authorized entity (usually a doctor), which resulted in this Action Performed (aka Procedure). A Promise is an intent to perform a service that has the strength of a commitment, i.e., other parties may rely on the originator of such promise that said originator will see to it that the promised act will be fulfilled. The Promise can be looked at as the Order from the point of view of the entity performing the Action. In other words, the Promise is the Order from the filler's point of view."A plan, proposal or order that is fulfilled in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.basedOn pattern."A plan, proposal or order that is fulfilled in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.basedOn pattern."An order, proposal or plan fulfilled in whole or in part by this Communication." - HL7 FHIR, Communication.basedOn"A plan or proposal that is fulfilled in whole or in part by this request." - HL7 FHIR, CommunicationRequest.basedOn
Aggregation | None |
Alias | |
Association | actionPerformed_fulfillsPromise |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | fulfillsPromise |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::fulfillsPromise |
Stereotype | |
Template Parameter | |
Type | Promise |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime nonCompletionTimeframe
"The original scheduled time for the action planned for execution." - HL7 CIMI, NonCompletion.nonCompletionTimeframe
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | nonCompletionTimeframe |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::nonCompletionTimeframe |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code outcome
"The outcome of the procedure - did it resolve the reasons for the procedure being performed?" - HL7 FHIR, Procedure.outcome
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | outcome |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::outcome |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public ActionPerformed partOf
"A larger action of which this particular action is a component or step." - HL7 CIMI, Performance.partOf"A larger event of which this particular [Event sub-type] is a component or step." - HL7 FHIR, Event.partOf pattern."Part of this action." - HL7 FHIR, Communication.partOf"A larger event of which this particular event is a component or step." - HL7 FHIR, MedicationAdministration.partOf"The procedure that trigger the dispense." - HL7 FHIR, MedicationDispense.partOf"A larger event of which this particular procedure is a component or step." - HL7 FHIR, Procedure.partOf
Aggregation | None |
Alias | |
Association | actionPerformed_partOf |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | partOf |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::partOf |
Stereotype | |
Template Parameter | |
Type | ActionPerformed |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «IVL_TS» Period performancePeriod
The date/time or period over which the procedure was performed. For Specimen collection events, this is the date and time during which the specimen was taken from the source (e.g., the patient, or other entity such as a sample of pond water). This property is of type Period in order to handle collections that take place over a period of time. Note that FHIR uses a choice of dateTime, Period, string, Age, or Range for its datatype, while FHIM currently only handles dateTime or Period. Further elaboration will be needed to handle string, Age, or Range in other fields.The date that the surgical procedure was performed. [FileMan 130,.09]"The clinically relevant date/time of the observation. In the case of observations taken directly from a subject, it is the actual date and time the observation was obtained. In the case of a specimen associated study, this field shall represent the date and time the specimen was collected or obtained." - HL7 Version 2.8, OBR-7."Contains the end date and time of a study or timed specimen collection." - HL7 Version 2.8, OBR-8."This field is required in two circumstances. The first is when the observations reported beneath one report header have different dates/times. This could occur in the case of queries, timed test sequences, or clearance studies where one measurement within a battery may have a different time than another measurement.... The observation date-time is the physiologically relevant date-time or the closest approximation to that date-time. In the case of tests performed on specimens, the relevant date-time is the specimen’s collection date-time. In the case of observations taken directly on the patient (e.g., X-ray images, history and physical), the observation date-time is the date-time that the observation was performed." - HL7 Version 2.8, OBX-14."The date and time when the specimen was acquired from the source. The use of the Date Range data type allows for description of specimens collected over a period of time, for example, 24-hour urine collection. For specimens collected at a point in time, only the first component (start date/time) will be populated." - HL7 Version 2.8, SPM-17."Time of product collection." - HL7 FHIR, BiologicallyDerivedProduct.collection.collected[x]"The date, period or timing when the [Event sub-type] did occur or is occurring." - HL7 FHIR, Event.occurrence[x] pattern."Date vaccine administered or was to be administered." - HL7 FHIR, Immunization.date"A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate." - HL7 FHIR, MedicationAdministration.effective[x]"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." - HL7 FHIR, Procedure.performed[x]. Note that in FHIR, this property can be a dateTime, Period, string, Age, or Range; in the FHIM this is currently modeled only as a Period (which can handle dateTime)."Time when specimen was collected from subject - the physiologically relevant time." - HL7 FHIR, Specimen.collection.collected[x]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | performancePeriod |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::performancePeriod |
Stereotype | |
Template Parameter | |
Type | «IVL_TS» Period |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Participation performer
Identifies the Entity that was principally responsible for the performance of the activity. In many cases this will be a clinician, but in other cases it may be the patient, a non-clinician care giver (e.g., the patient’s spouse), or an automated device."Identifies the person, department, or facility that collected the specimen." - HL7 Version 2.8, OBR-10"This field identifies the performing technician." - HL7 Version 2.8, OBR-34"This field contains the identifier of the individual directly responsible for the observation (i.e., the person who either performed or verified it). In a nursing service, the observer is usually the professional who performed the observation (e.g., took the blood pressure). In a laboratory, the observer is the technician who performed or verified the analysis...." - HL7 Version 2.8, OBX.16"Contains the provider ID of the person administering the pharmaceutical/treatment." - HL7 Version 2.8, RXA-10"The party that performed the action." - HL7 CIMI, Performance.performed"Healthcare professional who is performing the collection." - HL7 FHIR, BiologicallyDerivedProduct.collection.collector"Indicates who or what performed the event." - HL7 FHIR, Immunization.practitioner"Indicates who or what performed the medication administration and how they were involved." - HL7 FHIR, MedicationAdministration.performer"Limited to "real" people rather than equipment." - HL7 FHIR, Procedure.performer"Person who collected the specimen." - HL7 FHIR, Specimen.collection.collectorThe person who performs the major portion of the principal non-OR procedure. [FileMan 130,123]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | performer |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::performer |
Stereotype | |
Template Parameter | |
Type | Participation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code procedureModifier
Contains an optional modifier to further describe the procedure. Some coding systems employ combinations of procedure codes and modifiers, while others do not. This property accomodates those systems which do permit the use of a modifier.The Current Procedural Terminology (CPT) code modifier(s) corresponding with the principal surgical procedure. [FileMan 130,28]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | procedureModifier |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::procedureModifier |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public ClinicalDocument report
"This could be a histology result, pathology report, surgical report, etc." - HL7 FHIR, Procedure.report
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | report |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::report |
Stereotype | |
Template Parameter | |
Type | ClinicalDocument |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public ResearchStudy researchStudy
"Indicates that this [Event sub-type] is relevant to the specified research study(ies)." - HL7 FHIR, Event.researchStudy pattern.This property is included for compatibility to FHIR.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | researchStudy |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::researchStudy |
Stereotype | |
Template Parameter | |
Type | ResearchStudy |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code status
"A code specifying the state of the procedure. Generally, this will be the in-progress or completed state." Possible values are: Preparation; In Progress; Not Done; On Hold; Stopped; Completed; Entered in Error; Unknown - HL7 FHIR, Procedure.statusNote: In previous version of the FHIM, this class did not have a status, as logically the recordStatus property inherited from ClinicalStatement was considered to convey the concept of state. However, the value sets that represent the possible states are different, so this property has been re-introduced. It may eventually re-define the ClinicalStatement recordStatus property, or, more likely, the ClinicalStatement recordStatus property will be removed in favor of specific flavors of status in the various subtypes.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | status |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::status |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code statusReason
"Captures the reason for the current state of the [Event sub-type]." - HL7 FHIR, Event.statusReason pattern."Captures the reason for the current state of the [Request sub-type]." - HL7 FHIR, Request.statusReason pattern."Indicates the reason the immunization event was not performed." - HL7 FHIR, Immunization.statusReason"A code indicating why the administration was not performed." - HL7 FHIR, MedicationAdministration.statusReason"Captures the reason for the current state of the procedure." - HL7 FHIR, Procedure.statusReason
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | statusReason |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::statusReason |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public Integer timesPerformed
Indicates the number of times this procedure was performed for the patient at one setting. Most procedures are only performed (and recorded) once; this property allows for the recording of multiple procedures in order to remove the necessity to record the same procedure multiple times.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | timesPerformed |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::timesPerformed |
Stereotype | |
Template Parameter | |
Type | Integer |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «CS» Code topicCode
This property exists to show that the Action (generally a procedure) that has been performed is handled using the topicCode property inherited from ClinicalStatement. This property is marked as derived in that it will generally not be implemented, or if it is, it would be re-defined such that the allowable set of values that this property can reference is limited to procedures.Contains a code indicating a procedure or a non-procedural event involving the patient. This code could come from various coding systems; typically the Common Procedure Terminology (CPT) is used, but other coding systems might be employed, especially to capture workload-related data."A code that identifies the specific service or action that was or is being performed." - HL7 FHIR, Event.code pattern."The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy")." - HL7 FHIR, Procedure.codeThe name of the principal procedure for this surgical case. All cases must have a principal procedure. [FileMan 130,26]The Current Procedural Terminology (CPT) code corresponding with the planned principal surgical procedure. [FileMan 130,27]"Procedure code." - PCORnet Common Data Model, Procedures_PX."Procedure code type." - PCORnet Common Data Model, Procedures_PX_Type. Possible values include: ICD-9-CM; ICD-10-PCS; ICD-11-PCS; CPT; HCPCS; LOINC; NDC; Revenue; No information; Unknown; Other. Note that in the FHIM, this is built in to the Code data type.
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | true |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1..* |
Name | topicCode |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::topicCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «CS» Code usedCode
"Identifies coded items that were used as part of the procedure." - HL7 FHIR, Procedure.usedCode
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | usedCode |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::usedCode |
Stereotype | |
Template Parameter | |
Type | «CS» Code |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public «ANY» Any usedReference
"Identifies medications, devices and any other substance used as part of the procedure." - HL7 FHIR, Procedure.usedReference
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | * |
Name | usedReference |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::usedReference |
Stereotype | |
Template Parameter | |
Type | «ANY» Any |
Upper | * |
Upper Value | (*) |
Visibility | Public |
Public Boolean wasCompleted
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | ActionPerformed |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | wasCompleted |
Name Expression | |
Namespace | ActionPerformed |
Opposite | |
Owner | ActionPerformed |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Common::ActionPerformed::wasCompleted |
Stereotype | |
Template Parameter | |
Type | Boolean |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Common UML Documentation |
Summary:AttributesProperties | Detail:Attributes |