v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Logical Model: MSH - Detailed Descriptions

Draft as of 2023-08-09

Definitions for the MSH logical model.

Guidance on how to interpret the contents of this table can be found here

0. MSH
Definition

Message Header

Control1..1
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. MSH.fieldSeparator
Definition

Field Separator

ShortfieldSeparator
Control1..1
TypeST
Must Supporttrue
Max Length1
4. MSH.encodingCharacters
Definition

Encoding Characters

ShortencodingCharacters
Control1..1
TypeST
Must Supporttrue
Max Length5
6. MSH.sendingApplication
Definition

Sending Application

ShortsendingApplication
Control0..1
TypeHD
8. MSH.sendingFacility
Definition

Sending Facility

ShortsendingFacility
Control0..1
TypeHD
10. MSH.receivingApplication
Definition

Receiving Application

ShortreceivingApplication
Control0..1
TypeHD
12. MSH.receivingFacility
Definition

Receiving Facility

ShortreceivingFacility
Control0..*
TypeHD
14. MSH.dateTimeofMessage
Definition

DateTime of Message

ShortdateTimeofMessage
Control1..1
TypeDTM
Must Supporttrue
16. MSH.security
Definition

Security

Shortsecurity
Control0..1
TypeST
18. MSH.messageType
Definition

Message Type

ShortmessageType
Control1..1
TypeMSG
Must Supporttrue
20. MSH.messageControlID
Definition

Message Control ID

ShortmessageControlID
Control1..1
TypeST
Must Supporttrue
Max Length199
22. MSH.processingID
Definition

Processing ID

ShortprocessingID
Control1..1
TypePT
Must Supporttrue
24. MSH.versionID
Definition

Version ID

ShortversionID
Control1..1
TypeVID
Must Supporttrue
26. MSH.sequenceNumber
Definition

Sequence Number

ShortsequenceNumber
Control0..1
TypeNM
28. MSH.continuationPointer
Definition

Continuation Pointer

ShortcontinuationPointer
Control0..1
TypeST
30. MSH.acceptAcknowledgment
Definition

Accept Acknowledgment

ShortacceptAcknowledgment
Control0..1
TypeID
Max Length2
32. MSH.applicationAcknowledgmentType
Definition

Application Acknowledgment Type

ShortapplicationAcknowledgmentType
Control0..1
TypeID
Max Length2
34. MSH.countryCode
Definition

Country Code

ShortcountryCode
Control0..1
TypeID
Max Length3
36. MSH.characterSet
Definition

Character Set

ShortcharacterSet
Control0..*
TypeID
Max Length15
38. MSH.principalLanguageOfMessage
Definition

Principal Language Of Message

ShortprincipalLanguageOfMessage
Control0..1
TypeCWE
40. MSH.alternateCharacterSetHandlingScheme
Definition

Alternate Character Set Handling Scheme

ShortalternateCharacterSetHandlingScheme
Control0..1
TypeID
Max Length13
42. MSH.messageProfileIdentifier
Definition

Message Profile Identifier

ShortmessageProfileIdentifier
Control0..*
TypeEI
44. MSH.sendingResponsibleOrganization
Definition

Sending Responsible Organization

ShortsendingResponsibleOrganization
Control0..1
TypeXON
46. MSH.receivingResponsibleOrganization
Definition

Receiving Responsible Organization

ShortreceivingResponsibleOrganization
Control0..1
TypeXON
48. MSH.sendingNetworkAddress
Definition

Sending Network Address

ShortsendingNetworkAddress
Control0..1
TypeHD
50. MSH.receivingNetworkAddress
Definition

Receiving Network Address

ShortreceivingNetworkAddress
Control0..1
TypeHD
52. MSH.securityClassificationTag
Definition

Security Classification Tag

ShortsecurityClassificationTag
Control0..1
TypeCWE
54. MSH.securityHandlingInstructions
Definition

Security Handling Instructions

ShortsecurityHandlingInstructions
Control0..*
TypeCWE
56. MSH.specialAccessRestrictionInstructions
Definition

Special Access Restriction Instructions

ShortspecialAccessRestrictionInstructions
Control0..*
TypeST

Guidance on how to interpret the contents of this table can be found here

0. MSH
Definition

