Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

FHIR description

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

Schema

...

Device request document

Collection name: device_requests

This collection used to store device request documents

...

Name

...

Type

...

M/O

...

Description and constraints

...

HL7 vs eHealth comparison result

...

id

 

...

string

...

M

...

Unique system identifier of Device request

...

Ok

...

status

 

...

string

...

M

...

Status of Device request. Dictionary device_request_statuses

...

Ok

...

status_reason

...

{CodeableConcept}

...

O

...

Status reason why Device request was not performed. Dictionary device_request_revoke_reasons

...

Doesn't comply with FHIR

...

intent

...

string

...

M

...

Proposal of the Device request. Dictionary device_request_intent

...

Ok

...

code

...

{CodeableConcept}

...

M

...

The code of the device to be used. Dictionary device_definition_classification_type

...

Ok

...

quantity

...

SimpleQuantity

...

O

...

Quantity of devices to supply

Required for Device requests with programs.

...

Doesn't comply with FHIR (type)

...

subject

...

string

...

M

...

Hashed patient_id. Who the request is for

...

Doesn't comply with FHIR (type)

...

requester

...

{Reference}

...

M

...

Reference on employee who submitted device request

...

Ok

...

encounter

...

{Reference}

...

M

...

An encounter that provides additional context in which this request is made.

...

Ok

...

reason

...

[Reference]

...

O

...

Reason or justification for the use of this device.

Only reference on condition is allowed.

...

Ok

...

authored_on

...

dateTime

...

M

...

When recorded

Must be greater than Encounter start date

...

Ok

...

note

...

string

...

O

...

Notes or comments

...

Ok

...

requester_legal_entity

...

{Reference}

...

M

...

Legal entity where the Device request was created

...

Doesn't comply with FHIR

...

program

...

{Reference}

...

O

...

Medical program identifier

...

Doesn't comply with FHIR

...

requisition

...

string

...

M

...

Hashed value of human-readable Device request number

...

Doesn't comply with FHIR

...

dispense_valid_to

...

dateTime

...

M

...

Last day of dispense validity period, which is automatically determined by the eHealth system depends on inserted_at

...

Doesn't comply with FHIR

...

occurrence_period

...

start

...

dateTime

...

M

...

Start date of a treatment period, which is determined by the external system. Greater or equal to authored_on

...

Ok

...

end

...

dateTime

...

M

...

End date of a treatment period, which is determined by the external system. Greater or equal to started_at.

...

verification_code

...

string

...

M

...

Hashed verification code for dispensing Device request

...

Doesn’t comply with FHIR

...

context_episode_id

...

uuid

...

M

...

Episode identifier based on encounter was created

...

Doesn’t comply with FHIR

...

inserted_at

...

uuid

...

M

...

Datetime when Device request was created

...

Doesn’t comply with FHIR

...

inserted_by

...

uuid

...

M

...

User identifier who created the Device request

...

Doesn’t comply with FHIR

...

updated_at

...

uuid

...

M

...

Datetime when Device request was updated

...

Doesn’t comply with FHIR

...

updated_by

...

uuid

...

M

...

User identifier who updated the Device request

...

Doesn’t comply with FHIR

...

signed_content_links

...

[string]

...

M

...

Array with links on signed content in media storage.

...

Doesn't comply with FHIR

Example

...

titleDevice request document example

...

Table of Contents

FHIR description

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

Schema

...

Source:

View file
namedrModel.drawio

Device request document

Collection name: device_requests

This collection used to store device request documents

Name

Type

M/O

Description and constraints

HL7 vs eHealth comparison result

id

 

string

M

Unique system identifier of Device request

Ok

status

 

string

M

Status of Device request. Dictionary device_request_statuses

Ok

status_reason

{CodeableConcept}

O

Status reason why Device request was not performed. Dictionaries: device_request_revoke_reasons

device_request_mark_in_error_reasons

Doesn't comply with FHIR

intent

string

M

Proposal of the Device request. Dictionary device_request_intent

Ok

code

{CodeableConcept}

O

The code of the device to be used. Dictionary device_definition_classification_type

One of the code and code_reference is allowed

Ok

code_reference

{Reference}

O

Reference on device_definition

One of the code and code_reference is allowed

Doesn't comply with FHIR (type)

quantity

SimpleQuantity

O

Quantity of devices to supply

Required for Device requests with programs.

Doesn't comply with FHIR (type)

subject

string

M

Hashed patient_id. Who the request is for

Doesn't comply with FHIR (type)

requester

{Reference}

M

Reference on employee who submitted device request

Ok

encounter

{Reference}

M

An encounter that provides additional context in which this request is made.

Ok

reason

[Reference]

O

Reason or justification for the use of this device.

Only reference on condition, observation, diagnostic_report is allowed.

Ok

authored_on

dateTime

M

When recorded

Must be greater than Encounter start date and less than Encounter end date

Ok

note

string

O

Notes or comments

Ok

