API Reference

Create a new MessageHeader

MessageHeader on the FHIR specification website.

The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

The body should be a valid FHIR object for MessageHeader.

Here is an example:

{
  "resourceType": "MessageHeader",
  "id": "1cbdfb97-5859-48a4-8301-d54eab818d68",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <p>Update Person resource for Peter James CHALMERS (Jim), MRN: 12345 (Acme Healthcare)</p>\n    </div>"
  },
  "eventCoding": {
    "system": "http://example.org/fhir/message-events",
    "code": "admin-notify"
  },
  "destination": [
    {
      "name": "Acme Message Gateway",
      "target": {
        "reference": "Device/example"
      },
      "endpoint": "llp:10.11.12.14:5432",
      "receiver": {
        "reference": "http://acme.com/ehr/fhir/Practitioner/2323-33-4"
      }
    }
  ],
  "sender": {
    "reference": "Organization/1"
  },
  "enterer": {
    "reference": "Practitioner/example"
  },
  "author": {
    "reference": "Practitioner/example"
  },
  "source": {
    "name": "Acme Central Patient Registry",
    "software": "FooBar Patient Manager",
    "version": "3.1.45.AABB",
    "contact": {
      "system": "phone",
      "value": "+1 (555) 123 4567"
    },
    "endpoint": "llp:10.11.12.13:5432"
  },
  "reason": {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/message-reasons-encounter",
        "code": "admit"
      }
    ]
  },
  "response": {
    "identifier": "5015fe84-8e76-4526-89d8-44b322e8d4fb",
    "code": "ok"
  },
  "focus": [
    {
      "reference": "Patient/example"
    }
  ],
  "definition": "http:////acme.com/ehr/fhir/messagedefinition/patientrequest"
}

You can reference the FHIR documentation to determine the format for MessageHeader.

Language
Credentials
Click Try It! to start a request and see the response here!