Botswana FHIR Implementation Guide
1.0.0 - ci-build Botswana flag

Botswana FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/botswana-hie-fhir-ig/ and changes regularly. See the Directory of published versions

Sequence Diagrams

A sequence diagram is a type of UML diagram that shows how objects interact in a particular scenario of a system. It illustrates the sequence of messages exchanged between objects over time to carry out a specific functionality.

Cancel Lab Order (Using a Bundle)

Actors

Name Description Actor References*
FHIR Server The entity that stores the cancellation details for the lab order previously submitted by the PoS entity. ActorDefinition - Shared Health Record
Interoperability Layer The entity that receives the lab order cancellation request submitted by the PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that requested the lab order cancellation. ActorDefinition - OpenMRS,
ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Cancel Lab Order (Using a Bundle)​Cancel Lab Order (Using a Bundle)...a_FHIR.The entity that stores the cancellation details for the lab order previously submitted by the PoS entity.. FHIR Server.....a_PoS.The entity that requested the lab order cancellation.. Point of Service.....a_IL.The entity that receives the lab order cancellation request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the cancellation details for the lab order previously submitted by the PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​FHIR Server​FHIR Server...a_FHIR.The entity that stores the cancellation details for the lab order previously submitted by the PoS entity.. FHIR Server..Cancel Lab Orderdetails​Cancel lab order(payload)​Invoke FHIR mediatoractivate FHIR​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src hPJBRjim44Nt-WeYtIIB5B7xH1PTj41H0oeQsCag488HERQ9IAHAKYu48V_U8VMsrIQBR0nP8ddFlJF3M-aoPDz0SSnO32dxPGGQTdvdfTenO5zB9JAyYA82Z9DS5g0SExk_VmCFDtfJt-wHeNBILSpjmJ63lqkq3WNzHPRHUJgSnuD01avgzVQ9tMX9n-Wjsw0vI8v9SiR0qklDZCugdf7XA0ze_wFIeJ1Rfhbq7YcjmdfIQGyZafLoQ7I11bAP-VDZgD2qFAju1kVxZzNw1CWwRLgS2OH01pApRAlD4MjXy21rQRFg6KAl5tBgiVoRADePNHQdbID6fGKkEkaaUMRbUp8ZBRCS5HYfQL-kbNK6N6keC9gZjRvShJVV6lxBKEtU5m4Fmjx7vHUAyReJ-r3V5G8cEvXKb4uUydhgAFklISBEQQzye3UDmDMI5L1b6aIIN4Ih-4ZXOtq3jW4d8M1EX-SSXGGg4Z7RWlp9bDhULuN3u0ULA49dDXycNcTvwJbK8pJIGJzYKwrEB4c0EtaWlqtD6bZ_sED-gjTjdthDi9k8kyYzy97Sb2KDuqdo6s9l30TsSbZcXTyp4-2xSO1JmW1mEKtqjH3Rv766Q34c4ZYNsWZeyskKE8njNleBmaS7FHvBWJ_sOsWhwk-S_TbhSYQTXEvkcxjhV1rAxcEvxlg1u8Tk8A4e2Z_DIAw3fF06keXRYykJyVttsiNLIoTusuSZGXvwPBDpELn6emcVJ7LJ3zhL5sIng7zEmnUsEtquOVt2-hUtnaHWMGzt8ilqhl6bIyTrJlrdRJdSdg53--iprhlnsb4H_W80?>




Lab Order Results (Using a Bundle)

Actors

