Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Table of Contents

Data Structure

Service Request

Object name: service_request

...

HL7

...

Name

...

Type

...

M/O

...

Description and constraints

...

HL7 vs eHealth comparison result

...

Status

...

requisition : { Identifier } //A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier.

Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation.

...

performer_type

...

e-Health: references only to Conditions and Observations.

Corresponds to Findings field in the form of referral which is currently used.

...

e-Health: references to Episode of Care, Condition, Observation, Allergy Intolerance, Immunization 

Corresponds to Treatments given, Clinical History, Documents accompanying referral fields in the form of referral which is currently used.

...

Table of Contents

FHIR description

Service request

Schema

...

View file
nameService request data model.drawio

Service request document

Collection name: service_requests

This collection used to store service request documents.

Name

Type

M/O

Description and constraints

HL7 vs eHealth comparison result

id

string

M

System identifier of Service request (ObjectID)

Doesn't comply with FHIR

status

string

M

Status of Service request. Fetches from a dictionary service_request_statuses

Ok

status_history

inserted_at

string

M

Datetime when status was changed

Doesn't comply with FHIR

inserted_by

string

Identifier of the user who changed the status of the service request

status

string

Status of Service request. Fetches from a dictionary

status_reason

string

Reason of changing the status to completed/recalled/cancelled

program_processing_status

string

M

Status of processing Service request based on medical program. Fetches from a dictionary service_request_processing_statuses

Doesn't comply with FHIR

program_processing_status_history

inserted_at

string

M

Datetime when program_processing_status was changed

Doesn't comply with FHIR

inserted_by

string

Identifier of the user who changed the program_processing_status

program_processing_status

string

Status of processing Service request based on medical program.

intent

string

M

Proposal of the Service request. Fetches from a dictionary

Ok

priority

string

M

Indicates how quickly the Service request should be addressed with respect to other requests. Fetches from a dictionary

Ok

based_on

[Reference]

O

Reference on Care plan and its Activity

Ok

category

{Codeable_concept}

M

Category of the Service request. Fetches from the dictionary

Ok

code

{Reference}

M

Reference on Service or Service group. Fetches from the dictionary

Doesn't comply with FHIR (datatype)

quantity

{SimpleQuantity}

O

Quantity of required procedures, encounters or diagnostic_reports

Doesn't comply with FHIR

remaining_quantity

{SimpleQuantity}

O

Remaining Quantity of procedures, encounters or diagnostic_reports

Doesn't comply with FHIR

program

{Reference}

O

Reference on Medical program resource

Doesn't comply with FHIR

context

{Reference}

M

Reference on Encounter identifier based on Service request was created

Doesn't comply with FHIR

occurrence_date_time

occurrence_period

{Timing}

{Period}

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

expiration_date

string

M

Indicates expiration date of the Service request

Doesn't comply with FHIR

requester_employee

[Reference]

O

The individual who initiated the Service request and has responsibility for its activation

Doesn't comply with FHIR

requester_legal_entity

[Reference]

O

Legal entity where was initiated the Service request

Doesn't comply with FHIR

reason_reference

[Reference]

O

References on conditions/oservations.

Ok

supporting_info

[Reference]

O

Reference on supporting medical events.

Ok

note

string

O

Comments, notes about Service requests

Doesn't comply with FHIR

patient_instruction

string

O

Patient or consumer-oriented instructions

Ok

permitted_resources

[Reference]

O

Used for giving access rights to view listed episodes to the future performer of the request

Doesn't comply with FHIR

performer

{Reference}

O

Reference on employee who will perform the Service request.

Ok

location_reference

{Reference}

O

Reference on division where will be performed the Service request

Ok

performer_type

{Codeable_concept}

O

Desired type of performer for doing the requested service.

Ok

requisition

string

M

Hashed value of human-readable Service request number

Doesn't comply with FHIR

subject

string

M

Hashed patient_id

Doesn't comply with FHIR (datatype)

used_by_legal_entity

{Reference}

O

Legal entity where the service request has been used

Doesn't comply with FHIR

used_by_legal_entity_history

inserted_at

timestamp

O

Date and time when used_by_legal_entity changed

Doesn't comply with FHIR

inserted_by

string

User identifier who set the used_by_legal_entity

used_by_legal_entity

{Reference}

Legal entity where the service request has been used

used_by_division

{Reference}

O

Division where the service request has been used

Doesn't comply with FHIR

used_by_employee

{Reference}

O

Employee who used the service request

Doesn't comply with FHIR

used_by_employee_history

inserted_at

timestamp

O

Date and time when used_by_employee changed

Doesn't comply with FHIR

inserted_by

string

User identifier who set the used_by_employee

used_by_employee

{Reference}

Employee who used the service request

completed_with

