Skip to main content

MessageHeader

Trial Use 4 Foundation

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.

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/MessageHeader
InteractionMethodPath
ReadGET/fhir/R4/MessageHeader/[id]
VreadGET/fhir/R4/MessageHeader/[id]/_history/[vid]
UpdatePUT/fhir/R4/MessageHeader/[id]
PatchPATCH/fhir/R4/MessageHeader/[id]
DeleteDELETE/fhir/R4/MessageHeader/[id]
CreatePOST/fhir/R4/MessageHeader
SearchGET/fhir/R4/MessageHeader
HistoryGET/fhir/R4/MessageHeader/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
event[x]Coding / uri1..1Code for the event this message represents or link to event definition
destinationBackboneElement0..*Message destination application(s)
senderReference0..1Real world sender of the message
entererReference0..1The source of the data entry
authorReference0..1The source of the decision
sourceBackboneElement1..1Message source application
responsibleReference0..1Final responsibility for event
reasonCodeableConcept0..1Cause of event
responseBackboneElement0..1If this is a reply to prior message
focusReference0..*The actual content of the message
definitioncanonical0..1Link to the definition for this message

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
authorstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-author
codestringhttp://hl7.org/fhir/SearchParameter/MessageHeader-code
destinationstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-destination
destination-uristringhttp://hl7.org/fhir/SearchParameter/MessageHeader-destination-uri
entererstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-enterer
eventstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-event
focusstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-focus
receiverstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-receiver
response-idstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-response-id
responsiblestringhttp://hl7.org/fhir/SearchParameter/MessageHeader-responsible
senderstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-sender
sourcestringhttp://hl7.org/fhir/SearchParameter/MessageHeader-source
source-uristringhttp://hl7.org/fhir/SearchParameter/MessageHeader-source-uri
targetstringhttp://hl7.org/fhir/SearchParameter/MessageHeader-target

Reference​

  • Official FHIR R4 spec: MessageHeader
  • Maturity: Trial Use 4 (FMM 4).