Content Comparison

Table of Contents

FHIR description

Care Plan

Schema

...

eHealth description

Care plan

Collection name: care_plans

This collection used to store care plan document without activity documents.

Care plan document

Name	Type	M/O	Description and constraints	HL7 vs eHealth comparison result
id	string	M	System identifier of Care plan (ObjectID)	Doesn't comply with FHIR
based_on	{Reference}	O	Reference on parent Care plan	Ok
part_of	{Reference}	O	Reference on another Care plan	Ok
category	{Codeable_concept}	M	Category of the care plan. Fetches from the dictionary	Ok
title	string	M	Title of the care plan	Ok
description	string	O	Description of the care plan	Ok
period	{Period}	M	Period when care plan starts and ends	Ok
supporting_info	[Reference]	O	Reference on supporting medical events.	Ok
note	string	O	Comments, notes about care plan	Doesn't comply with FHIR
requisition	string	M	Hashed value of human-readable care plan number	Doesn't comply with FHIR
managing_organization	{Reference}	M	Reference on legal_entity	Doesn't comply with FHIR
intent	string	M	By default is order	Ok
encounter	{Reference}	M	Reference on encounter with main diagnosis	Ok
addresses	[Codeable_concept]	M	Condition code. Fetches from the dictionary `eHealth/ICD10_AM/condition_codes`	Doesn't comply with FHIR (datatype)
status	string	M	Status of care plan	Ok
status_reason	{Codeable_concept}	O	Reason of changing a status	Doesn't comply with FHIR
status_history	[Status_history]	M	Care plan status change history	Doesn't comply with FHIR
subject	string	M	Hashed patient_id	Doesn't comply with FHIR (datatype)
author	{Reference}	M	Reference on care plan creator employee	Ok
contributor	[Reference]	O	References on care plan contributor employees	Ok
terms_of_service	{Codeable_concept}	M	Providing condition of care plan. Fetches from the dictionary `PROVIDING_CONDITION`. Allowed values: INPATIENT, OUTPATIENT	Doesn't comply with FHIR
inserted_at	timestamp	M	Datetime when care plan was created	Doesn't comply with FHIR
inserted_by	string	M	Identifier on the user created the care plan	Doesn't comply with FHIR
updated_at	timestamp	M	Datetime when care plan was last updated	Doesn't comply with FHIR
updated_by	string	M	Identifier on the user last updated the care plan	Doesn't comply with FHIR
signed_content_links	[string]	M	Array with links on signed content in media storage.	Doesn't comply with FHIR

Activities

Collection name: care_plan_activities activities

This collection is used to store activities only with link on their Care plan

Activity document

Activity should be described with detail attribute only, without using reference attribute.

Name	Type	M/O	Description and constraints	HL7 vs eHealth comparison result
id	string	M	System identifier of the activity. Unique within the Care plan	Doesn’t comply with FHIR
care_plan	{Reference}	M	Reference on the Care plan to which activity has been related.	Doesn’t comply with FHIR
author	{Reference}	M	Reference on activity creator employee	Doesn’t comply with FHIR CarePlan (matches with ActivityDefinition)
signed_content_links	[string]	M	Array with links on signed content in media storage.	Doesn't comply with FHIR
outcome_reference	[Reference]	O	Reference on resources which represents result of the activity. For medication requests there are medication dispenses, for service requests - procedures, encounters, diagnostic_reports. And for device requests - there are device dispenses	Ok
outcome_codeable_concept	[Codeable_concept]	O	Descriptions of the activity result. Fetches from a dictionary.	Ok
inserted_at	timestamp	M	Datetime when care plan was created	Doesn't comply with FHIR
inserted_by	string	M	Identifier on the user created the care plan	Doesn't comply with FHIR
updated_at	timestamp	M	Datetime when care plan was last updated	Doesn't comply with FHIR
updated_by	string	M	Identifier on the user last updated the care plan	Doesn't comply with FHIR
detail	{Detail document}	M	Summary of the care plan activity	Ok

Detail document

