MessageHeader - FHIR Resource (r4)


This MessageHeader Resource uses the FHIR API standard for access and structure.

Validate an MessageHeader FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
authorfalseReference# The source of the decision
definitionfalsecanonical(MessageDefinition)# Link to the definition for this message
destinationtrueData Type# Message destination application(s)
entererfalseReference# The source of the data entry
event[x]falseCoding|uri#undefined
focustrueReference# The actual content of the message
reasonfalseCodeableConcept# Cause of event
responsefalseData Type# If this is a reply to prior message
responsiblefalseReference# Final responsibility for event
senderfalseReference# Real world sender of the message
sourcefalseData Type# Message source application

MessageHeader 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"
}

MessageHeader Structure

{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  // event[x]: Code for the event this message represents or link to event definition. One of these 2:
  "eventCoding" : { Coding },
  "eventUri" : "<uri>",
  "destination" : [{ // Message destination application(s)
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "endpoint" : "<url>", // R!  Actual destination address or id
    "receiver" : { Reference(Practitioner|PractitionerRole|Organization) } // Intended "real-world" recipient for the data
  }],
  "sender" : { Reference(Practitioner|PractitionerRole|Organization) }, // Real world sender of the message
  "enterer" : { Reference(Practitioner|PractitionerRole) }, // The source of the data entry
  "author" : { Reference(Practitioner|PractitionerRole) }, // The source of the decision
  "source" : { // R!  Message source application
    "name" : "<string>", // Name of system
    "software" : "<string>", // Name of software running the system
    "version" : "<string>", // Version of software running
    "contact" : { ContactPoint }, // Human contact for problems
    "endpoint" : "<url>" // R!  Actual message source address or id
  },
  "responsible" : { Reference(Practitioner|PractitionerRole|Organization) }, // Final responsibility for event
  "reason" : { CodeableConcept }, // Cause of event
  "response" : { // If this is a reply to prior message
    "identifier" : "<id>", // R!  Id of original message
    "code" : "<code>", // R!  ok | transient-error | fatal-error
    "details" : { Reference(OperationOutcome) } // Specific list of hints/warnings/errors
  },
  "focus" : [{ Reference(Any) }], // The actual content of the message
  "definition" : { canonical(MessageDefinition) } // Link to the definition for this message
}

MessageHeader Search Parameters

The following search parameters can be used to query MessageHeader resources. Just submit them like so:

https://api.1up.health/fhir/r4/MessageHeader?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
authorreferenceauthor
codetextresponse.code
destinationtextdestination.name
destination-uriuridestination.endpoint
entererreferenceenterer
eventtextevent
focusreferencefocus
receiverreferencedestination.receiver
response-idtextresponse.identifier
responsiblereferenceresponsible
senderreferencesender
sourcetextsource.name
source-uriurisource.endpoint
targetreferencedestination.target