FHIR IG Statistics: ExampleScenario/CancelLabOrder

Resources that use this resource

No resources found

Resources that this resource uses

No resources found

Narrative

Note: links and images are rebased to the (stated) source

Source

{
  "resourceType": "ExampleScenario",
  "id": "CancelLabOrder",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://moh.bw.org/ExampleScenario/CancelLabOrder",
  "version": "1.0.0",
  "name": "CancelLabOrder",
  "title": "Cancel Lab Order (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 request to cancel an active lab order, 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 requested the lab order cancellation."
    },
    {
      "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 cancellation 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 cancellation details for the lab order previously 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 - Cancel Lab Order",
      "description": "The FHIR bundle provided by the PoS entity when submitting a request to cancel the lab order service request.\n\nThis bundle includes the following resources:\n- [Cancelled Lab Order Task](Task-LabOrderCancellationTaskExample.html)\n- [Lab Order Specimen](Specimen-AvailableSpecimenForCancelledRequestsExample.html)\n- [Cancelled Lab Order Service Request](ServiceRequest-LabOrderRevokedServiceRequestOrderCancelledExample.html)",
      "content": {
        "reference": "Bundle/cancelled-lab-order-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": "Cancel Lab Order",
      "preConditions": "PoS entity submitted a request for the lab order to be cancelled.",
      "postConditions": "FHIR entity has updated the statuses for the Task and ServiceRequest resources by indicating its status as cancelled.",
      "step": [
        {
          "number": "1",
          "process": {
            "title": "Cancel Lab Order",
            "description": "This scenario demonstrates the process of cancelling the requested lab order.",
            "step": [
              {
                "number": "1.1",
                "operation": {
                  "type": {
                    "system": "http://hl7.org/fhir/restful-interaction",
                    "code": "update"
                  },
                  "title": "Cancel lab order",
                  "initiator": "PoS",
                  "receiver": "IL",
                  "description": "Updated lab order information",
                  "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 cancelling the lab order information in FHIR."
                }
              },
              {
                "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.",
                  "receiverActive": true,
                  "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 cancellation 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."
                }
              }
            ]
          }
        }
      ]
    }
  ]
}