Skip to end of metadata
Go to start of metadata

v2 Description: <segment description>

FHIR Description (<resource goes here>): <resource description>


Homework:

  • Review v2-to-FHIR threads on Zulip
    • Come back and talk about version ID and profile ID
  • What is the best way to send a sender or responsible organization when there is minimal data (maybe only a name)
  • Send examples to Craig to compare to this mapping

Mapping to <resource> 

HL7 V2 HL7 FHIR Comments
NameDefinitionData TypeCardinalityMapping RulesNameDefinitionData TypeCardinalityMapping Rules






MessageHeader.id





MSH-01.00.00 - Field SeparatorThis field contains the separator between the segment ID and the first real field, MSH-2 Encoding Characters. ST1..1

N/A




Field separators are not used in FHIR. Either XML or JSON or ....
MSH-02.00.00 - Encoding CharactersThis field contains five characters in the following order: the component separator, repetition separator, escape character, subcomponent separator, and truncation character. Recommended values are ^~\& #(ASCII 94, 126, 92, 38, and 35, respectively).ST1..1

N/A




Encoding characters are not used in FHIR.
MSH-03.00.00 - Sending ApplicationThis field uniquely identifies the sending application among all other applications within the network enterprise. HD0..1

MessageHeader.source
BackboneElement



MSH-03.01.00 - Sending Application : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


IF uri THEN MessageHeader.source.endpoint

ELSE

MessageHeader.source.name and

MessageHeader.source.#ext-endpoint-v2namespaceIdentifier#

AND

Provenance.agent.who(Device.identifier.value)

Provenance.agent.who(Device.identifier.system) is NOT valued.


string


Example: MSH|^~\%|LAB|...

If taking Provenance, should have both an instance of the original source (which may include a binary of the full v2 message) as well as an instance of the transformation.  See v2-to-FHIR Provenance.  It also may be that depending on how the v2 message is transformed, either into a FHIR message, or a FHIR "something else", would yield MessageHeader and/or Provenance for this data.  

MSH-03.02.00 - Sending Application : Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component_).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.source.#ext-v2nameAssignmentIdentifier#

AND

Provenance.agent.who(Device.identifier.value)

and if unique then Provenance.agent.who(Device.identifier.system="urn:ietf:rfc:3986") (or whatever)

The identifier of the organization that established the MessageHeader.source.name.String


Example: MSH|^~\%|LAB^2.16.840.1.113883.3.987.1^ISO|...



Use identifier??
If not, consider Organization??Provenance??
MSH-03.03.00 - Sending Application : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third component is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second component is a universal ID of that type.ID


MessageHeader.source.#ext-assigningAuthority#

AND

