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

...

Source:

View file
namedrModel.drawio

Device request document

Collection name: device_requests

...

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

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_string

String

M

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

authorize_with

String

O

Hashed patient authentication method used while creating device request

Doesn't comply with FHIR

Example

Expand
titleDevice request document example
Code Block
languagejson
{
    "_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" : {
        "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")
        }
    },
    "requisition" : "286C5DE020C747FE823C7C03722A3ECF36D8FC6D7C744674E11C0CF85B042F95",
    "dispense_valid_to" : ISODate("2023-01-10T23:59:59.000Z"),    
    "occurrence_period" : {
        "start" : ISODate("2022-01-15T13:57:07.964Z"),
        "end" : ISODate("2022-01-15T13:57:07.964Z"),
    },
    "verification_code" : "1341",
    "context_episode_id": "4894446b-3f33-4469-b21e-d430aa7a63bd",
    "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/create", 
        "93240a8b-05e1-49ac-bc60-42be82066773/revoke"
    ],
    "priority" : "routine",
    "performer" : {
        "display_value" : "Комунальне підприємство Добромед",
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "legal_entity",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("f15766d0-70fe-451d-8a66-3edfe6421947")
        }
    },
    "based_on": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "activity"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        }
      }
    ],    
    "supporting_info": [
      {
        "identifier": {
          "type": {
            "coding": [
              {
                "system": "eHealth/resources",
                "code": "episode_of_care"
              }
            ]
          },
          "value": "9183a36b-4d45-4244-9339-63d81cd08d9c"
        },
        "display_value": "null"
      }
    ],    
    "parameter" : [{
        "code" : {
          "coding" : [{
            "system" : "http://loinc.org",
            "code" : "28826-6",
            "display" : "Sphere distance Glasses prescription.lens - right"
          }],
          "text" : "sphere, right lens"
        },
        "valueQuantity" : {
          "value" : -2.00,
          "unit" : "Diopter",
          "system" : "http://unitsofmeasure.org",
          "code" : "[diop]"
        }
      },
      {
        "code" : {
          "coding" : [{
            "system" : "http://loinc.org",
            "code" : "28829-0",
            "display" : "Prism base distance Glasses prescription.lens - right"
          }],
          "text" : "prisms, right lens"
        },
        "valueQuantity" : {
          "value" : -2.00,
          "unit" : "Diopter",
          "system" : "http://unitsofmeasure.org",
          "code" : "[diop]"
        }
      }]
}