Message Header


A resource that includes narrative, extensions, and contained resources.

ShortA resource with narrative, extensions, and contained resources
Control10..1*
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. MSH.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. MSH.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. MSH.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MSH.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
8. MSH.fieldSeparator
Definition

Field Separator

ShortfieldSeparator
Control1..1
TypeST
Must Supporttrue
Max Length1
10. MSH.encodingCharacters
Definition

Encoding Characters

ShortencodingCharacters
Control1..1
TypeST
Must Supporttrue
Max Length5
12. MSH.sendingApplication
Definition

Sending Application

ShortsendingApplication
Control0..1
TypeHD
14. MSH.sendingFacility
Definition

Sending Facility

ShortsendingFacility
Control0..1
TypeHD
16. MSH.receivingApplication
Definition

Receiving Application

ShortreceivingApplication
Control0..1
TypeHD
18. MSH.receivingFacility
Definition

Receiving Facility

ShortreceivingFacility
Control0..*
TypeHD
20. MSH.dateTimeofMessage
Definition

DateTime of Message

ShortdateTimeofMessage
Control1..1
TypeDTM
Must Supporttrue
22. MSH.security
Definition

Security

Shortsecurity
Control0..1
TypeST
24. MSH.messageType
Definition

Message Type

ShortmessageType
Control1..1
TypeMSG
Must Supporttrue
26. MSH.messageControlID
Definition

Message Control ID

ShortmessageControlID
Control1..1
TypeST
Must Supporttrue
Max Length199
28. MSH.processingID
Definition

Processing ID

ShortprocessingID
Control1..1
TypePT
Must Supporttrue
30. MSH.versionID
Definition

Version ID

ShortversionID
Control1..1
TypeVID
Must Supporttrue
32. MSH.sequenceNumber
Definition

Sequence Number

ShortsequenceNumber
Control0..1
TypeNM
34. MSH.continuationPointer
Definition

Continuation Pointer

ShortcontinuationPointer
Control0..1
TypeST
36. MSH.acceptAcknowledgment
Definition

Accept Acknowledgment

ShortacceptAcknowledgment
Control0..1
TypeID
Max Length2
38. MSH.applicationAcknowledgmentType
Definition

Application Acknowledgment Type

ShortapplicationAcknowledgmentType
Control0..1
TypeID
Max Length2
40. MSH.countryCode
Definition

Country Code

ShortcountryCode
Control0..1
TypeID
Max Length3
42. MSH.characterSet
Definition

Character Set

ShortcharacterSet
Control0..*
TypeID
Max Length15
44. MSH.principalLanguageOfMessage
Definition

Principal Language Of Message

ShortprincipalLanguageOfMessage
Control0..1
TypeCWE
46. MSH.alternateCharacterSetHandlingScheme
Definition

Alternate Character Set Handling Scheme

ShortalternateCharacterSetHandlingScheme
Control0..1
TypeID
Max Length13
48. MSH.messageProfileIdentifier
Definition

Message Profile Identifier

ShortmessageProfileIdentifier
Control0..*
TypeEI
50. MSH.sendingResponsibleOrganization
Definition

Sending Responsible Organization

ShortsendingResponsibleOrganization
Control0..1
TypeXON
52. MSH.receivingResponsibleOrganization
Definition

Receiving Responsible Organization

ShortreceivingResponsibleOrganization
Control0..1
TypeXON
54. MSH.sendingNetworkAddress
Definition

Sending Network Address

ShortsendingNetworkAddress
Control0..1
TypeHD
56. MSH.receivingNetworkAddress
Definition

Receiving Network Address

ShortreceivingNetworkAddress
Control0..1
TypeHD
58. MSH.securityClassificationTag
Definition

Security Classification Tag

ShortsecurityClassificationTag
Control0..1
TypeCWE
60. MSH.securityHandlingInstructions
Definition

Security Handling Instructions

ShortsecurityHandlingInstructions
Control0..*
TypeCWE
62. MSH.specialAccessRestrictionInstructions
Definition

Special Access Restriction Instructions

ShortspecialAccessRestrictionInstructions
Control0..*
TypeST

Guidance on how to interpret the contents of this table can be found here

0. MSH
Definition

Message Header