Provenance.agent.who(Device.


The UID of the code system according to which MessageHeader.source.#ext-nameAssignmentIdentifier#.String


Example: MSH|^~\%|LAB^2.16.840.1.113883.3.987.1^ISO|...
Use identifier??
If not, consider Organization??
MSH-04.00.00 - Sending FacilityThis field further describes the sending application, MSH-3 Sending Application. HD0..1

MessageHeader.sender
Reference(Organization)
If MSH-24 is not valued, then MSH-04 is used to map also into MessageHeader.source.endpoint
How do we represent HD and identifiers? Need to work with InM.
Should consider aligning sender/receiver constructs.
Open gForge to request that 
MSH-04.01.00 - Sending Facility : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.sender(Organization.identifier.value)

MessageHeader.sender.endpoint



Normally, only MSH-04.01.00 OR MSH-04.02.00 is valued. If both are valued, each creates a separate identifier instance.

If MSH-24 is not valued, then MSH-04 is used to map also into MessageHeader.source.endpoint

MessageHeader.source.endpoint is 0..1.  Must be a reachable address.
MSH-04.02.00 - Sending Facility :  Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.sender(Organization.identifier.value)
Reference(Organization)
If MSH-04.02.00 is an OID or UUID (MSH-04.03.00="ISO" or "UUID") then ...system = "urn:ietf:rfc:3986" while the OID is put into ....value.

Need a gForge (#20522) to identifier data type to add the value set subset from HL7 0301 OR clarification on how to populate ...system when it is a DNS (or other relevant "types"), e.g., point to another RFC that defines domain names. And get better clarification between type and system.


Note that in messages that include the CLIA# for labs here would fall in the right place here.  However, in non-messages the CLIA # would not be in MessageHeader, but elsewhere.  That needs to be clarified first elsewhere before we can determine what additional guidance to provide.

MessageHeader.sender(Organization.identifier.system)If MSH-04.02.00 is a fully qualified domain name (MSH-04.03.00 = "DNS") then MSH-04.02.00 uses ....value and ...type ="DNS".https://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemEdit&tracker_item_id=20467&start=0
MSH-04.03.00 - Sending Facility : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second component is a universal ID of that type.ID


MessageHeader.sender(Organization.identifier.system)???
Reference(Organization)


How deep do we go to get to the "ISO" equivalent.


-includes CLIA as Type in V2.  CLIA # is Required US regulatory item

MessageHeader.sender(Organization.identifier.type)???
MSH-05.00.00 - Receiving ApplicationThis field uniquely identifies the receiving application among all other applications within the network enterprise. HD0..1

MessageHeader.destination
Backbone Element



MSH-05.01.00 - Receiving Application : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.destination.name
String


Example: MSH...|RH^2.16.840.1.113883.632.3^ISO|...
MSH-05.02.00 - Receiving Application :  Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.destination.#ext-nameAssignementIdentifier#
String


Example: MSH...|RH^2.16.840.1.113883.632.3^ISO|...
MSH-05.03.00 - Receiving Application : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


MessageHeader.destination.#ext-assigningAuthority#
String


Example: MSH...|RH^2.16.840.1.113883.632.3^ISO|...
MSH-06.00.00 - Receiving FacilityThis field identifies the receiving application among multiple identical instances of the application running on behalf of different organizationsHD0..1

MessageHeader.destination.receiver
Reference(Organization)



MSH-06.01.00 - Receiving Facility : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.destination.receiver(Organization.identifier.value

MessageHeader.destination.endpoint



If MSH-25 is not valued, then MSH-06 is used to map also into MessageHeader.destination.endpoint
Need gForge (#20522) to change MessageHeader.destination.endpoint from 1..1 to 0..1.  Must be a reachable address.
MSH-06.02.00 - Receiving Facility :  Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.destination.receiver(Organization.identifier.system)





MSH-06.03.00 - Receiving Facility : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


MessageHeader.destination.receiver(Organization.identifier.assigner(Organization.identifier.assigner.(Organization.identifier.?????))





MSH-07.00.00 - Date/Time of MessageThis field contains the date/time that the sending system created the message. DTM1..1

MessageHeader.ext-timestamp






The Bundle.timestamp is valued when the v2 message is converted to FHIR and put into a bundle, if that is what happens.
See https://chat.fhir.org/#narrow/stream/179188-v2-to.20FHIR/topic/MessageHeader.2Etimestamp for a discussion on this topic.
MSH-08.00.00 - SecurityIn some applications of HL7, this field is used to implement security features.ST0..1

Messageheader.meta.security






Depending on vocabulary used, mapping is locally defined.
MSH-09.00.00 - Message TypeThe receiving system uses this field to recognize the data segments, and possibly, the application to which to route this messageMSG1..1

MessageHeader.event




Set up time with InM.  Set up mapping tables for all components (message code, trigger event, structure)
MSH-09.01.00 - Message Type : Message CodeSpecifies the message type code. ID


N/A





MSH-09.02.00 - Message Type : Trigger EventSpecifies the trigger event code. ID


MessageHeader.event.eventCoding.coding.code


 Need to express that table in FHIR (extension) to stay in sync.

MSH-09.03.00 - Message Type : Message StructureSpecifies the abstract message structure code. ID


MessageHeader.definition(MessageDefinition.identifier)




Do we still care about message structure, or is MessageHeader.definition enough?  Yes.
Do we need to define a value set of message definitions to map into?  At some point.

Should MessageDefinition.event be a repeat as one message structure can be used in different events?

Likely need MessageHeader.definition to be 0..*

MSH-10.00.00 - Message Control IDThis field contains a number or other identifier that uniquely identifies the message. ST1..1

MessageHeader.id or #identifier#?




Need to check on zulip whether this acceptable.

Will create a gForge to suggest .identifier.

Note that as messages switch from V2 to FHIR and the response back from FHIR to V2, the "mapping engine" needs to track the actual MSH.10.00.00 value and Bundle.identifier value to connect responses correctly.
MSH-11.00.00 - Processing IDThis field is used to decide whether to process the message as defined in HL7 Application (level 7) Processing rules. PT1..1

MessageHeader.meta.tag
Coding


Would have to agree on how to recognize value set reflecting T and P.
MSH-11.01.00 - Processing ID : Processing IDA value that defines whether the message is part of a production, training, or debugging system. ID


MessageHeader.meta.tag.code
code
MessageHeader.meta.tag.system = ???
Need to define the code system that would represent T=Test, P=Production, etc.
MSH-11.02.00 - Processing ID : Processing ModeA value that defines whether the message is part of an archival process or an initial load.ID


MessageHeader.meta.tag.code
code
MessageHeader.meta.tag.system = ???
Need to define the code system that would represent I=Initial, A=Archive, etc.
MSH-12.00.00 - Version IDThis field is matched by the receiving system to its own version to be sure the message will be interpreted correctlyVID1..1







Note that use MessageHeader.meta.profile to indicate the version of FHIR that MessageHeader conforms to.
MSH.12.01.00 - Version  ID : Version IDUsed to identify the HL7 version. ID


N/A 


Based on a mapping.

Need a gForge/zulip (#20523) to create a list of HL7 V2.x to a set of HL7 defined uri-s.  E.g., V2.2 => hl7.messageVersion.v2.2  atlernatively point to https://www.hl7.org/implement/standards/product_brief.cfm?product_id=139.

This field would at most go into Provenance either as a reference or the full binary.

MSH.12.02.00 - Version  ID : Internationalization CodeUsed to identify the international affiliate country code. CWE


N/A


Based on a mapping.
Need a gForge/zulip (#20523) to create a list of HL7 V2.x to a set of HL7 defined uri-s.  E.g., V2.2 => hl7.messageVersion.v2.2  atlernatively point to https://www.hl7.org/implement/standards/product_brief.cfm?product_id=139.
MSH.12.02.01 - Version  ID : Internationalization Code : IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH.12.02.02 - Version  ID : Internationalization Code : TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH.12.02.03 - Version  ID : Internationalization Code : Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH.12.02.04 - Version  ID : Internationalization Code : Alternate IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH.12.02.05 - Version  ID : Internationalization Code : Alternate TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH.12.02.06 - Version  ID : Internationalization Code : Alternate Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH.12.02.07 - Version  ID : Internationalization Code : Coding System Version IDThis component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID.  If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. ST


N/A





MSH.12.02.08 - Version  ID : Internationalization Code : Alternate Coding System Version IDThis component carries the version for the coding system identified by components 4-6. Analogous To CWE.7 - Coding System Version ID.ST


N/A





MSH.12.02.09 - Version  ID : Internationalization Code : Original TextThe text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.ST


N/A





MSH.12.02.10 - Version  ID : Internationalization Code : Second Alternate IdentifierA sequence of characters that uniquely identifies a second alternate code. Analogous to CWE.1- Identifier. ST


N/A





MSH.12.02.11 - Version  ID : Internationalization Code : Second Alternate TextThe descriptive or textual name of the alternate identifier. Analogous to CWE.2 - Text. See usage note in section introduction.ST


N/A





MSH.12.02.12 - Version  ID : Internationalization Code : Name of Second Alternate Coding SystemIdentifies the coding scheme being used in the alternate identifier component. Analogous to CWE.3 Name of Coding System. See usage note in section introduction. As of v2.7 this component is required when CWE.10 is populated and CWE.20 is not populated. Both CWE.6 and CWE.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding System as specified in CWE.12 and/or CWE.20, the "Coding System" component or the "Coding System OID", for the tuple.ID


N/A





MSH.12.02.13 - Version  ID : Internationalization Code : Second Alternate Coding System Version IDThis component carries the version for the coding system identified by components 10-12. Analogous to CWE.7 - Coding System Version ID.ST


N/A





MSH.12.02.14 - Version  ID : Internationalization Code : Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.1 is populated and CWE.3 is not populated. Both CWE.3 and CWE.14 may be populated.ST


N/A





MSH.12.02.15 - Version  ID : Internationalization Code : Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used.ST


N/A





A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.
MSH.12.02.16 - Version  ID : Internationalization Code : Value Set Version IDThis component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published.DTM


N/A





Value set version ID is required if CWE.15 is populated.
MSH.12.02.17 - Version  ID : Internationalization Code : Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6. Analogous to CWE.14 Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.4 is populated and CWE.6 is not populated. Both CWE.6 and CWE.17 may be populated.ST


N/A





MSH.12.02.18 - Version  ID : Internationalization Code : Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.12.02.19 - Version  ID : Internationalization Code : Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.18. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.18 is populated.DTM


N/A





MSH.12.02.20 - Version  ID : Internationalization Code : Second Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12. Analogous to CWE.14 - Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.10 is populated and CWE.12 is not populated. Both CWE.12 and CWE.20 may be populated.ST


N/A





MSH.12.02.21 - Version  ID : Internationalization Code : Second Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.12.02.22 - Version  ID : Internationalization Code : Second Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.21. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.21 is populated.DTM


N/A





MSH.12.03.00 - Version ID : International Version IDThis field component identifies international affiliate’s version; it is especially important when the international affiliate has more than a single local version associated with a single US version.CWE


MessageHeader.implicitRules


Based on a mapping.
Need a gForge/zulip (#20523) to create a list of HL7 V2.x to a set of HL7 defined uri-s.  E.g., V2.2 => hl7.messageVersion.v2.2  atlernatively point to https://www.hl7.org/implement/standards/product_brief.cfm?product_id=139.
MSH.12.03.01 - Version ID : International Version ID : IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH.12.03.02 - Version ID : International Version ID : TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH.12.03.03 - Version ID : International Version ID : Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH.12.03.04 - Version ID : International Version ID : Alternate IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH.12.03.05 - Version ID : International Version ID : Alternate TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH.12.03.06 - Version ID : International Version ID : Alternate Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH.12.03.07 - Version ID : International Version ID : Coding System Version IDThis component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID.  If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. ST


N/A





MSH.12.03.08 - Version ID : International Version ID : Alternate Coding System Version IDThis component carries the version for the coding system identified by components 4-6. Analogous To CWE.7 - Coding System Version ID.ST


N/A





MSH.12.03.09 - Version ID : International Version ID : Original TextThe text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.ST


N/A





MSH.12.03.10 - Version ID : International Version ID : Second Alternate IdentifierA sequence of characters that uniquely identifies a second alternate code. Analogous to CWE.1- Identifier. ST


N/A





MSH.12.03.11 - Version ID : International Version ID : Second Alternate TextThe descriptive or textual name of the alternate identifier. Analogous to CWE.2 - Text. See usage note in section introduction.ST


N/A





MSH.12.03.12 - Version ID : International Version ID : Name of Second Alternate Coding SystemIdentifies the coding scheme being used in the alternate identifier component. Analogous to CWE.3 Name of Coding System. See usage note in section introduction. As of v2.7 this component is required when CWE.10 is populated and CWE.20 is not populated. Both CWE.6 and CWE.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding System as specified in CWE.12 and/or CWE.20, the "Coding System" component or the "Coding System OID", for the tuple.ID


N/A





MSH.12.03.13 - Version ID : International Version ID : Second Alternate Coding System Version IDThis component carries the version for the coding system identified by components 10-12. Analogous to CWE.7 - Coding System Version ID.ST


N/A





MSH.12.03.14 - Version ID : International Version ID : Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.1 is populated and CWE.3 is not populated. Both CWE.3 and CWE.14 may be populated.ST


N/A





MSH.12.03.15 - Version ID : International Version ID : Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.12.03.16 - Version ID : International Version ID : Value Set Version IDThis component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.15 is populated.DTM


N/A





MSH.12.03.17 - Version ID : International Version ID : Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6. Analogous to CWE.14 Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.4 is populated and CWE.6 is not populated. Both CWE.6 and CWE.17 may be populated.ST


N/A





MSH.12.03.18 - Version ID : International Version ID : Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.12.03.19 - Version ID : International Version ID : Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.18. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.18 is populated.DTM


N/A





MSH.12.03.20 - Version ID : International Version ID : Second Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12. Analogous to CWE.14 - Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.10 is populated and CWE.12 is not populated. Both CWE.12 and CWE.20 may be populated.ST


N/A





MSH.12.03.21 - Version ID : International Version ID : Second Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.12.03.22 - Version ID : International Version ID : Second Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.21. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.21 is populated.DTM


N/A





MSH-13.00.00 - Sequence NumberA non null value in this field implies that the sequence number protocol is in use. NM0..1

Who is using it?





MSH-14.00.00 - Continuation PointerThis field is used to define continuations in application-specific ways.ST0..1

N/A





MSH-15.00.00 - Accept Acknowledgment TypeThis field identifies the conditions under which accept acknowledgments are required to be returned in response to this message.  ID0..1

Offer in For Comment as a question to state a preference for:

  • MessageHeader.#ext-acceptAcknowledgementType#
  • MessageHeader.meta.tag (create a set of tags)





Check what LRI/LOI terminology is and use that.
Craig - we should consider creating MessageDefinition resources for each message type (and presumably response patterns (MSH-15/16 combinations)) which explicitly list out allowedResponse values
MSH-16.00.00 - Application Acknowledgment TypeThis field contains the conditions under which application acknowledgments are required to be returned in response to this message.  ID0..1

Offer in For Comment as a question to state a preference for:

  • MessagaeHeader.#ext-applicationAcknowledgementType#
  • MessageHeader.meta.tag (create a set of tags)





Check what LRI/LOI terminology is and use that.
MSH-17.00.00 - Country CodeThis field contains the country of origin for the message. It will be used primarily to specify default elements, such as currency denominations.ID0..1

MessageHeader.sender(Organization.address.country)







MSH-18.00.00 - Character SetThis field contains the character set for the entire message. ID0..*

N/A




 We need to investigate how FHIR resources define a character set (if they even do).
MSH-19.00.00 - Principal Language Of MessageThis field contains the principal language of the messageCWE0..1

MessageHeader.language




This does only cover the MessageHeader resource. Need to have clarity that if other resources that are part of the message that do not have Resource.meta.language valued, then it is assumed to follow MessageHeader.meta.language?? Doesn't seem RESTful, so what is the default for Resource.meta.language?
MSH.19.01.00  - Principal Language of Message : IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


MessageHeader.language
code



MSH.19.02.00  - Principal Language of Message : TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


Review the code/value set identifier from FHIR to be used here.





MSH.19.03.00  - Principal Language of Message : Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST









MSH.19.04.00  - Principal Language of Message : Alternate IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH.19.05.00  - Principal Language of Message : Alternate TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH.19.06.00  - Principal Language of Message : Alternate Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH.19.07.00  - Principal Language of Message : Coding System Version IDThis component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID.  If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. ST


TBD





MSH.19.08.00  - Principal Language of Message : Alternate Coding System Version IDThis component carries the version for the coding system identified by components 4-6. Analogous To CWE.7 - Coding System Version ID.ST


N/A





MSH.19.09.00  - Principal Language of Message : Original TextThe text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.ST


N/A





MSH.19.10.00  - Principal Language of Message : Second Alternate IdentifierA sequence of characters that uniquely identifies a second alternate code. Analogous to CWE.1- Identifier. ST


N/A





MSH.19.11.00  - Principal Language of Message : Second Alternate TextThe descriptive or textual name of the alternate identifier. Analogous to CWE.2 - Text. See usage note in section introduction.ST


N/A





MSH.19.12.00  - Principal Language of Message : Name of Second Alternate Coding SystemIdentifies the coding scheme being used in the alternate identifier component. Analogous to CWE.3 Name of Coding System. See usage note in section introduction. As of v2.7 this component is required when CWE.10 is populated and CWE.20 is not populated. Both CWE.6 and CWE.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding System as specified in CWE.12 and/or CWE.20, the "Coding System" component or the "Coding System OID", for the tuple.ID


N/A





MSH.19.13.00  - Principal Language of Message : Second Alternate Coding System Version IDThis component carries the version for the coding system identified by components 10-12. Analogous to CWE.7 - Coding System Version ID.ST


N/A





MSH.19.14.00  - Principal Language of Message : Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.1 is populated and CWE.3 is not populated. Both CWE.3 and CWE.14 may be populated.ST


??





MSH.19.15.00  - Principal Language of Message : Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


??





MSH.19.16.00  - Principal Language of Message : Value Set Version IDThis component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.15 is populated.DTM


??





MSH.19.17.00  - Principal Language of Message : Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6. Analogous to CWE.14 Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.4 is populated and CWE.6 is not populated. Both CWE.6 and CWE.17 may be populated.ST


N/A





MSH.19.18.00  - Principal Language of Message : Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.19.19.00  - Principal Language of Message : Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.18. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.18 is populated.DTM


N/A





MSH.19.20.00  - Principal Language of Message : Second Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12. Analogous to CWE.14 - Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.10 is populated and CWE.12 is not populated. Both CWE.12 and CWE.20 may be populated.ST


N/A





MSH.19.21.00  - Principal Language of Message : Second Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH.19.22.00  - Principal Language of Message : Second Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.21. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.21 is populated.DTM


N/A





MSH-20.00.00 - Alternate Character Set Handling SchemeWhen any alternative character sets are used (as specified in the second or later iterations of MSH-18 Character Set), and if any special handling scheme is needed, this component is to specify the scheme used, according to HL7 Table 0356- Alternate Character Set Handling Scheme as defined in Chapter 2C, Code Tables,.ID0..1

N/A




See MSH-18 for same guidance.
MSH-21.00.00 - Message Profile IdentifierSites may use this field to assert adherence to, or reference, a message profile. Message profiles contain detailed explanations of grammar, syntax, and usage for a particular message or set of messages. EI0..*

MessageHeader.meta.profile AND/OR MessageHeader.definition(MessageDefinition)




Need to support multiple profiles. Also, comment on implicitRules is highly idealistic.

Discuss with Grahame at Thursday Q0

MSH-21.01.00 - Message Profile Identifier : Entity IdentifierThe first component, <entity identifier>, is usually defined to be unique within the series of identifiers created by the <assigning authority>, defined by a hierarchic designator, represented by components 2 through 4. See Section 2.A.33, "HD - hierarchic designator".ST


??





MSH-21.02.00 - Message Profile Identifier : Namespace IDSee Section 2.A.33.1, "Namespace ID (IS)" for definition. The component intentionally remains associated with the IS data type in v 2.7.IS


??





MSH-21.03.00 - Message Profile Identifier : Universal IDSee Section 2.A.33.2, "Universal ID (ST)" for definition.ST


??





MSH-21.04.00 - Message Profile Identifier : Universal ID TypeSee Section 2.A.33.3, "Universal ID Type (ID)," for definition.ID


??





MSH-22.00.00 - Sending Responsible OrganizationBusiness organization that originated and is accountable for the content of the message.XON0..1

MessageHeader.responsible(Organization)
R+I201eference(Organization)



MSH-22.01.00 - Sending Responsible Organization : Organization NameThe name of the specified organization.ST


MessageHeader.responsible(Organization.name)
string



MSH-22.02.00 - Sending Responsible Organization : Organization Name Type CodeA code that represents the type of name i.e., legal name, display name. Refer to User-defined Table 0204 - Organizational Name Type for suggested values.CWE


MessageHeader.responsible(Organization.#ext-nameType#)
coding



MSH-22.02.01 - Sending Responsible Organization : Organization Name Type Code : IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


MessageHeader.responsible(Organization.#ext-nameType.code#)
code



MSH-22.02.02 - Sending Responsible Organization : Organization Name Type Code : TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


MessageHeader.responsible(Organization.#ext-nameType.display#)
string



MSH-22.02.03 - Sending Responsible Organization : Organization Name Type Code : Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


MessageHeader.responsible(Organization.#ext-nameType.system#)
uri



MSH-22.02.04 - Sending Responsible Organization : Organization Name Type Code : Alternate IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH-22.02.05 - Sending Responsible Organization : Organization Name Type Code : Alternate TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH-22.02.06 - Sending Responsible Organization : Organization Name Type Code : Alternate Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH-22.02.07 - Sending Responsible Organization : Organization Name Type Code : Coding System Version IDThis component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID.  If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. ST


MessageHeader.responsible(Organization.#ext-nameType.version#)
string



MSH-22.02.08 - Sending Responsible Organization : Organization Name Type Code : Alternate Coding System Version IDThis component carries the version for the coding system identified by components 4-6. Analogous To CWE.7 - Coding System Version ID.ST


N/A





MSH-22.02.09 - Sending Responsible Organization : Organization Name Type Code : Original TextThe text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.ST


N/A





MSH-22.02.10 - Sending Responsible Organization : Organization Name Type Code : Second Alternate IdentifierA sequence of characters that uniquely identifies a second alternate code. Analogous to CWE.1- Identifier. ST


N/A





MSH-22.02.11 - Sending Responsible Organization : Organization Name Type Code : Second Alternate TextThe descriptive or textual name of the alternate identifier. Analogous to CWE.2 - Text. See usage note in section introduction.ST


N/A





MSH-22.02.12 - Sending Responsible Organization : Organization Name Type Code : Name of Second Alternate Coding SystemIdentifies the coding scheme being used in the alternate identifier component. Analogous to CWE.3 Name of Coding System. See usage note in section introduction. As of v2.7 this component is required when CWE.10 is populated and CWE.20 is not populated. Both CWE.6 and CWE.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding System as specified in CWE.12 and/or CWE.20, the "Coding System" component or the "Coding System OID", for the tuple.ID


N/A





MSH-22.02.13 - Sending Responsible Organization : Organization Name Type Code : Second Alternate Coding System Version IDThis component carries the version for the coding system identified by components 10-12. Analogous to CWE.7 - Coding System Version ID.ST


N/A





MSH-22.02.14 - Sending Responsible Organization : Organization Name Type Code : Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.1 is populated and CWE.3 is not populated. Both CWE.3 and CWE.14 may be populated.ST


??





MSH-22.02.15 - Sending Responsible Organization : Organization Name Type Code : Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


??





MSH-22.02.16 - Sending Responsible Organization : Organization Name Type Code : Value Set Version IDThis component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.15 is populated.DTM


??





MSH-22.02.17 - Sending Responsible Organization : Organization Name Type Code : Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6. Analogous to CWE.14 Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.4 is populated and CWE.6 is not populated. Both CWE.6 and CWE.17 may be populated.ST


N/A





MSH-22.02.18 - Sending Responsible Organization : Organization Name Type Code : Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH-22.02.19 - Sending Responsible Organization : Organization Name Type Code : Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.18. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.18 is populated.DTM


N/A






MSH-22.02.20 - Sending Responsible Organization : Organization Name Type Code : Second Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12. Analogous to CWE.14 - Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.10 is populated and CWE.12 is not populated. Both CWE.12 and CWE.20 may be populated.ST


N/A





MSH-22.02.21 - Sending Responsible Organization : Organization Name Type Code : Second Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH-22.02.22 - Sending Responsible Organization : Organization Name Type Code : Second Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.21. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.21 is populated.DTM


N/A





MSH-22.03.00 - Sending Responsible Organization : ID Number
NM 


MessageHeader.responsible(Organization.identifier.value)
identifier



MSH-22.04.00 - Sending Responsible Organization : Identifier Check DigitThe check digit in this data type is not an add-on produced by the message processor. It is the check digit that is part of the identifying number used in the sending application. If the sending application does not include a self-generated check digit in the identifying number, this component should be valued null.NM 


MessageHeader.responsible(Organization.#ext-identifier.CheckDigit#??)





MSH-22.05.00 - Sending Responsible Organization : Check Digit SchemeContains the code identifying the check digit scheme employed. The check digit scheme codes are defined in HL7 Table 0061 - Check digit scheme.ID


MessageHeader.responsible(Organization.#ext-identifier.CheckDigitScheme#??)





MSH-22.06.00 - Sending Responsible Organization : Assigning AuthorityThe assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data. Assigning authorities are unique across a given HL7 implementation. Refer to User-defined Table 0363 - Assigning Authority for suggested values. HD


MessageHeader.responsible(Organization.identifier.assigner(Organization)





MSH-22.06.01 - Sending Responsible Organization : Assigning Authority : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.responsible(Organization.identifier.assigner(Organization.??))





MSH-22.06.02 - Sending Responsible Organization :  Assigning Authority : Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.responsible(Organization.identifier.assigner(Organization.??))





MSH-22.06.03 - Sending Responsible Organization :  Assigning Authority : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


MessageHeader.responsible(Organization.identifier.assigner(Organization.??))





MSH-22.07.00 - Sending Responsible Organization : Identifier Type CodeA code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the "Assigning authority" component. Refer to HL7 Table 0203 - Identifier Type for suggested values.ID


MessageHeader.responsible(Organization.identifier.type.coding.code)





MessageHeader.responsible(Organization.identifier.type.coding.system) = "HL70203"
MSH-22.08.00 - Sending Responsible Organization : Assigning FacilityThe place or location identifier where the identifier was first assigned to the person. This component is not an inherent part of the identifier but rather part of the history of the identifier: as part of this data type, its existence is a convenience for certain intercommunicating systems.HD


MessageHeader.responsible(Organization.#ext-location(Location)#)





MSH-22.08.01 - Sending Responsible Organization : Assigning Facility : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.responsible(Organization.#ext-location(Location)#)





MSH-22.08.02 - Sending Responsible Organization :  Assigning Facility : Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


??





MSH-22.08.03 - Sending Responsible Organization :  Assigning Facility : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


??





MSH-22.09.00 - Sending Responsible Organization : Name Representation CodeDifferent <name/address types> and representations of the same <name/address> should be described by repeating of this field, with different values of the <name/address type> and/or <name/address representation> component. Refer to HL7 Table 0465 – Name/address Representation Code for valid values.ID


N/A





MSH-22.10.00 - Sending Responsible Organization : Organization IdentifierThis component contains the sequence of characters (the code) that uniquely identifies the item being referenced by XON.1 Organization Name. This component replaces XON.3 ID Number as of v 2.5.ST


MessageHeader.responsible(Organization.identifier.value)





MSH-23.00.00 - Receiving Responsible OrganizationBusiness organization that is the intended receiver of the message and is accountable for acting on the data conveyed by the transaction.XON0..1

MessageHeader.#ext-receiverResponsible(Organization)
Reference(Organization)


We should see if this should be added to the base resource. FHIR Zulip thread on extension or base resource change: https://chat.fhir.org/#narrow/stream/179188-v2-to.20FHIR/topic/MSH-23.20to.20MessageHeader/near/163382914.
MSH-23.01.00 - Receiving Responsible Organization : Organization NameThe name of the specified organization.ST


MessageHeader.#ext-receiverResponsible(Organization.name)
string



MSH-23.02.00 - Receiving Responsible Organization : Organization Name Type CodeA code that represents the type of name i.e., legal name, display name. Refer to User-defined Table 0204 - Organizational Name Type for suggested values.CWE


MessageHeader.#ext-receiverResponsible(Organization.#ext-nameType#)
coding



MSH-23.02.01 - Receiving Responsible Organization : Organization Name Type Code : IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


MessageHeader.#ext-receiverResponsible(Organization.#ext-nameType.code#)
code



MSH-23.02.02 - Receiving Responsible Organization : Organization Name Type Code : TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


MessageHeader.#ext-receiverResponsible(Organization.#ext-nameType.display#)
string



MSH-23.02.03 - Receiving Responsible Organization : Organization Name Type Code : Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


MessageHeader.#ext-receiverResponsible(Organization.#ext-nameType.system#)
uri



MSH-23.02.04 - Receiving Responsible Organization : Organization Name Type Code : Alternate IdentifierSequence of characters (the code) that uniquely identifies the item being referenced by the <text>.  Differ-ent coding schemes will have different elements here.ST


N/A





MSH-23.02.05 - Receiving Responsible Organization : Organization Name Type Code : Alternate TextName or description of the item in question.  E.g., myocardial infarction or X-ray impression.  Its data type is string (ST).ST


N/A





MSH-23.02.06 - Receiving Responsible Organization : Organization Name Type Code : Alternate Name of Coding SystemEach coding system is assigned a unique identifier.  This component will serve to identify the coding scheme being used in the identifier component.  The combination of the identifier and name of coding system components will be a unique code for a data item.  ST


N/A





MSH-23.02.07 - Receiving Responsible Organization : Organization Name Type Code : Coding System Version IDThis component carries the version for the coding system identified by components 1-3. If CWE.3 is populated with a value other than HL7nnnn or is of table type user-defined, version ID must be valued with an actual version ID.  If CWE.3 is populated with a value of HL7nnnn and nnnn is of table type HL7, version ID may have an actual value or it may be absent. If version ID is absent, it will be interpreted to have the same value as the HL7 version number in the message header. ST


MessageHeader.#ext-receiverResponsible(Organization.#ext-nameType.version#)
string



MSH-23.02.08 - Receiving Responsible Organization : Organization Name Type Code : Alternate Coding System Version IDThis component carries the version for the coding system identified by components 4-6. Analogous To CWE.7 - Coding System Version ID.ST


N/A





MSH-23.02.09 - Receiving Responsible Organization : Organization Name Type Code : Original TextThe text as seen and/or selected by the user who entered the data. Original text can be used in a structured user interface to capture what the user saw as a representation of the code on the data input screen, or in a situation where the user dictates or directly enters text, it is the text entered or uttered by the user. In a situation where the code is assigned sometime after the text was entered, original text is the text or phrase used as the basis for assigning the code.ST


N/A





MSH-23.02.10 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate IdentifierA sequence of characters that uniquely identifies a second alternate code. Analogous to CWE.1- Identifier. ST


N/A





MSH-23.02.11 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate TextThe descriptive or textual name of the alternate identifier. Analogous to CWE.2 - Text. See usage note in section introduction.ST


N/A





MSH-23.02.12 - Receiving Responsible Organization : Organization Name Type Code : Name of Second Alternate Coding SystemIdentifies the coding scheme being used in the alternate identifier component. Analogous to CWE.3 Name of Coding System. See usage note in section introduction. As of v2.7 this component is required when CWE.10 is populated and CWE.20 is not populated. Both CWE.6 and CWE.17 may be populated. Receivers should not identify a code based on its position within the tuples (Identifier, Alternate Identifier, or Second Alternate Identifier) or position within a repeating field. Instead, the receiver should always examine the coding System as specified in CWE.12 and/or CWE.20, the "Coding System" component or the "Coding System OID", for the tuple.ID


N/A





MSH-23.02.13 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate Coding System Version IDThis component carries the version for the coding system identified by components 10-12. Analogous to CWE.7 - Coding System Version ID.ST


N/A





MSH-23.02.14 - Receiving Responsible Organization : Organization Name Type Code : Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.3. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.1 is populated and CWE.3 is not populated. Both CWE.3 and CWE.14 may be populated.ST


??





MSH-23.02.15 - Receiving Responsible Organization : Organization Name Type Code : Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.1 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


??





MSH-23.02.16 - Receiving Responsible Organization : Organization Name Type Code : Value Set Version IDThis component carries the version for the value set identified by CWE.15. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.15 is populated.DTM


??





MSH-23.02.17 - Receiving Responsible Organization : Organization Name Type Code : Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.6. Analogous to CWE.14 Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.4 is populated and CWE.6 is not populated. Both CWE.6 and CWE.17 may be populated.ST


N/A





MSH-23.02.18 - Receiving Responsible Organization : Organization Name Type Code : Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.4 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH-23.02.19 - Receiving Responsible Organization : Organization Name Type Code : Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.18. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.18 is populated.DTM


N/A





MSH-23.02.20 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate Coding System OIDThis component contains the ISO Object Identifier (OID) for the coding system or value set named in CWE.12. Analogous to CWE.14 - Coding System OID. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined code systems the OID registered in the HL7 OID registry SHALL be used. This component is required when CWE.10 is populated and CWE.12 is not populated. Both CWE.12 and CWE.20 may be populated.ST


N/A





MSH-23.02.21 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate Value Set OIDThis component contains the ISO Object Identifier (OID) to allow identification of the value set from which the value in CWE.10 is obtained. The value for this component is 2.16.840.1.113883.12.#### where  "####" is to be replaced by the HL7 table number in the case of an HL7 defined or user defined table. For externally defined value sets, the OID registered in the HL7 OID registry SHALL be used. A value set may or need not be present irrespective of other fields. Note that if a code is provided, the meaning of the code must come from the definition of the code in the code system. The meaning of the code SHALL NOT depend on the value set.  Applications SHALL NOT be required to interpret the code in light of the valueSet, and they SHALL NOT reject an instance because of the presence or absence of any or a particular value set/ value set version ID.ST


N/A





MSH-23.02.22 - Receiving Responsible Organization : Organization Name Type Code : Second Alternate Value Set Version IDThis component carries the version for the value set identified by CWE.21. The version is a date. The date is the date/time that the value set being used was published. Value set version ID is required if CWE.21 is populated.DTM


N/A





MSH-23.03.00 - Receiving Responsible Organization : ID Number
NM 


MessageHeader.#ext-receiverResponsible(Organization.identifier.value)
identifier



MSH-23.04.00 - Receiving Responsible Organization : Identifier Check DigitThe check digit in this data type is not an add-on produced by the message processor. It is the check digit that is part of the identifying number used in the sending application. If the sending application does not include a self-generated check digit in the identifying number, this component should be valued null.NM 


MessageHeader.#ext-receiverResponsible(Organization.#ext-identifier.CheckDigit#??)





MSH-23.05.00 - Receiving Responsible Organization : Check Digit SchemeContains the code identifying the check digit scheme employed. The check digit scheme codes are defined in HL7 Table 0061 - Check digit scheme.ID


MessageHeader.#ext-receiverResponsible(Organization.#ext-identifier.CheckDigitScheme#??)





MSH-23.06.00 - Receiving Responsible Organization : Assigning AuthorityThe assigning authority is a unique identifier of the system (or organization or agency or department) that creates the data. Assigning authorities are unique across a given HL7 implementation. Refer to User-defined Table 0363 - Assigning Authority for suggested values. HD


MessageHeader.#ext-receiverResponsible(Organization.identifier.assigner(Organization)





MSH-23.06.01 - Receiving Responsible Organization : Assigning Authority : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.#ext-receiverResponsible(Organization.identifier.assigner(Organization.??))





MSH-23.06.02 - Receiving Responsible Organization :  Assigning Authority : Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.#ext-receiverResponsible(Organization.identifier.assigner(Organization.??))





MSH-23.06.03 - Receiving Responsible Organization :  Assigning Authority : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


MessageHeader.#ext-receiverResponsible(Organization.identifier.assigner(Organization.??))





MSH-23.07.00 - Receiving Responsible Organization : Identifier Type CodeA code corresponding to the type of identifier. In some cases, this code may be used as a qualifier to the "Assigning authority" component. Refer to HL7 Table 0203 - Identifier Type for suggested values.ID


MessageHeader.#ext-receiverResponsible(Organization.identifier.type.coding.code)





MSH-23.08.00 - Receiving Responsible Organization : Assigning FacilityThe place or location identifier where the identifier was first assigned to the person. This component is not an inherent part of the identifier but rather part of the history of the identifier: as part of this data type, its existence is a convenience for certain intercommunicating systems.HD


MessageHeader.#ext-receiverResponsible(Organization.identifier.type.coding.system) = "HL70203"
MSH-23.08.01 - Receiving Responsible Organization : Assigning Facility : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


MessageHeader.#ext-receiverResponsible(Organization.#ext-location(Location)#)





MSH-23.08.02 - Receiving Responsible Organization :  Assigning Facility : Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


MessageHeader.#ext-receiverResponsible(Organization.#ext-location(Location)#)





MSH-23.08.03 - Receiving Responsible Organization :  Assigning Facility : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


??





MSH-23.09.00 - Receiving Responsible Organization : Name Representation CodeDifferent <name/address types> and representations of the same <name/address> should be described by repeating of this field, with different values of the <name/address type> and/or <name/address representation> component. Refer to HL7 Table 0465 – Name/address Representation Code for valid values.ID


??





MSH-23.10.00 - Receiving Responsible Organization : Organization IdentifierThis component contains the sequence of characters (the code) that uniquely identifies the item being referenced by XON.1 Organization Name. This component replaces XON.3 ID Number as of v 2.5.ST









MSH-24.00.00 - Sending Network AddressIdentifier of the network location the message was transmitted from.  Identified by an OID or text string (e.g., URI). HD0..1

Messageheader.source.endpoint


Depending on content of MSH-24, this may require a lookup.

MSH-24 gets priority over MSH-4 if both are populated with URLs



MSH-24.01.00 - Sending Network Address : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


??





MSH-24.02.00 - Sending Network Address :  Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


??





MSH-24.03.00 - Sending Network Address : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


??





MSH-25.00.00 - Receiving Network AddressIdentifier of the network location the message was transmitted to.  HD0..1

MessageHeader.destination.endpoint
url
Depending on content of MSH-25, this may require a lookup.

MSH-25.01.00 - Receiving Network Address : Namespace IDUser-defined table 0300 - Namespace ID is used as the HL7 identifier for the user-defined table of values for this component. IS


??





MSH-25.02.00 - Receiving Network Address :  Universal IDThe HD’s second component, <universal ID (UID), is a string formatted according to the scheme defined by the third component, <universal ID type> (UID type).  The UID is intended to be unique over time with-in the UID type.  It is rigorously defined.  Each UID must belong to one of the specifically enumerated schemes for constructing UID’s (defined by the UID type).  The UID (second component) must follow the syntactic rules of the particular universal identifier scheme (defined by the third component).  Note that these syntactic rules are not defined within HL7 but are defined by the rules of the particular universal identifier scheme (defined by the third component).ST 


??





MSH-25.03.00 - Receiving Network Address : Universal ID TypeThe third component governs the interpretation of the second component of the HD.  If the third compo-nent is a known UID refer to HL7 table 0301 - Universal ID type for valid values, then the second compo-nent is a universal ID of that type.ID


??







  • No labels