Name Description Actor References*
FHIR Server The entity that stores the details for the lab results documented by the PoS entity. ActorDefinition - Shared Health Record
Interoperability Layer The entity that receives the lab results request submitted by the PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that documents the lab results. ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Lab Order Results (Using a Bundle)​Lab Order Results (Using a Bundle)...a_FHIR.The entity that stores the details for the lab results documented by the PoS entity.. FHIR Server.....a_PoS.The entity that documents the lab results.. Point of Service.....a_IL.The entity that receives the lab results request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the details for the lab results documented by the PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​FHIR Server​FHIR Server...a_FHIR.The entity that stores the details for the lab results documented by the PoS entity.. FHIR Server..Lab Resultsdetails​Lab results(payload)​Invoke FHIR mediatoractivate FHIR​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src hPHDRzim38Rl_XL4TsaFBPhieqCFE-mmB8271KbxAeo2jfX4g6rvafmX2FhVHycMOyyEq4Cl-R0fydbVadgGDYU8CONVMf265PawjmOk7uqiju3mlIv5JbTHLA6sCfCLbXOkdfu-uFDIhOyFEm8ghRG7i3kq85HM5_p0y5-2dFFg9kFDAooLvBDg0slIUvbHabm06dwydaY-Y4UvDMKazpHApTz_QZ8MJ9qMqbeIa1vy4ATkCt3vHMb9gueqfZ9tIMCya6uX5l44mu-VYzM8mbYbMmP15cLkOAFqY2aOSGR6fVO-T0JkIHHjjQehtu_G2IOfbQ1Pg9OavuC-CQqqO38gKKl5HmfL6glHjiILLXaPuveG05sRtQi0xiGWRDdeqWjIVYvawOCyTYVYHEIqNNzZ5-y3okVZOoNGoUyduUG5MgdALu_VramIkEHZyfb3VUJDxHmgFEGAHP9SHOlul-HVZaiqRG_G8bZbVnSa979xNDwAXSkKPzlfoJ3FWqugHUK7STC4Ca1uDP3hfFgfsQkNLdZ8doIOMRbdTKtN6ZxtioEyEwxQeNHb_6c63FQxOZqpWhlz-KdztZ70ce4RbLu9owgBofsQSErZtxKXeqUu7jhuVf2juJJ1DEip2PfoheVqzJqww_UqgDsDuCp33WzIp5wwPJG7Owc0lpl5sgILVbgRLMXSuU9XIqRI9nTYNMVEklimDIplD3EC4aN-ezdVbOSIhafeGsl2VBJhvsDdjs_T-Krdd_2EgPuHmOVJ3ThpOR3fJSVuLDUosUpuQzWUOKBsKuRL6oUalKa61UR7qzq9kTeskbHjCrNmZ1fJdsxPOKDYjUt7zfhm3m00?>




Register New Patient

Actors

