Healthcare Financial Services IG Edition 1 - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: Nphies MessageHeader (base) ( Abstract )

MessageHeader (base) Profile

Usages:

• Derived from this Profile: Nphies MessageHeader (Error Notice) and Nphies MessageHeader

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	ΣC	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
tag	SΣ	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
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	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination	Σ	1..1	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	DP_url	Actual destination address or id
receiver	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
sender	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
source	Σ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	DP_url	Actual message source address or id
focus	SΣ	0..*	DP_Reference_1(Resource)	The actual content of the message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG
MessageHeader.destination.receiver.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.destination.receiver.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.destination.receiver.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
MessageHeader.sender.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.sender.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.sender.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
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()
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	C	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
tag	S	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
event[x]		1..1	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination		1..1	BackboneElement	Message destination application(s)
endpoint		1..1	DP_url	Actual destination address or id
receiver		1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
type		1..1	DP_uri	Type the reference refers to (e.g. "Patient") Required Pattern: Organization
sender		1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
type		1..1	DP_uri	Type the reference refers to (e.g. "Patient") Required Pattern: Organization
source
endpoint		1..1	DP_url	Actual message source address or id
focus	S	0..*	DP_Reference_1(Resource)	The actual content of the message
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	ΣC	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta	Σ	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..*	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	SΣ	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination	Σ	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	DP_url	Actual destination address or id
receiver	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
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	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	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	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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
sender	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
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	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	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	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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
enterer	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the data entry
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	DP_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.
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(OperationOutcome)	Specific list of hints/warnings/errors
focus	SΣ	0..*	DP_Reference_1(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 / Code	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG
MessageHeader.destination.receiver.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.destination.receiver.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.destination.receiver.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
MessageHeader.sender.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.sender.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.sender.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
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

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
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()
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

This structure is derived from MessageHeader

Summary

Mandatory: 6 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• DP_Coding (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Coding)
• DP_url (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-url)
• DP_Reference_1or3b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3b)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)
• Nphies Insurer Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/insurer-organization)
• DP_Reference_1 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	ΣC	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta	Σ	1..1	Meta	Metadata about the resource
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
tag	SΣ	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
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	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination	Σ	1..1	BackboneElement	Message destination application(s)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	DP_url	Actual destination address or id
receiver	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
sender	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
reference	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
source	Σ	1..1	BackboneElement	Message source application
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
endpoint	Σ	1..1	DP_url	Actual message source address or id
focus	SΣ	0..*	DP_Reference_1(Resource)	The actual content of the message
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG
MessageHeader.destination.receiver.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.destination.receiver.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.destination.receiver.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
MessageHeader.sender.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.sender.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.sender.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
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()
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

Differential View

This structure is derived from MessageHeader

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	C	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta		1..1	Meta	Metadata about the resource
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
tag	S	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
event[x]		1..1	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination		1..1	BackboneElement	Message destination application(s)
endpoint		1..1	DP_url	Actual destination address or id
receiver		1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
type		1..1	DP_uri	Type the reference refers to (e.g. "Patient") Required Pattern: Organization
sender		1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
type		1..1	DP_uri	Type the reference refers to (e.g. "Patient") Required Pattern: Organization
source
endpoint		1..1	DP_url	Actual message source address or id
focus	S	0..*	DP_Reference_1(Resource)	The actual content of the message
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
MessageHeader	C	0..*	MessageHeader	This is an abstract profile. Child profiles: NphiesMessageHeaderErrorNotice, NphiesMessageHeader A resource that describes a message that is exchanged between systems Constraints: BV-00168, BV-00221
id	ΣC	1..1	id	Logical id of this artifact Constraints: ksa-iduuid Max Length:64
meta	Σ	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..*	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	SΣ	0..*	DP_Coding	Tags applied to this resource Binding: MetaTags (required)
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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	DP_Coding	Code for the event this message represents or link to event definition Binding: KSA Message Events (required)
destination	Σ	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	DP_url	Actual destination address or id
receiver	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Receiver's organization Number
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	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	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	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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
sender	Σ	1..1	DP_Reference_1or3b(Nphies Provider Organization | Nphies Insurer Organization)	Sender's organization Number
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	SΣC	0..1	string	Literal reference, Relative, internal or absolute URL Max Length:250
type	Σ	1..1	DP_uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	SΣ	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	SΣ	0..1	DP_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	Σ	1..1	DP_uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456 Max Length:50
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
enterer	Σ	0..1	Reference(Practitioner | PractitionerRole)	The source of the data entry
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	DP_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.
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(OperationOutcome)	Specific list of hints/warnings/errors
focus	SΣ	0..*	DP_Reference_1(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 / Code	URI
MessageHeader.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
MessageHeader.meta.tag	required	MetaTags http://nphies.sa/terminology/ValueSet/meta-tags From this IG
MessageHeader.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
MessageHeader.event[x]	required	KSAMessageEvents(a valid code from KSA Message Events) http://nphies.sa/terminology/ValueSet/ksa-message-events From this IG
MessageHeader.destination.receiver.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.destination.receiver.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.destination.receiver.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
MessageHeader.sender.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
MessageHeader.sender.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
MessageHeader.sender.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
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

Constraints

Id	Grade	Path(s)	Details	Requirements
BV-00168	error	MessageHeader	MessageHeader ID is not a valid GUID. : id.matches('([a-f0-9]{8})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{4})-([a-f0-9]{12})')
BV-00221	error	MessageHeader	Message Header Focus contains more than one main resource. : focus.count() <= 1
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()
ksa-iduuid	error	MessageHeader.id	Must be 'GUID'. : toString().matches('([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})')

This structure is derived from MessageHeader

Summary

Mandatory: 6 elements
Must-Support: 2 elements

Structures

This structure refers to these other structures:

• DP_Coding (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Coding)
• DP_url (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-url)
• DP_Reference_1or3b (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1or3b)
• Nphies Provider Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/provider-organization)
• Nphies Insurer Organization (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/insurer-organization)
• DP_Reference_1 (http://nphies.sa/fhir/ksa/nphies-fs/StructureDefinition/DP-Reference-1)

Other representations of profile: CSV, Excel, Schematron