HL7 PT FHIR Implementation Guide: Example IG Release 1 | STU1, published by HL7 Portugal. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-pt/core/ and changes regularly. See the Directory of published versions

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

Resource Profile: PT_MessageHeader

A generic Message Header resource for Portugal

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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		0..1	id	Logical id of this artifact
meta
versionId		0..1	id	Version specific identifier
lastUpdated		0..1	instant	When the resource version last changed
event[x]		1..1	Coding	Code for the event this message represents or link to event definition
display		0..1	string	Representation defined by the system
destination
name		0..1	string	Name of system
endpoint		1..1	url	Actual destination address or id
sender		0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	Real world sender of the message
display		0..1	string	Text alternative for the resource
enterer		0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
reference		0..1	string	Literal reference, Relative, internal or absolute URL
identifier
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
value		0..1	string	The value that is unique
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
source
name		0..1	string	Name of system
endpoint		1..1	url	Actual message source address or id
reason		0..1	CodeableConcept	Cause of event
coding
code		0..1	code	Symbol in syntax defined by the system
response
identifier		1..1	id	Id of original message
code		1..1	code	ok | transient-error | fatal-error
details		0..1	Reference(PT_OperationOutcome)	Specific list of hints/warnings/errors
reference		0..1	string	Literal reference, Relative, internal or absolute URL
identifier
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
display		0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.enterer.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	Σ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	Σ	1..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.
display	Σ	0..1	string	Representation defined by the system
sender	Σ	0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	Real world sender of the message
display	Σ	0..1	string	Text alternative for the resource
enterer	Σ	0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
source	Σ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	0..1	string	Name of system
endpoint	Σ	1..1	url	Actual message source address or id
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard

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	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	0..*	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
event[x]	Σ	1..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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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	Σ	0..*	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	Σ	0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	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	0..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
enterer	Σ	0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
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	0..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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
author	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the decision
source	Σ	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
responsible	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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
text	Σ	0..1	string	Plain text representation of the concept
response	Σ	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(PT_OperationOutcome)	Specific list of hints/warnings/errors
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	0..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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
focus	Σ	0..*	Reference(Resource)	The actual content of the message
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
MessageHeader.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.enterer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.enterer.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
MessageHeader.enterer.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard
MessageHeader.response.details.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.response.details.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
MessageHeader.response.details.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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()

This structure is derived from MessageHeader

Summary

Structures

This structure refers to these other structures:

• PT_Practitioner (http://hl7.pt/fhir/core/StructureDefinition/ac7bcb60-c472-44c2-8a98-d412e8645c6d)
• PT_PractitionerRole (http://hl7.pt/fhir/core/StructureDefinition/PTPractitionerRole)
• PT_OperationOutcome (http://hl7.pt/fhir/core/StructureDefinition/PTOperationOutcome)

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		0..1	id	Logical id of this artifact
meta
versionId		0..1	id	Version specific identifier
lastUpdated		0..1	instant	When the resource version last changed
event[x]		1..1	Coding	Code for the event this message represents or link to event definition
display		0..1	string	Representation defined by the system
destination
name		0..1	string	Name of system
endpoint		1..1	url	Actual destination address or id
sender		0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	Real world sender of the message
display		0..1	string	Text alternative for the resource
enterer		0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
reference		0..1	string	Literal reference, Relative, internal or absolute URL
identifier
type		0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
coding
code		0..1	code	Symbol in syntax defined by the system
value		0..1	string	The value that is unique
assigner		0..1	Reference(Organization)	Organization that issued id (may be just text)
source
name		0..1	string	Name of system
endpoint		1..1	url	Actual message source address or id
reason		0..1	CodeableConcept	Cause of event
coding
code		0..1	code	Symbol in syntax defined by the system
response
identifier		1..1	id	Id of original message
code		1..1	code	ok | transient-error | fatal-error
details		0..1	Reference(PT_OperationOutcome)	Specific list of hints/warnings/errors
reference		0..1	string	Literal reference, Relative, internal or absolute URL
identifier
system		0..1	uri	The namespace for the identifier value
value		0..1	string	The value that is unique
display		0..1	string	Text alternative for the resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.enterer.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
MessageHeader		0..*	MessageHeader	A resource that describes a message that is exchanged between systems
id	Σ	0..1	id	Logical id of this artifact
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
event[x]	Σ	1..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.
display	Σ	0..1	string	Representation defined by the system
sender	Σ	0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	Real world sender of the message
display	Σ	0..1	string	Text alternative for the resource
enterer	Σ	0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
source	Σ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	0..1	string	Name of system
endpoint	Σ	1..1	url	Actual message source address or id
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard

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	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..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	Σ	0..*	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
event[x]	Σ	1..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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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	Σ	0..*	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	Σ	0..1	Reference(Organization | PT_Practitioner | PT_PractitionerRole)	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	0..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
enterer	Σ	0..1	Reference(PT_Practitioner | PT_PractitionerRole)	The source of the data entry
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	0..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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: hl7VS-identifierType (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
author	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the decision
source	Σ	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
responsible	Σ	0..1	Reference(Practitioner | PractitionerRole | Organization)	Final responsibility for event
reason	Σ	0..1	CodeableConcept	Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..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
text	Σ	0..1	string	Plain text representation of the concept
response	Σ	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(PT_OperationOutcome)	Specific list of hints/warnings/errors
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	0..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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
display	Σ	0..1	string	Text alternative for the resource
focus	Σ	0..*	Reference(Resource)	The actual content of the message
definition	Σ	0..1	canonical(MessageDefinition)	Link to the definition for this message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
MessageHeader.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
MessageHeader.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
MessageHeader.event[x]	example	MessageEvent http://hl7.org/fhir/ValueSet/message-events from the FHIR Standard
MessageHeader.sender.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.enterer.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.enterer.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
MessageHeader.enterer.identifier.type	extensible	Hl7VSIdentifierType http://terminology.hl7.org/ValueSet/v2-0203
MessageHeader.reason	example	ExampleMessageReasonCodes http://hl7.org/fhir/ValueSet/message-reason-encounter from the FHIR Standard
MessageHeader.response.code	required	ResponseType http://hl7.org/fhir/ValueSet/response-code|4.0.1 from the FHIR Standard
MessageHeader.response.details.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
MessageHeader.response.details.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
MessageHeader.response.details.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard

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()

This structure is derived from MessageHeader

Summary

Structures

This structure refers to these other structures:

• PT_Practitioner (http://hl7.pt/fhir/core/StructureDefinition/ac7bcb60-c472-44c2-8a98-d412e8645c6d)
• PT_PractitionerRole (http://hl7.pt/fhir/core/StructureDefinition/PTPractitionerRole)
• PT_OperationOutcome (http://hl7.pt/fhir/core/StructureDefinition/PTOperationOutcome)

Other representations of profile: CSV, Excel, Schematron