1 FHIR description
2 Schema
3 Resources
- 3.1 Device
- 3.2 Device Association
- 3.3 Detected Issue
4 Example

FHIR description

Device - Device - FHIR v5.0.0
Device Association - DeviceAssociation - FHIR v5.0.0
Detected Issue - DetectedIssue - FHIR v5.0.0

Schema

Resources

Device

Collection name: devices

This collection is used to store device documents

Name		Type		M/O		Description and constraints	FHIR(v5) vs eHealth comparison

Name		Type		M/O		Description and constraints	FHIR(v5) vs eHealth comparison
id		string		M		System identifier of Device (ObjectID)	Ok
identifier		[Identifier]		O		Device identifier. Type fills from `external_system` dictionary	Ok
definition		{Reference}		O		The reference to the definition for the device	Ok
status		string		M		Status of Device. Dictionary `device_statuses`	Ok
manufacturer		string		O		Name of device manufacturer	Ok
manufacture_date		dateTime		O		Date when the device was made	Ok
expiration_date		dateTime		O		Date and time of expiry of this device (if applicable)	Ok
lot_number		string		O		Lot number of manufacture	Ok
serial_number		string		O		Serial number assigned by the manufacturer	Ok
name	type	array	string	M	M		Ok
name	value	array	string	M	M		Ok
model_number		string		O		The manufacturer's model number for the device	Ok
type		{CodeableConcept}		M		The kind or type of device	Ok
property	code	array	{CodeableConcept}	O	M	Dictionary `device_properties`	Ok
	value[x]					One value[x] is allowed Value[x] is required
	value_codeable_concept		{CodeableConcept}		M
	value_quantity		{Quantity}		M
	value_range		{Range}		M
	value_boolean		Boolean		M
	value_integer		Integer		M
	value_string		String		M
note		string		O		Device notes and comments	Ok
parent		{Reference}		O		Reference to parent device	Ok
recorder		{Reference}		M		Employee who registered device	Ok
recorder_legal_entity		{Reference}		M		Legal entity who registered device	Doesn't comply with FHIR
subject		string		M		Hashed patient_id	Doesn't comply with FHIR
context		{Reference}		M		Reference to encounter during which the record was created	Doesn't comply with FHIR
context_episode_id		uuid		M		Reference to episode of care during which the record was created	Doesn't comply with FHIR
inserted_at		timestamp		M		Datetime when Device was created	Doesn't comply with FHIR
inserted_by		string		M		User identifier who created the Device association	Doesn't comply with FHIR
updated_at		timestamp		M		Datetime when Device association was updated	Doesn't comply with FHIR
updated_by		string		M		User identifier who updated the Device association	Doesn't comply with FHIR

Device Association

Collection name:device_associations

This collection is used to store device association documents

Name	Type	M/O	Description and constraints	FHIR(v5) vs eHealth comparison

Name	Type	M/O	Description and constraints	FHIR(v5) vs eHealth comparison
id	string	M	System identifier of Device Association (ObjectID)	Ok
device	{Reference}	M	Reference to device	Ok
status	string	M	Status of Device association. Dictionary `device_association_statuses`	Ok
status_reason	{CodeableConcept}	O	The reasons given for the current association status Dictionary `device_association_status_reasons`	Ok
subject	string	M	Hashed patient_id	Ok
body_site	{CodeableConcept}	O	Current anatomical location of the device in/on subject Dictionary `eHealth/body_structures`	FHIR defines this as Reference to BodyStructure resource
association_date	date	O	Date of implantation\attachment or explantation\detachment of the device to the patient	Doesn't comply with FHIR
context	{Reference}	M	Reference to encounter during which the record was created	Doesn't comply with FHIR
context_episode_id	uuid	M	Reference to episode of care during which the record was created	Doesn't comply with FHIR
recorded	dateTime	M	The date of setting the direction of the relationship of the device to the patient	Doesn't comply with FHIR
recorder	{Reference}	M	Employee who registered device association	Doesn't comply with FHIR
recorder_legal_entity	{Reference}	M	Legal entity who registered device association	Doesn't comply with FHIR
inserted_at	timestamp	M	Datetime when Device association was created	Doesn't comply with FHIR
inserted_by	string	M	User identifier who created the Device association	Doesn't comply with FHIR
updated_at	timestamp	M	Datetime when Device association was updated	Doesn't comply with FHIR
updated_by	string	M	User identifier who updated the Device association	Doesn't comply with FHIR

Detected Issue

Collection name:detected_issues

This collection is used to store detected issue documents

Name	Type	M/O	Description and constraints	FHIR(v5) vs eHealth comparison