Name	Type	M/O	Description and constraints	HL7 vs eHealth comparison result
kind	string	M	Type of the activity. Allowed values: `medication_request`, `service_request` or device_request	Ok
reason_code	[Codeable_concept]	O	Diagnoses. May be a few, fetches from the `condition_codes` dictionary	Ok
reason_reference	[Reference]	O	References on conditions/oservations/diagnostic_reports with diagnoses.	Ok
goal	[Codeable_concept]	O	A goal of the activity. Fetches from a dictionary.	Doesn't comply with FHIR (type)
status	string	M	Status of the activity.	Ok
status_reason	{Codeable_concept}	O	Reason of the activity status change. Fetches from a dictionary.	Ok
quantity	{SimpleQuantity}	O	Quantity of required medications (MR) or procedures e.t.c. (SR)	Ok
scheduled_timing sheduled_period scheduted_string	{Timing} {Period} string	O	One of these fields is allowed, another should be forbidden. Describes a period, timing or frequency upon which the activity is to occur.	Ok
location	{Reference}	O	Reference on the performer’s division	Ok
performer	{Reference}	O	Reference on employee who will perform the activity.	Ok
product_reference product_codeable_concept	{Reference}	M О О	~~Required.~~

If {SimpleQuantity

If kind=medication_request , ~~reference on the~~ medication. If kind=service_request ~~, reference on the~~ service

Ok

daily_amount

{SimpleQuantity}

O

Quantity of medication, procedures to be consumed a day

Ok

remaining_quantity

Field `product_reference` is required for kind medication_request or service_request only: If `kind=medication_request` - reference to the `medication`. If `kind=service_request` - reference to the `service` For kind device_request one of these fields is allowed, another should be forbidden - product_reference or product_codeable_concept: if `product_reference` has chosen, then there should be reference to the `device_definition` resource if `product_codeable_concept` has chosen, then there should be a value from the `device_definition_classification_type` dictionary	Ok
daily_amount	{SimpleQuantity}	O	Quantity of medication, procedures to be consumed a day	Ok
remaining_quantity	{SimpleQuantity}	O	Remaining quantity medication (procedures e.t.c. fot SR) allowed to medication dispense. It calculates as difference between detail.quantity and count of corresponding references in activity.outcome_reference???	Ok
description	string	O	Description of the activity	Ok
do_not_perform	bool	M	By default is false	Ok
program	{Reference}	O	Reference on medical program resource	Doesn't comply with FHIR

Example

Expand

title	eHealth Care plan document exqmple

Code Block

language	js

{{
    "id": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"-919d7a0773ca",
    "based_on": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "system": "eHealth/resources",
                        "code": "care_plan"
                    }
                ]
            },
            "value": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"
        }
    },
    "basedpart_onof": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "system": "eHealth/resources",
                        "code": "care_plan"
                    }
                ]
            },
            "value": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"
 -919d7a0773ca"
        }
    },
     "managing_organization" : {
        "display_value" : "Solute Med",
        "identifier" : {
            "value" : UUID("0010a929-336e-4aa2-a628-a9079820492d"),
      }     },     "part_of""type" : {
    
   "identifier": {             "typetext" : {null,
                "coding" : [ 
                    {
                        "systemcode" : "eHealth/resourceslegal_entity",
                        "codesystem" : "care_planeHealth/resources"
                    }
                ]
            },
    
       "value": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"
        }
    },
    "category": {
        "coding": [
            {
                "system": "eHealth/SNOMED/care_plan_categories",
                "code": "diabetics"
            }
        ]
    },
    "title": "Example",
    "description": "Care plan example",
    "period": {
        "start": "2020-01-01",
        "end": "2021-01-01"
    },
    "supporting_info": [
        {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "episode_of_care",
                            "system": "eHealth/resources"
                        }
                    ]
                },
                "value": "789b1866-31b3-4ed3-82e9-236ff629cb23"
            }
        }
    ],
    "note": "Some notes",
    "requisition": "3D19B775D1444A16A4AA61172103F4A4F0ADB474216927898C75A9391D81BA0A",
    "intent": "order",
    "encounter": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "code": "encounter",
                        "system": "eHealth/resources"
                    }
                ]
            },
            "value": "0433b247-d907-4d09-b460-9614f84e6db6"
        }
    },
    "addresses": [
            {
            "coding" : [ 
                {
                    "code" : "E11.9",
                    "system" : "eHealth/ICD10_AM/condition_codes"
                }
            ]
        }
    ],
    "status": "active",
    "status_reason": {
        "coding": [
            {
                "system": "eHealth/care_plan_status_reasons",
                "code": "some code"
            }
        ]
    }, 
    "status_history": [
        {
            "inserted_at": "2020-09-22T08:23:33.597Z",
            "inserted_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
            "status": "active",
            "status_reason": null
        }
    ],
    "subject": "87B0E1A2D106232D253ACB8627BCCCD8056FC685CEBA1CB587B2C3AFD9467BA9",
    "author": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "code": "employee",
                        "system": "eHealth/resources"
                    }
                ],
                "text": null
            },
            "value": "740246db-6a9a-41ca-bb0b-da2774121369",
        }
    },
    "contributor": [
        {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "employee",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121368",
            }
        }
    ],
    "terms_of_service": {
        "coding": [
            {
                "code": "INPATIENT",
                "system": "eHealth/PROVIDING_CONDITION"
            }
        ],
        "text": "Стаціонарні умови"
    },
    "inserted_at": "2020-09-22T08:23:33.597Z",
    "inserted_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
    "updated_at": "2020-09-22T08:23:33.597Z",
    "updated_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
    "signed_content_links":["https://36bacca3-ee29-48fa-8ec8-919d7a0773ca/create"]
}

