Norwegian openEHR Repository
Name
Device summary
Description
An ongoing and persistent overview about devices that have been fitted or implanted.
Purpose
To record an ongoing and persistent overview about devices that have been fitted or implanted.
Use
Use to record a summary of devices that have been fitted or implanted including, but not limited to:
- assisted hearing devices, such as hearing aids or auditory implants;
- orthotics or artificial limbs;
- dentures or dental implants; and
- eyeglasses or contact lenses.

This archetype has been specifically designed to assist in providing an overview of device management over time. It may be used to share as a summary within messages or between clinical systems, where the detail is not required. If assisted hearing devices have been used in the past, as much detail as is available can be added in this archetype to create a context which may influence decisions about current or future devices.

In practice, some clinical systems will need to record specific and detailed INSTRUCTION and ACTION archetypes to reflect the request for an assisted hearing device and subseqent activities that need to be recorded as that request is carried out. It is inevitable that there will be some overlap in this summary and these detailed archetypes. All are neccessary in various situations.

If clinicians are recording the process of request and provision of assisted hearing devices, then this summary should be derived from those recordings, such that there is no duplication of clinical input.
Misuse
Not to be used to request an assisted hearing device - use the INSTRUCTION.request family for this purpose.

Not to be used to record the activities that occur in the planning and fitting of a device - use the ACTION.device_fitting archetype for this purpose.

Not to be used to record the activities that occur in the planning and fitting of an implant - use the ACTION.procedure archetype for this purpose.
References
Avgrenet fra: Device summary, Draft Archetype [Internet]. openEHR Foundation, openEHR Clinical Knowledge Manager [cited: 2016-05-30]. Available from: http://openehr.org/ckm/#showArchetype_1013.1.2381
Archetype Id
openEHR-EHR-EVALUATION.device_summary.v0
Copyright
© Northern Territory Department of Health, Australia, Nasjonal IKT HF
Licencing
Original Author
Heather Leslie
Ocean Informatics
Date Originally Authored
2015-10-05
Name Card Type Description
Device type
0..1 DV_TEXT Name of the type of device.
Comment
For example: Assisted hearing devices, eyeglasses, contact lens, dental braces, dentures, orthotics or artificial limbs.
Status
0..1 DV_CODED_TEXT Assertion about the fitting or implanting of devices, as at the date 'Last updated'.
Constraint for DV_CODED_TEXT
  • Never
    [The device type has never been fitted or implanted.]
  • Current
    [The device type is currently fitted or implanted.]
  • Previous
    [The device type has been fitted or implanted in the past.]
Description
0..1 DV_TEXT Narrative description about the use of the fitted device type.
Device details
0..* CLUSTER Details about each device.
CLUSTER
Device name
0..1 DV_TEXT Identification of the specific device, by name.
Start date
0..1 DV_DATE_TIME Date of fitting or implant of the device.
Body site
0..1 DV_TEXT Identification of the body site where the device is fitted/implanted.
Structured body site
0..* Slot (Cluster) A structured anatomical location of the body site where the device is fitted/implanted.
Slot
Slot
Description
0..1 DV_TEXT Narrative description about the device.
Structured detail
0..* Slot (Cluster) Additional structured detail about the device.
Slot
Slot
Multimedia
0..* Slot (Cluster) Digital image, video or diagram about the device.
Slot
Slot
End date
0..1 DV_DATE_TIME Date when the device stopped being used or was removed.
URI to original data
0..1 DV_URI Link to the original data about the fitting or insertion.
Comment
Commonly, this will be an ACTION archetype that contains the details about the fitting or insertion of the device.
Next review due
0..1 DV_DATE_TIME Date on which this device should be reviewed.
Name Card Type Description
Extension
0..* Slot (Cluster) Additional information required to capture local content or to align with other reference models/formalisms.
Comment
For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents.
Slot
Slot
Last updated
0..1 DV_DATE_TIME The date this summary was last updated.
archetype (adl_version=1.4; uid=dd9045f5-72da-4d03-9d9d-70ecbde92909)
	openEHR-EHR-EVALUATION.device_summary.v0

concept
	[at0000]	-- Device summary
language
	original_language = <[ISO_639-1::en]>