Name Description Actor References*
FHIR Server The entity that stores a restricted version of the Patient Resource submitted by the PoS entity. ActorDefinition - Shared Health Record
Client Registry The entity that stores PII and demographic information for the patient included in the Patient Resource submitted by the PoS entity. ActorDefinition - Client Registry
Interoperability Layer The entity that receives the registration request submitted by PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that registers the patient. ActorDefinition - OpenMRS,
ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Register New Patient​Register New Patient...a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the Patient Resource submitted by the PoS entity.. Client Registry.....a_FHIR.The entity that stores a restricted version of the Patient Resource submitted by the PoS entity.. FHIR Server.....a_FHIR.The entity that stores a restricted version of the Patient Resource submitted by the PoS entity.. FHIR Server.....a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the Patient Resource submitted by the PoS entity.. Client Registry.....a_FHIR.The entity that stores a restricted version of the Patient Resource submitted by the PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​Client Registry​Client Registry​FHIR Server​FHIR Server...a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the Patient Resource submitted by the PoS entity.. Client Registry.....a_FHIR.The entity that stores a restricted version of the Patient Resource submitted by the PoS entity.. FHIR Server.....a_FHIR.The entity that stores a restricted version of the Patient Resource submitted by the PoS entity.. FHIR Server..Register Patient in CRdetails​Patient resource(payload)​Get patient datadeactivate IL​Validate patient data for compliance(payload)​response(payload)​Validation success: Send patient data(payload)​response(payload)​Success: Invoke FHIR mediatorendRegister Patient in FHIRdetails​Remove all PII and business identifiersdeactivate IL​Update Resource.metaactivate IL​Add the MPI identifierdeactivate IL​Set the Restricted Patient Resource literal IDactivate FHIR​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Create Patient Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src xLXTRzis57ttho2w0Kk0rOYTfktwC61mjqw0CnXskfT2A6YAjebAeafIJWmZ_tttafH4sOhi51tsifUYvjSzzznpFvGxOL9EvdmjjE6A_CNloOmQmNCp61HK6S54GND3Ndpwz0FzF9EB_Ts64zWMPaVCXXgY_5qDFpaftENX8vb90VVaYYousWh6u_W5eHgM5nqFHzEETnaNM-wUTKOKF2vp-F6rvDeGNIupOGnFo7A7x_hhO3lA0P0ikA9BaUABKxhZoYE8fXq09lCZ0Df81UPdKKHedf24PtAjQB4HZ8Xy9LNcqC3_GizXZwLb0g14RjSzdS2nbgLYl0tRdWYXJr9_sZgyyvWdymxCV_mPFOcQ0ajmNp2qiuNe85G8nZSWGZCsY3M3k38Oh9KiYqOwizf_G4i0O2uJFWBQ31MfZkEppj-0Fq8JpNXEbP2MzDm6tWkXK99nhT4Lz5Jawv3ydpI1e6kPqxGL8n-AoVndGjdNKYXmTQLaraq7HbjnKweSdwVabhO0Htd27yZ5xIow9291cbO2jWzq0CGrhYEVBty5vRsh77szhvxh0lnO6rCUL1oJ2xWgFgky65wDmCekbJI9uyi1PKPiWI0KTZGziFDcVyiJGO4gmX-0HsPQUKeIQcWF5VUWzaqbQL1LcWPuQzyrEFk1czQZSPpmOsIed1hRs_tSPp9oXriGln-tD1K9NhBvQyDd964RphuuXIDGNHO594hYy8DYcCnW0NFZNfYDFVCUjnPuS8TnFF9jfkHAf7pOPxbQSgHbe3ow1kj6bGpquQGYW58B0s3oNEFoluBpaVnT0Mn73yYhdZrFA3P_RLg_RAlb_uWyCoAGdWKKg0FMhqFMWpImlBj4c3HfyCl-o02MG5m0_AvksNZusWUGXkJEBLEj9HEM3gXJiwZneQWB29CgiRJurY1C8oLaL9SCdtq7DHuEjNFuj9QWCqsETFIVkDGTYrTFn68oFowMeol0hPsoAlqubVaIwas89SnCDksW85Oj2CWhxCXZDnG7i7udXw6gbR7GZb0AW7bHSH_bM_d5AQGs5yVmvc1W_tcwUTehte7nMUqsl34QVqF7VTPmuLe8VmXQ28vKJMfMr1GA8iDsA0G0T2oWgWcX5TH5q7k5rcKplO28j6mo7iBCA4wDjRBiCeF82NOmA5mWDvUDv13fnGHMaj9w_k7tkshyrAqEtzk4HzTGLpEvvTRxfmP9rFEoX5n0jeFcsZUfQ8l6pZFU-NaJcPww5S2fvjikqzrDFFJi5NXMf9GvJla3Y0rvoe2OOU7COSakUSDfKwiJle8OMES_pgVr17MU2nyBsncgdI6QZED-j3VxtvAa5X3eGQppbcue5fqE9ge9iWSQG0eVR-wU9l7rVi6TLk5Z1HfTIgBtPrYiofEcMKKoTUa1rwtyx-7toU-H-cJ_Pq05iGzG0p-8HD3rMkFVwCt9Bc4hbRQV7bOTgrB1SgjjFBgs5Kn2K5Mo0aNLRWJZvur2tmjTTrUwEJqXX5ZUVe--PEESbVZXZ8pH6XfPKZl9kO3h7VIB3Cgs93OvAKRQ5apiQM4NjcMmeua1_huMXaOJT67Y7cneTgEdT_gwevUTUNLyTMvJMzNa9POl6T1Gi-2QIoy53LGNF7YXZjvur7o3ULkwilJaW_FJigb5WtzIyL-OBRlZVPF099Lhvxei3Ooy_A1dMYtNkJwLw_1i4CL_0000?>




Register New Patient (Using a Bundle)

Actors