Name	Type	M/O	Description and constraints	FHIR(v5) vs eHealth comparison
id	string	M	System identifier of Detected Issue (ObjectID)	Ok
status	string	M	Issue status. Dictionary `detected_issue_statuses`	Ok
code	{CodeableConcept}	O	Specific type of detected issue	Ok
subject	{Reference}	M	Device which issue has been detected	Ok
patient_id	string	M	Hashed patient_id. System field	Doesn't comply with FHIR
encounter	{Reference}	M	Reference to encounter during which the record was created	Ok
identified_date_time	dateTime	O	When identified	Ok
author	{Reference}	M	The employee or person who identified the issue	Ok
implicated	{Reference}	O	Device which caused an issue	Ok
detail	string	O	Description and context	Ok
recorder	{Reference}	M	The employee who registered the issue	Ok
recorder_legal_entity	{Reference}	М	The legal entity who registered the issue	Doesn't comply with FHIR
context_episode_id	uuid	M	Reference to episode of care during which the record was created	Doesn't comply with FHIR
inserted_at	timestamp	M	Datetime when Detected issue was created	Doesn't comply with FHIR
inserted_by	string	M	User identifier who created the Detected issue	Doesn't comply with FHIR
updated_at	timestamp	M	Datetime when Detected issue was updated	Doesn't comply with FHIR
updated_by	string	M	User identifier who updated the Detected issue	Doesn't comply with FHIR

Example

devices

{
    "_id" : UUID("59a5d6ed-b724-43cc-bfd7-b67028797df1"),
    "context" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "encounter",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("459010ca-52fc-49d2-8fc3-7e60f4d1b2ab")
        }
    },
    "context_episode_id" : UUID("e8f13f2b-1522-4a7f-afd5-3a0c0fe21a23"),
    "definition" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "device_definition",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("b12d9f00-46ff-4aa6-8e60-cfff1bcf80e2")
        }
    },
    "expiration_date" : ISODate("2020-01-01T00:00:00.000Z"),
    "identifier" : [ 
        {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "external_system"
                    }
                ],
                "text" : null
            },
            "value" : "№324-1231-ФФ"
        }
    ],
    "inserted_at" : ISODate("2024-03-18T14:40:12.544Z"),
    "inserted_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5"),
    "lot_number" : "RZ12345678",
    "manufacture_date" : ISODate("1999-01-01T00:00:00.000Z"),
    "manufacturer" : "GlobalMed, Inc",
    "model_number" : "NSPX30",
    "name" : [ 
        {
            "type" : "user_friendly",
            "value" : "Смужки Accu-Chek Active для глюкометра"
        }, 
        {
            "type" : "registered",
            "value" : "Тест-смужки Accu-Chek Active для глюкометра"
        }
    ],
    "note" : "Імплант був вилучений по причині заміни на новий",
    "parent" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "device",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("90a9e15b-b71b-4caf-8f2e-ff247e8a5600")
        }
    },
    "property" : [ 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : null,
            "value_codeable_concept" : null,
            "value_integer" : null,
            "value_quantity" : {
                "code" : "kg",
                "comparator" : ">",
                "system" : "eHealth/ucum/units",
                "unit" : "kg",
                "value" : 1.5
            },
            "value_range" : null,
            "value_string" : null
        }, 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : null,
            "value_codeable_concept" : {
                "coding" : [ 
                    {
                        "code" : "30221",
                        "system" : "device_definition_classification_type"
                    }
                ],
                "text" : null
            },
            "value_integer" : null,
            "value_quantity" : null,
            "value_range" : null,
            "value_string" : null
        }, 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : null,
            "value_codeable_concept" : null,
            "value_integer" : 12,
            "value_quantity" : null,
            "value_range" : null,
            "value_string" : null
        }, 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : null,
            "value_codeable_concept" : null,
            "value_integer" : null,
            "value_quantity" : null,
            "value_range" : {
                "high" : {
                    "code" : "kg",
                    "comparator" : "<",
                    "system" : "eHealth/ucum/units",
                    "unit" : "kg",
                    "value" : 2.5
                },
                "low" : {
                    "code" : "kg",
                    "comparator" : ">",
                    "system" : "eHealth/ucum/units",
                    "unit" : "kg",
                    "value" : 1.5
                }
            },
            "value_string" : null
        }, 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : false,
            "value_codeable_concept" : null,
            "value_integer" : null,
            "value_quantity" : null,
            "value_range" : null,
            "value_string" : null
        }, 
        {
            "code" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "device_properties"
                    }
                ],
                "text" : null
            },
            "value_boolean" : null,
            "value_codeable_concept" : null,
            "value_integer" : null,
            "value_quantity" : null,
            "value_range" : null,
            "value_string" : "some value"
        }
    ],
    "recorder" : {
        "display_value" : "СЕРГІЙ ОЛЕКСАНДРОВИЧ ПАВЛОВСЬКИЙ",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("eb794be3-e081-40ea-9ff7-e5e3f013b721")
        }
    },
    "recorder_legal_entity" : {
        "display_value" : "Solute Med",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "legal_entity",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("6e5a53bc-9c71-4c66-9cdc-37560d6dbf49")
        }
    },
    "serial_number" : "NSPX30",
    "status" : "active",
    "subject" : "5E0168F480B03462A33EFD0E13C419374E681C3C1280A407612715BC019C0904",
    "type" : {
        "coding" : [ 
            {
                "code" : "30221",
                "system" : "device_definition_classification_type"
            }
        ],
        "text" : null
    },
    "updated_at" : ISODate("2024-03-18T14:40:12.544Z"),
    "updated_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5")
}

