RC___[UPD] Device dispense data model

1 FHIR description
2 Schema
3 Device dispense document
4 Example

FHIR description

http://hl7.org/fhir/R5/devicedispense.html

Schema

Untitled Diagram-1689166355024.drawio.png

Device dispense document

Collection name: device_dispenses

This collection used to store device dispenses documents

Name		Type		M/O		Description and constraints	HL7 vs eHealth comparison result

Name		Type		M/O		Description and constraints	HL7 vs eHealth comparison result
id		string		M		Unique system identifier of Device dispense	Ok
based_on		{Reference}		M		Device request that this dispense is fulfilling	Ok
status		string		M		Status of Device dispense. Dictionary `device_dispense_statuses`	Ok
subject		string		M		Hashed patient_id. Who the dispense is for	Doesn't comply with FHIR (type)
performer		{Reference}		M		Reference on employee who performed the dispense	Doesn't comply with FHIR (type)
location		{Reference}		M		Division where the Device dispense was created
when_handed_over		dateTime		O		When product was given out	Ok
note		string		O		Notes or comments	Ok
performer_legal_entity		{Reference}		M		Legal entity where the Device dispense was created	Doesn't comply with FHIR
program		{Reference}		O		Medical program identifier	Doesn't comply with FHIR
details	device	array	{Reference}	M	O	One of is required: device_definition or device.	Doesn't comply with FHIR
	device_code		CodeableConcept		O	The code of the device to be used. Dictionary `device_definition_classification_type`
	program_device		{Reference}		O	Program device definition participant
	quantity		SimpleQuantity		M	Quantity of devices to supply Required for Device disp with programs.
	sell_price		float		O	Price of the device definition
	reimbursement_amount		float		O	Reimbursement amount of the device definition
	discount_amount		float		O	Total reimbursement amount
payment_id		varchar(255)		O		Receipt number (not System identifier)	Doesn’t comply with FHIR
payment_amount		float		O		Amount of money paid by Patient	Doesn’t comply with FHIR
inserted_at		uuid		M		Datetime when Device dispense was created	Doesn’t comply with FHIR
inserted_by		uuid		M		User identifier who created the Device dispense	Doesn’t comply with FHIR
updated_at		uuid		M		Datetime when Device dispense was updated	Doesn’t comply with FHIR
updated_by		uuid		M		User identifier who updated the Device dispense	Doesn’t comply with FHIR
signed_content_links		[string]		M		Array with links on signed content in media storage.	Doesn't comply with FHIR
part_of		{Reference}		O		The Procedure that this dispense is a part of	Ok
encounter		{Reference}		O		Encounter associated with the dispense	Ok
context_episode_id		uuid		O		Reference to the episode in which device dispense was created	Doesn't comply with FHIR
origin_episode_id		uuid		O		Reference to the episode in which related device request was created	Doesn't comply with FHIR
supporting_info		[{Reference}]		O		References to resources that supports the dispensing of the device: condition, observation, diagnostic_report, procedure, encounter, episode, device, device_association)	Doesn't comply with FHIR
status_reason		CodeableConcept		O		The reason for the status	Ok

Example

