> ## Documentation Index
> Fetch the complete documentation index at: https://hmis-docs.derrickmugabwa.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# OIE channels

> Channel roles, boundaries, and documentation requirements.

## Current pilot channels

| Channel                        | Role                                                                                    |                       |
| ------------------------------ | --------------------------------------------------------------------------------------- | --------------------- |
| HMIS Laboratory Results Relay  | Receives normalized JSON and calls the HMIS results API using the results-write token.  |                       |
| HMIS Laboratory Worklist Relay | Receives barcode lookups and calls the HMIS worklist API using the worklist-read token. |                       |
| Mock ASTM Results Inbound      | Parses ASTM/TCP messages into the normalized result shape.                              |                       |
| Mock HL7 Results Inbound       | Parses HL7 ORU messages, relays results, and returns an HL7 \`MSA                       | AA\` acknowledgement. |

## Export rule

After any working change, export the affected channel from OIE Administrator and store a sanitised XML copy under `oie-channel-exports/`.

Before committing an export, replace tokens, passwords, private addresses, and patient values with placeholders.

## Normalized result shape

```json theme={null}
{
  "message_id": "{{MESSAGE_ID}}",
  "instrument_code": "{{INSTRUMENT_CODE}}",
  "specimen_number": "{{SPECIMEN_NUMBER}}",
  "received_at": "2026-01-01T00:00:00Z",
  "results": [
    {
      "analyzer_test_code": "HGB",
      "value": 13.4,
      "unit": "g/dL",
      "flag": "N",
      "observed_at": "2026-01-01T00:00:00Z"
    }
  ]
}
```