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 - JSON Representation

Active as of 2025-08-20

Raw json | Download

{
  "resourceType" : "Requirements",
  "id" : "CrossServiceAPIRequirements",
  "meta" : {
    "profile" : [
      🔗 "http://moh.bw.org/StructureDefinition/bw-requirements"
    ]
  },
  "text" : {
    "status" : "generated",
    "div" : "<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>\n</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>\n</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>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://moh.bw.org/StructureDefinition/requirements-type",
      "valueCodeableConcept" : {
        "coding" : [
          {
            "system" : "http://moh.bw.org/CodeSystem/cs-requirements-type-codes",
            "code" : "functional"
          }
        ]
      }
    }
  ],
  "url" : "http://moh.bw.org/Requirements/CrossServiceAPIRequirements",
  "version" : "1.0.0",
  "name" : "CrossServiceAPIRequirements",
  "status" : "active",
  "date" : "2025-08-20T07:21:53+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"
        }
      ]
    }
  ],
  "actor" : [
    🔗 "http://moh.bw.org/ActorDefinition/APIActorDefinitionExample"🔗 ,
    "http://moh.bw.org/ActorDefinition/BDRSActorDefinitionExample"🔗 ,
    "http://moh.bw.org/ActorDefinition/ICSActorDefinitionExample"🔗 ,
    "http://moh.bw.org/ActorDefinition/OmangActorDefinitionExample"
  ],
  "_actor" : [
    {
      🔗 "extension" : [
        {
          "url" : "http://moh.bw.org/StructureDefinition/actor-classification",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "http://moh.bw.org/CodeSystem/cs-actor-classification-codes",
                "code" : "primary"
              }
            ]
          }
        }
      ]
    },
    {
      🔗 "extension" : [
        {
          "url" : "http://moh.bw.org/StructureDefinition/actor-classification",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "http://moh.bw.org/CodeSystem/cs-actor-classification-codes",
                "code" : "secondary"
              }
            ]
          }
        }
      ]
    },
    {
      🔗 "extension" : [
        {
          "url" : "http://moh.bw.org/StructureDefinition/actor-classification",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "http://moh.bw.org/CodeSystem/cs-actor-classification-codes",
                "code" : "secondary"
              }
            ]
          }
        }
      ]
    },
    {
      🔗 "extension" : [
        {
          "url" : "http://moh.bw.org/StructureDefinition/actor-classification",
          "valueCodeableConcept" : {
            "coding" : [
              {
                "system" : "http://moh.bw.org/CodeSystem/cs-actor-classification-codes",
                "code" : "secondary"
              }
            ]
          }
        }
      ]
    }
  ],
  "statement" : [
    {
      "key" : "BOTS.FR-CSAPI.001",
      "requirement" : "Should be able to handle a valid FHIR search query that includes parameters across the Omang, BDRS, and Immigration services."
    },
    {
      "key" : "BOTS.FR-CSAPI.002",
      "requirement" : "Should be able to return a search bundle with results representing a union of results from the three services."
    },
    {
      "key" : "BOTS.FR-CSAPI.003",
      "requirement" : "Needs to provide a separate endpoint that returns a single patient resource based on the first match, using a hierarchical matching algorithm."
    }
  ]
}