ShortA resource with narrative, extensions, and contained resources
Control1..1
Is Modifierfalse
Must Supportfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. MSH.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. MSH.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. MSH.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. MSH.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguages: IETF language tag for a human language
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. MSH.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. MSH.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. MSH.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MSH.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
16. MSH.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Must Supportfalse
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on MSH.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
18. MSH.fieldSeparator
Definition

Field Separator

ShortfieldSeparator
Control1..1
TypeST
Must Supporttrue
Max Length1
20. MSH.encodingCharacters
Definition

Encoding Characters

ShortencodingCharacters
Control1..1
TypeST
Must Supporttrue
Max Length5
22. MSH.sendingApplication
Definition

Sending Application

ShortsendingApplication
Control0..1
TypeHD
24. MSH.sendingFacility
Definition

Sending Facility

ShortsendingFacility
Control0..1
TypeHD
26. MSH.receivingApplication
Definition

Receiving Application

ShortreceivingApplication
Control0..1
TypeHD
28. MSH.receivingFacility
Definition

Receiving Facility

ShortreceivingFacility
Control0..*
TypeHD
30. MSH.dateTimeofMessage
Definition

DateTime of Message

ShortdateTimeofMessage
Control1..1
TypeDTM
Must Supporttrue
32. MSH.security
Definition

Security

Shortsecurity
Control0..1
TypeST
34. MSH.messageType
Definition

Message Type

ShortmessageType
Control1..1
TypeMSG
Must Supporttrue
36. MSH.messageControlID
Definition

Message Control ID

ShortmessageControlID
Control1..1
TypeST
Must Supporttrue
Max Length199
38. MSH.processingID
Definition

Processing ID

ShortprocessingID
Control1..1
TypePT
Must Supporttrue
40. MSH.versionID
Definition

Version ID

ShortversionID
Control1..1
TypeVID
Must Supporttrue
42. MSH.sequenceNumber
Definition

Sequence Number

ShortsequenceNumber
Control0..1
TypeNM
44. MSH.continuationPointer
Definition

Continuation Pointer

ShortcontinuationPointer
Control0..1
TypeST
46. MSH.acceptAcknowledgment
Definition

Accept Acknowledgment

ShortacceptAcknowledgment
Control0..1
TypeID
Max Length2
48. MSH.applicationAcknowledgmentType
Definition

Application Acknowledgment Type

ShortapplicationAcknowledgmentType
Control0..1
TypeID
Max Length2
50. MSH.countryCode
Definition

Country Code

ShortcountryCode
Control0..1
TypeID
Max Length3
52. MSH.characterSet
Definition

Character Set

ShortcharacterSet
Control0..*
TypeID
Max Length15
54. MSH.principalLanguageOfMessage
Definition

Principal Language Of Message

ShortprincipalLanguageOfMessage
Control0..1
TypeCWE
56. MSH.alternateCharacterSetHandlingScheme
Definition

Alternate Character Set Handling Scheme

ShortalternateCharacterSetHandlingScheme
Control0..1
TypeID
Max Length13
58. MSH.messageProfileIdentifier
Definition

Message Profile Identifier

ShortmessageProfileIdentifier
Control0..*
TypeEI
60. MSH.sendingResponsibleOrganization
Definition

Sending Responsible Organization

ShortsendingResponsibleOrganization
Control0..1
TypeXON
62. MSH.receivingResponsibleOrganization
Definition

Receiving Responsible Organization

ShortreceivingResponsibleOrganization
Control0..1
TypeXON
64. MSH.sendingNetworkAddress
Definition

Sending Network Address

ShortsendingNetworkAddress
Control0..1
TypeHD
66. MSH.receivingNetworkAddress
Definition

Receiving Network Address

ShortreceivingNetworkAddress
Control0..1
TypeHD
68. MSH.securityClassificationTag
Definition

Security Classification Tag

ShortsecurityClassificationTag
Control0..1
TypeCWE
70. MSH.securityHandlingInstructions
Definition

Security Handling Instructions

ShortsecurityHandlingInstructions
Control0..*
TypeCWE
72. MSH.specialAccessRestrictionInstructions
Definition

Special Access Restriction Instructions

ShortspecialAccessRestrictionInstructions
Control0..*
TypeST