Common
Class ActionStatement

"A pattern to be followed by resources that represent the performance of some activity, possibly in accordance with a request or service definition." - HL7 FHIR, Event pattern.

Attributes
«CS» Code category category

"A code that classifies the procedure for searching, sorting and display purposes (e.g., Surgical Procedure)." - HL7 FHIR, Procedure.category

«CS» Code currentStatus currentStatus

"The latest recorded status of an action within the specified context. An action may be interpretable within a specific context such as whether it is planned, ordered, or performed. Moreover, within each of these contexts, an action may have a set of allowable states in which it can exist. For instance, a proposal may be rejected or an order may be signed, canceled or superceded by another order." - HL7 CIMI, ActionContext.currentStatus

The current state of the Substance Administration. Possible values include: Infusing, Given, Held, Completed, etc. "Status of treatment administration event. Refer to HL7 Table 0322 - Completion Status for valid values." - HL7 Version 2.8, RXA-20

"Indicates the current status of the vaccination event." - HL7 FHIR, Immunization.status
"Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way." - HL7 FHIR, MedicationAdministration.status
"A code specifying the state of the procedure. Generally this will be in-progress or completed state." - HL7 FHIR, Procedure.status

String description description

"An account of the procedure in narrative form." - HL7 CIMI, ProcedureTopic.description
"A sub-classification of an activity such as “wound care? which modifies the “patient instruction? classification." - HL7 Care Plan Domain Analysis Model.
"This provides a textual description of Terminologies on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc." - HL7 FHIR, CarePlan.activity.detail.description

«CS» Code indication indication

"Conditions or situations where the procedure is recommended." - HL7 CIMI, ProcedureTopic.indication

ClinicalStatement inputFinding inputFinding

"Patient findings expected for the performance of the specified procedure. For instance, an x-ray of a fracture prior to a surgical procedure for a bone fracture." - HL7 CIMI, ProcedureTopic.inputFinding

String instantiatesCanonical instantiatesCanonical

"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.instantiatesCanonical pattern.
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.instantiatesCanonical pattern.
"The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity." - HL7 FHIR, CarePlan.activity.detail.instantiatesCanonical
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." - HL7 FHIR, Communication.instantiatesCanonical
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder." - HL7 FHIR, NutritionOrder.instantiatesCanonical
"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." - HL7 FHIR, Procedure.instantiatesCanonical

String instantiatesUri instantiatesUri

"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.instantiatesUri pattern.
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.instantiatesUri pattern.
"The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity." - HL7 FHIR, CarePlan.activity.detail.instantiatesUri
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." - HL7 FHIR, Communication.instantiatesUri
"A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event." - HL7 FHIR, MedicationAdministration.instantiates
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder." - HL7 FHIR, NutritionOrder.instantiatesUri
"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." - HL7 FHIR, Procedure.instantiatesUri

Coverage insurance insurance

"Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service." - HL7 FHIR, Request.insurance pattern.
Note that in FHIR, the data type of this property could be a Coverage or a Claim Response. In the FHIM, this is currently modeled as a Coverage.

«CS» Code intent intent

"Indicates the level of authority/intentionality associated with the [Request sub-type] and where the request fits into the workflow chain."
Possible values are: Proposal; Plan; Directive; Order; Original Order; Reflex Order; Filler Order; Instance Order; Option. - HL7 FHIR, Request.intent pattern. Note that in the FHIM the distinction of the kind of action is largely handled by subtypes of the Action Statement class, so this property is not needed, except to distinguish between the kinds of orders (i.e., reflex order version filler order, etc.), so this property may be marked as derived in the future. In the meantime, while this property is required in FHIR, it is optional in the FHIM.

«CS» Code justification justification

"Reason the action was done or justification for the action. Reasons may also be specified for not performing an action." - HL7 CIMI, ActionContext.justification

ServiceDeliveryLocation location location