{
   "_id":"UUID(""93240a8b-05e1-49ac-bc60-42be82066773"")",
   "based_on":{
      "display_value":null,
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"device_request",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""38cfbd3c-a84f-46cd-89c6-2455dc1b1705"")"
      }
   },
   "status":"stopped",
   "subject":"C638240F4B629E4A722B76F207647D8E16C131A76C19291C8854DA5A1A921D12",
   "performer":{
      "display_value":"Петрарка Петро Петрович",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"employee",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "location":{
      "display_value":"Друге відділення аптеки доброї ночі",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"division",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "when_handed_over":"ISODate(""2023-01-10T23:59:59.000Z"")",
   "note":null,
   "performer_legal_entity":{
      "display_value":"Аптека доброї ночі",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"legal_entity",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "program":{
      "display_value":null,
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"medical_program",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""4894446b-3f33-4469-b21e-d430aa7a63bd"")"
      }
   },
   "details":[
      {
         "device":{
            "display_value":"Тест-смужки для глюкометра",
            "identifier":{
               "type":{
                  "coding":[
                     {
                        "code":"device_definition",
                        "system":"eHealth/resources"
                     }
                  ],
                  "text":null
               },
               "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
            }
         },
         "program_device":{
            "display_value":"Тест-смужки для глюкометра",
            "identifier":{
               "type":{
                  "coding":[
                     {
                        "code":"program_device",
                        "system":"eHealth/resources"
                     }
                  ],
                  "text":null
               },
               "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
            }
         },         
         "quantity":{
            "value":10,
            "system":"device_unit",
            "code":"piece",
            "unit":"шт"
         },
         "sell_price":18.65,
         "discount_amount":150,
         "reimbursement_amount":450
      }
   ],
   "payment_id": "1239804",
   "payment_amount": 50, 
   "part_of": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "procedure"
              }
            ]
          },
          "value": "UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")"
        },
        "display_value": "null"
      },
      "encounter": {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "encounter"
              }
            ]
          },
          "value": "UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")"
        },
        "display_value": "null"
      },
      "supporting_info": [
        {
          "identifier": {
            "type": {
              "coding": [
                {
                  "system": "eHealth/resources",
                  "code": "condition"
                }
              ]
            },
            "value": "UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")"
          }
        }
      ]  
   "inserted_at":"ISODate(""2022-01-10T14:00:17.391Z"")",
   "inserted_by":"UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")",
   "updated_at":"ISODate(""2022-01-10T14:00:17.391Z"")",
   "updated_by":"UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")",
   "signed_content_links":[
      "93240a8b-05e1-49ac-bc60-42be82066773/сomplete"
   ]
}

{
   "_id":"UUID(""93240a8b-05e1-49ac-bc60-42be82066773"")",
   "based_on":{
      "display_value":null,
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"device_request",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""38cfbd3c-a84f-46cd-89c6-2455dc1b1705"")"
      }
   },
   "status":"stopped",
   "subject":"C638240F4B629E4A722B76F207647D8E16C131A76C19291C8854DA5A1A921D12",
   "performer":{
      "display_value":"Петрарка Петро Петрович",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"employee",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "location":{
      "display_value":"Друге відділення аптеки доброї ночі",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"division",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "when_handed_over":"ISODate(""2023-01-10T23:59:59.000Z"")",
   "note":null,
   "performer_legal_entity":{
      "display_value":"Аптека доброї ночі",
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"legal_entity",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
      }
   },
   "program":{
      "display_value":null,
      "identifier":{
         "type":{
            "coding":[
               {
                  "code":"medical_program",
                  "system":"eHealth/resources"
               }
            ],
            "text":null
         },
         "value":"UUID(""4894446b-3f33-4469-b21e-d430aa7a63bd"")"
      }
   },
   "details":[
      {
         "device":{
            "display_value":"Тест-смужки для глюкометра",
            "identifier":{
               "type":{
                  "coding":[
                     {
                        "code":"device_definition",
                        "system":"eHealth/resources"
                     }
                  ],
                  "text":null
               },
               "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
            }
         },
         "program_device":{
            "display_value":"Тест-смужки для глюкометра",
            "identifier":{
               "type":{
                  "coding":[
                     {
                        "code":"program_device",
                        "system":"eHealth/resources"
                     }
                  ],
                  "text":null
               },
               "value":"UUID(""f15766d0-70fe-451d-8a66-3edfe6421947"")"
            }
         },         
         "quantity":{
            "value":10,
            "system":"device_unit",
            "code":"piece",
            "unit":"шт"
         },
         "sell_price":18.65,
         "discount_amount":150,
         "reimbursement_amount":450
      }
   ],
   "payment_id": "1239804",
   "payment_amount": 50, 
   "inserted_at":"ISODate(""2022-01-10T14:00:17.391Z"")",
   "inserted_by":"UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")",
   "updated_at":"ISODate(""2022-01-10T14:00:17.391Z"")",
   "updated_by":"UUID(""66bab341-96f8-4dfa-a601-aeb1359b763c"")",
   "signed_content_links":[
      "93240a8b-05e1-49ac-bc60-42be82066773/сomplete"
   ]
}