# Outbox - Medtech ALEX® AU Implementation Guide v1.0.0

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **Outbox**

## Resource Profile: Outbox 

| | |
| :--- | :--- |
| *Official URL*:https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox | *Version*:1.0.0 |
| Active as of 2026-01-12 | *Computable Name*:AlexOutbox |

 
The ALEX Outbox that utilises the Communication resource 

**Usages:**

* Use this Profile: [Outbox Bundle](StructureDefinition-outbox-search-bundle.md)
* Examples for this Profile: [Communication/outbox-full-example](Communication-outbox-full-example.md) and [Communication/outbox-min-example](Communication-outbox-min-example.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/medtechglobal.fhir.alex|current/StructureDefinition/alex-outbox)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-alex-outbox.csv), [Excel](StructureDefinition-alex-outbox.xlsx), [Schematron](StructureDefinition-alex-outbox.sch) 



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "alex-outbox",
  "url" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox",
  "version" : "1.0.0",
  "name" : "AlexOutbox",
  "title" : "Outbox",
  "status" : "active",
  "date" : "2026-01-12T22:43:00+00:00",
  "publisher" : "Medtech Global",
  "contact" : [
    {
      "name" : "Medtech Global",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://medtechglobal.com/au/"
        },
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com"
        }
      ]
    },
    {
      "name" : "Medtech Support",
      "telecom" : [
        {
          "system" : "email",
          "value" : "supportau@medtechglobal.com",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "The ALEX Outbox that utilises the Communication resource",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001",
          "display" : "World"
        }
      ]
    }
  ],
  "fhirVersion" : "4.0.1",
  "mapping" : [
    {
      "identity" : "workflow",
      "uri" : "http://hl7.org/fhir/workflow",
      "name" : "Workflow Pattern"
    },
    {
      "identity" : "w5",
      "uri" : "http://hl7.org/fhir/fivews",
      "name" : "FiveWs Pattern Mapping"
    },
    {
      "identity" : "rim",
      "uri" : "http://hl7.org/v3",
      "name" : "RIM Mapping"
    }
  ],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Communication",
  "baseDefinition" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-communication",
  "derivation" : "constraint",
  "differential" : {
    "element" : [
      {
        "id" : "Communication",
        "path" : "Communication"
      },
      {
        "id" : "Communication.meta",
        "path" : "Communication.meta",
        "min" : 1
      },
      {
        "id" : "Communication.meta.profile",
        "path" : "Communication.meta.profile",
        "min" : 1,
        "max" : "1",
        "mustSupport" : true
      },
      {
        "id" : "Communication.identifier",
        "path" : "Communication.identifier",
        "constraint" : [
          {
            "key" : "alex-outbox-external-reference-length",
            "severity" : "error",
            "human" : "External reference size validation",
            "expression" : "value.empty() or value.length() <= 34",
            "source" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox"
          }
        ]
      },
      {
        "id" : "Communication.identifier.use",
        "path" : "Communication.identifier.use",
        "max" : "0"
      },
      {
        "id" : "Communication.identifier.type",
        "path" : "Communication.identifier.type",
        "max" : "0"
      },
      {
        "id" : "Communication.identifier.system",
        "path" : "Communication.identifier.system",
        "max" : "0"
      },
      {
        "id" : "Communication.identifier.value",
        "path" : "Communication.identifier.value",
        "short" : "The external reference number of the Outbox record/Message"
      },
      {
        "id" : "Communication.identifier.period",
        "path" : "Communication.identifier.period",
        "max" : "0"
      },
      {
        "id" : "Communication.status",
        "path" : "Communication.status",
        "patternCode" : "completed"
      },
      {
        "id" : "Communication.category.coding.system",
        "path" : "Communication.category.coding.system",
        "patternUri" : "http://snomed.info/sct"
      },
      {
        "id" : "Communication.category.coding.code",
        "path" : "Communication.category.coding.code",
        "patternCode" : "423876004"
      },
      {
        "id" : "Communication.category.coding.display",
        "path" : "Communication.category.coding.display",
        "patternString" : "Clinical document (record artifact)"
      },
      {
        "id" : "Communication.subject",
        "path" : "Communication.subject",
        "constraint" : [
          {
            "key" : "alex-outbox-display-length",
            "severity" : "error",
            "human" : "Patient external name size validation",
            "expression" : "display.empty() or display.length() <= 35",
            "source" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox"
          }
        ]
      },
      {
        "id" : "Communication.payload",
        "path" : "Communication.payload",
        "short" : "The vendor has to send base64 encoded data of the PDF version of the Webform submitted successfully"
      },
      {
        "id" : "Communication.payload.content[x]:contentAttachment",
        "path" : "Communication.payload.content[x]",
        "sliceName" : "contentAttachment",
        "type" : [
          {
            "code" : "Attachment"
          }
        ],
        "constraint" : [
          {
            "key" : "alex-outbox-attachment-title-length",
            "severity" : "error",
            "human" : "Attachment title size validation",
            "expression" : "title.empty() or title.length() <= 50",
            "source" : "https://alexapi.medtechglobal.com.au/fhir/StructureDefinition/alex-outbox"
          }
        ]
      },
      {
        "id" : "Communication.payload.content[x]:contentAttachment.contentType",
        "path" : "Communication.payload.content[x].contentType",
        "patternCode" : "application/pdf"
      },
      {
        "id" : "Communication.payload.content[x]:contentAttachment.title",
        "path" : "Communication.payload.content[x].title",
        "short" : "This will be sent by the vendor in the payload, must limit to 50 characters, otherwise the subject will be cutoff in the UI"
      }
    ]
  }
}

```
