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: Implanted Medical Device Summary

Official URL: https://aehrc.csiro.au/fhir/logical-models/ImplantedMedicalDeviceSummary Version: 0.0.1
Draft as of 2023-09-11 Computable Name: ImplantedMedicalDeviceSummary
Other Identifiers: https://aehrc.csiro.au/id/archetype_id#openEHR-EHR-EVALUATION.implanted_device_summary.v0

The Implanted Medical Device Summary Logical Model Mindmap is shown below.

A summary or overview detailing the history and context of use for a specified type of implantable medical device, including details about specific implantation episodes.

Purpose

To record a summary or overview detailing the history and context of use for a specified type of implantable medical device.

Misuse

Not to be used to request a medical device. Use a relevant INSTRUCTION archetype for this purpose.

Not to be used to record the activities that occur in the insertion or removal of an implant. Use the ACTION.procedure archetype for this purpose.

Considerations

Use to record a summary or overview of a single implanted medical device, or category of device.

The intended scope of this archetype includes, but is not limited to:

  • a cochlear implant;
  • an intracardiac pacemaker;
  • one or more aneurysm clips;
  • a femoral head prosthesis;
  • a coronary stent;
  • bone fixation devices such as screws or plates;
  • deep brain electrical stimulation system lead; or
  • deep brain electrical stimulation system pulse generator.

This archetype has been specifically designed to:

  • support the management of implanted medical devices over time;
  • assist in the identification of implanted medical devices in situ that may carry health risks for imaging and other health-related activities; and
  • carry critical information such as device identification that will support product recalls.

The repeating 'Specific implant details' CLUSTER supports documentation about each insertion of each specific medical device, including more precise identification and summary details about the device insertion and removal. This archetype can be further developed to document medical device details such as the manufacturer, batch numbers and device identifiers by nesting the CLUSTER.device_details in the 'Structured device detail' SLOT.

In practice, some clinical systems will need to record specific and detailed INSTRUCTION and ACTION archetypes to reflect the request for a medical device and subsequent activities that need to be recorded as that request is carried out. There will inevitably be some overlap between this summary and these detailed archetypes. All may be necessary in different contexts however, where possible, ideally this summary should be derived from the point of care INSTRUCTION and ACTION documentation by clinicians, to prevent the need for clinicians to duplicate data input.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 22 elements

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImplantedMedicalDeviceSummary S 0..* Base Implanted Medical Device Summary
Instances of this logical model are not marked to be the target of a Reference
... Protocol S 0..1 BackboneElement Protocol
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Lastupdated S 0..1 dateTime Last updated
.... Extension S 0..1 Reference() Extension
... Data S 0..1 BackboneElement Data
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... Devicetypename S 1..1 CodeableConcept Device type name
.... Overallstatus S 0..1 Coding Overall status
.... Overalldescription S 0..1 string Overall description
.... Specificimplanteddevicedetails S 0..1 BackboneElement Specific implanted device details
..... @id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... Devicename S 0..1 CodeableConcept Device name
..... Label S 0..1 string Label
..... Status S 0..1 Coding Status
..... Description S 0..1 string Description
..... Insertiondate S 0..1 dateTime Insertion date
..... Implantbodysite S 0..1 CodeableConcept Implant body site
..... Structuredimplantbodysite S 0..1 Reference() Structured implant body site
..... Structureddevicedetail S 0..1 Reference() Structured device detail
..... Multimediarepresentation S 0..1 Reference() Multimedia representation
..... Removaldate S 0..1 dateTime Removal date
..... Reasonforremoval S 0..1 string Reason for removal
..... Nextreviewdue S 0..1 dateTime Next review due
..... Comment S 0..1 string Comment
.... Overallcomment S 0..1 string Overall comment

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 22 elements

 

Other representations of profile: CSV, Excel