This page is part of the HL7 Belgium FHIR Implementation Guide - MyCareNet profiles (v2.0.0: Trial Use) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: MyCareNet MessageHeader BE profile

This is the generic MessageHeader profile for use in the different eAgreement flows from MyCareNet.

Usage:

• Use this Resource Profile: MyCareNet eAgreement Consult Bundle BE profile, MyCareNet eAgreement Consult Reply Bundle BE profile, MyCareNet eAgreement Demand Bundle BE profile and MyCareNet eAgreement Demand Reply Bundle BE profile

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	S	1..1	id	Logical id of this artifact
meta	S	1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
event[x]	S	1..1	Coding, uri	Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this
eventCoding		0..1	Coding	Code for the event this message represents or link to event definition
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
destination	S	1..1	BackboneElement	Message destination application(s)
sender	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
reference		1..1	string	Literal reference, Relative, internal or absolute URL
enterer		0..0
author		0..0
source	S	1..1	BackboneElement	Message source application
responsible		0..0
reason		0..0
response	S	0..1	BackboneElement	If this is a reply to prior message
focus	S	1..1	Reference(Resource)	The actual content of the message
reference		1..1	string	Literal reference, Relative, internal or absolute URL
definition		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for event[x]	SΣ	1..1		Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
eventCoding			Coding
eventUri			uri
event[x]:eventCoding	Σ	0..1	Coding	Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
destination	SΣ	1..1	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	url	Actual destination address or id
sender	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
source	SΣ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	url	Actual message source address or id
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
focus	SΣ	1..1	Reference(Resource)	The actual content of the message
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.event[x]	example	MessageEvent
MessageHeader.event[x]:eventCoding	example	MessageEvent
MessageHeader.response.code	required	ResponseType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for event[x]	SΣ	1..1		Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
eventCoding			Coding
eventUri			uri
event[x]:eventCoding	Σ	0..1	Coding	Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
destination	SΣ	1..1	BackboneElement	Message destination application(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
source	SΣ	1..1	BackboneElement	Message source application
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
endpoint	Σ	1..1	url	Actual message source address or id
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details	Σ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
focus	SΣ	1..1	Reference(Resource)	The actual content of the message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.meta.security	extensible	All Security Labels
MessageHeader.meta.tag	example	CommonTags
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	example	MessageEvent
MessageHeader.event[x]:eventCoding	example	MessageEvent
MessageHeader.sender.type	extensible	ResourceType
MessageHeader.response.code	required	ResponseType
MessageHeader.focus.type	extensible	ResourceType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 8 elements (2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

• The element MessageHeader.event[x] is sliced based on the value of type:$this

Differential View

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	S	1..1	id	Logical id of this artifact
meta	S	1..1	Meta	Metadata about the resource
profile		1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
event[x]	S	1..1	Coding, uri	Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this
eventCoding		0..1	Coding	Code for the event this message represents or link to event definition
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
destination	S	1..1	BackboneElement	Message destination application(s)
sender	S	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
reference		1..1	string	Literal reference, Relative, internal or absolute URL
enterer		0..0
author		0..0
source	S	1..1	BackboneElement	Message source application
responsible		0..0
reason		0..0
response	S	0..1	BackboneElement	If this is a reply to prior message
focus	S	1..1	Reference(Resource)	The actual content of the message
reference		1..1	string	Literal reference, Relative, internal or absolute URL
definition		0..0
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for event[x]	SΣ	1..1		Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
eventCoding			Coding
eventUri			uri
event[x]:eventCoding	Σ	0..1	Coding	Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
system	Σ	1..1	uri	Identity of the terminology system
code	Σ	1..1	code	Symbol in syntax defined by the system
destination	SΣ	1..1	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	url	Actual destination address or id
sender	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
source	SΣ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	url	Actual message source address or id
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
focus	SΣ	1..1	Reference(Resource)	The actual content of the message
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.event[x]	example	MessageEvent
MessageHeader.event[x]:eventCoding	example	MessageEvent
MessageHeader.response.code	required	ResponseType

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	MessageHeader	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	MessageHeader	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	MessageHeader	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	MessageHeader	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	SΣ	1..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..1	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for event[x]	SΣ	1..1		Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
eventCoding			Coding
eventUri			uri
event[x]:eventCoding	Σ	0..1	Coding	Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
destination	SΣ	1..1	BackboneElement	Message destination application(s)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	0..1	string	Name of system
target	Σ	0..1	Reference(Device)	Particular delivery destination within the destination
endpoint	Σ	1..1	url	Actual destination address or id
receiver	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Intended "real-world" recipient for the data
sender	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization)	Real world sender of the message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
source	SΣ	1..1	BackboneElement	Message source application
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
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
endpoint	Σ	1..1	url	Actual message source address or id
response	SΣ	0..1	BackboneElement	If this is a reply to prior message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
identifier	Σ	1..1	id	Id of original message
code	Σ	1..1	code	ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message.
details	Σ	0..1	Reference(OperationOutcome)	Specific list of hints/warnings/errors
focus	SΣ	1..1	Reference(Resource)	The actual content of the message
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
MessageHeader.meta.security	extensible	All Security Labels
MessageHeader.meta.tag	example	CommonTags
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	example	MessageEvent
MessageHeader.event[x]:eventCoding	example	MessageEvent
MessageHeader.sender.type	extensible	ResourceType
MessageHeader.response.code	required	ResponseType
MessageHeader.focus.type	extensible	ResourceType

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Mandatory: 8 elements (2 nested mandatory elements)
Must-Support: 8 elements
Prohibited: 5 elements

Slices

This structure defines the following Slices:

• The element MessageHeader.event[x] is sliced based on the value of type:$this

Other representations of profile: CSV, Excel, Schematron