Package | botswana.hie.fhir |
Type | ImplementationGuide |
Id | botswana.hie.fhir |
FHIR Version | R5 |
Source | http://moh.bw.org/https://build.fhir.org/ig/jembi/botswana-hie-fhir-ig/index.html |
URL | http://moh.bw.org/ImplementationGuide/botswana.hie.fhir |
Version | 1.0.0 |
Status | active |
Date | 2024-07-25 |
Name | BotswanaHIE |
Title | Botswana FHIR Implementation Guide |
Description | A FHIR Implementation Guide - Botswana HIE |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: ImplementationGuide botswana.hie.fhir
The official URL for this implementation guide is:
http://moh.bw.org/ImplementationGuide/botswana.hie.fhir
A FHIR Implementation Guide - Botswana HIE
{ "resourceType": "ImplementationGuide", "id": "botswana.hie.fhir", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "http://moh.bw.org/ImplementationGuide/botswana.hie.fhir", "version": "1.0.0", "name": "BotswanaHIE", "title": "Botswana FHIR Implementation Guide", "status": "active", "date": "2024-07-25", "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" } ] } ], "description": "A FHIR Implementation Guide - Botswana HIE", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "BW", "display": "Botswana" } ] } ], "packageId": "botswana.hie.fhir", "license": "CC0-1.0", "fhirVersion": [ "5.0.0" ], "dependsOn": [ { "id": "hl7tx", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment", "valueMarkdown": "Automatically added as a dependency - all IGs depend on HL7 Terminology" } ], "uri": "http://terminology.hl7.org/ImplementationGuide/hl7.terminology", "packageId": "hl7.terminology.r5", "version": "6.3.0" }, { "id": "hl7ext", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/implementationguide-dependency-comment", "valueMarkdown": "Automatically added as a dependency - all IGs depend on the HL7 Extension Pack" } ], "uri": "http://hl7.org/fhir/extensions/ImplementationGuide/hl7.fhir.uv.extensions", "packageId": "hl7.fhir.uv.extensions.r5", "version": "5.2.0" } ], "definition": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/ig-internal-dependency", "valueCode": "hl7.fhir.uv.tools.r5#0.5.0" } ], "resource": [ { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:extension" } ], "reference": { "reference": "StructureDefinition/actor-classification" }, "name": "Actor Classification", "description": "An extension to capture whether the actor is primary or secondary in the context of the requirements defintion.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ValueSet" } ], "reference": { "reference": "ValueSet/vs-actor-classification-codes" }, "name": "Actor Classification Codes", "description": "A coded value that represents whether the actor is primary or secondary in the context of the requirements definition.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-actor-classification-codes" }, "name": "Actor Classification Codes", "description": "A coded value that represents whether the actor is primary or secondary in the context of the requirements definition.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:extension" } ], "reference": { "reference": "StructureDefinition/actor-reference" }, "name": "Actor Reference", "description": "An extension to reference the Actor Resource describing additional details regarding the actor.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/BDRSActorDefinitionExample" }, "name": "ActorDefinition - Birth and Death Registration System", "description": "Represents the system used for recording births and deaths, ensuring that citizens are formally recognized and provided with legal identification.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/ClientRegistryActorDefinitionExample" }, "name": "ActorDefinition - Client Registry", "description": "Represents the system designed to uniquely identify individuals who receive healthcare services, often by maintaining a central record of patients and their demographics, assigning unique identifiers, and enabling healthcare workers to identify facilities where a patient has received care.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/ClinicianActorDefinitionExample" }, "name": "ActorDefinition - Clinician", "description": "Represents the individual responsible for the care of patient.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/APIActorDefinitionExample" }, "name": "ActorDefinition - Cross-Service API", "description": "Represents the system used to provide a single entrypoint for demographic search queries that might have a mix of various query parameters.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/ICSActorDefinitionExample" }, "name": "ActorDefinition - Immigration and Citizenship System", "description": "Represents the system used to manage the entry, stay, and exit of foreign nationals and to govern the acquisition and loss of citizenship in the country.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/InteroperabilityLayerActorDefinitionExample" }, "name": "ActorDefinition - Interoperability Layer", "description": "Represents the architectural component responsible for coordinating transactions from one system to another during Health Information Exchange.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/IPMSActorDefinitionExample" }, "name": "ActorDefinition - IPMS", "description": "Represents a centralized electronic medical record (EMR) system implemented by the Ministry of Health and Wellness. It aims to enhance patient care by providing a unified platform for managing medical records across public health facilitie.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/LaboratoryTechnicianActorDefinitionExample" }, "name": "ActorDefinition - Laboratory Technician", "description": "Represents the individual responsible for conducting lab tests.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/MFLActorDefinitionExample" }, "name": "ActorDefinition - Master Facility List", "description": "Represents a comprehensive, standardized registry of all health facilities—both public and private—across the country. Managed by the Ministry of Health and Wellness, the MFL assigns unique codes to each facility, ensuring accurate identification and facilitating interoperability across health information systems. This system supports efficient health data management, reporting, and planning.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/OmangActorDefinitionExample" }, "name": "ActorDefinition - Omang", "description": "Represents the system used for national identification of the population in Botswana.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/OpenMRSActorDefinitionExample" }, "name": "ActorDefinition - OpenMRS", "description": "Represents an open-source electronic medical record system that is used to manage patient data, support HIV care, and strengthen health information systems across the country’s healthcare facilities.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/PIMSActorDefinitionExample" }, "name": "ActorDefinition - PIMS", "description": "Represents the system used to collect, manage, and track patient health records across healthcare facilities, supporting improved care, reporting, and decision-making.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ActorDefinition" } ], "reference": { "reference": "ActorDefinition/SHRActorDefinitionExample" }, "name": "ActorDefinition - Shared Health Record", "description": "Represents the system that stores a defined set of normalized patient data, serving as a longitudinal health record across different facilities, ensuring continuity of care.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/BirthDeathRegistrationRequirements" }, "name": "Birth and Death Registration System Requirements", "description": "Birth and Death Registration System Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CapabilityStatement" } ], "reference": { "reference": "CapabilityStatement/bw-hie-server" }, "name": "Botswana HIE Capability Statement", "description": "This section describes the expected capabilities of the Botswana HIE server actor which is responsible for providing responses to the queries submitted for lab orders. The list of FHIR profiles and operations supported by the Botswana HIE server are defined.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/BwPatientExample" }, "name": "Botswana Patient", "description": "Is used to document demographics and other personal information about an individual receiving care or other health-related services.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-patient" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/cancelled-lab-order-bundle" }, "name": "Bundle - Cancelled Lab Order", "description": "Lab order has been cancelled", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-bundle" }, "name": "Bundle - Create New Lab Order", "description": "Submit new lab orders", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-conditional-patient-create-bundle" }, "name": "Bundle - Create New Lab Order (Incl. Conditional Patient Create)", "description": "Submit new lab orders.\n\n Note: This bundle includes the Patient Resource as a conditional create!", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-conditional-patient-update-bundle" }, "name": "Bundle - Create New Lab Order (Incl. Conditional Patient Update)", "description": "Submit new lab orders.\n\n Note: This bundle includes the Patient Resource as a conditional update!", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-with-patient-bundle" }, "name": "Bundle - Create New Lab Order (incl. Patient Resource)", "description": "Submit new lab orders (incl. Patient Resource)", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-with-restricted-patient-bundle" }, "name": "Bundle - Create New Lab Order (incl. Restricted Patient Create)", "description": "Submit new lab orders and replace the patient profile resource that supplied the data with the \"RestrictedPatient\" profile resource.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/process-patient-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-order-auto-generate-ids-bundle" }, "name": "Bundle - Create New Lab Order (Uses System Generated IDs)", "description": "Submit new lab orders.\n\n Note: This bundle includes Resources without explicitly provided Resource ID's! \n The system will auto-generate the Resource.id values (Literal ID) during the POST request.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/lab-result-bundle" }, "name": "Bundle - Document Lab Result", "description": "Lab order has been completed", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-orders-bundle" }, "name": "Bundle - Lab Orders", "description": "This bundle contains all of the lab order profiles for managing lab orders.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/process-patient-bundle" }, "name": "Bundle - Process Patient in FHIR", "description": "While this bundle contains all of the lab order profiles for managing lab orders as defined in the bundle for \"Lab Orders\", it also includes the \"RestrictedPatient\" profile that will replace the \"Botswana Patient\" in the FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Bundle" } ], "reference": { "reference": "Bundle/rejected-lab-order-bundle" }, "name": "Bundle - Rejected Lab Order", "description": "Lab order has been rejected", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-orders-bundle" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/CancelLabOrder" }, "name": "Cancel Lab Order (Using a Bundle)", "description": "Demonstrates the process flow to submit a cancellation request for an active lab order from the Point-of-Service application to the FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/ClientRegistryRequirements" }, "name": "Client Registry Requirements", "description": "Client Registry Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/ClinicianRequirements" }, "name": "Clinician Requirements", "description": "Clinician Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-connection-type-codes" }, "name": "Connection Type Codes", "description": "A coded value that represents the technical details of the usage of an endpoint.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/CrossServiceAPIRequirements" }, "name": "Cross-Service API Requirements", "description": "Cross-Service API Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-order-diagnostic-report" }, "name": "DiagnosticReport - Lab Order", "description": "Represents the results for the lab order.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "DiagnosticReport" } ], "reference": { "reference": "DiagnosticReport/LabResultsDiagnosticReportExample" }, "name": "DiagnosticReport - Lab Result", "description": "Represents the results for the lab order.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-diagnostic-report" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/target-facility-encounter" }, "name": "Encounter - Initiated By The Facility Providing the Service", "description": "Represents the current facility at which the patient is receiving health services.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Encounter" } ], "reference": { "reference": "Encounter/TargetFacilityEncounterExample" }, "name": "Encounter - Initiated By The Facility Providing the Service", "description": "Represents the current facility at which the patient is receiving health services.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/target-facility-encounter" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/RestrictedPatientExample1" }, "name": "Excludes all personal patient data - After new patient submitted for creation.", "description": "The patient resource that should be stored in the FHIR database when using a Client Registry.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/patient-identity-cross-reference" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/HIESystemRequirements" }, "name": "HIE System Requirements", "description": "HIE System Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/ImmigrationCitizenshipSystemRequirements" }, "name": "Immigration and Citizenship System Requirements", "description": "Immigration and Citizenship System Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Patient" } ], "reference": { "reference": "Patient/RestrictedPatientExample2" }, "name": "Includes all personal patient data - After being supplied by the Client Registry.", "description": "The patient resource after having its data populated by the Client Registry.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/patient-identity-cross-reference" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/IntegratedPatientManagementSystemRequirements" }, "name": "Integrated Patient Management System Requirements", "description": "Integrated Patient Management System Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/InteroperabilityLayerRequirements" }, "name": "Interoperability Layer Requirements", "description": "Interoperability Layer Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ValueSet" } ], "reference": { "reference": "ValueSet/vs-lab-order-codes" }, "name": "Lab Order Codes", "description": "Codes used during lab orders.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/LabOrderResults" }, "name": "Lab Order Results (Using a Bundle)", "description": "Demonstrates the process flow to submit lab results from the Point-of-Service application to the FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/LaboratoryTechnicianRequirements" }, "name": "Laboratory Technician Requirements", "description": "Laboratory Technician Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ValueSet" } ], "reference": { "reference": "ValueSet/vs-master-facility-list-codes" }, "name": "Master Facility List (MFL) Codes", "description": "Codes found in the MFL.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-master-facility-list-codes" }, "name": "Master Facility List (MFL) Codes", "description": "Codes found in the MFL.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/MPIForPatientIssuedByCR" }, "name": "Master Patient Index identifier issued by the Client Registry.", "description": "Interoperability layer receives an MPI as part of the response from the CR when creating new patients.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/NonFunctionalRequirements" }, "name": "Non Functional Requirements", "description": "Non Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Observation" } ], "reference": { "reference": "Observation/LabResultObservationExample" }, "name": "Observation - Diagnostic Test Result", "description": "Documents the patient's diagnostic test result.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-result-observation" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-result-observation" }, "name": "Observation - Lab Result", "description": "Represents the patient's test result for a given lab order.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/OmangRequirements" }, "name": "Omang Requirements", "description": "Omang Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-openmrs-lab-codes" }, "name": "OpenMRS Lab Codes", "description": "Codes used during OpenMRS lab orders.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/OpenMRSRequirements" }, "name": "OpenMRS Requirements", "description": "OpenMRS Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Organization" } ], "reference": { "reference": "Organization/ServiceProviderExample" }, "name": "Organization - Current Facility", "description": "Current organization providing health related services.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/service-organization" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/bw-patient" }, "name": "Patient - Botswana Patient", "description": "Is used to document demographics and other personal information about an individual receiving care or other health-related services.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/patient-identity-cross-reference" }, "name": "Patient - Patient Identity Cross Reference", "description": "Is used by the Client Registry to re-identify the patient with his/her corresponding longitudinal clinical record.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Requirements" } ], "reference": { "reference": "Requirements/PatientInformationManagementSystemRequirements" }, "name": "Patient Information Management System Requirements", "description": "Patient Information Management System Functional Requirements", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/bw-requirements" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-pims-lab-codes" }, "name": "PIMS Lab Codes", "description": "Codes used during PIMS lab orders.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/practitioner" }, "name": "Practitioner", "description": "Represents the practitioner who participated in the health related service.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Practitioner" } ], "reference": { "reference": "Practitioner/BwPractitionerExample" }, "name": "Practitioner", "description": "Represents the practitioners who participated in the health-related event.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/practitioner" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/ProcessFHIRBundle" }, "name": "Process FHIR Bundle", "description": "Point-of-Service systems can submit \"PUT\" or \"POST\" requests using a FHIR Bundle Resource.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/RegisterNewPatient" }, "name": "Register New Patient", "description": "Demonstrates the process flow between the Client Registry and FHIR server during patient registration.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/RegisterNewPatientInBundle" }, "name": "Register New Patient (Using a Bundle)", "description": "Demonstrates the process flow between the Client Registry and FHIR server during patient registration.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/RejectLabOrder" }, "name": "Reject Lab Order (Using a Bundle)", "description": "Demonstrates the process flow to submit a rejection request for an active lab order from the Point-of-Service application to the FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/bw-requirements" }, "name": "Requirements", "description": "Represents the requirements for the use case described in this Implementation Guide.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:extension" } ], "reference": { "reference": "StructureDefinition/requirements-type" }, "name": "Requirements Type", "description": "An extension to capture the type of requirements contained in the Resource.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ValueSet" } ], "reference": { "reference": "ValueSet/vs-requirements-type-codes" }, "name": "Requirements Type Codes", "description": "A coded value that represents the type of requirements contained in the Resource.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-requirements-type-codes" }, "name": "Requirements Type Codes", "description": "A coded value that represents the type of requirements contained in the Resource.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/FHIRResourceProcessResponse" }, "name": "Response issued by FHIR after CRUD requests.", "description": "Interoperability layer receives an outcome response for each CRUD request.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/RetrievePatientRecord" }, "name": "Retrieve Patient Record", "description": "Demonstrates the process flow to retrieve a patient record from the Client Registry and FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "CodeSystem" } ], "reference": { "reference": "CodeSystem/cs-scenario-op-type-codes" }, "name": "Scenario Operation Type Codes", "description": "A coded value that represents the HTTP method when sending a request to a specified endpoint.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/SearchForPatientInCRResponse" }, "name": "Search Patient in Client Registry - Response.", "description": "Interoperability layer receives a response from the CR for the search request.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/SearchForPatientInCR" }, "name": "Search Patient in Client Registry.", "description": "Interoperability layer searches for a patient in the client registry using business identifiers (Omang, BDRS, Immigration) or Demographics.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/SearchForPatientInFHIR" }, "name": "Search Patient in FHIR.", "description": "Point-of-Service systems can search for a patient in FHIR using one or more business identifiers (Omang, BDRS, Immigration) or Demographics.", "isExample": true }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/service-organization" }, "name": "Service Provider", "description": "Organization providing health related services.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ServiceRequest" } ], "reference": { "reference": "ServiceRequest/LabOrderActiveServiceRequestExample" }, "name": "ServiceRequest - Lab Order (Active)", "description": "Represents an active service request for the lab order.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-service-request" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ServiceRequest" } ], "reference": { "reference": "ServiceRequest/LabOrderCompletedServiceRequestExample" }, "name": "ServiceRequest - Lab Order (Completed)", "description": "Represents a completed service request for the lab order.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-service-request" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ServiceRequest" } ], "reference": { "reference": "ServiceRequest/LabOrderRevokedServiceRequestOrderCancelledExample" }, "name": "ServiceRequest - Lab Order (Revoked - Order Cancelled)", "description": "Represents a service request that has been revoked before it could be fully attended to.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-service-request" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ServiceRequest" } ], "reference": { "reference": "ServiceRequest/LabOrderRevokedServiceRequestPoorSpecimenExample" }, "name": "ServiceRequest - Lab Order (Revoked - Unsatisfactory Specimen)", "description": "Represents a service request that has been revoked before it could be fully attended to.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-service-request" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-order-service-request" }, "name": "ServiceRequest - Lab Orders", "description": "Represents the service request for lab orders.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-order-specimen" }, "name": "Specimen", "description": "The specimen associated with the lab order.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Specimen" } ], "reference": { "reference": "Specimen/UnsatisfactorySpecimenForRevokedRequestsExample" }, "name": "Specimen - Unsatisfactory", "description": "The specimen associated with the lab order that was considered ready for testing but the service request was revoked due to an unsatisfactory specimen.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-specimen" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Specimen" } ], "reference": { "reference": "Specimen/AvailableSpecimenForCompletedRequestsExample" }, "name": "Specimen - Used During Testing (Completed Order)", "description": "The specimen associated with the lab order that was used during testing.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-specimen" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Specimen" } ], "reference": { "reference": "Specimen/AvailableSpecimenForCancelledRequestsExample" }, "name": "Specimen - Used During Testing (Order Cancelled)", "description": "The specimen associated with the lab order that was used during testing.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-specimen" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Specimen" } ], "reference": { "reference": "Specimen/AvailableSpecimenForActiveRequestsExample" }, "name": "Specimen - Used During Testing (Order is Active)", "description": "The specimen associated with the lab order that will be used during testing.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-specimen" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "ExampleScenario" } ], "reference": { "reference": "ExampleScenario/SubmitNewLabOrders" }, "name": "Submit New Lab Orders (Using a Bundle)", "description": "Demonstrates the process flow to submit a new lab order from the Point-of-Service application to the FHIR server.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Task" } ], "reference": { "reference": "Task/LabOrderCancellationTaskExample" }, "name": "Task - Lab Order Cancelled by Requester", "description": "Indicates that the task that has been initiated for the lab request has been cancelled by the requestiong organization/practitioner.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-task" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Task" } ], "reference": { "reference": "Task/LabOrderResultTaskExample" }, "name": "Task - Lab Order Completed", "description": "Indicates that the task that has been initiated for the lab request has now been completed and the lab result issued.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-task" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Task" } ], "reference": { "reference": "Task/LabOrderRejectionTaskExample" }, "name": "Task - Lab Order Rejected by Laboratory", "description": "Indicates that the task that has been initiated for the lab request has been rejected by the receiving laboratory/lab technician.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-task" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "StructureDefinition:resource" } ], "reference": { "reference": "StructureDefinition/lab-order-task" }, "name": "Task - Lab Orders", "description": "Assists with tracking the state of the lab order and its completion status.", "isExample": false }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Task" } ], "reference": { "reference": "Task/LabOrderTaskExample" }, "name": "Task - New Lab Order Requested", "description": "Represents a task that has been initiated to facilitate the overall progress of the new lab request.", "isExample": true, "profile": [ "http://moh.bw.org/StructureDefinition/lab-order-task" ] }, { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/resource-information", "valueString": "Endpoint" } ], "reference": { "reference": "Endpoint/ValidatePatientResourceInFHIR" }, "name": "Validate Patient Resource in FHIR.", "description": "FHIR uses its $validate operation to ensure that data provided in the Patient Resource is compliant with the specified FHIR Profile.", "isExample": true } ], "page": { "sourceUrl": "toc.html", "name": "toc.html", "title": "Table of Contents", "generation": "html", "page": [ { "sourceUrl": "index.html", "name": "index.html", "title": "Home", "generation": "html" }, { "sourceUrl": "changes.html", "name": "changes.html", "title": "Changes", "generation": "html" }, { "sourceUrl": "downloads.html", "name": "downloads.html", "title": "Downloads", "generation": "markdown" }, { "sourceUrl": "functional-requirements.html", "name": "functional-requirements.html", "title": "Functional Requirements", "generation": "markdown" }, { "sourceUrl": "non-functional-requirements.html", "name": "non-functional-requirements.html", "title": "Non Functional Requirements", "generation": "markdown" }, { "sourceUrl": "sequence-diagrams.html", "name": "sequence-diagrams.html", "title": "Sequence Diagrams", "generation": "markdown" }, { "sourceUrl": "use_cases.html", "name": "use_cases.html", "title": "Use Cases", "generation": "markdown" } ] }, "parameter": [ { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "copyrightyear" }, "value": "2021+" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "releaselabel" }, "value": "ci-build" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "autoload-resources" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/capabilities" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/examples" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/extensions" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/models" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/operations" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/profiles" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/resources" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/vocabulary" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/maps" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/testing" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "input/history" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-resource" }, "value": "fsh-generated/resources" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-pages" }, "value": "template/config" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-pages" }, "value": "input/images" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-liquid" }, "value": "template/liquid" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-liquid" }, "value": "input/liquid" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-qa" }, "value": "temp/qa" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-temp" }, "value": "temp/pages" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-output" }, "value": "output" }, { "code": { "system": "http://hl7.org/fhir/guide-parameter-code", "code": "path-tx-cache" }, "value": "input-cache/txcache" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-suppressed-warnings" }, "value": "input/ignoreWarnings.txt" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "path-history" }, "value": "http://moh.bw.org/history.html" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "template-html" }, "value": "template-page.html" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "template-md" }, "value": "template-page-md.html" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-contact" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-context" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-copyright" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-jurisdiction" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-license" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-publisher" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-version" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "apply-wg" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "active-tables" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "fmm-definition" }, "value": "http://hl7.org/fhir/versions.html#maturity" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "propagate-status" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "excludelogbinaryformat" }, "value": "true" }, { "code": { "system": "http://hl7.org/fhir/tools/CodeSystem/ig-parameters", "code": "tabbed-snapshots" }, "value": "true" } ] } }