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
| Draft as of 2023-09-11 |
Definitions for the ProcedureAUCDI logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Procedure | |
| Definition | A clinical procedure is an intentional intervention to diagnose, treat or manage a health condition, often involving invasive or potentially harmful techniques requiring skin or mucosal penetration or tissue manipulation. |
| Short | Procedure AUCDI |
| Comments | Purpose To record details about a procedure that has been performed or carried out. Misuse
Considerations
|
| Control | 0..* |
| Is Modifier | false |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | procedure, Operation, Intervention, Surgery |
| 2. Procedure.Description | |
| Definition | @ internal @ |
| Short | Description |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Procedure.Description.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. Procedure.Description.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Procedure.Description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. Procedure.Description.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 10. Procedure.Description.Procedurename | |
| Definition | Identification of the procedure by name. |
| Short | Procedure name |
| Comments | Considerations It is strongly recommended that ‘Procedure name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate coded value is available. Example SNOMED CT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Operation name |
| 12. Procedure.Description.ProcedureDescription | |
| Definition | Narrative description about the procedure, as appropriate for the pathway step. |
| Short | Procedure Description |
| Comments | Considerations For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 14. Procedure.Description.Indication | |
| Definition | The clinical symptom, sign or diagnosis that necessitates the procedure. |
| Short | Indication |
| Comments | Considerations It is recommended that ‘Clinical indication’ be coded, where possible. Free text entry should only be permitted if no appropriate coded value is available. This data element has multiple occurrences to allow the recording of more than one clinical indication per procedure. Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Reason for procedure |
| 16. Procedure.Description.Method | |
| Definition | Identification of specific method or technique for the procedure. |
| Short | Method |
| Comments | Considerations Use this data element to record simple terms or a narrative description. If the requirements for recording the method require more complex modelling then this can be represented by additional archetypes within the 'Procedure detail' SLOT in this archetype. If the method is included in the 'Procedure name' via precoordinated codes, this data element becomes redundant. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 18. Procedure.Description.Urgency | |
| Definition | Urgency of the procedure. |
| Short | Urgency |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 20. Procedure.Description.Bodysite | |
| Definition | Identification of the body site for the procedure. |
| Short | Body site |
| Comments | Considerations Occurrences for this data element are unbounded to allow for clinical scenarios such as removing multiple skin lesions in different places, but where all of the other attributes are identical. Use this data element to record simple terms or precoordinated anatomical locations. If the requirements for recording the anatomical location are determined at run-time by the application or require more complex modelling such as relative locations then use the CLUSTER.anatomical_location or CLUSTER.relative_location within the 'Procedure detail' SLOT in this archetype. If the anatomical location is included in the 'Procedure name' via precoordinated codes, this data element becomes redundant. |
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| 22. Procedure.Description.Proceduredetail | |
| Definition | Structured information about the procedure. |
| Short | Procedure detail |
| Comments | Considerations Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 24. Procedure.Description.Outcome | |
| Definition | Outcome of procedure performed. |
| Short | Outcome |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 26. Procedure.Description.Proceduraldifficulty | |
| Definition | Difficulties or issues encountered during performance of the procedure. |
| Short | Procedural difficulty |
| Comments | Considerations Examples: The patient was agitated, insufficient emptying of the stomach before gastroscopy, a tumour in the bile ducts made it impossible to pass the scope through. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 28. Procedure.Description.Complication | |
| Definition | Details about any complication arising from the procedure. |
| Short | Complication |
| Comments | Considerations Use this data element to record simple terms or precoordinated complications. If the requirements for recording complication are more complex then use of a specific CLUSTER archetype within the 'Procedure detail' SLOT in this archetype is advised and this data element becomes redundant. Examples: Hematuria after a kidney biopsy, tissue irritation after insertion of intravenous catheter. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 30. Procedure.Description.Scheduleddatetime | |
| Definition | The date and/or time on which the procedure is intended to be performed. |
| Short | Scheduled date time |
| Comments | Considerations Only for use in association with the 'Procedure scheduled' pathway step. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 32. Procedure.Description.Finalenddatetime | |
| Definition | The date, and optional time, when the procedure was performed. |
| Short | Date performed |
| Comments | Considerations
|
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Date completed |
| 34. Procedure.Description.Multimedia | |
| Definition | Mulitimedia representation of a performed procedure. |
| Short | Multimedia |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 36. Procedure.Description.Proceduretype | |
| Definition | The type of procedure. |
| Short | Procedure type |
| Comments | Considerations This pragmatic data element may be used to support organisation within the user interface. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 38. Procedure.Description.Reason | |
| Definition | Reason that the activity or care pathway step for the identified procedure was carried out. |
| Short | Reason |
| Comments | Considerations For example: the reason for the cancellation or suspension of the procedure. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 40. Procedure.Description.Comment | |
| Definition | Additional narrative about the procedure not captured in other fields. |
| Short | Comment |
| Comments | Considerations None |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 42. Procedure.Description.Bodysite | |
| Definition | Identification of the body site for the procedure. |
| Short | Body site |
| Comments | Considerations
Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Anatomical location |
| 44. Procedure.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Procedure.Protocol.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 48. Procedure.Protocol.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Procedure.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 50. Procedure.Protocol.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists()) |
| 52. Procedure.Protocol.Requestororderidentifier | |
| Definition | The local ID assigned to the order by the healthcare provider or organisation requesting the service. |
| Short | Requestor order identifier |
| Comments | Considerations This is equivalent to Placer Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 54. Procedure.Protocol.Requestor | |
| Definition | Details about the healthcare provider or organisation requesting the service. |
| Short | Requestor |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
| 56. Procedure.Protocol.Receiverorderidentifier | |
| Definition | The ID assigned to the order by the healthcare provider or organisation receiving the request for service. This is also referred to as Filler Order Identifier. |
| Short | Receiver order identifier |
| Comments | Considerations This is equivalent to Filler Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 58. Procedure.Protocol.Receiver | |
| Definition | Details about the healthcare provider or organisation receiving the request for service. |
| Short | Receiver |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 60. Procedure.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Procedure | |
| Definition | A clinical procedure is an intentional intervention to diagnose, treat or manage a health condition, often involving invasive or potentially harmful techniques requiring skin or mucosal penetration or tissue manipulation. |
| Short | Procedure AUCDI |
| Comments | Purpose To record details about a procedure that has been performed or carried out. Misuse
Considerations
|
| Control | 0..* |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | Operation, Intervention, Surgery |
| 2. Procedure.Description | |
| Definition | @ internal @ |
| Short | Description |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| 4. Procedure.Description.Procedurename | |
| Definition | Identification of the procedure by name. |
| Short | Procedure name |
| Comments | Considerations It is strongly recommended that ‘Procedure name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate coded value is available. Example SNOMED CT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Operation name |
| 6. Procedure.Description.ProcedureDescription | |
| Definition | Narrative description about the procedure, as appropriate for the pathway step. |
| Short | Procedure Description |
| Comments | Considerations For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 8. Procedure.Description.Bodysite | |
| Definition | Identification of the body site for the procedure. |
| Short | Body site |
| Comments | Considerations
Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Anatomical location |
| 10. Procedure.Description.Indication | |
| Definition | The clinical symptom, sign or diagnosis that necessitates the procedure. |
| Short | Indication |
| Comments | Considerations It is recommended that ‘Clinical indication’ be coded, where possible. Free text entry should only be permitted if no appropriate coded value is available. This data element has multiple occurrences to allow the recording of more than one clinical indication per procedure. Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Reason for procedure |
| 12. Procedure.Description.Method | |
| Definition | Identification of specific method or technique for the procedure. |
| Short | Method |
| Comments | Considerations Use this data element to record simple terms or a narrative description. If the requirements for recording the method require more complex modelling then this can be represented by additional archetypes within the 'Procedure detail' SLOT in this archetype. If the method is included in the 'Procedure name' via precoordinated codes, this data element becomes redundant. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 14. Procedure.Description.Urgency | |
| Definition | Urgency of the procedure. |
| Short | Urgency |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 16. Procedure.Description.Proceduredetail | |
| Definition | Structured information about the procedure. |
| Short | Procedure detail |
| Comments | Considerations Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 18. Procedure.Description.Outcome | |
| Definition | Outcome of procedure performed. |
| Short | Outcome |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 20. Procedure.Description.Proceduraldifficulty | |
| Definition | Difficulties or issues encountered during performance of the procedure. |
| Short | Procedural difficulty |
| Comments | Considerations Examples: The patient was agitated, insufficient emptying of the stomach before gastroscopy, a tumour in the bile ducts made it impossible to pass the scope through. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 22. Procedure.Description.Complication | |
| Definition | Details about any complication arising from the procedure. |
| Short | Complication |
| Comments | Considerations Use this data element to record simple terms or precoordinated complications. If the requirements for recording complication are more complex then use of a specific CLUSTER archetype within the 'Procedure detail' SLOT in this archetype is advised and this data element becomes redundant. Examples: Hematuria after a kidney biopsy, tissue irritation after insertion of intravenous catheter. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 24. Procedure.Description.Scheduleddatetime | |
| Definition | The date and/or time on which the procedure is intended to be performed. |
| Short | Scheduled date time |
| Comments | Considerations Only for use in association with the 'Procedure scheduled' pathway step. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 26. Procedure.Description.Finalenddatetime | |
| Definition | The date, and optional time, when the procedure was performed. |
| Short | Date performed |
| Comments | Considerations
|
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Date completed |
| 28. Procedure.Description.Multimedia | |
| Definition | Mulitimedia representation of a performed procedure. |
| Short | Multimedia |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 30. Procedure.Description.Proceduretype | |
| Definition | The type of procedure. |
| Short | Procedure type |
| Comments | Considerations This pragmatic data element may be used to support organisation within the user interface. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 32. Procedure.Description.Reason | |
| Definition | Reason that the activity or care pathway step for the identified procedure was carried out. |
| Short | Reason |
| Comments | Considerations For example: the reason for the cancellation or suspension of the procedure. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 34. Procedure.Description.Comment | |
| Definition | Additional narrative about the procedure not captured in other fields. |
| Short | Comment |
| Comments | Considerations None |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 36. Procedure.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| 38. Procedure.Protocol.Requestororderidentifier | |
| Definition | The local ID assigned to the order by the healthcare provider or organisation requesting the service. |
| Short | Requestor order identifier |
| Comments | Considerations This is equivalent to Placer Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 40. Procedure.Protocol.Requestor | |
| Definition | Details about the healthcare provider or organisation requesting the service. |
| Short | Requestor |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
| 42. Procedure.Protocol.Receiverorderidentifier | |
| Definition | The ID assigned to the order by the healthcare provider or organisation receiving the request for service. This is also referred to as Filler Order Identifier. |
| Short | Receiver order identifier |
| Comments | Considerations This is equivalent to Filler Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 44. Procedure.Protocol.Receiver | |
| Definition | Details about the healthcare provider or organisation receiving the request for service. |
| Short | Receiver |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 46. Procedure.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Procedure | |
| Definition | A clinical procedure is an intentional intervention to diagnose, treat or manage a health condition, often involving invasive or potentially harmful techniques requiring skin or mucosal penetration or tissue manipulation. |
| Short | Procedure AUCDI |
| Comments | Purpose To record details about a procedure that has been performed or carried out. Misuse
Considerations
|
| Control | 0..* |
| Is Modifier | false |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | procedure, Operation, Intervention, Surgery |
| 2. Procedure.Description | |
| Definition | @ internal @ |
| Short | Description |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. Procedure.Description.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. Procedure.Description.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Procedure.Description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. Procedure.Description.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. Procedure.Description.Procedurename | |
| Definition | Identification of the procedure by name. |
| Short | Procedure name |
| Comments | Considerations It is strongly recommended that ‘Procedure name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate coded value is available. Example SNOMED CT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Operation name |
| 12. Procedure.Description.ProcedureDescription | |
| Definition | Narrative description about the procedure, as appropriate for the pathway step. |
| Short | Procedure Description |
| Comments | Considerations For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 14. Procedure.Description.Indication | |
| Definition | The clinical symptom, sign or diagnosis that necessitates the procedure. |
| Short | Indication |
| Comments | Considerations It is recommended that ‘Clinical indication’ be coded, where possible. Free text entry should only be permitted if no appropriate coded value is available. This data element has multiple occurrences to allow the recording of more than one clinical indication per procedure. Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Reason for procedure |
| 16. Procedure.Description.Method | |
| Definition | Identification of specific method or technique for the procedure. |
| Short | Method |
| Comments | Considerations Use this data element to record simple terms or a narrative description. If the requirements for recording the method require more complex modelling then this can be represented by additional archetypes within the 'Procedure detail' SLOT in this archetype. If the method is included in the 'Procedure name' via precoordinated codes, this data element becomes redundant. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 18. Procedure.Description.Urgency | |
| Definition | Urgency of the procedure. |
| Short | Urgency |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 20. Procedure.Description.Bodysite | |
| Definition | Identification of the body site for the procedure. |
| Short | Body site |
| Comments | Considerations Occurrences for this data element are unbounded to allow for clinical scenarios such as removing multiple skin lesions in different places, but where all of the other attributes are identical. Use this data element to record simple terms or precoordinated anatomical locations. If the requirements for recording the anatomical location are determined at run-time by the application or require more complex modelling such as relative locations then use the CLUSTER.anatomical_location or CLUSTER.relative_location within the 'Procedure detail' SLOT in this archetype. If the anatomical location is included in the 'Procedure name' via precoordinated codes, this data element becomes redundant. |
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| 22. Procedure.Description.Proceduredetail | |
| Definition | Structured information about the procedure. |
| Short | Procedure detail |
| Comments | Considerations Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 24. Procedure.Description.Outcome | |
| Definition | Outcome of procedure performed. |
| Short | Outcome |
| Comments | Considerations Coding with a terminology is preferred, where possible. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 26. Procedure.Description.Proceduraldifficulty | |
| Definition | Difficulties or issues encountered during performance of the procedure. |
| Short | Procedural difficulty |
| Comments | Considerations Examples: The patient was agitated, insufficient emptying of the stomach before gastroscopy, a tumour in the bile ducts made it impossible to pass the scope through. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 28. Procedure.Description.Complication | |
| Definition | Details about any complication arising from the procedure. |
| Short | Complication |
| Comments | Considerations Use this data element to record simple terms or precoordinated complications. If the requirements for recording complication are more complex then use of a specific CLUSTER archetype within the 'Procedure detail' SLOT in this archetype is advised and this data element becomes redundant. Examples: Hematuria after a kidney biopsy, tissue irritation after insertion of intravenous catheter. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 30. Procedure.Description.Scheduleddatetime | |
| Definition | The date and/or time on which the procedure is intended to be performed. |
| Short | Scheduled date time |
| Comments | Considerations Only for use in association with the 'Procedure scheduled' pathway step. |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 32. Procedure.Description.Finalenddatetime | |
| Definition | The date, and optional time, when the procedure was performed. |
| Short | Date performed |
| Comments | Considerations
|
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Date completed |
| 34. Procedure.Description.Multimedia | |
| Definition | Mulitimedia representation of a performed procedure. |
| Short | Multimedia |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 36. Procedure.Description.Proceduretype | |
| Definition | The type of procedure. |
| Short | Procedure type |
| Comments | Considerations This pragmatic data element may be used to support organisation within the user interface. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 38. Procedure.Description.Reason | |
| Definition | Reason that the activity or care pathway step for the identified procedure was carried out. |
| Short | Reason |
| Comments | Considerations For example: the reason for the cancellation or suspension of the procedure. |
| Control | 0..* |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 40. Procedure.Description.Comment | |
| Definition | Additional narrative about the procedure not captured in other fields. |
| Short | Comment |
| Comments | Considerations None |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 42. Procedure.Description.Bodysite | |
| Definition | Identification of the body site for the procedure. |
| Short | Body site |
| Comments | Considerations
Example SNOMED CT-AU:
|
| Control | 0..* |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Anatomical location |
| 44. Procedure.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 46. Procedure.Protocol.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 48. Procedure.Protocol.extension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
| Short | Additional content defined by implementations |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| Slicing | This element introduces a set of slices on Procedure.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 50. Procedure.Protocol.modifierExtension | |
| Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
| Short | Extensions that cannot be ignored even if unrecognized |
| Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
| Alternate Names | extensions, user content, modifiers |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 52. Procedure.Protocol.Requestororderidentifier | |
| Definition | The local ID assigned to the order by the healthcare provider or organisation requesting the service. |
| Short | Requestor order identifier |
| Comments | Considerations This is equivalent to Placer Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 54. Procedure.Protocol.Requestor | |
| Definition | Details about the healthcare provider or organisation requesting the service. |
| Short | Requestor |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
| 56. Procedure.Protocol.Receiverorderidentifier | |
| Definition | The ID assigned to the order by the healthcare provider or organisation receiving the request for service. This is also referred to as Filler Order Identifier. |
| Short | Receiver order identifier |
| Comments | Considerations This is equivalent to Filler Order Number in HL7 v2 specifications. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 58. Procedure.Protocol.Receiver | |
| Definition | Details about the healthcare provider or organisation receiving the request for service. |
| Short | Receiver |
| Control | 0..* |
| Type | Reference |
| Must Support | false |
| 60. Procedure.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents. |
| Control | 0..* |
| Type | Reference |
| Must Support | false |