Expand

title	Activity document example for service request

Code Block

...

language	js

{
    "id" : ObjectId(UUID) 
    "care_plan": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "system": "eHealth/resources",
                        "code": "care_plan"
                    }
                ]
            },
            "value": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"
        }
    },
    "author": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "code": "employee",
                        "system": "eHealth/resources"
                    }
                ],
                "text": null
            },
            "value": "740246db-6a9a-41ca-bb0b-da2774121368",
        }
    },
    "signed_content_links":["https://36bacca3-ee29-48fa-8ec8-919d7a0773ca/36bacca3-ee29-48fa-8ec8-919d7a0773c1/create"]
    "outcome_reference": [
        {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "procedure",
                            "system": "eHealth/resources"
                        }
                    ]
                },
                "value": "c1d60d70-41f3-498b-b97f-3bd9f6ecdf1e"
            }
        }
    ],
    "outcome_codeable_concept": [
        {
            "coding": [
                {
                    "system": "eHealth/procedure_outcomes",
                    "code": "procedure_cancelled"
                }
            ]
        }
    ],
    "detail": {
        "kind": "service_request",
        "reason_code": [
            {
                "coding": [
                    {
                        "system": "eHealth/ICD10_AM/condition_codes",
                        "code": "X85"
                    }
                ]
            }
        ],
        "reason_reference": [
            {
                "identifier": {
                    "type": {
                        "coding": [
                            {
                                "code": "condition",
                                "system": "eHealth/resources"
                            }
                        ]
                    },
                    "value": "c1d60d70-41f3-498b-b97f-3bd9f6ecdf2e"
                }
            }
        ],
        "goal": [
            {
                "coding": [
                    {
                        "system": "eHealth/care_plan_goals",
                        "code": "diabetes_treatment"
                    }
                ]
            }
        ],
        "status": "cencelled",
        "status_reason": {
            "coding": [
                {
                    "system": "eHealth/activity_status_reasons",
                    "code": "incorrect_patient"
                }
            ]
        },
        "quantity": {
            "value": 10
        },
        "scheduled_period": {
            "start": "2020-12-14",
            "end": "2020-12-28"
        },
        "location": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "division",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121379",
            }
        },
        "performer": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "employee",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121369",
            }
        },
        "product_reference": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "system": "eHealth/resources",
                            "code": "service"
                        }
                    ]
                },
                "value": "97d57238-ffbe-4335-92ea-28d4de117ea2"
            }
        },
        "product_codeable_concept": null,
        "daily_amount": {
            "value": 10
        },
        "remaining_quantity": {
            "value": 10
        },
        "description": "Some description of the activity",
        "do_not_perform": false,
        "inserted_at": "2020-09-22T08:23:33.597Z",
        "inserted_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
        "updated_at": "2020-09-22T08:23:33.597Z",
        "updated_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
        "program": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "medical_program",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121179",
            }
        }
    }
}

Expand

title	Activity document example for medication request

Code Block

...

...