Name Description Actor References*
FHIR Server The entity that stores clinical information for the patient included in the request submitted by PoS entity. ActorDefinition - Shared Health Record
Client Registry The entity that stores PII and demographic information for the patient included in the lab order bundle submitted by PoS entity. ActorDefinition - Client Registry
Interoperability Layer The entity that receives the registration request submitted by PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that registers the patient. ActorDefinition - OpenMRS,
ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Register New Patient (Using a Bundle)​Register New Patient (Using a Bundle)...a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the lab order bundle submitted by PoS entity.. Client Registry.....a_FHIR.The entity that stores clinical information for the patient included in the request submitted by PoS entity.. FHIR Server.....a_FHIR.The entity that stores clinical information for the patient included in the request submitted by PoS entity.. FHIR Server.....a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the lab order bundle submitted by PoS entity.. Client Registry.....a_FHIR.The entity that stores clinical information for the patient included in the request submitted by PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​Client Registry​Client Registry​FHIR Server​FHIR Server...a_PoS.The entity that registers the patient.. Point of Service.....a_IL.The entity that receives the registration request submitted by PoS entity.. Interoperability Layer.....a_CR.The entity that stores PII and demographic information for the patient included in the lab order bundle submitted by PoS entity.. Client Registry.....a_FHIR.The entity that stores clinical information for the patient included in the request submitted by PoS entity.. FHIR Server.....a_FHIR.The entity that stores clinical information for the patient included in the request submitted by PoS entity.. FHIR Server..Register Patient in CRdetails​Lab order bundle(payload)​Get patient datadeactivate IL​Validate patient data for compliance(payload)​response(payload)​Validation success: Send patient data(payload)​response(payload)​Success: Invoke FHIR mediatorendRegister Patient in FHIRdetails​Remove Data Supplying Patient Resourcedeactivate IL​Add Restricted Patient Resourceactivate IL​Add the MPI identifierdeactivate IL​Set the Restricted Patient Resource literal IDactivate FHIR​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Create Patient Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src xLZRRXit47tNLx1fWTf0RLXsRAT-AD3ARRA07GYIsvTW4L3SaKHaHMv8hcn1qBztXjohxYvIzAKlXirTpfmvS-QoVf8k1JQ0YRGE3Fi8pwpFdGJbsCcVLge9u-otN2Kfd7Ow6JTE2fbnVFhcqwVl-UU-7YwVfi3mVUaMp4svOwOmPl5FO5cmThvYVItndXwp8PYv5137RnYtU3pSOZXws69NW9n3C1kS63Ik5VxnDGVhcCr7C-aS96oq8Bl5TVGTAGIaCp1y95Eo-C0NO0e4qSCM0Bt11W3hj47t_IXYN2KiWPcU69vDfM1IZRMP1JJuMpDoV2RIF45GKldpb8-ODWcoFVB4xe7TIxs5a1wpAF3s1blm_l4XsebOf599mTDNmJnCAhdqoQoOf9DEPs9qdjMQwbSE43b3i4edq4Nw79UfZUEZth_6sAHbLe3YHcfFll82A0IH6It0Mj8NHKtARKJtesMOVAlL6Wb5hBt1JuoBhxaq6EROw9a_BO4CmEhS2F1PD-1oeq9XFF8Mu4WbyC9E7llHAPC9qJIM-7YDQ2Ik3ftuFFi55NXN1dgpBCqbt74cjC9tLQswRRbSePpRcefZTe86vMUZihFH-SKLUb-acYTnVDhXmiav4aV2ZnxM_Dyk7o6H72bay8By2jUguu1gDqNFM0tJKakMyJHj45znOf64z-1QHkCuWKrafAWAsxlbe10bSKgFCAy_p7ag4xhawzkdrMacfY2-X2eWe3RFCYoc9E179GazmmEgdsVfflwTUteqf1SNbD-DsFf6ZsKAv_iybqU1j1agaa_GkpEvGDq42KcarCD0cA0i7VyhE5Vihn9WEtj8NcbMR4YbkrKglh9zmP-rzV9_JbwP4sp86RQk3TwlcxmtIi4p7ugXLvV2pyiD5zGUwG0Z23tDPwJeYmZgd3s5Oswj5j8JWZsi7zLHb3B1KOlTn1DJZ13fQZaHfpONPFOE-p--rAxZO_I4CwoteQN_9AXT-RZPaO_UOBDfTYyGkGtwAbKKj5QqqiA97E6uz-M7ZR4SKKXWvbSZ_y00mYsUADp6MfMBuuhaWAY79V-HckilGIMLkpX6cvsE_x5xkFehHG2NHutZvetkvJ-Oo9o8S4OAMYTmRR0a9No-PvJ0IsEKq12i2xIa9ZEO6R4WAI2WJGcLmuYya38QirbQcuVDfb2NrNNTOve5f-soqfO_thfDdH0tfxNe2Eb93q-It4V-_lUdSgEohGrWxp3kNc5tdUav7DLZggcyiM66nILBET7Hw5g3EXlhrbQiy7p0w_QntOpXxVBN93dahgoOTUWhHfVtN8pZ_TwlA--KUioadAXMnZarZ56EpOJ4sjI6EinHqtPzzJ0dDyiX197XrmZEgPH5zqSuB5coV0Oqrd8W-5whzootUCD7KtUyCHXGlWRyMnf_-6RahTdoE51zpZvg1tVKKB6uIFbQfGismciAlgEUKq3U1x0Efv6OnWXhxNFTs-NwuhhUy7tBiVuRm_V7SMvy38q9i0epgB7QO7kOPLIMwptzxUjscs-5RzU8kJqyyfjetdsB8UExsood3pjYZLVWs8ZxvGpyHvvTOFEVOG_MA1BfgFa5fVi1rHoglgTjcKY8Vzyy8gS9XT0B1cibXMso2Ffgos0wykhbnR4JQboHbtY-T8E6YeKmAVPIK4CDoKCBLVOkk_M7LU7Bbfvs6XmS8vnADlIVbEA3ikNvSbb_jhDKJqBmEdUunyBQ2FHwhhxm7_Ia-MuZZty3?>