device_associations

{
    "_id" : UUID("b625c578-a2a6-4153-8c24-cbd0c311fd8f"),
    "association_date" : ISODate("2024-01-05T00:00:00.000Z"),
    "body_site" : {
        "coding" : [ 
            {
                "code" : "head",
                "system" : "eHealth/body_sites"
            }
        ],
        "text" : null
    },
    "context" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "encounter",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("459010ca-52fc-49d2-8fc3-7e60f4d1b2ab")
        }
    },
    "context_episode_id" : UUID("e8f13f2b-1522-4a7f-afd5-3a0c0fe21a23"),
    "device" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "device",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("59a5d6ed-b724-43cc-bfd7-b67028797df1")
        }
    },
    "inserted_at" : ISODate("2024-03-18T14:40:12.556Z"),
    "inserted_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5"),
    "recorded" : ISODate("2024-01-07T09:00:00.000Z"),
    "recorder" : {
        "display_value" : "СЕРГІЙ ОЛЕКСАНДРОВИЧ ПАВЛОВСЬКИЙ",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("eb794be3-e081-40ea-9ff7-e5e3f013b721")
        }
    },
    "recorder_legal_entity" : {
        "display_value" : "Solute Med",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "legal_entity",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("6e5a53bc-9c71-4c66-9cdc-37560d6dbf49")
        }
    },
    "status" : "implanted",
    "status_reason" : null,
    "subject" : "5E0168F480B03462A33EFD0E13C419374E681C3C1280A407612715BC019C0904",
    "updated_at" : ISODate("2024-03-18T14:40:12.556Z"),
    "updated_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5")
}

detected_issues

{
    "_id" : UUID("f1448af5-dd29-4abb-95d4-29686b4087ee"),
    "author" : {
        "display_value" : "Олег Васильович Поплавок",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("131fe1bc-7c32-4ac1-a462-7fe25ffe98b0")
        }
    },
    "code" : {
        "coding" : [ 
            {
                "code" : "default",
                "system" : "detected_issue_codes"
            }
        ],
        "text" : null
    },
    "context_episode_id" : UUID("e8f13f2b-1522-4a7f-afd5-3a0c0fe21a23"),
    "detail" : "some details",
    "encounter" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "encounter",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("459010ca-52fc-49d2-8fc3-7e60f4d1b2ab")
        }
    },
    "identified_date_time" : ISODate("2018-08-02T10:45:16.000Z"),
    "implicated" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "device",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("59a5d6ed-b724-43cc-bfd7-b67028797df1")
        }
    },
    "inserted_at" : ISODate("2024-03-18T14:40:12.559Z"),
    "inserted_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5"),
    "patient_id" : "5E0168F480B03462A33EFD0E13C419374E681C3C1280A407612715BC019C0904",
    "recorder" : {
        "display_value" : "СЕРГІЙ ОЛЕКСАНДРОВИЧ ПАВЛОВСЬКИЙ",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("eb794be3-e081-40ea-9ff7-e5e3f013b721")
        }
    },
    "recorder_legal_entity" : {
        "display_value" : "Solute Med",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "legal_entity",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("6e5a53bc-9c71-4c66-9cdc-37560d6dbf49")
        }
    },
    "status" : "mitigated",
    "subject" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "device",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("af3230f9-7d58-432e-be54-5175f96034ff")
        }
    },
    "updated_at" : ISODate("2024-03-18T14:40:12.559Z"),
    "updated_by" : UUID("27f4a543-aae0-4575-b10c-ee4f4cb008f5")
}

E-Health

[NEW] Device & DeviceAssociation Data Model