message headers

Create Message Header

post
/organizations/{organizationId}/fhir/3/MessageHeader

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringMessageHeaderThis is a MessageHeader resource
event*CodingCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events".
destinationarray(MessageHeader_Destination)The destination application which the message is intended for.
receiverReferenceAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
senderReferenceIdentifies the sending system to allow the use of a trust relationship.
timestampstringThe time that the message was sent.
entererReferenceThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
authorReferenceThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
source*MessageHeader_SourceThe source application from which this message originated.
responsibleReferenceThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
reasonCodeableConceptCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
responseMessageHeader_ResponseInformation about the message that this message is a response to. Only present if this message is a response.
focusarray(Reference)The actual data of the message - a reference to the root/focus class of the event.

Response

Patch Message Header

patch
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}

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.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMessageHeaderThis is a MessageHeader resource
event*CodingCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events".
destinationarray(MessageHeader_Destination)The destination application which the message is intended for.
receiverReferenceAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
senderReferenceIdentifies the sending system to allow the use of a trust relationship.
timestampstringThe time that the message was sent.
entererReferenceThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
authorReferenceThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
source*MessageHeader_SourceThe source application from which this message originated.
responsibleReferenceThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
reasonCodeableConceptCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
responseMessageHeader_ResponseInformation about the message that this message is a response to. Only present if this message is a response.
focusarray(Reference)The actual data of the message - a reference to the root/focus class of the event.

Response

Read Message Header

get
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Message Header

get
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Message Header

get
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Message Header

delete
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Message Header

get
/organizations/{organizationId}/fhir/3/MessageHeader

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
codestring
destinationstring
destination-uristring
entererstring
eventstring
focusstring
receiverstring
response-idstring
responsiblestring
senderstring
sourcestring
source-uristring
targetstring
timestampstring

Params

organizationId*string|stringid|slug

Response

Search History Message Header

get
/organizations/{organizationId}/fhir/3/MessageHeader/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Message Header

post
/organizations/{organizationId}/fhir/3/MessageHeader/_search

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.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
authorstring
codestring
destinationstring
destination-uristring
entererstring
eventstring
focusstring
receiverstring
response-idstring
responsiblestring
senderstring
sourcestring
source-uristring
targetstring
timestampstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringMessageHeaderThis is a MessageHeader resource
event*CodingCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events".
destinationarray(MessageHeader_Destination)The destination application which the message is intended for.
receiverReferenceAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
senderReferenceIdentifies the sending system to allow the use of a trust relationship.
timestampstringThe time that the message was sent.
entererReferenceThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
authorReferenceThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
source*MessageHeader_SourceThe source application from which this message originated.
responsibleReferenceThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
reasonCodeableConceptCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
responseMessageHeader_ResponseInformation about the message that this message is a response to. Only present if this message is a response.
focusarray(Reference)The actual data of the message - a reference to the root/focus class of the event.

Response

Update Message Header

put
/organizations/{organizationId}/fhir/3/MessageHeader/{resourceId}

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.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringMessageHeaderThis is a MessageHeader resource
event*CodingCode that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://hl7.org/fhir/message-events".
destinationarray(MessageHeader_Destination)The destination application which the message is intended for.
receiverReferenceAllows data conveyed by a message to be addressed to a particular person or department when routing to a specific application isn't sufficient.
senderReferenceIdentifies the sending system to allow the use of a trust relationship.
timestampstringThe time that the message was sent.
entererReferenceThe person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
authorReferenceThe logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
source*MessageHeader_SourceThe source application from which this message originated.
responsibleReferenceThe person or organization that accepts overall responsibility for the contents of the message. The implication is that the message event happened under the policies of the responsible party.
reasonCodeableConceptCoded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
responseMessageHeader_ResponseInformation about the message that this message is a response to. Only present if this message is a response.
focusarray(Reference)The actual data of the message - a reference to the root/focus class of the event.

Response