Skip to main content

R4 MessageHeader

The MessageHeader resource describes 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." (HL7 FHIR R4 MessageHeader)

Supported Profiles

This API supports the following FHIR profiles:

Operations

The General Purpose FHIR R4 MessageHeader resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED----
myAvatar----
myEvolv----
myUnity----
Referral Manager----
info

Not all Netsmart solutions support MessageHeader search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports a combination of standard and custom search parameters in addition to the common parameters.

Standard Parameters

NameTypeDescription
eventtokenCode for the event this message represents or link to event definition.
receiverreferenceIntended "real-world" recipient for the data
response-idtokenId of original message
responsiblereferenceFinal responsibility for message
source-uriuriActual message source address or id

Custom Parameters

NameTypeDescription
enddateDeprecated. Use date parameter with le prefix instead.
startdateDeprecated. Use date parameter with ge prefix instead.

Search Examples

The POST method is recommended as it keeps health information out of the URL.

Search Message Headers by ID
curl -X POST https://fhir.netsmartcloud.com/v4/MessageHeader/_search \
-H "Authorization: {Bearer Token}" \
-H "Accept: application/fhir+json" \
-H "Content-Type: application/x-form-urlencoded" \
-d "id=12345" \