Botswana AMR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Export WHONET Flat File - JSON Representation

Draft as of 2026-03-13

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "ExportWHONET",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition ExportWHONET</b></p><a name=\"ExportWHONET\"> </a><a name=\"hcExportWHONET\"> </a><p>URL: [base]/DiagnosticReport/$export-whonet</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>start</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#date\">date</a></td><td/><td><div><p>Start of date range filter for specimen collection date (inclusive). Only DiagnosticReports whose specimen was collected on or after this date are included.</p>\n</div></td></tr><tr><td>IN</td><td>end</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#date\">date</a></td><td/><td><div><p>End of date range filter for specimen collection date (inclusive). Only DiagnosticReports whose specimen was collected on or before this date are included.</p>\n</div></td></tr><tr><td>IN</td><td>facility</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#string\">string</a></td><td/><td><div><p>Filter results by facility name. Matches against the Encounter.serviceProvider organization name or DiagnosticReport.performer organization name.</p>\n</div></td></tr><tr><td>IN</td><td>format</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4B/datatypes.html#code\">code</a></td><td/><td><div><p>Output format: 'whonet' for WHONET pipe-delimited format, 'glass' for WHO GLASS batch submission format. Defaults to 'whonet'.</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4B/binary.html\">Binary</a></td><td/><td><div><p>The generated flat file returned as a Binary resource with contentType text/csv.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://bw.health.gov/fhir/amr/OperationDefinition/ExportWHONET",
  "version" : "0.1.0",
  "name" : "ExportWHONET",
  "title" : "Export WHONET Flat File",
  "status" : "draft",
  "kind" : "operation",
  "date" : "2026-03-13T21:27:21-04:00",
  "publisher" : "University of Botswana Partnership",
  "contact" : [
    {
      "name" : "University of Botswana Partnership",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://github.com/Dokotela/bw-amr-ig"
        }
      ]
    }
  ],
  "description" : "Exports AMR DiagnosticReport data as a WHONET-compatible flat file or GLASS submission file. The operation flattens the FHIR resource graph (DiagnosticReport -> OrganismObservation -> SusceptibilityObservation) into isolate-centric rows suitable for WHONET import or WHO GLASS batch upload.",
  "code" : "export-whonet",
  "resource" : [
    "DiagnosticReport"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "start",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Start of date range filter for specimen collection date (inclusive). Only DiagnosticReports whose specimen was collected on or after this date are included.",
      "type" : "date"
    },
    {
      "name" : "end",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "End of date range filter for specimen collection date (inclusive). Only DiagnosticReports whose specimen was collected on or before this date are included.",
      "type" : "date"
    },
    {
      "name" : "facility",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Filter results by facility name. Matches against the Encounter.serviceProvider organization name or DiagnosticReport.performer organization name.",
      "type" : "string"
    },
    {
      "name" : "format",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Output format: 'whonet' for WHONET pipe-delimited format, 'glass' for WHO GLASS batch submission format. Defaults to 'whonet'.",
      "type" : "code"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "The generated flat file returned as a Binary resource with contentType text/csv.",
      "type" : "Binary"
    }
  ]
}