The location at which the procedure or action was performed or is planned to be performed. Note that the FHIM ServiceDeliveryLocation can refer to a medical facility or to a general location identified by mailing address or by geospatial coordinates. For example, actions performed at an automobile accident scene might reference geospatial coordinates. For inpatient situations, this location may be the room, bed, and/or ward at which the patient was located at the time of the action (e.g., medication administration, procedure).

"Contains the inpatient or outpatient location at which the drug or treatment was administered (if applicable)." - HL7 Version 2.8, RXA-11
"Specifies the location where the drug or treatment was administered." - HL7 Version 2.8, RXA-27

"Location where procedure was performed or is to be performed." - HL7 CIMI, ProcedureTopic.location
"The principal physical location where the [Event sub-type] was performed." - HL7 FHIR, Event.location pattern.
"The service delivery location where the vaccine administration occurred." - HL7 FHIR, Immunization.location
"The principal physical location where the dispense was performed." - HL7 FHIR, MedicationDispense.location
"The location where the procedure actually happened, e.g., a newborn at home, a tracheostomy at a restaurant." - HL7 FHIR, Procedure.location

«CS» Code method method

"Technique or way of accomplishing the act, e.g., endoscopic, arthroscopic, etc." - HL7 CIMI, ProcedureTopic.method

ClinicalStatement outputFinding outputFinding

"Patient findings documented during the performance of the procedure." - HL7 CIMI, ProcedureTopic.outputFinding

«CS» Code precondition precondition

"Patient state or condition that must be true prior to the performance of the procedure such as 'at rest', 'supine', 'fasting', etc." - HL7 CIMI, ProcedureTopic.precondition

«CS» Code reasonCode reasonCode