Reject Lab Order (Using a Bundle)

Actors

Name Description Actor References*
FHIR Server The entity that stores the rejection details for the lab order previously submitted by the PoS entity. ActorDefinition - Shared Health Record
Interoperability Layer The entity that receives the lab order rejection request submitted by the PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that requested the lab order rejection. ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Reject Lab Order (Using a Bundle)​Reject Lab Order (Using a Bundle)...a_FHIR.The entity that stores the rejection details for the lab order previously submitted by the PoS entity.. FHIR Server.....a_PoS.The entity that requested the lab order rejection.. Point of Service.....a_IL.The entity that receives the lab order rejection request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the rejection details for the lab order previously submitted by the PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​FHIR Server​FHIR Server...a_FHIR.The entity that stores the rejection details for the lab order previously submitted by the PoS entity.. FHIR Server..Reject Lab Orderdetails​Reject lab order(payload)​Invoke FHIR mediatoractivate FHIR​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src hPGzRzim48Pt_Of3kYH3YjZzH8OE7OeQSD70JgP022ZnRBEHT2f9kH2C_FSUAL4Vje9ao18eidZlyxvtnrjbCuGL_i7Kmb8ay5jBr71-PrIn1G7Vgq9cU155fT1MfQeKXOMp-_jtuk66reVR7G8MLjaQx4vOqFYtGcDHyhy86TSZNqzx0KN5-oUu8SKrQ0Dhr7kLOXoVWJ3yUZqXibXEQAIezcYUamWGOAeaLzR19BN_c2NQIeonA2ngAb6BH6Mk-5BKg5kOnNA2vSVFnUg4nbZIBKjF8D4AbHdOa3wYB3Nk5LKcgr_0Ss8-eOx9lOcYhQQgF6qO0nOaSHQau_Y5Bp-o4sN0f5W8hOZFvLGOguLjtPIQKZJ6DQernWFHs0mzxcmnRw_hR5n-umYlWzQdmrqfnUW4g8B3oOMBwob0Th_6CPppMVN0Rng1gpcKeiv8o3Y-Y1RB8uNFXnjX6cuM4c39F-SebU06CRCfsPvAUDXTKrAHPS4F5hBq8xaXVMHr4fUVVI_y3Etf4PjU1Qqu5bnWptQRZZMixh6Z_N9OjIFg9Frf1Ww1E-4ZkJ5BudUIvTUCtlZrdjXWbPVkp4H-7uRvZGazmEKuqBT2R8F72QBPa4ZYL6e3eAzlqM6_iNdbxWONdUZm817fOxU4fkRnpk7VZjYPiag42-taZd5Dg5ANoNKO1YRlHu5LeiZ_2TlezAIZ3_cs_kOJc_lSjxEhroxlfaj6-Z1eu35OxE-XmNQFDhff1f_gkZ6R7NwDavScLEyhh5xP_FR660dC3_rr21bj6rzKsPHo7ZvZglxYzEFPtPnBsWw_7JJXFm00?>




Retrieve Patient Record

Actors

