| 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
...
identifier : { Identifier } // Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller
...
id
...
uuid
...
M
...
Unique identifier of the current record
...
Ok
...
Approved
...
instantiates : { uri } //Protocol or definition followed by this request.
...
-
...
No Implementation
...
Approved
...
basedOn : [{ Reference(CarePlan | ServiceRequest | MedicationRequest) }] //Plan/proposal/order fulfilled by this request.
...
-
...
No Implementation
...
Approved
...
replaces : [{ Reference(ServiceRequest ) }] //The request takes the place of the referenced completed or terminated request(s).
...
-
...
No Implementation
...
Approved
...
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.
...
requisition
...
string
...
М
...
Should be unique human readable number. See Human readable requisition number
...
Ok
...
Approved
...
status : { code } //draft | active | suspended | completed | entered-in-error | cancelled RequestStatus (Required) The status of the order.
...
status
...
string
...
M
...
Active, Enterred In Error, Cancelled
...
Ok
...
Approved
...
status_reason
...
codeable_concept
...
O
...
Implemented as a part of status_history
...
Ok
...
Approved
...
explanatory_letter
...
string
...
O
...
Text explanation on why service request was cancelled or recalled.
...
Ok
...
Approved
...
-
...
status_history
...
[ status_history ]
...
O
...
History of service request status changes if there were any. Contains status, code of a reason why status was set, date and time of change.
...
Ok
...
Approved
...
intent : { code } //proposal | plan | order + RequestIntent (Required) Whether the request is a proposal, plan, an original order or a reflex order.
...
intent
...
string
...
M
...
e-Health: by default Order
...
Ok
...
Approved
...
priority : { code } //routine | urgent | asap | stat RequestPriority (Required)Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
...
priority
...
string
...
M
...
e-Health: by default Routine
...
Ok
...
Approved
...
doNotPerform : { boolean } // Set this to true if the record is saying that the service/procedure should NOT be performed.
...
-
...
No Implementation
...
Approved
...
category : { CodeableConcept } //Classification of service Service Request Category Codes (Example) A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").
...
category
...
codeable_concept
...
M
...
A code that classifies service which has to be provided to a patient
...
Ok
...
Approved
...
code : { CodeableConcept } // What is being requested/ordered Procedure Codes (SNOMED CT) (Example) A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.
...
code
...
codeable_concept
...
M
...
e-Health: first release may not contain values in the dictionary
...
Ok
...
Approved
...
orderDetail : { CodeableConcept } // Additional order information Service Request Order Details Codes (Example). Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have a order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied.
...
-
...
e-Health: no implementation because of no process at the moment
...
No Implementation
...
Approved
...
subject : { Reference(Patient | Group| Location | Device) } // Individual the service is ordered for. On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).
...
subject
...
uuid
...
M
...
Patient for whoom the service is to be performed
...
Ok
...
Approved
...
context : { Reference(Encounter | EpisodeOfCare) } // Encounter or Episode during which request was created.
...
context
...
Reference (Encounter)
...
M
...
Encounter during which service request was created
...
Ok
...
Approved
...
occurrence[x] : { } //When service should occur
...
occurrence
...
occurrence
...
O
...
No Implementation
...
Approved
...
occurrenceDateTime : { dateTime }
...
occurrence_date_time
...
date_time
...
O
...
Ok
...
Approved
...
occurrencePeriod : { Period }
...
occurrence_period
...
period
...
O
...
Period when service should but does not have to occur. When creating service request one of should be specified: occurrence_date_time or occurrence_period.
...
Ok
...
Approved
...
occurrenceTiming : { Timing }
...
No Implementation
...
Approved
...
asNeeded[x] : { } // Preconditions for service SNOMED CT Medication As Needed Reason Codes (Example) If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc
...
No Implementation
...
Approved
...
asNeededBoolean : { boolean }
...
asNeededCodeableConcept : { CodeableConcept }
...
authoredOn : { dateTime } Date request signed.
...
authored_on
...
date_time
...
M
...
When the request transitioned to being actionable. In case of e-Health it is the date when request was signed.
...
Ok
...
Approved
...
requester : { Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) } // The individual who initiated the request and has responsibility for its activation
...
requester_employee
...
Reference(Employee)
...
M
...
Employee who has created and signed service request
...
Ok
...
Approved
...
requester_legal_entity
...
Reference(Legal_entity)
...
M
...
Organization (legal entity) which is responsible for service request
...
Ok
...
Approved
...
performerType : { CodeableConcept } // Performer role Participant Roles (Example) Desired type of performer for doing the requested service.
...
performer_type
...
codeable_concept
...
O
...
specialization to which the patient is referred (only for referrals for hospitalization it is mandatory, for others it cannot be indicated)
More information in:
https://www.hl7.org/fhir/servicerequest.html
...
Ok
...
Approved
...
performer : { Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson | HealthcareService | CareTeam) } // Requested perfomer. The desired perfomer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc
...
performer
...
O
...
reference to the organization where the patient is sent (only for transfer it is mandatory, for others it cannot be indicated)
More information in:
https://www.hl7.org/fhir/servicerequest.html
...
Ok
...
Approved
...
location_reference
...
O
...
a link to the separated patient to whom the patient is referred (only for transfer it is optional, for others it cannot be indicated)
More information in:
https://www.hl7.org/fhir/servicerequest.html
...
Ok
...
Approved
...
reasonCode : [{ CodeableConcept }]// Procedure Reason Codes (Example). An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in supportingInformation
...
reason 
...
No Implementation
...
Approved
...
reasonReference : [{ Reference(Condition | Observation | DiagnosticReport | DocumentReference) }] // Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in supportingInformation
...
reason_references
...
[Reference(Condition | Observation)]
...
O
...
e-Health: references only to Conditions and Observations.
Corresponds to Findings field in the form of referral which is currently used.
...
Ok
...
Approved
...
insurance : { Reference(Coverage | ClaimResponse) } // Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service
...
-
...
No Implementation
...
Approved
...
supportingInfo : [{ Reference(Any) }] // Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements.
...
supporting_info
...
[Reference(Episode of Care | Condition | Observation | Allergy Intolerance | Immunization | Diagnostic report)]
...
O
...
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.
...
Ok
...
Approved
...
specimen : [{ Reference(Specimen) }] // One or more specimens that the laboratory procedure will use
...
-
...
No Implementation
...
Approved
...
bodySite : [{ CodeableConcept }] // Location on Body SNOMED CT Body Structures (Example) (Anatomic location where the procedure should be performed. This is the target site)
...
No dictionary at the moment
...
No Implementation
...
Approved
...
note : [{ Annotation }] // Comments
...
note
...
string
...
O
...
Any notes and comments made about the service request.
...
Ok
...
Approved
...
patientInstruction : { string } // Patient or consumer oriented instructions
...
patient_instruction
...
string
...
O
...
Instructions in terms that are understood by the patient on how to be prepared for service obtaining
...
Ok
...
Approved
...
relevantHistory : [{ Reference(Provenance) }] // Key events in the history of the reques
...
-
...
No Implementation
...
Approved
...
-
...
permitted_resources
...
[Reference(EpisodeOfCare)|Reference(Diagnostic Report]
...
O
...
e-Health: used for giving access rights to view listed episodes to the future performer of the request
...
Ok
...
Approved/Renamed
...
-
...
used_by_employee
...
Reference(Employee)
...
O
...
e-Health: represents employee assigned to this referral
...
-
...
program
...
Reference(Program)
...
O
...
Medical program by which patient is getting prescribed service
...
New
...
-
...
used_by_legal_entity
...
Reference(Legal_enity)
...
O
...
Organization (legal entity) which is going to provide service by service request under a program. Not used for service requests without program.
...
New
...
-
...
expiration_date
...
string
...
M
...
format: datetime
...
New
...
-
...
program_processing_status
...
string
...
O
...
new, in queue, in progress, completed
...
| Table of Contents |
|---|
FHIR description
Schema
...
| View file | ||
|---|---|---|
|
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 | 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 | 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 | O | Quantity of required procedures, encounters or diagnostic_reports | Doesn't comply with FHIR | ||
remaining_quantity | 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 | |||||
|---|---|---|---|---|---|
| |||||
|