{
    "id" : ObjectId(UUID)
    "care_plan": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "system": "eHealth/resources",
                        "code": "care_plan"
                    }
                ]
            },
            "value": "36bacca3-ee29-48fa-8ec8-919d7a0773ca"
        }
    },
    "author": {
        "identifier": {
            "type": {
                "coding": [
                    {
                        "code": "employee",
                        "system": "eHealth/resources"
                    }
                ],
                "text": null
            },
            "value": "740246db-6a9a-41ca-bb0b-da2774121369",
        }
    },
    "signed_content_links":["https://36bacca3-ee29-48fa-8ec8-919d7a0773ca/36bacca3-ee29-48fa-8ec8-919d7a0773c2/create"]"
    "outcome_reference": [
        {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "medication_dispense",
                            "system": "eHealth/resources"
                        }
                    ]
                },
                "value": "c1d60d70-41f3-498b-b97f-3bd9f6ecdf2e"
            }
        },
        {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "medication_dispense",
                            "system": "eHealth/resources"
                        }
                    ]
                },
                "value": "c1d60d70-41f3-498b-b97f-3bd9f6ecdf3e"
            }
        }
    ],
    "outcome_codeable_concept": [
        {
            "coding": [
                {
                    "system": "http://snomed.info/sct",
                    "code": "medication_dispensed"
                }
            ]
        }
    ],
    "detail": {
        "kind": "medication_request",
        "reason_code": [
            {
                "coding": [
                    {
                        "system": "eHealth/ICD10_AM/condition_codes",
                        "code": "X85"
                    }
                ]
            }
        ],
        "reason_reference": [
            {
                "identifier": {
                    "type": {
                        "coding": [
                            {
                                "code": "condition",
                                "system": "eHealth/resources"
                            }
                        ]
                    },
                    "value": "c1d60d70-41f3-498b-b97f-3bd9f6ecdf2e"
                }
            }
        ],
        "goal": {
            "coding": [
                {
                    "system": "eHealth/care_plan_goals",
                    "code": "diabetes_treatment"
                }
            ]
        },
        "status": "in_progress",
        "status_reason": null,
        "quantity": {
            "value": 10
        },
        "scheduled_timing": {
            "event": [
                "2017-04-20T19:14:13Z"
            ],
            "repeat": {
                "bounds_duration": {
                    "value": 10,
                    "comparator": ">",
                    "unit": "days",
                    "system": "eHealth/ucum/units",
                    "code": "d"
                },
                "count": 2,
                "count_max": 4,
                "duration": 4,
                "duration_max": 6,
                "duration_unit": "d",
                "frequency": 1,
                "frequency_max": 2,
                "period": 4,
                "period_max": 6,
                "period_unit": "d",
                "day_of_week": [
                    "mon"
                ],
                "time_of_day": [
                    "19:14:00"
                ],
                "when": [
                    "WAKE"
                ],
                "offset": 4
            },
            "code": {
                "coding": [
                    {
                        "system": "TIMING_ABBREVIATION",
                        "code": "Q4H"
                    }
                ]
            }
        },
        "location": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "division",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121379",
            }
        },
        "performer": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "employee",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121369",
            }
        },
        "product_reference": {
            "identifier": {
                "type": {
                    "coding": [
                        {
                            "code": "medication",
                            "system": "eHealth/resources"
                        }
                    ],
                    "text": null
                },
                "value": "740246db-6a9a-41ca-bb0b-da2774121389",
            }
        },
        "daily_amount": {
            "value": 1
        },
        "remaining_quantity": {
            "value": 3
        },
        "description": "Some description of the activity",
        "do_not_perform": false,
        "program": null,
        "inserted_at": "2020-09-22T08:23:33.597Z",
        "inserted_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
        "updated_at": "2020-09-22T08:23:33.597Z",
        "updated_by": "22b42cb6-bc01-4436-a1f4-a5a7365fa29a",
    }
}

Version	Old Version 2	New Version Current
Changes made by	Nickolay Kolotov (SoE eHealth)	Iryna Lishtaba (SoE eHealth)
Saved on	Apr 02, 2021	Oct 22, 2024

Versions Compared

Key

FHIR description

Schema

eHealth description

Care plan

Care plan document

Activities

Activity document

Detail document

Example