Skip to content

MessageHeader Profile

Canonical../StructureDefinition/nexus-emr-core-messageheader
Statusdraft (experimental) · 1.26.0
BaseMessageHeader (constraint)
SourceFSH · JSON

Nexus EMR profile for MessageHeader -- the routing envelope on an eReferral message bundle, consumed by the gateway's operation-routing middleware. Infrastructure rather than clinical content: no effective date, and R4 gives it no identifier element. First pass: the event vocabulary is not settled.

Examples

Inbound eReferral Routing Envelope

MessageHeader on an inbound cardiology eReferral response. Note R4 gives MessageHeader no identifier element -- response.identifier correlates it with the referral it answers

MessageHeader/mh-ereferral-inbound-cardiology-01 — claims conformance to MessageHeader Profile

{
  "resourceType": "MessageHeader",
  "id": "mh-ereferral-inbound-cardiology-01",
  "meta": {
    "profile": [
      "../StructureDefinition/nexus-emr-core-messageheader"
    ]
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns='http://www.w3.org/1999/xhtml'><p>Routing envelope on an inbound eReferral message: the partner's acknowledgement of the cardiology referral this estate sent for Avery Linwood. Carries no clinical content of its own -- focus points at the ServiceRequest and Patient entries in the enclosing bundle.</p><p>The event system is eHealth Ontario's, not this specification's. A response message echoes the event of the message it answers, so this one carries the same <code>add-service-request</code> the outbound referral did, and <code>response.code</code> says how it was received. <code>event[x]</code> is deliberately unbound: a partner may send a code, or a system, this specification has never named, and a consumer must handle the <code>eventUri</code> form as well as the <code>eventCoding</code> one.</p><p>Note there is no identifier element on MessageHeader in R4. response.identifier is what correlates this with the referral it answers, and it is type <code>id</code> -- so it holds the plain id of the message being responded to, constrained to [A-Za-z0-9-.]{1,64}. A urn:uuid: value is NOT valid here.</p></div>"
  },
  "eventCoding": {
    "system": "https://ehealthontario.ca/fhir/CodeSystem/message-event-code",
    "code": "add-service-request"
  },
  "source": {
    "name": "Regional eReferral Network",
    "software": "OceanMD eReferral",
    "endpoint": "https://ereferral.example.ca/fhir/$process-message"
  },
  "destination": [
    {
      "name": "Cedarbrook Family Health",
      "endpoint": "https://gateway.apps.health/fhir/$process-message"
    }
  ],
  "sender": {
    "identifier": {
      "system": "../NamingSystem/organization-identifier",
      "value": "riverside-cardiology"
    },
    "display": "Riverside Cardiology Associates"
  },
  "focus": [
    {
      "reference": "ServiceRequest/referral-cardiology-inbound",
      "display": "Cardiology referral for Avery Linwood"
    },
    {
      "reference": "Patient/avery-linwood",
      "display": "Avery Linwood"
    }
  ],
  "response": {
    "identifier": "mh-ereferral-outbound-cardiology-20250410",
    "code": "ok"
  }
}