Indicates why the Action was proposed, proposed against, planned, ordered, promised, or performed. For Medication Administrations, this property indicates why the medication was given. Valid values in FHIR currently consist of only Given as ordered and Emergency, whereas in FHIM this property is expected to also provide a reason why a medication was administered when under a PRN* order (e.g., patient was in pain, patient was nauseous, etc.). [*PRN is an abbreviation for "pro re nata", a Latin phrase meaning "as the need arises." In a PRN order, the administration times (if any) are determined by the patient's needs].

"Describes why the [Event sub-type] occurred in coded or textual form." - HL7 FHIR, Event.reasonCode pattern.
"Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited." - HL7 FHIR, CarePlan.activity.detail.reasonCode
"Reasons why a vaccine was administered." - HL7 FHIR, Immunization.explanation.reason
"A code indicating why the medication was given." - HL7 FHIR, MedicationAdministration.reasonCode
"The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text." - HL7 FHIR, Procedure.reasonCode
"Describes why the request is being made in coded or textual form." - HL7 FHIR, Request.reasonCode pattern.

"This field contains a coded explanation of the reason for the order event described by the order control code " - HL7 Version 2.8, ORC-16

"The reason for performing this act." - HL7 CIMI, ProcedureTopic.reason

The reason that this surgical case was cancelled. [FileMan 130,18]. Possible values include:
* Patient Related Issue (e.g., patient did not follow pre-surgery instructions, patient chooses to cancel for any reason);
* Environmental Issue (OR availability impacted by e.g., air handling, electrical outage, emergency construction, weather causing OR hospital closure);
* Staff Issue (e.g., unavailable surgeon, anesthesia or nursing staff; no documented consent, provider cancels due to change in patient treatment plan);
* Patient Health Status (Provider cancels due to change in patient health status);
* More clinically urgent/emergent case superseded this scheduled case;
* Scheduling Issues Not Created By An Emergency Case (previous case overtime, case delayed, double booked, general time restrictions, administrative scheduling error);
* Unavailable Bed;
* Unavailable Equipment [excluding RME] (e.g., vendor, c-arm, implant, malfunctioning equipment);
* Unavailable Reusable Medical Equipment (RME) (includes defective packaging, damaged instruments or failure of Sterile Processing Services [SPS] to provide reprocessed equipment in a timely manner);
* Patient scheduled into an earlier date for surgery.

String reasonNarrative reasonNarrative

"This field contains the explanation (in text form) of the reason for the order event described by the order control code" - HL7 Version 2.8, ORC-16
Comments or additional information concerning why the surgical case was canceled. [FileMan 130,19]

«ANY» Any reasonReference reasonReference

"Indicates another resource whose existence justifies this [Event sub-type]." - HL7 FHIR, Event.reasonReference pattern.
"Indicates another resource whose existence justifies this request." - HL7 FHIR, Request.reasonReference pattern.
"Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan." - HL7 FHIR, CarePlan.activity.detail.reasonReference
"Indicates another resource whose existence justifies this communication." - HL7 FHIR, Communication.reasonReference
"Indicates another resource whose existence justifies this request." - HL7 FHIR, CommunicationRequest.reasonReference
"The justification of why the procedure was performed." - HL7 FHIR, Procedure.reasonReference

Provenance relevantHistory relevantHistory

"Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource." - HL7 FHIR, Request.relevantHistory pattern.
"A summary of the events of interest that have occurred, such as when the administration was verified." - HL7 FHIR, MedicationAdministration.eventHistory
"A summary of the events of interest that have occurred, such as when the dispense was verified." - HL7 FHIR, MedicationDispense.eventHistory

«CS» Code scope scope

"Indicates the scope or clinical setting where the context applies, e.g., Inpatient, outpatient, community." - HL7 CIMI, ActionContext.scope

InformationEntry supportingInformation supportingInformation

"Additional information that supports the performance, non-performance, ordering, or proposing of the clinical action, for example, the patient height and weight, or documentation of heart rate before administering the medication (in case medication needs to be held if heart rate falls in a specific range)." - HL7 CIMI, ActionContext.supportingInformation
"Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc." - HL7 FHIR, CarePlan.supportingInfo
"Information that may be needed by/relevant to the performer in their execution of this [Request sub-type]." - HL7 FHIR, Request.supportingInfo pattern.
"Additional information (for example, patient height and weight) that supports the administration of the medication." - HL7 FHIR, MedicationAdministration.supportingInformation
"Additional information that supports the medication being dispensed." - HL7 FHIR, MedicationDispense.supportingInformation

DeviceInstance usingDevice usingDevice

"The instrument or equipment utilized to execute an action" - HL7 CIMI, ProcedureTopic.usingDevice

Boolean wasReported wasReported

"Indicates if this record was captured as a secondary reported record rather than as an original primary source-of-truth record. It may also indicate the source of the report." - HL7 FHIR, Event.reported[x] pattern.
"Indicates if this record was captured as a secondary reported record rather than as an original primary source-of-truth record. It may also indicate the source of the report." - HL7 FHIR, Request.reported[x] pattern.
Note that this property can be a boolean or a pointer to a number of different resources in FHIR. In the FHIM, this property is currently modeled only as a boolean.

Attributes inherited from FHIM::Common::ClinicalStatement FHIM::Common::ClinicalStatement
clinicalDataSource clinicalDataSource, contentVersion contentVersion, contextCode contextCode, encounter encounter, note note, recordStatus recordStatus, relatedClinicalInformation relatedClinicalInformation, sourceRecordType sourceRecordType, sourceSystem sourceSystem, subjectGroup subjectGroup, subjectOfInformation subjectOfInformation, subjectOfRecord subjectOfRecord, temporalContext temporalContext, topicCode topicCode, cosigned cosigned, recorded recorded, signed signed, verified verified

Attributes inherited from FHIM::Common::InformationEntry FHIM::Common::InformationEntry
identifier identifier

Properties:

Alias
Classifier Behavior
Is Abstracttrue
Is Activefalse
Is Leaffalse
Keywords
NameActionStatement
Name Expression
NamespaceCommon
Owned Template Signature
OwnerCommon
Owning Template Parameter
PackageCommon
Qualified NameFHIM::Common::ActionStatement
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 category
Public «CS» Code category

"A code that classifies the procedure for searching, sorting and display purposes (e.g., Surgical Procedure)." - HL7 FHIR, Procedure.category

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Terminologies[
HL7_FHIR_R4 MedicationRequest Category Codes http://hl7.org/fhir/ValueSet/medicationrequest-category
,
HL7_FHIR_R4 MedicationRequest Course of Therapy Codes http://hl7.org/fhir/ValueSet/medicationrequest-course-of-therapy
,
HL7_FHIR_R4 Procedure Category Codes (SNOMED CT) http://hl7.org/fhir/ValueSet/procedure-category
,
HL7_FHIR_R4 Service Request Category Codes http://hl7.org/fhir/ValueSet/servicerequest-category
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namecategory
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::category
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 currentStatus
Public «CS» Code currentStatus

"The latest recorded status of an action within the specified context. An action may be interpretable within a specific context such as whether it is planned, ordered, or performed. Moreover, within each of these contexts, an action may have a set of allowable states in which it can exist. For instance, a proposal may be rejected or an order may be signed, canceled or superceded by another order." - HL7 CIMI, ActionContext.currentStatus

The current state of the Substance Administration. Possible values include: Infusing, Given, Held, Completed, etc. "Status of treatment administration event. Refer to HL7 Table 0322 - Completion Status for valid values." - HL7 Version 2.8, RXA-20

"Indicates the current status of the vaccination event." - HL7 FHIR, Immunization.status
"Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way." - HL7 FHIR, MedicationAdministration.status
"A code specifying the state of the procedure. Generally this will be in-progress or completed state." - HL7 FHIR, Procedure.status

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Terminologies[
HL7_V2 Treatment Completion Status (HL7) 2.16.840.1.114222.4.11.821
,
HL7_FHIR_R4 ImmunizationStatusCodes http://hl7.org/fhir/ValueSet/immunization-status
,
C-CDA_2.1 Act Status 2.16.840.1.113883.1.11.15933
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamecurrentStatus
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::currentStatus
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 description
Public String description

"An account of the procedure in narrative form." - HL7 CIMI, ProcedureTopic.description
"A sub-classification of an activity such as “wound care? which modifies the “patient instruction? classification." - HL7 Care Plan Domain Analysis Model.
"This provides a textual description of Terminologies on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc." - HL7 FHIR, CarePlan.activity.detail.description

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namedescription
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::description
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 indication
Public «CS» Code indication

"Conditions or situations where the procedure is recommended." - HL7 CIMI, ProcedureTopic.indication

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameindication
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::indication
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 inputFinding
Public ClinicalStatement inputFinding

"Patient findings expected for the performance of the specified procedure. For instance, an x-ray of a fracture prior to a surgical procedure for a bone fracture." - HL7 CIMI, ProcedureTopic.inputFinding

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameinputFinding
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::inputFinding
Stereotype
Template Parameter
TypeClinicalStatement
Upper*
Upper Value(*)
VisibilityPublic


 instantiatesCanonical
Public String instantiatesCanonical

"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.instantiatesCanonical pattern.
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.instantiatesCanonical pattern.
"The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity." - HL7 FHIR, CarePlan.activity.detail.instantiatesCanonical
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." - HL7 FHIR, Communication.instantiatesCanonical
"The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder." - HL7 FHIR, NutritionOrder.instantiatesCanonical
"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." - HL7 FHIR, Procedure.instantiatesCanonical

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameinstantiatesCanonical
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::instantiatesCanonical
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 instantiatesUri
Public String instantiatesUri

"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Event sub-type]." - HL7 FHIR, Event.instantiatesUri pattern.
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this [Request sub-type]." - HL7 FHIR, Request.instantiatesUri pattern.
"The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan activity." - HL7 FHIR, CarePlan.activity.detail.instantiatesUri
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication." - HL7 FHIR, Communication.instantiatesUri
"A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event." - HL7 FHIR, MedicationAdministration.instantiates
"The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this NutritionOrder." - HL7 FHIR, NutritionOrder.instantiatesUri
"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." - HL7 FHIR, Procedure.instantiatesUri

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameinstantiatesUri
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::instantiatesUri
Stereotype
Template Parameter
TypeString
Upper*
Upper Value(*)
VisibilityPublic


 insurance
Public Coverage insurance

"Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant in delivering the requested service." - HL7 FHIR, Request.insurance pattern.
Note that in FHIR, the data type of this property could be a Coverage or a Claim Response. In the FHIM, this is currently modeled as a Coverage.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameinsurance
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::insurance
Stereotype
Template Parameter
TypeCoverage
Upper*
Upper Value(*)
VisibilityPublic


 intent
Public «CS» Code intent

"Indicates the level of authority/intentionality associated with the [Request sub-type] and where the request fits into the workflow chain."
Possible values are: Proposal; Plan; Directive; Order; Original Order; Reflex Order; Filler Order; Instance Order; Option. - HL7 FHIR, Request.intent pattern. Note that in the FHIM the distinction of the kind of action is largely handled by subtypes of the Action Statement class, so this property is not needed, except to distinguish between the kinds of orders (i.e., reflex order version filler order, etc.), so this property may be marked as derived in the future. In the meantime, while this property is required in FHIR, it is optional in the FHIM.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Terminologies[
HL7_FHIR_R4 MedicationRequest Intent Codes http://hl7.org/fhir/ValueSet/medicationrequest-intent
,
HL7_FHIR_R4 RequestIntent http://hl7.org/fhir/ValueSet/request-intent
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Nameintent
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::intent
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 justification
Public «CS» Code justification

"Reason the action was done or justification for the action. Reasons may also be specified for not performing an action." - HL7 CIMI, ActionContext.justification

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Namejustification
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::justification
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 location
Public ServiceDeliveryLocation location

The location at which the procedure or action was performed or is planned to be performed. Note that the FHIM ServiceDeliveryLocation can refer to a medical facility or to a general location identified by mailing address or by geospatial coordinates. For example, actions performed at an automobile accident scene might reference geospatial coordinates. For inpatient situations, this location may be the room, bed, and/or ward at which the patient was located at the time of the action (e.g., medication administration, procedure).

"Contains the inpatient or outpatient location at which the drug or treatment was administered (if applicable)." - HL7 Version 2.8, RXA-11
"Specifies the location where the drug or treatment was administered." - HL7 Version 2.8, RXA-27

"Location where procedure was performed or is to be performed." - HL7 CIMI, ProcedureTopic.location
"The principal physical location where the [Event sub-type] was performed." - HL7 FHIR, Event.location pattern.
"The service delivery location where the vaccine administration occurred." - HL7 FHIR, Immunization.location
"The principal physical location where the dispense was performed." - HL7 FHIR, MedicationDispense.location
"The location where the procedure actually happened, e.g., a newborn at home, a tracheostomy at a restaurant." - HL7 FHIR, Procedure.location

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namelocation
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::location
Stereotype
Template Parameter
TypeServiceDeliveryLocation
Upper1
Upper Value(1)
VisibilityPublic


 method
Public «CS» Code method

"Technique or way of accomplishing the act, e.g., endoscopic, arthroscopic, etc." - HL7 CIMI, ProcedureTopic.method

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namemethod
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::method
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 outputFinding
Public ClinicalStatement outputFinding

"Patient findings documented during the performance of the procedure." - HL7 CIMI, ProcedureTopic.outputFinding

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameoutputFinding
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::outputFinding
Stereotype
Template Parameter
TypeClinicalStatement
Upper*
Upper Value(*)
VisibilityPublic


 precondition
Public «CS» Code precondition

"Patient state or condition that must be true prior to the performance of the procedure such as 'at rest', 'supine', 'fasting', etc." - HL7 CIMI, ProcedureTopic.precondition

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
Nameprecondition
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::precondition
Stereotype
Template Parameter
Type«CS» Code
Upper*
Upper Value(*)
VisibilityPublic


 reasonCode
Public «CS» Code reasonCode

Indicates why the Action was proposed, proposed against, planned, ordered, promised, or performed. For Medication Administrations, this property indicates why the medication was given. Valid values in FHIR currently consist of only Given as ordered and Emergency, whereas in FHIM this property is expected to also provide a reason why a medication was administered when under a PRN* order (e.g., patient was in pain, patient was nauseous, etc.). [*PRN is an abbreviation for "pro re nata", a Latin phrase meaning "as the need arises." In a PRN order, the administration times (if any) are determined by the patient's needs].

"Describes why the [Event sub-type] occurred in coded or textual form." - HL7 FHIR, Event.reasonCode pattern.
"Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited." - HL7 FHIR, CarePlan.activity.detail.reasonCode
"Reasons why a vaccine was administered." - HL7 FHIR, Immunization.explanation.reason
"A code indicating why the medication was given." - HL7 FHIR, MedicationAdministration.reasonCode
"The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text." - HL7 FHIR, Procedure.reasonCode
"Describes why the request is being made in coded or textual form." - HL7 FHIR, Request.reasonCode pattern.

"This field contains a coded explanation of the reason for the order event described by the order control code " - HL7 Version 2.8, ORC-16

"The reason for performing this act." - HL7 CIMI, ProcedureTopic.reason

The reason that this surgical case was cancelled. [FileMan 130,18]. Possible values include:
* Patient Related Issue (e.g., patient did not follow pre-surgery instructions, patient chooses to cancel for any reason);
* Environmental Issue (OR availability impacted by e.g., air handling, electrical outage, emergency construction, weather causing OR hospital closure);
* Staff Issue (e.g., unavailable surgeon, anesthesia or nursing staff; no documented consent, provider cancels due to change in patient treatment plan);
* Patient Health Status (Provider cancels due to change in patient health status);
* More clinically urgent/emergent case superseded this scheduled case;
* Scheduling Issues Not Created By An Emergency Case (previous case overtime, case delayed, double booked, general time restrictions, administrative scheduling error);
* Unavailable Bed;
* Unavailable Equipment [excluding RME] (e.g., vendor, c-arm, implant, malfunctioning equipment);
* Unavailable Reusable Medical Equipment (RME) (includes defective packaging, damaged instruments or failure of Sterile Processing Services [SPS] to provide reprocessed equipment in a timely manner);
* Patient scheduled into an earlier date for surgery.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Terminologies[
HL7_FHIR_R4 ImmunizationReasonCodes http://hl7.org/fhir/ValueSet/immunization-reason
,
HL7_FHIR_R4 Condition/Problem/Diagnosis Codes http://hl7.org/fhir/ValueSet/condition-code
,
HL7_FHIR_R4 MedicationRequest Status Reason Codes http://hl7.org/fhir/ValueSet/medicationrequest-status-reason
,
HL7_FHIR_R4 Procedure Reason Codes http://hl7.org/fhir/ValueSet/procedure-reason
,
HL7_FHIR_R4 SupplyRequestReason http://hl7.org/fhir/ValueSet/supplyrequest-reason
,
C-CDA_2.1 Problem 2.16.840.1.113883.3.88.12.3221.7.4
,
HL7_FHIR_R4 Clinical Findings http://hl7.org/fhir/ValueSet/clinical-findings
]
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereasonCode
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::reasonCode
StereotypeValueSetConstraints
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 reasonNarrative
Public String reasonNarrative

"This field contains the explanation (in text form) of the reason for the order event described by the order control code" - HL7 Version 2.8, ORC-16
Comments or additional information concerning why the surgical case was canceled. [FileMan 130,19]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamereasonNarrative
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::reasonNarrative
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 reasonReference
Public «ANY» Any reasonReference

"Indicates another resource whose existence justifies this [Event sub-type]." - HL7 FHIR, Event.reasonReference pattern.
"Indicates another resource whose existence justifies this request." - HL7 FHIR, Request.reasonReference pattern.
"Indicates another resource, such as the health condition(s), whose existence justifies this request and drove the inclusion of this particular activity as part of the plan." - HL7 FHIR, CarePlan.activity.detail.reasonReference
"Indicates another resource whose existence justifies this communication." - HL7 FHIR, Communication.reasonReference
"Indicates another resource whose existence justifies this request." - HL7 FHIR, CommunicationRequest.reasonReference
"The justification of why the procedure was performed." - HL7 FHIR, Procedure.reasonReference

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamereasonReference
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::reasonReference
Stereotype
Template Parameter
Type«ANY» Any
Upper*
Upper Value(*)
VisibilityPublic


 relevantHistory
Public Provenance relevantHistory

"Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource." - HL7 FHIR, Request.relevantHistory pattern.
"A summary of the events of interest that have occurred, such as when the administration was verified." - HL7 FHIR, MedicationAdministration.eventHistory
"A summary of the events of interest that have occurred, such as when the dispense was verified." - HL7 FHIR, MedicationDispense.eventHistory

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamerelevantHistory
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::relevantHistory
Stereotype
Template Parameter
TypeProvenance
Upper*
Upper Value(*)
VisibilityPublic


 scope
Public «CS» Code scope

"Indicates the scope or clinical setting where the context applies, e.g., Inpatient, outpatient, community." - HL7 CIMI, ActionContext.scope

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
Namescope
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::scope
Stereotype
Template Parameter
Type«CS» Code
Upper1
Upper Value(1)
VisibilityPublic


 supportingInformation
Public InformationEntry supportingInformation

"Additional information that supports the performance, non-performance, ordering, or proposing of the clinical action, for example, the patient height and weight, or documentation of heart rate before administering the medication (in case medication needs to be held if heart rate falls in a specific range)." - HL7 CIMI, ActionContext.supportingInformation
"Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc." - HL7 FHIR, CarePlan.supportingInfo
"Information that may be needed by/relevant to the performer in their execution of this [Request sub-type]." - HL7 FHIR, Request.supportingInfo pattern.
"Additional information (for example, patient height and weight) that supports the administration of the medication." - HL7 FHIR, MedicationAdministration.supportingInformation
"Additional information that supports the medication being dispensed." - HL7 FHIR, MedicationDispense.supportingInformation

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NamesupportingInformation
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::supportingInformation
Stereotype
Template Parameter
TypeInformationEntry
Upper*
Upper Value(*)
VisibilityPublic


 usingDevice
Public DeviceInstance usingDevice

"The instrument or equipment utilized to execute an action" - HL7 CIMI, ProcedureTopic.usingDevice

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity*
NameusingDevice
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::usingDevice
Stereotype
Template Parameter
TypeDeviceInstance
Upper*
Upper Value(*)
VisibilityPublic


 wasReported
Public Boolean wasReported

"Indicates if this record was captured as a secondary reported record rather than as an original primary source-of-truth record. It may also indicate the source of the report." - HL7 FHIR, Event.reported[x] pattern.
"Indicates if this record was captured as a secondary reported record rather than as an original primary source-of-truth record. It may also indicate the source of the report." - HL7 FHIR, Request.reported[x] pattern.
Note that this property can be a boolean or a pointer to a number of different resources in FHIR. In the FHIM, this property is currently modeled only as a boolean.

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassActionStatement
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamewasReported
Name Expression
NamespaceActionStatement
Opposite
OwnerActionStatement
Owning Association
Owning Template Parameter
Qualified NameFHIM::Common::ActionStatement::wasReported
Stereotype
Template Parameter
TypeBoolean
Upper1
Upper Value(1)
VisibilityPublic