MessageHeader - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
authorfalseReference The source of the decision
destinationtrueData Type Message destination application(s)
entererfalseReference The source of the data entry
eventfalseCoding Code for the event this message represents
focustrueReference The actual content of the message
reasonfalseCodeableConcept Cause of event
receiverfalseReference Intended "real-world" recipient for the data
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
timestampfalseinstant Time that the message was sent

MessageHeader Example

{
  "sender": {
    "reference": "Organization/1"
  },
  "author": {
    "reference": "Practitioner/example"
  },
  "resourceType": "MessageHeader",
  "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>"
  },
  "destination": [
    {
      "endpoint": "llp:10.11.12.14:5432",
      "name": "Acme Message Gateway",
      "target": {
        "reference": "Device/example"
      }
    }
  ],
  "enterer": {
    "reference": "Practitioner/example"
  },
  "focus": [
    {
      "reference": "Patient/example"
    }
  ],
  "event": {
    "code": "admin-notify",
    "system": "http://hl7.org/fhir/message-events"
  },
  "source": {
    "endpoint": "llp:10.11.12.13:5432",
    "version": "3.1.45.AABB",
    "contact": {
      "system": "phone",
      "value": "+1 (555) 123 4567"
    },
    "name": "Acme Central Patient Registry",
    "software": "FooBar Patient Manager"
  },
  "reason": {
    "coding": [
      {
        "code": "admit",
        "system": "http://hl7.org/fhir/message-reasons-encounter"
      }
    ]
  },
  "timestamp": "2012-01-04T09:10:14Z",
  "response": {
    "code": "ok",
    "identifier": "5015fe84-8e76-4526-89d8-44b322e8d4fb"
  },
  "id": "1cbdfb97-5859-48a4-8301-d54eab818d68"
}

MessageHeader Structure


  
{
  "resourceType" : "MessageHeader",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "event" : { Coding }, // R!  Code for the event this message represents
  "destination" : [{ // Message destination application(s)
    "name" : "<string>", // Name of system
    "target" : { Reference(Device) }, // Particular delivery destination within the destination
    "endpoint" : "<uri>" // R!  Actual destination address or id
  }],
  "receiver" : { Reference(Practitioner|Organization) }, // Intended "real-world" recipient for the data
  "sender" : { Reference(Practitioner|Organization) }, // Real world sender of the message
  "timestamp" : "<instant>", // R!  Time that the message was sent
  "enterer" : { Reference(Practitioner) }, // The source of the data entry
  "author" : { Reference(Practitioner) }, // 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" : "<uri>" // R!  Actual message source address or id
  },
  "responsible" : { Reference(Practitioner|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
}


 

MessageHeader Search Parameters

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

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