Header

The header is the first part of a KMEHR message. It is mandatory. It mainly identifies the sender and the receiver of the message as well as the message itself.

It is composed the following elements.

confidentiality	This element restricts the access to the content of the header to enumerated healthcare parties. (not recommended)	Optional
standard	Specifies the version of the KMEHR specification your message complies with. You must use a value from CD-STANDARD.	Mandatory
id	Identifies the message within the system according to ID-KMEHR identification system. The value must be the concatenation of the id of the first hcparty of the sender element, a dot, and a unique message number within your own system. This latest can be easily implemented through a timestamp like YYYYMMDDHHMMSSmmm. In addition to this, you can always add your own local message identifiers.	Mandatory
date	Date of the creation of the message.	Mandatory
time	Time of the creation of the message.	Mandatory
sender	Contains a combination of hcparty that specifies the sender of the message.	Mandatory
recipient	Contains a combination of hcparty that specifies the receiver of the message. By convention, the first recipient is the main addressee of the message. The following recipients are considered as cc (carbon copy). KMEHR compliant IT systems should use this information to route the message.	Mandatory
urgency	Specifies the urgency of the message using a value from CD-URGENCY.	Optional
acknowledgment	Specifies the type of acknowledgment that is desired by the sender unsing a value from urgency of the message using a value from CD-ACKNOWLEDGMENT.	Optional
text	Comments the message.	Optional
lnk	Establishes links with the message. For instance, to replace another message by using the value ‘isanewversionof’ from CD-LNK; to manage order/result relationship by using the value ‘isareplyto’ from CD-LNK.	Optional

XML example

<header>
 <standard>
 <cd SV="1.0" S="CD-STANDARD">20090101</cd>
 </standard>
 <id SV="1.0" S="ID-KMEHR">71071801.20090415123000123</id>
 <date>2009-04-15</date>
 <time>12:30:00</time>
 <sender>
 <hcparty>
 <id SV="1.0" S="ID-HCPARTY">71071801</id>
 <cd SV="1.0" S="CD-HCPARTY">orghospital</cd>
 <name>Hôpital civil de Charleroi</name>
 </hcparty>
 <hcparty>
 <cd SV="1.0" S="CD-HCPARTY">application</cd>
 <name>application name</name>
 </hcparty>
 </sender>
 <recipient>
 <hcparty>
 <cd SV="1.0" S="CD-HCPARTY">application</cd>
 <name>target application name</name>
 </hcparty>
 </recipient>
 </header>