Name Description Actor References*
FHIR Server The entity that will provide the clinical information for the patient. ActorDefinition - Shared Health Record
Client Registry The entity that will provide PII and demographic information for the patient. ActorDefinition - Client Registry
Interoperability Layer The entity that retrieves the patient data from the CR and FHIR entities. ActorDefinition - Interoperability Layer
Point of Service The entity that submits a request for a patient record. ActorDefinition - OpenMRS,
ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Retrieve Patient Record​Retrieve Patient Record...a_PoS.The entity that submits a request for a patient record.. Point of Service.....a_IL.The entity that retrieves the patient data from the CR and FHIR entities.. Interoperability Layer.....a_CR.The entity that will provide PII and demographic information for the patient.. Client Registry.....a_FHIR.The entity that will provide the clinical information for the patient.. FHIR Server.....a_PoS.The entity that submits a request for a patient record.. Point of Service.....a_IL.The entity that retrieves the patient data from the CR and FHIR entities.. Interoperability Layer.....a_CR.The entity that will provide PII and demographic information for the patient.. Client Registry.....a_FHIR.The entity that will provide the clinical information for the patient.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​Client Registry​Client Registry​FHIR Server​FHIR Server...a_PoS.The entity that submits a request for a patient record.. Point of Service.....a_IL.The entity that retrieves the patient data from the CR and FHIR entities.. Interoperability Layer.....a_CR.The entity that will provide PII and demographic information for the patient.. Client Registry.....a_FHIR.The entity that will provide the clinical information for the patient.. FHIR Server..Retrieve Patient in CRdetails​Request for patient record(payload)​Find patient(payload)​response(payload)​Success: Invoke FHIR mediatorendRetrieve Patient Record in FHIRdetails​Get patient record(payload)​response(payload)​Success: Invoke IL mediator 1endUpdate Patient Recorddetails​Remove Restricted Patient Resourceactivate IL​Insert Data Supplying Patient Resourcedeactivate IL​Success: Invoke IL mediator 2endRespond to Search Requestdetails​Response(payload)​Log the outcomeactivate PoS​Consume dataend<?plantuml-src jLTDRziu4BtxLn3jOLkW2MgdJTeUzh1UxAw0133axgaG2feQsqGbKajIJWsZ_trdg2_AKcndFmw9BOgSD_DctWpzMReCM0pEIDW1Mt0dGJbS4Dgaaqd1ZPD25XpNNdpvyf9_NUZbuVCM6EwIRi_SbZjcorKkdMMS6VYh1ElOMXjyAcfhnbkx_i4MMkAZNhCbc9qKa2Gl6BUul1n1Yku7GARsq-8ZjEPJxZXR6vtxrNdCk4hPRtz4SNLMWaNeI3amkW33Lp8ZW_Ty3wPs8BeVmP_70_n7cMMiC7edK-GgYZnI2hdU65vifM1IOUGv-gMLvo1m4tsOPpMv6scTsTVWytW4dDm_3K-cHIQL53mxW-kv8ChRW6bbCjaONHR3v4j59A8RIgSmnVWSbvbDaelstwBNqZ8hG74ZjMT7ORJSDLapMe2rL0LrEgNQX0x_P1ccoMfr51V2LFbzmnwHwoqkYAnCQxCFt6A2MvyYbS9tzkfX4Rrco1QIk9RuUiXD5nqNJkxGJL-E-CUkViR2-DG4TdU8w-8MMk4PXI4eO6WmrmROghHIKLmT6fLT70YYBuSaOQ_GjFngYkktCtovppJ7rTUJw9wWvt4B_U7GcM5hYJNt7Bge0EXClR-7UnlYjWHWHM92h_hn_sid3DW2Im5w3jo53gGGkb3H47ZmyO1Bt5empbQ28DkDsQe3eDzjUiRzo_PjYlWAUzy9wNXvSuP5vByLX5sPzIt7QVyzXrHoXoThJoHP9KiepAofRL1fuPiVlR30ZTZIgruBGx98bqZLiXIaaKzOnZlz3Ie1DpX9WiOc4__l2KLMxRinsF0tEo_byOFJwNyXQjEp_OQHOAezI71FYLNcQLUR--diyD3mN5euJcwJ8lWEeYIdU4roRoAD-OF0luExM9jjWVeEwaawqid_wUceXDu_8I7luK14qvl30kkuLyMygs42NvS6tvecgPYbQqQZwAJwVYbLcjKYzBGy8SDsP7bm74MFW4CDFwcRN_lDCR9Wf72G1dLfTMa4r9s_jQsqkle7mXwH60RNaZ0TIkpF8lMZeQ-JcjERWR1ERf--VuQSIhBqf9YQ2r4Q4B_QutAHST6SEicdT5k_wLTAnx8iYcnFvmORhUwIVgRf2wxO2fhnd3P3e2sL5HVVckQ91JnKVbYkjvsQ3DBKtFrEnTHU1LTLJGP5LdURO4Zx6KrsJvbCabPLU5KSEddNEObLMIlaFASu3tJFKHetHO5bPuaVUH7RT6Ziya7XMiAM6D1gtytXo7juphaa2Lh9QD0VXeta-UFGrrHUOjkpu8VjKPLi_NMCsJtUxd9KFxAYy4hFAKlqygXtrfzdz3qR6w44cr8GoyfaSzkfmtqtCZpF79czlLJdwvQkr3Eaky0ldWqZ5zasRMYfpTji6YhAOze6yGYjRGuZSF7OA7eNZgBw2jt3dXrejVvDa-bDHOCkdT0vwi7QiYlMxXVS7l7kzIRS6oWokAxti6v2B9mOjip3sniN54b0DmvhWn4gW9HkxlFgXDySrClV?>




