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

Logical Model: ProcedureAUCDI - Detailed Descriptions

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.

ShortProcedure AUCDI
Comments

Purpose

To record details about a procedure that has been performed or carried out.

Misuse

  • Not to be used to record vaccination administration – use the ‘Vaccination administration’ data group for this purpose.
  • Not to be used to record problem/diagnosis – use the ‘Problem/Diagnosis Summary’ data group for this purpose.
  • Not to be used to record information about imaging service events – a specific data model for this purpose will be developed in a future release of AUCDI.
  • Not to be used to record non-invasive procedure events found in some terminology coding hierarchies, such as patient transportation, day care services, home modification or exercise.

Considerations

  • Significant procedures can be persisted within a curated Procedure or Surgical History list (or similar).
  • In future updates, it is anticipated this data group will be extended to incorporate additional detail.
Control0..*
Is Modifierfalse
Must Supporttrue
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Alternate Namesprocedure, Operation, Intervention, Surgery
2. Procedure.Description
Definition

@ internal @

ShortDescription
Control0..1
TypeBackboneElement
Must Supportfalse
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

ShortAdditional 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.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-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())
SlicingThis element introduces a set of slices on Procedure.Description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 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).

    ShortExtensions 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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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 Namesextensions, user content, modifiers
    Invariantsele-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.

    ShortProcedure 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:

    • 232722009|Coronary artery bypass grafts x 4|
    • 312681000|Bone density scan|
    • 239592001|Forefoot amputation|
    • 34309001|Drainage of tonsil|
    • 307998000|Excision of pigmented skin lesion|
    • 428923005|Radiotherapy to breast|
    Control1..1
    TypeCodeableConcept
    Must Supporttrue
    Alternate NamesOperation name
    12. Procedure.Description.ProcedureDescription
    Definition

    Narrative description about the procedure, as appropriate for the pathway step.

    ShortProcedure Description
    Comments

    Considerations

    For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure.

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    14. Procedure.Description.Indication
    Definition

    The clinical symptom, sign or diagnosis that necessitates the procedure.

    ShortIndication
    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:

    • 4557003|Unstable angina|
    • 59848001|Obstructive jaundice|
    • 46635009|Diabetes Mellitus Type 1|
    • 33261009|Abscess of tonsil|
    • 80201000119103|Atypical pigmented lesion|
    • 289916006|Family history of kidney disease|
    • 772150003|Diphtheria suspected|
    • 422181004|Antibiotic prophylaxis|
    • 274920002|Jellyfish sting|
    Control0..*
    TypeCodeableConcept
    Must Supporttrue
    Alternate NamesReason for procedure
    16. Procedure.Description.Method
    Definition

    Identification of specific method or technique for the procedure.

    ShortMethod
    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.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    18. Procedure.Description.Urgency
    Definition

    Urgency of the procedure.

    ShortUrgency
    Comments

    Considerations

    Coding with a terminology is preferred, where possible.

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    20. Procedure.Description.Bodysite
    Definition

    Identification of the body site for the procedure.

    ShortBody 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.

    Control0..*
    TypeCodeableConcept
    Must Supporttrue
    22. Procedure.Description.Proceduredetail
    Definition

    Structured information about the procedure.

    ShortProcedure detail
    Comments

    Considerations

    Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc.

    Control0..*
    TypeReference
    Must Supportfalse
    24. Procedure.Description.Outcome
    Definition

    Outcome of procedure performed.

    ShortOutcome
    Comments

    Considerations

    Coding with a terminology is preferred, where possible.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    26. Procedure.Description.Proceduraldifficulty
    Definition

    Difficulties or issues encountered during performance of the procedure.

    ShortProcedural 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.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    28. Procedure.Description.Complication
    Definition

    Details about any complication arising from the procedure.

    ShortComplication
    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.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    30. Procedure.Description.Scheduleddatetime
    Definition

    The date and/or time on which the procedure is intended to be performed.

    ShortScheduled date time
    Comments

    Considerations

    Only for use in association with the 'Procedure scheduled' pathway step.

    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    32. Procedure.Description.Finalenddatetime
    Definition

    The date, and optional time, when the procedure was performed.

    ShortDate performed
    Comments

    Considerations

    • Partial dates are permitted.
    • For example:
      • 2015
      • February 2015
      • 7 February 2015
      • 7 February 2015, 1:28 pm
      • 2015-02-07T13:28:17-05:00
    Control0..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Alternate NamesDate completed
    34. Procedure.Description.Multimedia
    Definition

    Mulitimedia representation of a performed procedure.

    ShortMultimedia
    Control0..*
    TypeReference
    Must Supportfalse
    36. Procedure.Description.Proceduretype
    Definition

    The type of procedure.

    ShortProcedure type
    Comments

    Considerations

    This pragmatic data element may be used to support organisation within the user interface.

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    38. Procedure.Description.Reason
    Definition

    Reason that the activity or care pathway step for the identified procedure was carried out.

    ShortReason
    Comments

    Considerations

    For example: the reason for the cancellation or suspension of the procedure.

    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    40. Procedure.Description.Comment
    Definition

    Additional narrative about the procedure not captured in other fields.

    ShortComment
    Comments

    Considerations

    None

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Alternate NamesNote
    42. Procedure.Description.Bodysite
    Definition

    Identification of the body site for the procedure.

    ShortBody site
    Comments

    Considerations

    • Specification of ‘Body site/laterality’ is recommended when it is necessary to provide additional clarity about the Procedure and the ‘Procedure name’ does not include or imply a specific body site.
    • This data element has multiple occurrences to allow the recording of more than one body site for each named procedure – for example, to record multiple related skin sites requiring excision of pigmented lesions in one procedure.
    • It is strongly recommended that the ‘Body site/laterality’ be coded with a terminology, where possible. Free text entry should only be permitted if no appropriate coded value is available.

    Example

    SNOMED CT-AU:

    • 761920005|Bone structure of shaft of right humerus|
    • 51636004|Left ankle|
    • 38033009|Amputation stump|
    • 110501003|Upper outer quadrant of left breast|
    Control0..*
    TypeCodeableConcept
    Must Supporttrue
    Alternate NamesAnatomical location
    44. Procedure.Protocol
    Definition

    @ internal @

    ShortProtocol
    Control0..1
    TypeBackboneElement
    Must Supportfalse
    Invariantsele-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.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    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.

    ShortAdditional 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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    SlicingThis element introduces a set of slices on Procedure.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 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).

      ShortExtensions 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.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      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 Namesextensions, user content, modifiers
      Invariantsele-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.

      ShortRequestor order identifier
      Comments

      Considerations

      This is equivalent to Placer Order Number in HL7 v2 specifications.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      54. Procedure.Protocol.Requestor
      Definition

      Details about the healthcare provider or organisation requesting the service.

      ShortRequestor
      Control0..1
      TypeReference
      Must Supportfalse
      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.

      ShortReceiver order identifier
      Comments

      Considerations

      This is equivalent to Filler Order Number in HL7 v2 specifications.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      58. Procedure.Protocol.Receiver
      Definition

      Details about the healthcare provider or organisation receiving the request for service.

      ShortReceiver
      Control0..*
      TypeReference
      Must Supportfalse
      60. Procedure.Protocol.Extension
      Definition

      Additional information required to capture local content or to align with other reference models/formalisms.

      ShortExtension
      Comments

      Considerations

      For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents.

      Control0..*
      TypeReference
      Must Supportfalse

      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.

      ShortProcedure AUCDI
      Comments

      Purpose

      To record details about a procedure that has been performed or carried out.

      Misuse

      • Not to be used to record vaccination administration – use the ‘Vaccination administration’ data group for this purpose.
      • Not to be used to record problem/diagnosis – use the ‘Problem/Diagnosis Summary’ data group for this purpose.
      • Not to be used to record information about imaging service events – a specific data model for this purpose will be developed in a future release of AUCDI.
      • Not to be used to record non-invasive procedure events found in some terminology coding hierarchies, such as patient transportation, day care services, home modification or exercise.

      Considerations

      • Significant procedures can be persisted within a curated Procedure or Surgical History list (or similar).
      • In future updates, it is anticipated this data group will be extended to incorporate additional detail.
      Control0..*
      Must Supporttrue
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      Alternate NamesOperation, Intervention, Surgery
      2. Procedure.Description
      Definition

      @ internal @

      ShortDescription
      Control0..1
      TypeBackboneElement
      Must Supportfalse
      4. Procedure.Description.Procedurename
      Definition

      Identification of the procedure by name.

      ShortProcedure 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:

      • 232722009|Coronary artery bypass grafts x 4|
      • 312681000|Bone density scan|
      • 239592001|Forefoot amputation|
      • 34309001|Drainage of tonsil|
      • 307998000|Excision of pigmented skin lesion|
      • 428923005|Radiotherapy to breast|
      Control1..1
      TypeCodeableConcept
      Must Supporttrue
      Alternate NamesOperation name
      6. Procedure.Description.ProcedureDescription
      Definition

      Narrative description about the procedure, as appropriate for the pathway step.

      ShortProcedure Description
      Comments

      Considerations

      For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      8. Procedure.Description.Bodysite
      Definition

      Identification of the body site for the procedure.

      ShortBody site
      Comments

      Considerations

      • Specification of ‘Body site/laterality’ is recommended when it is necessary to provide additional clarity about the Procedure and the ‘Procedure name’ does not include or imply a specific body site.
      • This data element has multiple occurrences to allow the recording of more than one body site for each named procedure – for example, to record multiple related skin sites requiring excision of pigmented lesions in one procedure.
      • It is strongly recommended that the ‘Body site/laterality’ be coded with a terminology, where possible. Free text entry should only be permitted if no appropriate coded value is available.

      Example

      SNOMED CT-AU:

      • 761920005|Bone structure of shaft of right humerus|
      • 51636004|Left ankle|
      • 38033009|Amputation stump|
      • 110501003|Upper outer quadrant of left breast|
      Control0..*
      TypeCodeableConcept
      Must Supporttrue
      Alternate NamesAnatomical location
      10. Procedure.Description.Indication
      Definition

      The clinical symptom, sign or diagnosis that necessitates the procedure.

      ShortIndication
      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:

      • 4557003|Unstable angina|
      • 59848001|Obstructive jaundice|
      • 46635009|Diabetes Mellitus Type 1|
      • 33261009|Abscess of tonsil|
      • 80201000119103|Atypical pigmented lesion|
      • 289916006|Family history of kidney disease|
      • 772150003|Diphtheria suspected|
      • 422181004|Antibiotic prophylaxis|
      • 274920002|Jellyfish sting|
      Control0..*
      TypeCodeableConcept
      Must Supporttrue
      Alternate NamesReason for procedure
      12. Procedure.Description.Method
      Definition

      Identification of specific method or technique for the procedure.

      ShortMethod
      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.

      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      14. Procedure.Description.Urgency
      Definition

      Urgency of the procedure.

      ShortUrgency
      Comments

      Considerations

      Coding with a terminology is preferred, where possible.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      16. Procedure.Description.Proceduredetail
      Definition

      Structured information about the procedure.

      ShortProcedure detail
      Comments

      Considerations

      Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc.

      Control0..*
      TypeReference
      Must Supportfalse
      18. Procedure.Description.Outcome
      Definition

      Outcome of procedure performed.

      ShortOutcome
      Comments

      Considerations

      Coding with a terminology is preferred, where possible.

      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      20. Procedure.Description.Proceduraldifficulty
      Definition

      Difficulties or issues encountered during performance of the procedure.

      ShortProcedural 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.

      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      22. Procedure.Description.Complication
      Definition

      Details about any complication arising from the procedure.

      ShortComplication
      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.

      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      24. Procedure.Description.Scheduleddatetime
      Definition

      The date and/or time on which the procedure is intended to be performed.

      ShortScheduled date time
      Comments

      Considerations

      Only for use in association with the 'Procedure scheduled' pathway step.

      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      26. Procedure.Description.Finalenddatetime
      Definition

      The date, and optional time, when the procedure was performed.

      ShortDate performed
      Comments

      Considerations

      • Partial dates are permitted.
      • For example:
        • 2015
        • February 2015
        • 7 February 2015
        • 7 February 2015, 1:28 pm
        • 2015-02-07T13:28:17-05:00
      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Alternate NamesDate completed
      28. Procedure.Description.Multimedia
      Definition

      Mulitimedia representation of a performed procedure.

      ShortMultimedia
      Control0..*
      TypeReference
      Must Supportfalse
      30. Procedure.Description.Proceduretype
      Definition

      The type of procedure.

      ShortProcedure type
      Comments

      Considerations

      This pragmatic data element may be used to support organisation within the user interface.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      32. Procedure.Description.Reason
      Definition

      Reason that the activity or care pathway step for the identified procedure was carried out.

      ShortReason
      Comments

      Considerations

      For example: the reason for the cancellation or suspension of the procedure.

      Control0..*
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      34. Procedure.Description.Comment
      Definition

      Additional narrative about the procedure not captured in other fields.

      ShortComment
      Comments

      Considerations

      None

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Alternate NamesNote
      36. Procedure.Protocol
      Definition

      @ internal @

      ShortProtocol
      Control0..1
      TypeBackboneElement
      Must Supportfalse
      38. Procedure.Protocol.Requestororderidentifier
      Definition

      The local ID assigned to the order by the healthcare provider or organisation requesting the service.

      ShortRequestor order identifier
      Comments

      Considerations

      This is equivalent to Placer Order Number in HL7 v2 specifications.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      40. Procedure.Protocol.Requestor
      Definition

      Details about the healthcare provider or organisation requesting the service.

      ShortRequestor
      Control0..1
      TypeReference
      Must Supportfalse
      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.

      ShortReceiver order identifier
      Comments

      Considerations

      This is equivalent to Filler Order Number in HL7 v2 specifications.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supportfalse
      44. Procedure.Protocol.Receiver
      Definition

      Details about the healthcare provider or organisation receiving the request for service.

      ShortReceiver
      Control0..*
      TypeReference
      Must Supportfalse
      46. Procedure.Protocol.Extension
      Definition

      Additional information required to capture local content or to align with other reference models/formalisms.

      ShortExtension
      Comments

      Considerations

      For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents.

      Control0..*
      TypeReference
      Must Supportfalse

      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.

      ShortProcedure AUCDI
      Comments

      Purpose

      To record details about a procedure that has been performed or carried out.

      Misuse

      • Not to be used to record vaccination administration – use the ‘Vaccination administration’ data group for this purpose.
      • Not to be used to record problem/diagnosis – use the ‘Problem/Diagnosis Summary’ data group for this purpose.
      • Not to be used to record information about imaging service events – a specific data model for this purpose will be developed in a future release of AUCDI.
      • Not to be used to record non-invasive procedure events found in some terminology coding hierarchies, such as patient transportation, day care services, home modification or exercise.

      Considerations

      • Significant procedures can be persisted within a curated Procedure or Surgical History list (or similar).
      • In future updates, it is anticipated this data group will be extended to incorporate additional detail.
      Control0..*
      Is Modifierfalse
      Must Supporttrue
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      Alternate Namesprocedure, Operation, Intervention, Surgery
      2. Procedure.Description
      Definition

      @ internal @

      ShortDescription
      Control0..1
      TypeBackboneElement
      Must Supportfalse
      Invariantsele-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.

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      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.

      ShortAdditional 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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-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())
      SlicingThis element introduces a set of slices on Procedure.Description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 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).

        ShortExtensions 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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        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 Namesextensions, user content, modifiers
        Invariantsele-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.

        ShortProcedure 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:

        • 232722009|Coronary artery bypass grafts x 4|
        • 312681000|Bone density scan|
        • 239592001|Forefoot amputation|
        • 34309001|Drainage of tonsil|
        • 307998000|Excision of pigmented skin lesion|
        • 428923005|Radiotherapy to breast|
        Control1..1
        TypeCodeableConcept
        Must Supporttrue
        Alternate NamesOperation name
        12. Procedure.Description.ProcedureDescription
        Definition

        Narrative description about the procedure, as appropriate for the pathway step.

        ShortProcedure Description
        Comments

        Considerations

        For example: description about the performance and findings from the the procedure, the aborted attempt or the cancellation of the procedure.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        14. Procedure.Description.Indication
        Definition

        The clinical symptom, sign or diagnosis that necessitates the procedure.

        ShortIndication
        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:

        • 4557003|Unstable angina|
        • 59848001|Obstructive jaundice|
        • 46635009|Diabetes Mellitus Type 1|
        • 33261009|Abscess of tonsil|
        • 80201000119103|Atypical pigmented lesion|
        • 289916006|Family history of kidney disease|
        • 772150003|Diphtheria suspected|
        • 422181004|Antibiotic prophylaxis|
        • 274920002|Jellyfish sting|
        Control0..*
        TypeCodeableConcept
        Must Supporttrue
        Alternate NamesReason for procedure
        16. Procedure.Description.Method
        Definition

        Identification of specific method or technique for the procedure.

        ShortMethod
        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.

        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        18. Procedure.Description.Urgency
        Definition

        Urgency of the procedure.

        ShortUrgency
        Comments

        Considerations

        Coding with a terminology is preferred, where possible.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        20. Procedure.Description.Bodysite
        Definition

        Identification of the body site for the procedure.

        ShortBody 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.

        Control0..*
        TypeCodeableConcept
        Must Supporttrue
        22. Procedure.Description.Proceduredetail
        Definition

        Structured information about the procedure.

        ShortProcedure detail
        Comments

        Considerations

        Use to capture detailed, structured information about anatomical location, method & technique, equipment used, devices implanted, results, findings etc.

        Control0..*
        TypeReference
        Must Supportfalse
        24. Procedure.Description.Outcome
        Definition

        Outcome of procedure performed.

        ShortOutcome
        Comments

        Considerations

        Coding with a terminology is preferred, where possible.

        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        26. Procedure.Description.Proceduraldifficulty
        Definition

        Difficulties or issues encountered during performance of the procedure.

        ShortProcedural 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.

        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        28. Procedure.Description.Complication
        Definition

        Details about any complication arising from the procedure.

        ShortComplication
        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.

        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        30. Procedure.Description.Scheduleddatetime
        Definition

        The date and/or time on which the procedure is intended to be performed.

        ShortScheduled date time
        Comments

        Considerations

        Only for use in association with the 'Procedure scheduled' pathway step.

        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        32. Procedure.Description.Finalenddatetime
        Definition

        The date, and optional time, when the procedure was performed.

        ShortDate performed
        Comments

        Considerations

        • Partial dates are permitted.
        • For example:
          • 2015
          • February 2015
          • 7 February 2015
          • 7 February 2015, 1:28 pm
          • 2015-02-07T13:28:17-05:00
        Control0..1
        TypedateTime
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Alternate NamesDate completed
        34. Procedure.Description.Multimedia
        Definition

        Mulitimedia representation of a performed procedure.

        ShortMultimedia
        Control0..*
        TypeReference
        Must Supportfalse
        36. Procedure.Description.Proceduretype
        Definition

        The type of procedure.

        ShortProcedure type
        Comments

        Considerations

        This pragmatic data element may be used to support organisation within the user interface.

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        38. Procedure.Description.Reason
        Definition

        Reason that the activity or care pathway step for the identified procedure was carried out.

        ShortReason
        Comments

        Considerations

        For example: the reason for the cancellation or suspension of the procedure.

        Control0..*
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        40. Procedure.Description.Comment
        Definition

        Additional narrative about the procedure not captured in other fields.

        ShortComment
        Comments

        Considerations

        None

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Alternate NamesNote
        42. Procedure.Description.Bodysite
        Definition

        Identification of the body site for the procedure.

        ShortBody site
        Comments

        Considerations

        • Specification of ‘Body site/laterality’ is recommended when it is necessary to provide additional clarity about the Procedure and the ‘Procedure name’ does not include or imply a specific body site.
        • This data element has multiple occurrences to allow the recording of more than one body site for each named procedure – for example, to record multiple related skin sites requiring excision of pigmented lesions in one procedure.
        • It is strongly recommended that the ‘Body site/laterality’ be coded with a terminology, where possible. Free text entry should only be permitted if no appropriate coded value is available.

        Example

        SNOMED CT-AU:

        • 761920005|Bone structure of shaft of right humerus|
        • 51636004|Left ankle|
        • 38033009|Amputation stump|
        • 110501003|Upper outer quadrant of left breast|
        Control0..*
        TypeCodeableConcept
        Must Supporttrue
        Alternate NamesAnatomical location
        44. Procedure.Protocol
        Definition

        @ internal @

        ShortProtocol
        Control0..1
        TypeBackboneElement
        Must Supportfalse
        Invariantsele-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.

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        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.

        ShortAdditional 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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-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())
        SlicingThis element introduces a set of slices on Procedure.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 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).

          ShortExtensions 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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          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 Namesextensions, user content, modifiers
          Invariantsele-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.

          ShortRequestor order identifier
          Comments

          Considerations

          This is equivalent to Placer Order Number in HL7 v2 specifications.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          54. Procedure.Protocol.Requestor
          Definition

          Details about the healthcare provider or organisation requesting the service.

          ShortRequestor
          Control0..1
          TypeReference
          Must Supportfalse
          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.

          ShortReceiver order identifier
          Comments

          Considerations

          This is equivalent to Filler Order Number in HL7 v2 specifications.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          58. Procedure.Protocol.Receiver
          Definition

          Details about the healthcare provider or organisation receiving the request for service.

          ShortReceiver
          Control0..*
          TypeReference
          Must Supportfalse
          60. Procedure.Protocol.Extension
          Definition

          Additional information required to capture local content or to align with other reference models/formalisms.

          ShortExtension
          Comments

          Considerations

          For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents.

          Control0..*
          TypeReference
          Must Supportfalse