{Reference}

O

The medical event with which the request was completed

Doesn't comply with FHIR

context_program_service

{Reference}

O

The program service with which the request was completed

Doesn't comply with FHIR

inserted_at

timestamp

M

Datetime when Service request was created

Doesn't comply with FHIR

inserted_by

string

M

Identifier on the user created the Service request

Doesn't comply with FHIR

updated_at

timestamp

M

Datetime when Service request was last updated

Doesn't comply with FHIR

updated_by

string

M

Identifier on the user last updated the Service 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

specimens

 

[Reference]

O

Procedure Samples

Ok

Example

Expand
titleService request document example
Code Block
languagejson
{
    "_id" : UUID("93240a8b-05e1-49ac-bc60-42be82066773"),
    "performer_type" : null,
    "used_by_division" : null,
    "status_history" : [ 
        {
            "inserted_at" : ISODate("2022-01-10T14:00:17.391Z"),
            "inserted_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
            "status" : "active",
            "status_reason" : null
        }, 
        {
            "inserted_at" : ISODate("2022-01-10T14:11:00.783Z"),
            "inserted_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
            "status" : "recalled",
            "status_reason" : {
                "coding" : [ 
                    {
                        "code" : "default",
                        "system" : "eHealth/service_request_recall_reasons"
                    }
                ],
                "text" : null
            }
        }
    ],
    "subject" : "C638240F4B629E4A722B76F207647D8E16C131A76C19291C8854DA5A1A921D12",
    "intent" : "order",
    "used_by_employee" : null,
    "permitted_resources" : [],
    "based_on" : [],
    "note" : null,
    "reason_reference" : [],
    "updated_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
    "inserted_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
    "requester_legal_entity" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "legal_entity",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("f15766d0-70fe-451d-8a66-3edfe6421947")
        }
    },
    "category" : {
        "coding" : [ 
            {
                "code" : "diagnostic_curative",
                "system" : "eHealth/SNOMED/service_request_categories"
            }
        ],
        "text" : null
    },
    "inserted_at" : ISODate("2022-01-10T14:00:17.391Z"),
    "program" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "medical_program",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("4894446b-3f33-4469-b21e-d430aa7a63bd")
        }
    },
    "performer" : null,
    "updated_at" : ISODate("2022-01-10T14:11:00.783Z"),
    "occurrence" : {
        "occurrence_date_time" : ISODate("2022-01-15T13:57:07.964Z"),
        "occurrence_period" : null
    },
    "explanatory_letter" : "Some recall explanation",
    "expiration_date" : ISODate("2023-01-10T23:59:59.000Z"),
    "" : [ 
        "93240a8b-05e1-49ac-bc60-42be82066773/create", 
        "93240a8b-05e1-49ac-bc60-42be82066773/recall"
    ],
    "requisition" : "286C5DE020C747FE823C7C03722A3ECF36D8FC6D7C744674E11C0CF85B042F95",
    "status" : "recalled",
    "completed_with" : null,
    "location_reference" : null,
    "supporting_info" : [ 
        {
            "display_value" : null,
            "identifier" : {
                "type" : {
                    "coding" : [ 
                        {
                            "code" : "episode_of_care",
                            "system" : "eHealth/resources"
                        }
                    ],
                    "text" : null
                },
                "value" : UUID("7bcf2360-786f-47de-9d40-2c881dd59f8b")
            }
        }
    ],
    "program_service" : null,
    "priority" : null,
    "context" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "encounter",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("38cfbd3c-a84f-46cd-89c6-2455dc1b1705")
        }
    },
    "status_reason" : {
        "coding" : [ 
            {
                "code" : "default",
                "system" : "eHealth/service_request_recall_reasons"
            }
        ],
        "text" : null
    },
    "context_program_service" : null,
    "program_processing_status" : "new",
    "requester_employee" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "employee",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("0ec40ce7-5f26-4f1c-baec-30215c964bd6")
        }
    },
    "patient_instruction" : null,
    "program_processing_status_history" : [ 
        {
            "inserted_at" : ISODate("2022-01-10T14:00:17.391Z"),
            "inserted_by" : UUID("66bab341-96f8-4dfa-a601-aeb1359b763c"),
            "program_processing_status" : "new"
        }
    ],
    "used_by_legal_entity" : null,
    "code" : {
        "display_value" : null,
        "identifier" : {
            "type" : {
                "coding" : [ 
                    {
                        "code" : "service",
                        "system" : "eHealth/resources"
                    }
                ],
                "text" : null
            },
            "value" : UUID("bc71706a-472f-4a1a-8f36-8d5421508bb5")
        }
    },
    "quantity": null,
    "remaining_quantity": null,
    "used_by_legal_entity_history": null,
    "used_by_employee_history": null
}