requester_legal_entity

{Reference}

M

Legal entity where the Device request was created

Doesn't comply with FHIR

program

{Reference}

O

Medical program identifier

Doesn't comply with FHIR

requisition

string

M

Hashed value of human-readable Device request number

Doesn't comply with FHIR

dispense_valid_to

date

O

Last day of dispense validity period, which is automatically determined by the eHealth system depends on inserted_at

Doesn't comply with FHIR

occurrence_period

start

object

dateTime

M

Start date of a treatment period, which is determined by the external system. Greater or equal to authored_on

Ok

end

dateTime

M

End date of a treatment period, which is determined by the external system. Greater or equal to started_at.

verification_code

string

M

Hashed verification code for dispensing Device request

Doesn’t comply with FHIR

context_episode_id

uuid

M

Episode identifier based on encounter was created

Doesn’t comply with FHIR

inserted_at

uuid

M

Datetime when Device request was created

Doesn’t comply with FHIR

inserted_by

uuid

M

User identifier who created the Device request

Doesn’t comply with FHIR

updated_at

uuid

M

Datetime when Device request was updated

Doesn’t comply with FHIR

updated_by

uuid

M

User identifier who updated the Device request

Doesn’t comply with FHIR

signed_content_links

[string]

M

Array with links on signed content in media storage.

Doesn't comply with FHIR

based_on

[Reference]

O

Allowed resources to reference:

  • activity

Ok

priority

string

O

Proposal of the Device request. Dictionary device_request_priority

Ok

parameter

code

array

 

O

O

Dictionary device_properties

Ok

value[x]

 

 

One value[x] is allowed

Value[x] is required

  • value_codeable_concept

{CodeableConcept}

O

 

  • value_quantity

{Quantity}

O

 

  • value_range

{Range}

O

 

  • value_boolean

Boolean

O

 

  • value_string

 

String

O

 

performer

{Reference}

O

The desired legal entity to provide device for the patient

Allowed resources to reference:

  • legal_entity

Ok

supporting_info

[Reference]

O

Additional clinical information

References to other patient’s medical data

Allowed resources to reference:

  • condition

  • observation

  • diagnostic_report

  • procedure

  • encounter

  • episode

  • device

  • device_association

Ok

context_care_plan_id

Reference

O

Care plan on which Device request is based

Doesn't comply with FHIR

Example

