MessageHeader

ResourceFoundation · OtherTrial useMaturity 4

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

14 of 14 parameters tested

Structure

Show inherited elements (17)

Element	Card.	Type	Description
event[x]RequiredΣ	1..1	Coding | uri	Code for the event this message represents or link to event definitionBinding (example): message-events
destinationΣ	0..*	BackboneElement	Message destination application(s)
nameΣ	0..1	string	Name of system
targetΣ	0..1	Reference(Device)	Particular delivery destination within the destination
endpointRequiredΣ	1..1	url	Actual destination address or id
receiverΣ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data
senderΣ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
entererΣ	0..1	Reference(Practitioner | PractitionerRole)	The source of the data entry
authorΣ	0..1	Reference(Practitioner | PractitionerRole)	The source of the decision
sourceRequiredΣ	1..1	BackboneElement	Message source application
nameΣ	0..1	string	Name of system
softwareΣ	0..1	string	Name of software running the system
versionΣ	0..1	string	Version of software running
contactΣ	0..1	ContactPoint	Human contact for problems
endpointRequiredΣ	1..1	url	Actual message source address or id
responsibleΣ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Final responsibility for event
reasonΣ	0..1	CodeableConcept	Cause of eventBinding (example): message-reason-encounter
responseΣ	0..1	BackboneElement	If this is a reply to prior message
identifierRequiredΣ	1..1	id	Id of original message
codeRequiredΣ	1..1	code	ok | transient-error | fatal-errorBinding (required): response-code
detailsΣ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
focusΣ	0..*	Reference(Resource)	The actual content of the message
definitionΣ	0..1	canonical(MessageDefinition)	Link to the definition for this message

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/MessageHeader?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
author	reference	The source of the decision MessageHeader.author
code	token	ok | transient-error | fatal-error MessageHeader.response.code
destination	string	Name of system MessageHeader.destination.name
destination-uri	uri	Actual destination address or id MessageHeader.destination.endpoint
enterer	reference	The source of the data entry MessageHeader.enterer
event	token	Code for the event this message represents or link to event definition MessageHeader.event
focus	reference	The actual content of the message MessageHeader.focus
receiver	reference	Intended "real-world" recipient for the data MessageHeader.destination.receiver
response-id	token	Id of original message MessageHeader.response.identifier
responsible	reference	Final responsibility for event MessageHeader.responsible
sender	reference	Real world sender of the message MessageHeader.sender
source	string	Name of system MessageHeader.source.name
source-uri	uri	Actual message source address or id MessageHeader.source.endpoint
target	reference	Particular delivery destination within the destination MessageHeader.destination.target

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition