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

: Cross-Service API Requirements - XML Representation

Active as of 2025-08-20

Raw xml | Download


<Requirements xmlns="http://hl7.org/fhir">
  <id value="CrossServiceAPIRequirements"/>
  <meta>
    <profile value="http://moh.bw.org/StructureDefinition/bw-requirements"/>
  </meta>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: Requirements CrossServiceAPIRequirements</b></p><a name="CrossServiceAPIRequirements"> </a><a name="hcCrossServiceAPIRequirements"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px"/><p style="margin-bottom: 0px">Profile: <a href="StructureDefinition-bw-requirements.html">Requirements</a></p></div><p>These requirements apply to the following actors: </p><ul><li><a href="ActorDefinition-APIActorDefinitionExample.html">Cross-Service API (API)</a></li><li><a href="ActorDefinition-BDRSActorDefinitionExample.html">Birth and Death Registration System (BDRS)</a></li><li><a href="ActorDefinition-ICSActorDefinitionExample.html">Immigration and Citizenship System (ICS)</a></li><li><a href="ActorDefinition-OmangActorDefinitionExample.html">Omang</a></li></ul><table class="grid"><tr><td><b><a name="BOTS.FR-CSAPI.001"> </a></b>BOTS.FR-CSAPI.001</td><td/><td><div><p>Should be able to handle a valid FHIR search query that includes parameters across the Omang, BDRS, and Immigration services.</p>
</div></td></tr><tr><td><b><a name="BOTS.FR-CSAPI.002"> </a></b>BOTS.FR-CSAPI.002</td><td/><td><div><p>Should be able to return a search bundle with results representing a union of results from the three services.</p>
</div></td></tr><tr><td><b><a name="BOTS.FR-CSAPI.003"> </a></b>BOTS.FR-CSAPI.003</td><td/><td><div><p>Needs to provide a separate endpoint that returns a single patient resource based on the first match, using a hierarchical matching algorithm.</p>
</div></td></tr></table></div>
  </text>
  <extension url="http://moh.bw.org/StructureDefinition/requirements-type">
    <valueCodeableConcept>
      <coding>
        <system
                value="http://moh.bw.org/CodeSystem/cs-requirements-type-codes"/>
        <code value="functional"/>
      </coding>
    </valueCodeableConcept>
  </extension>
  <url value="http://moh.bw.org/Requirements/CrossServiceAPIRequirements"/>
  <version value="1.0.0"/>
  <name value="CrossServiceAPIRequirements"/>
  <status value="active"/>
  <date value="2025-08-20T07:21:53+00:00"/>
  <publisher value="Jembi Health Systems"/>
  <contact>
    <name value="Jembi Health Systems"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.jembi.org"/>
    </telecom>
    <telecom>
      <system value="email"/>
      <value value="info@jembi.org"/>
    </telecom>
  </contact>
  <contact>
    <name value="Jembi Health Systems"/>
    <telecom>
      <system value="email"/>
      <value value="info@jembi.org"/>
      <use value="work"/>
    </telecom>
  </contact>
  <jurisdiction>
    <coding>
      <system value="urn:iso:std:iso:3166"/>
      <code value="BW"/>
      <display value="Botswana"/>
    </coding>
  </jurisdiction>
  <actor value="http://moh.bw.org/ActorDefinition/APIActorDefinitionExample">🔗 
    <extension
               url="http://moh.bw.org/StructureDefinition/actor-classification">
      <valueCodeableConcept>
        <coding>
          <system
                  value="http://moh.bw.org/CodeSystem/cs-actor-classification-codes"/>
          <code value="primary"/>
        </coding>
      </valueCodeableConcept>
    </extension>
  </actor>
  <actor
         value="http://moh.bw.org/ActorDefinition/BDRSActorDefinitionExample">🔗 
    <extension
               url="http://moh.bw.org/StructureDefinition/actor-classification">
      <valueCodeableConcept>
        <coding>
          <system
                  value="http://moh.bw.org/CodeSystem/cs-actor-classification-codes"/>
          <code value="secondary"/>
        </coding>
      </valueCodeableConcept>
    </extension>
  </actor>
  <actor value="http://moh.bw.org/ActorDefinition/ICSActorDefinitionExample">🔗 
    <extension
               url="http://moh.bw.org/StructureDefinition/actor-classification">
      <valueCodeableConcept>
        <coding>
          <system
                  value="http://moh.bw.org/CodeSystem/cs-actor-classification-codes"/>
          <code value="secondary"/>
        </coding>
      </valueCodeableConcept>
    </extension>
  </actor>
  <actor
         value="http://moh.bw.org/ActorDefinition/OmangActorDefinitionExample">🔗 
    <extension
               url="http://moh.bw.org/StructureDefinition/actor-classification">
      <valueCodeableConcept>
        <coding>
          <system
                  value="http://moh.bw.org/CodeSystem/cs-actor-classification-codes"/>
          <code value="secondary"/>
        </coding>
      </valueCodeableConcept>
    </extension>
  </actor>
  <statement>
    <key value="BOTS.FR-CSAPI.001"/>
    <requirement
                 value="Should be able to handle a valid FHIR search query that includes parameters across the Omang, BDRS, and Immigration services."/>
  </statement>
  <statement>
    <key value="BOTS.FR-CSAPI.002"/>
    <requirement
                 value="Should be able to return a search bundle with results representing a union of results from the three services."/>
  </statement>
  <statement>
    <key value="BOTS.FR-CSAPI.003"/>
    <requirement
                 value="Needs to provide a separate endpoint that returns a single patient resource based on the first match, using a hierarchical matching algorithm."/>
  </statement>
</Requirements>