Sparked Logical Models
0.0.1 - CI Build
Australia (AUS)
Sparked Logical Models, published by CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/logical-model-web/ and changes regularly. See the Directory of published versions
Official URL: https://aehrc.csiro.au/fhir/logical-models/Procedure | Version: 0.0.1 | |||
Draft as of 2023-09-11 | Computable Name: Procedure | |||
Other Identifiers: https://aehrc.csiro.au/id/archetype_id#openEHR-EHR-ACTION.procedure.v1 | ||||
Keywords: core |
The Procedure Logical Model Mindmap is shown below.
A clinical activity carried out for screening, investigative, diagnostic, curative, therapeutic, evaluative or palliative purposes.
Purpose
To record information about the activities required to carry out a procedure, including the planning, scheduling, performance, suspension, cancellation, documentation and completion.
Misuse
Not to be used to record details about the anaesthetic - use a separate ACTION archetype for this purpose.
Not to be used to record details about imaging investigations - use ACTION.imaging_exam for this purpose.
Not to be used to record details about laboratory investigations - use ACTION.laboratory_test for this purpose.
Not to be used to record details about education delivered - use ACTION.health_education for this purpose.
Not to be used to record details about administrative activities - use specific ADMIN archetypes for this purpose.
Not to be used to record details about related activities such as the use of frozen sections taken during an operation, medication administered as part of the procedure or when imaging guidance is used during the procedure - use separate and specific ACTION archetypes within the same template for this purpose .
Not to be used to record a whole operation or procedure report - use a template in which this archetype is only one component of the full report.
Considerations
Use to record information about the activities required to carry out a procedure, including the planning, scheduling, performance, suspension, cancellation, documentation and completion. This is done by the recording of data against specific activities, as defined by the 'Pathway' careflow steps in this archetype.
The scope of this archetype encompasses activities for a broad range of clinical procedures performed for evaluative, investigative, screening, diagnostic, curative, therapeutic or palliative purposes. Examples range from the relatively simple activities, such as insertion of an intravenous cannula, through to complex surgical operations.
Additional structured and detailed information about the procedure can be captured using purpose-specific archetypes inserted into the 'Procedure detail' slot, where required.
Timings related to a procedure can be managed in one of two ways:
Within the context of an Operation Report, this archetype will be used to record only what was done during the procedure. Separate archetypes will be used to record the other required components of the Operation Report, including the taking of tissue specimen samples, use of imaging guidance, operation findings, post-operative instructions and plans for follow up.
Within the context of a Problem list or summary, this archetype may be used to represent procedures that have been performed. The EVALUATION.problem_diagnosis will be used to represent the patient's problems and diagnoses.
In practice, many procedures (for example, in ambulatory care) will occur once and not be ordered in advance. The details about the procedure will be added against the pathway step, 'Procedure completed'. In some cases a recurring procedure will be ordered, and in this situation data against the 'Procedure performed' step will be recorded on each occasion, leaving the instruction in the active state. When the last occurrence is recorded the 'Procedure completed' action is recorded showing that this order is now in the completed state.
In other situations, such as secondary care, there may be a formal order for a procedure using a corresponding INSTRUCTION archetype. This ACTION archetype can then be used to record the workflow of when and how the order has been carried out.
Recording information using this ACTION archetype indicates that some sort of activity has actually occurred; this will usually be the procedure itself but may be a failed attempt or another activity such as postponing the procedure. If there is a formal order for the procedure, the state of this order is represented by the Pathway step against which the data is recorded. For example, using this archetype the progressing state of a Gastroscopy order may be recorded through separate entries in the EHR progress notes at each 'Pathway' step:
Please note that in the openEHR Reference Model there is a 'Time' attribute, which is intended to record the date and time at which each pathway step of the Action was performed. This is the attribute to use to record the start of the procedure (using the 'Procedure performed' pathway step) or the time that the procedure was aborted (using the 'Procedure aborted' pathway step).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
This structure is derived from Base
Differential View
This structure is derived from Base
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | S | 0..* | Base | Procedure Instances of this logical model are not marked to be the target of a Reference |
Description | S | 0..1 | BackboneElement | Description |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Procedurename | S | 1..1 | CodeableConcept | Procedure name |
ProcedureDescription | S | 0..1 | string | Procedure Description |
Indication | S | 0..* | CodeableConcept | Indication |
Method | S | 0..* | string | Method |
Urgency | S | 0..1 | string | Urgency |
Bodysite | S | 0..* | CodeableConcept | Body site |
Proceduredetail | S | 0..* | Reference() | Procedure detail |
Outcome | S | 0..* | string | Outcome |
Proceduraldifficulty | S | 0..* | string | Procedural difficulty |
Complication | S | 0..* | string | Complication |
Scheduleddatetime | S | 0..1 | dateTime | Scheduled date time |
Finalenddatetime | S | 0..1 | dateTime | Final end date time |
Multimedia | S | 0..* | Reference() | Multimedia |
Proceduretype | S | 0..1 | string | Procedure type |
Reason | S | 0..* | string | Reason |
Comment | S | 0..1 | string | Comment |
Protocol | S | 0..1 | BackboneElement | Protocol |
@id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
Requestororderidentifier | S | 0..1 | string | Requestor order identifier |
Requestor | S | 0..1 | Reference() | Requestor |
Receiverorderidentifier | S | 0..1 | string | Receiver order identifier |
Receiver | S | 0..* | Reference() | Receiver |
Extension | S | 0..* | Reference() | Extension |
Documentation for this format |
This structure is derived from Base