description
	original_author = <
		["name"] = <"Heather Leslie">
		["organisation"] = <"Ocean Informatics">
		["email"] = <"heather.leslie@oceaninformatics.com">
		["date"] = <"2015-10-05">
	>
	details = <
		["en"] = <
			language = <[ISO_639-1::en]>
			purpose = <"To record an ongoing and persistent overview about devices that have been fitted or implanted.">
			use = <"Use to record a summary of devices that have been fitted or implanted including, but not limited to:
- assisted hearing devices, such as hearing aids or auditory implants;
- orthotics or artificial limbs; 
- dentures or dental implants; and
- eyeglasses or contact lenses.

This archetype has been specifically designed to assist in providing an overview of device management over time. It may be used to share as a summary within messages or between clinical systems, where the detail is not required. If assisted hearing devices have been used in the past, as much detail as is available can be added in this archetype to create a context  which may influence decisions about current or future devices.

In practice, some clinical systems will need to record specific and detailed INSTRUCTION and ACTION archetypes to reflect the request for an assisted hearing device and subseqent activities that need to be recorded as that request is carried out. It is inevitable that there will be some overlap in this summary and these detailed archetypes. All are neccessary in various situations. 

If clinicians are recording the process of request and provision of assisted hearing devices, then this summary should be derived from those recordings, such that there is no duplication of clinical input.">
			misuse = <"Not to be used to request an assisted hearing device - use the INSTRUCTION.request family for this purpose.

Not to be used to record the activities that occur in the planning and fitting of a device - use the ACTION.device_fitting archetype for this purpose.

Not to be used to record the activities that occur in the planning and fitting of an implant - use the ACTION.procedure archetype for this purpose.">
			copyright = <"© Northern Territory Department of Health, Australia, Nasjonal IKT HF">
		>
	>
	lifecycle_state = <"in_development">
	other_contributors = <"Kathy Currie, NT Hearing Health Program Leader, Australia", ...>
	other_details = <
		["custodian_organisation"] = <"Nasjonal IKT">
		["references"] = <"Avgrenet fra: Device summary, Draft Archetype [Internet]. openEHR Foundation, openEHR Clinical Knowledge Manager [cited: 2016-05-30]. Available from: http://openehr.org/ckm/#showArchetype_1013.1.2381">
		["original_namespace"] = <"no.nasjonalikt">
		["original_publisher"] = <"Nasjonal IKT">
		["custodian_namespace"] = <"no.nasjonalikt">
		["MD5-CAM-1.0.1"] = <"805AFFA8A6C4C85B2CEEDEDAD9B75E71">
		["build_uid"] = <"b7b2c343-e483-4464-aef7-0e43f2d622ba">
		["revision"] = <"0.0.1-alpha">
	>

definition
	EVALUATION[at0000] matches {	-- Device summary
		data matches {
			ITEM_TREE[at0001] matches {	-- Tree
				items cardinality matches {0..*; unordered} matches {
					ELEMENT[at0020] occurrences matches {0..1} matches {	-- Device type
						value matches {
							DV_TEXT matches {*}
						}
					}
					ELEMENT[at0002] occurrences matches {0..1} matches {	-- Status
						value matches {
							DV_CODED_TEXT matches {
								defining_code matches {
									[local::
									at0003, 	-- Never
									at0004, 	-- Current
									at0005]	-- Previous
								}
							}
						}
					}
					ELEMENT[at0015] occurrences matches {0..1} matches {	-- Description
						value matches {
							DV_TEXT matches {*}
						}
					}
					CLUSTER[at0022] occurrences matches {0..*} matches {	-- Device details
						items cardinality matches {1..*; unordered} matches {
							ELEMENT[at0007] occurrences matches {0..1} matches {	-- Device name
								value matches {
									DV_TEXT matches {*}
								}
							}
							ELEMENT[at0008] occurrences matches {0..1} matches {	-- Start date
								value matches {
									DV_DATE_TIME matches {*}
								}
							}
							ELEMENT[at0012] occurrences matches {0..1} matches {	-- Body site
								value matches {
									DV_TEXT matches {*}
								}
							}
							allow_archetype CLUSTER[at0013] occurrences matches {0..*} matches {	-- Structured body site
								include
									archetype_id/value matches {/openEHR-EHR-CLUSTER\.anatomical_location(-[a-zA-Z0-9_]+)*\.v1/}
							}
							ELEMENT[at0014] occurrences matches {0..1} matches {	-- Description
								value matches {
									DV_TEXT matches {*}
								}
							}
							allow_archetype CLUSTER[at0010] occurrences matches {0..*} matches {	-- Structured detail
								include
									archetype_id/value matches {/openEHR-EHR-CLUSTER\.device(-[a-zA-Z0-9_]+)*\.v1/}
							}
							allow_archetype CLUSTER[at0021] occurrences matches {0..*} matches {	-- Multimedia
								include
									archetype_id/value matches {/openEHR-EHR-CLUSTER\.multimedia(-[a-zA-Z0-9_]+)*\.v1/}
							}
							ELEMENT[at0009] occurrences matches {0..1} matches {	-- End date
								value matches {
									DV_DATE_TIME matches {*}
								}
							}
							ELEMENT[at0023] occurrences matches {0..1} matches {	-- URI to original data
								value matches {
									DV_URI matches {*}
								}
							}
							ELEMENT[at0019] occurrences matches {0..1} matches {	-- Next review due
								value matches {
									DV_DATE_TIME matches {*}
								}
							}
						}
					}
				}
			}
		}
		protocol matches {
			ITEM_TREE[at0016] matches {	-- Tree
				items cardinality matches {0..*; unordered} matches {
					allow_archetype CLUSTER[at0018] occurrences matches {0..*} matches {	-- Extension
						include
							archetype_id/value matches {/.*/}
					}
					ELEMENT[at0017] occurrences matches {0..1} matches {	-- Last updated
						value matches {
							DV_DATE_TIME matches {*}
						}
					}
				}
			}
		}
	}




