Package | botswana.hie.fhir |
Type | ExampleScenario |
Id | SubmitNewLabOrders |
FHIR Version | R5 |
Source | http://moh.bw.org/https://build.fhir.org/ig/jembi/botswana-hie-fhir-ig/ExampleScenario-SubmitNewLabOrders.html |
URL | http://moh.bw.org/ExampleScenario/SubmitNewLabOrders |
Version | 1.0.0 |
Status | active |
Date | 2025-05-19T15:02:57+00:00 |
Name | SubmitNewLabOrders |
Title | Submit New Lab Orders (Using a Bundle) |
Purpose | This serves to demonstrate the submission of a new lab orders, from the Point-of-Service (PoS) application to the FHIR datastore. |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ExampleScenario SubmitNewLabOrders
url: Submit New Lab Orders (Using a Bundle)
version: 1.0.0
name: SubmitNewLabOrders
title: Submit New Lab Orders (Using a Bundle)
status: Active
experimental: false
date: 2025-05-19 15:02:57+0000
publisher: Jembi Health Systems
contact: Jembi Health Systems: https://www.jembi.org,info@jembi.org, Jembi Health Systems: info@jembi.org
jurisdiction: Botswana
purpose:
This serves to demonstrate the submission of a new lab orders, from the Point-of-Service (PoS) application to the FHIR datastore.
actor
Actor Reference: ActorDefinition Patient Information Management System (PIMS)
Actor Reference: ActorDefinition OpenMRS
key: PoS
type: System
title: Point of Service
description:
The entity that creates the lab order.
actor
Actor Reference: ActorDefinition Interoperability Layer (IL)
key: IL
type: System
title: Interoperability Layer
description:
The entity that receives the lab order request submitted by the PoS entity.
actor
Actor Reference: ActorDefinition Shared Health Record (SHR)
key: FHIR
type: System
title: FHIR Server
description:
The entity that stores the details for the lab order submitted by the PoS entity.
instance
key: laborder.01
structureType: All FHIR Types Endpoint: Endpoint
structureProfile: Endpoint
title: Outcome response
description:
FHIR issues an outcome response to each CRUD request.
instance
key: laborder.02
structureType: All FHIR Types Bundle: Bundle
structureProfile: Bundle - Lab Orders
title: Lab Order Bundle - New Lab Orders
description:
The FHIR bundle provided by the PoS entity when submitting the lab order service request.
This bundle includes the following resources:
content: Bundle: type = transaction
instance
key: laborder.03
structureType: All FHIR Types Endpoint: Endpoint
structureProfile: Endpoint
title: FHIR request
description:
FHIR processes each request in the bundle using the HTTP request method defined for each Resource included in the Bundle.
content: Endpoint Bundle
process
title: New Lab Order
preConditions:
PoS entity has submitted a lab order request.
postConditions:
FHIR entity has stored the lab order details for the patient and sent an outcome response for the request to the IL entity.
step
number: 1
process
title: New Lab Order
description:
This scenario demonstrates the process of storing the patient's lab order information in the FHIR datastore.
step
number: 1.1
operation
type: FHIR Restful Interactions update: update
title: Submit lab order
initiator: PoS
receiver: IL
description:
Lab order information
initiatorActive: true
Requests
InstanceReference laborder.02 step
number: 1.2
Operations
Title Initiator Receiver Description InitiatorActive Invoke FHIR mediator IL IL Pass the data to the mediator responsible for calling the endpoint for creating the lab order information in FHIR.
true step
number: 1.3
operation
type: FHIR Restful Interactions update: update
title: Send data for consumption
initiator: IL
receiver: FHIR
description:
Request for FHIR to process the information in the lab order bundle.
Requests
InstanceReference laborder.03 Responses
InstanceReference laborder.01 step
number: 1.4
Operations
Title Initiator Receiver Description Success: Invoke IL mediator IL IL Pass the data to the mediator responsible for calling the endpoint that must send a response back the PoS system who initiated the lab order request.
process
title: Respond to Request
preConditions:
FHIR entity has processed the request and has issued an outcome response.
postConditions:
IL entity has received the outcome response from FHIR and forwarded the response to the PoS system.
step
number: 2
process
title: Respond to Request
description:
This scenario demonstrates the process for responding to the PoS sytem who submitted the request.
step
number: 2.1
operation
title: Response
initiator: IL
receiver: PoS
description:
Mediator responds to the request.
Requests
InstanceReference laborder.01 step
number: 2.2
Operations
Title Initiator Receiver Description Log the outcome PoS PoS PoS entity logs the outcome issued by the FHIR entity.
{ "resourceType": "ExampleScenario", "id": "SubmitNewLabOrders", "text": { "status": "extensions", "div": "<!-- snip (see above) -->" }, "url": "http://moh.bw.org/ExampleScenario/SubmitNewLabOrders", "version": "1.0.0", "name": "SubmitNewLabOrders", "title": "Submit New Lab Orders (Using a Bundle)", "status": "active", "experimental": false, "date": "2025-05-19T15:02:57+00:00", "publisher": "Jembi Health Systems", "contact": [ { "name": "Jembi Health Systems", "telecom": [ { "system": "url", "value": "https://www.jembi.org" }, { "system": "email", "value": "info@jembi.org" } ] }, { "name": "Jembi Health Systems", "telecom": [ { "system": "email", "value": "info@jembi.org", "use": "work" } ] } ], "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "BW", "display": "Botswana" } ] } ], "purpose": "This serves to demonstrate the submission of a new lab orders, from the Point-of-Service (PoS) application to the FHIR datastore.", "actor": [ { "extension": [ { "url": "http://moh.bw.org/StructureDefinition/actor-reference", "valueReference": { "reference": "ActorDefinition/PIMSActorDefinitionExample" } }, { "url": "http://moh.bw.org/StructureDefinition/actor-reference", "valueReference": { "reference": "ActorDefinition/OpenMRSActorDefinitionExample" } } ], "key": "PoS", "type": "system", "title": "Point of Service", "description": "The entity that creates the lab order." }, { "extension": [ { "url": "http://moh.bw.org/StructureDefinition/actor-reference", "valueReference": { "reference": "ActorDefinition/InteroperabilityLayerActorDefinitionExample" } } ], "key": "IL", "type": "system", "title": "Interoperability Layer", "description": "The entity that receives the lab order request submitted by the PoS entity." }, { "extension": [ { "url": "http://moh.bw.org/StructureDefinition/actor-reference", "valueReference": { "reference": "ActorDefinition/SHRActorDefinitionExample" } } ], "key": "FHIR", "type": "system", "title": "FHIR Server", "description": "The entity that stores the details for the lab order submitted by the PoS entity." } ], "instance": [ { "key": "laborder.01", "structureType": { "system": "http://hl7.org/fhir/fhir-types", "code": "Endpoint" }, "structureProfileCanonical": "http://hl7.org/fhir/StructureDefinition/Endpoint", "title": "Outcome response", "description": "FHIR issues an outcome response to each CRUD request.", "content": { "reference": "Endpoint/FHIRResourceProcessResponse" } }, { "key": "laborder.02", "structureType": { "system": "http://hl7.org/fhir/fhir-types", "code": "Bundle" }, "structureProfileCanonical": "http://moh.bw.org/StructureDefinition/lab-orders-bundle", "title": "Lab Order Bundle - New Lab Orders", "description": "The FHIR bundle provided by the PoS entity when submitting the lab order service request.\n\nThis bundle includes the following resources:\n- [Ready Lab Order](Task-LabOrderTaskExample.html)\n- [Lab Order Specimen](Specimen-AvailableSpecimenForActiveRequestsExample.html)\n- [Active Lab Order Service Request](ServiceRequest-LabOrderActiveServiceRequestExample.html)", "content": { "reference": "Bundle/lab-order-with-patient-bundle" } }, { "key": "laborder.03", "structureType": { "system": "http://hl7.org/fhir/fhir-types", "code": "Endpoint" }, "structureProfileCanonical": "http://hl7.org/fhir/StructureDefinition/Endpoint", "title": "FHIR request", "description": "FHIR processes each request in the bundle using the HTTP request method defined for each Resource included in the Bundle.", "content": { "reference": "Endpoint/ProcessFHIRBundle" } } ], "process": [ { "title": "New Lab Order", "preConditions": "PoS entity has submitted a lab order request.", "postConditions": "FHIR entity has stored the lab order details for the patient and sent an outcome response for the request to the IL entity.", "step": [ { "number": "1", "process": { "title": "New Lab Order", "description": "This scenario demonstrates the process of storing the patient's lab order information in the FHIR datastore.", "step": [ { "number": "1.1", "operation": { "type": { "system": "http://hl7.org/fhir/restful-interaction", "code": "update" }, "title": "Submit lab order", "initiator": "PoS", "receiver": "IL", "description": "Lab order information", "initiatorActive": true, "request": { "instanceReference": "laborder.02" } } }, { "number": "1.2", "operation": { "title": "Invoke FHIR mediator", "initiator": "IL", "receiver": "IL", "description": "Pass the data to the mediator responsible for calling the endpoint for creating the lab order information in FHIR.", "initiatorActive": true } }, { "number": "1.3", "operation": { "type": { "system": "http://hl7.org/fhir/restful-interaction", "code": "update" }, "title": "Send data for consumption", "initiator": "IL", "receiver": "FHIR", "description": "Request for FHIR to process the information in the lab order bundle.", "request": { "instanceReference": "laborder.03" }, "response": { "instanceReference": "laborder.01" } } }, { "number": "1.4", "operation": { "title": "Success: Invoke IL mediator", "initiator": "IL", "receiver": "IL", "description": "Pass the data to the mediator responsible for calling the endpoint that must send a response back the PoS system who initiated the lab order request." } } ] } } ] }, { "title": "Respond to Request", "preConditions": "FHIR entity has processed the request and has issued an outcome response.", "postConditions": "IL entity has received the outcome response from FHIR and forwarded the response to the PoS system.", "step": [ { "number": "2", "process": { "title": "Respond to Request", "description": "This scenario demonstrates the process for responding to the PoS sytem who submitted the request.", "step": [ { "number": "2.1", "operation": { "title": "Response", "initiator": "IL", "receiver": "PoS", "description": "Mediator responds to the request.", "request": { "instanceReference": "laborder.01" } } }, { "number": "2.2", "operation": { "title": "Log the outcome", "initiator": "PoS", "receiver": "PoS", "description": "PoS entity logs the outcome issued by the FHIR entity." } } ] } } ] } ] }