Submit New Lab Orders (Using a Bundle)

Actors

Name Description Actor References*
FHIR Server The entity that stores the details for the lab order submitted by the PoS entity. ActorDefinition - Shared Health Record
Interoperability Layer The entity that receives the lab order request submitted by the PoS entity. ActorDefinition - Interoperability Layer
Point of Service The entity that creates the lab order. ActorDefinition - OpenMRS,
ActorDefinition - PIMS

* An actor reference will only be available if a reference was provided using the "Actor Reference" extension.


See process details: Interactions and steps

<?plantuml 1.2026.1?>Submit New Lab Orders (Using a Bundle)​Submit New Lab Orders (Using a Bundle)...a_PoS.The entity that creates the lab order.. Point of Service.....a_IL.The entity that receives the lab order request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the details for the lab order submitted by the PoS entity.. FHIR Server.....a_PoS.The entity that creates the lab order.. Point of Service.....a_IL.The entity that receives the lab order request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the details for the lab order submitted by the PoS entity.. FHIR Server..​Point of Service​Point of Service​Interoperability Layer​Interoperability Layer​FHIR Server​FHIR Server...a_PoS.The entity that creates the lab order.. Point of Service.....a_IL.The entity that receives the lab order request submitted by the PoS entity.. Interoperability Layer.....a_FHIR.The entity that stores the details for the lab order submitted by the PoS entity.. FHIR Server..New Lab Orderdetails​Submit lab order(payload)​Invoke FHIR mediatordeactivate IL​Send data for consumption(payload)​response(payload)​Success: Invoke IL mediatorendRespond to Requestdetails​Response(payload)​Log the outcomeend<?plantuml-src hPHDRzim38Rl_XL4TrXxwD1ad-XXXns61V2s86bFXL784fC8jIrFabC4Hl_xACPVIToYXru2Hn_am_UbUADzXh2iqbnx-8EF48iK_bg5ri7vhTF56WJyg0gLuKKKbS9wBNKf2WzdTtVlnFtSBEkR3G8MNliT-8tm82qAZux-86GKpeHm7vvWRZJTCojOejrgYKbo1iBHyd8ay2m-YMjHejuU1wRbVnKw3uwByAWWtV4H2jpSf-IpmgCr9LgHwYo4ZCKEROCmYqS8VlwQBKuOd3Us8L3eXSuSh8mz8dgP9CHb2RhqOIMArjPKvQ47G225KJXfaoN9IyS-4Qvsu2GMmcf3bt9JE6yxDqfh93eNF0Y517TvMNXDUE_Te0PTK5qvRPY2llaOWolX1Oj0bVHGGdgzfJHiPgZsyZk9Ujs2VQxZiS1FRUDrQPC4pkcElgULVTjSJGblbncXakIYpqEEpUAZB5_gkN2DDqG9tl1tZaeB8gP6SINfeLFg-62Q55dMIe25AhazUICqSBlph2H13cwihNben6bJ9Od2KzHmf8FzMY-QlWqP-JRnjWQ5n2CEz2mfFqbAloJoVRbCJlLLUHdkZ4ZvSLHAxZu6k3pKywqG6zrnX6Wo91fenamd1dzx2uFv6UTL61X1Ej7XGIhaG_TStSvvpE5nOwWoxIa1FUVHmHDCg6JGvBfj1YBlMu6oH17_x9_kWlEfGD_gszGtFNdcpv-TNBtsiQywPHIBOGOrjYNs4olizONrF7ipw5RdncHI_pvKNhasUXzXyKhpcw5na61QzuCJChFUrsKgBqrEpUTSrOzORizkniPcFJmxCE4_?>