ontology
	term_definitions = <
		["en"] = <
			items = <
				["at0000"] = <
					text = <"Device summary">
					description = <"An ongoing and persistent overview about devices that have been fitted or implanted.">
				>
				["at0001"] = <
					text = <"Tree">
					description = <"@ internal @">
				>
				["at0002"] = <
					text = <"Status">
					description = <"Assertion about the fitting or implanting of devices, as at the date 'Last updated'.">
				>
				["at0003"] = <
					text = <"Never">
					description = <"The device type has never been fitted or implanted.">
				>
				["at0004"] = <
					text = <"Current">
					description = <"The device type is currently fitted or implanted.">
				>
				["at0005"] = <
					text = <"Previous">
					description = <"The device type has been fitted or implanted in the past.">
				>
				["at0007"] = <
					text = <"Device name">
					description = <"Identification of the specific device, by name.">
				>
				["at0008"] = <
					text = <"Start date">
					description = <"Date of fitting or implant of the device.">
				>
				["at0009"] = <
					text = <"End date">
					description = <"Date when the device stopped being used or was removed.">
				>
				["at0010"] = <
					text = <"Structured detail">
					description = <"Additional structured detail about the device.">
				>
				["at0012"] = <
					text = <"Body site">
					description = <"Identification of the body site where the device is fitted/implanted.">
				>
				["at0013"] = <
					text = <"Structured body site">
					description = <"A structured anatomical location of the body site where the device is fitted/implanted.">
				>
				["at0014"] = <
					text = <"Description">
					description = <"Narrative description about the device.">
				>
				["at0015"] = <
					text = <"Description">
					description = <"Narrative description about the use of the fitted device type.">
				>
				["at0016"] = <
					text = <"Tree">
					description = <"@ internal @">
				>
				["at0017"] = <
					text = <"Last updated">
					description = <"The date this summary was last updated.">
				>
				["at0018"] = <
					text = <"Extension">
					description = <"Additional information required to capture local content or to align with other reference models/formalisms.">
					comment = <"For example: local information requirements or additional metadata to align with FHIR or CIMI equivalents.">
				>
				["at0019"] = <
					text = <"Next review due">
					description = <"Date on which this device should be reviewed.">
				>
				["at0020"] = <
					text = <"Device type">
					description = <"Name of the type of device.">
					comment = <"For example: Assisted hearing devices, eyeglasses, contact lens, dental braces, dentures, orthotics or artificial limbs.">
				>
				["at0021"] = <
					text = <"Multimedia">
					description = <"Digital image, video or diagram about the device.">
				>
				["at0022"] = <
					text = <"Device details">
					description = <"Details about each device.">
				>
				["at0023"] = <
					text = <"URI to original data">
					description = <"Link to the original data about the fitting or insertion.">
					comment = <"Commonly, this will be an ACTION archetype that contains the details about the fitting or insertion of the device.">
				>
			>
		>
	>