Expand
titleDevice request document example
Code Block
{
    "_id" : UUID("93240a8b-05e1-49ac-bc60-42be82066773"),
    "status" : "revoked",
    "status_reason" : {
        "coding" : [ 
            {
                "code" : "incorrect_patient",
                "system" : "device_request_revoke_reasons"
            }
        ],
        "text" : null
    },
    "intent" : "order",
    "code" : {
        "coding" : [ 
            {
                "code" : "30221",
                "system" : "device_definition_classification_type"
            }
        ],
        "text" : null
    },    
    "quantity": {
      "value": 10,
      "system": "device_unit",
      "code": "piece",
      "unit": "шт"
    },
    "subject" : "C638240F4B629E4A722B76F207647D8E16C131A76C19291C8854DA5A1A921D12",
    "requester" : {
        "display_value" : "Петрарка Петро Петрович",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("f15766d0-70fe-451d-8a66-3edfe6421947")
        }
    },
    "encounter" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "encounter",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("38cfbd3c-a84f-46cd-89c6-2455dc1b1705")
        }
    },
    "reason": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "condition"
              }
            ]
          },
          "value": UUID("38cfbd3c-a84f-46cd-89c6-2455dc1b1705")
        },
        "display_value": "null"
      }
    ],
	"authored_on" : ISODate("2023-01-10T23:59:59.000Z"),    
    "note" : null,
    "requester_legal_entity" : {
        "codingdisplay_value" : ["Комунальне підприємство Добромед",
        "identifier"  : {
                "codetype" : "incorrect_patient",{
                "systemcoding" : "device_request_revoke_reasons" [ 
               }     {
   ],         "text" : null     },     "intentcode" : "orderlegal_entity",
            "code"  : {         "codingsystem" : [ "eHealth/resources"
                 {   }
             "code"  : "30221"],
                "systemtext" : "device_definition_classification_type"
  null
         }   },
     ],       "value" : "text" : nullUUID("f15766d0-70fe-451d-8a66-3edfe6421947")
        },
    },
    "quantityprogram" : {
        "display_value" : 10null,
        "systemidentifier" : "device_unit", {
           "code": "piecetype", : {
    "unit": "шт"       },     "subjectcoding" : "C638240F4B629E4A722B76F207647D8E16C131A76C19291C8854DA5A1A921D12", [ 
      "requester" : {         "display_value" : "Петрарка Петро{
Петрович",         "identifier" : {             "typecode" : {"medical_program",
                "coding" : [      "system" : "eHealth/resources"
             {       }
                ],
"code" : "employee",               "text" : null
        "system" : "eHealth/resources"  },
            "value" : UUID("4894446b-3f33-4469-b21e-d430aa7a63bd")
   }     }
    },
    "requisition" : ]"286C5DE020C747FE823C7C03722A3ECF36D8FC6D7C744674E11C0CF85B042F95",
    "dispense_valid_to" : ISODate("2023-01-10T23:59:59.000Z"),    
       "text"occurrence_period" : null{
        "start"    },
 : ISODate("2022-01-15T13:57:07.964Z"),
          "valueend" : UUIDISODate("f15766d02022-70fe-451d-8a66-3edfe6421947")
        }
    }01-15T13:57:07.964Z"),
    },
    "verification_code" : "1341",
    "context_episode_id": "4894446b-3f33-4469-b21e-d430aa7a63bd",
    "encounterinserted_at" : {ISODate("2022-01-10T14:00:17.391Z"),
        "displayinserted_valueby" : null,
UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
       "identifier"updated_at" : {ISODate("2022-01-10T14:00:17.391Z"),
    "updated_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
     "typesigned_content_links" : {[ 
          "93240a8b-05e1-49ac-bc60-42be82066773/create", 
   "coding" : [   "93240a8b-05e1-49ac-bc60-42be82066773/revoke"
    ],
    "priority" : "routine",
    "performer" : {
        "display_value" : "Комунальне підприємство   Добромед",
         "codeidentifier" : "encounter",{
            "type" : {
         "system" : "eHealth/resources"      "coding" : [ 
           }         {
       ],                 "textcode" : null
"legal_entity",
           },             "valuesystem" : UUID("38cfbd3c-a84f-46cd-89c6-2455dc1b1705")
"eHealth/resources"
       }     },     "reason": [  }
    {         "identifier": {    ],
      "type": {             "coding": [
    text" : null
         {   },
             "systemvalue" : "eHealth/resources",UUID("f15766d0-70fe-451d-8a66-3edfe6421947")
        }
    },
    "codebased_on": [
"condition"      {
        }"identifier": {
          "type": ]{
          },  "coding": [
       "value": UUID("38cfbd3c-a84f-46cd-89c6-2455dc1b1705")
       {
       },         "display_valuesystem": "nulleHealth/resources",
      }       ],   "authored_oncode" : ISODate("2023-01-10T23:59:59.000Z"),"activity"
              }
 "note" : null,     "requester_legal_entity" : {  ]
      "display_value" : "Комунальне підприємство Добромед"},
          "identifiervalue" : {"9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
   "type" : {   }
    ],    
    "codingsupporting_info" : [
      {
        "identifier": {
    {      "type": {
            "coding": [
   "code" : "legal_entity",           {
                "system" : "eHealth/resources",
                "code": "episode_of_care"
  }            }
    ],                 "text" : null]
             },
            "value" : UUID("f15766d09183a36b-70fe4d45-451d4244-8a669339-3edfe6421947")
        }
    },63d81cd08d9c"
      "program" : {},
        "display_value" : "null,"
      }
 "identifier" : { ],    
       "typeparameter" : [{
        "code" : {
          "coding" : [{
            "system" : "http://loinc.org",
      {      "code"     : "28826-6",
             "codedisplay" : "medical_program",
  Sphere distance Glasses prescription.lens - right"
          }],
          "systemtext" : "eHealth/resources"sphere, right lens"
        },
        "valueQuantity" : {
    }      "value" : -2.00,
        ],  "unit" : "Diopter",
          "system" : "text" : null"http://unitsofmeasure.org",
          "code" : "[diop]"
   },     }
      },
"value" : UUID("4894446b-3f33-4469-b21e-d430aa7a63bd")    {
    }    "code" },: {
   "requisition" : "286C5DE020C747FE823C7C03722A3ECF36D8FC6D7C744674E11C0CF85B042F95",     "dispense_valid_tocoding" : ISODate("2023-01-10T23:59:59.000Z"),[{
            "occurrence_periodsystem" : { "http://loinc.org",
            "startcode" : ISODate("2022-01-15T13:57:07.964Z"),28829-0",
            "enddisplay" : ISODate("2022-01-15T13:57:07.964Z"),"Prism base distance Glasses prescription.lens - right"
          }],
    "verification_code" : "1341",     "context_episode_idtext" : "4894446b-3f33-4469-b21e-d430aa7a63bd",prisms, right lens"
      "inserted_at" : ISODate("2022-01-10T14:00:17.391Z") },
    "inserted_by    "valueQuantity" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"), {
          "updated_atvalue" : ISODate("2022-01-10T14:00:17.391Z"),
    "updated_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),-2.00,
          "signed_content_linksunit" : "Diopter",
  [        "system" : "93240a8b-05e1-49ac-bc60-42be82066773/createhttp://unitsofmeasure.org",
          "code" : "93240a8b-05e1-49ac-bc60-42be82066773/revoke"[diop]"
        ],}
      }]
}