Skip to end of metadata
Go to start of metadata

For each segment one or more flavors may be defined:

  • Segment[General] - Most common mapping used in the various V2 messages.
  • Segment[FlavorName] - The FlavorName (or profile) will typically be the FHIR resource that it maps to, or some other descriptive name.


Spreadsheet Format

The spreadsheets have the following columns:

  • HL7 V2
    • Display Sequence - Informational Only.  Available to return the rows into the original sequence if one were to sort differently.  The format is used based on a frequently use method to identify segment and field components.
    • Identifier - Unique Link.  This represents the unique link to the attribute to enable a converter to identify the mapping in the HL7 FHIR section, based on the Condition in column F.
    • Name - Informational Only. This represents the name as provided in the most current published HL7 v2 version.
    • Data Type - Informational Only.  This represents the data type as provided in the most current published Hl7 v2 version, or the last published version when the field was deprecated.
    • Cardinality - Informational Only.  This represents the cardinality as provided in the most current published Hl7 v2 version, or the last published version when the field was deprecated.
  • Condition 
    • See: ANTLR Condition Syntax
    • Conditions that decide on the flavor of segment mapping will primarily be done within the message structure.
  • HL7 FHIR
    • FHIR Attribute - Unique Link.  The target attribute that the HL7 v2 field/component is to be mapped to using FHIR R4.
      • Generally this uses the fully specified path down to the data type component.
      • If the reference is to an existing extension, then the string "ext-" is appended to the front of the actual extension name used to clarify it is an extension that is used, plus the cell is linked to that extension's definitional page.  Note this format is subject to change, but so far considered most clear to a reader.
      • If the reference is to a proposed extension, then the string "#ext-" is appended to the front of the proposed extension name, while at the end of the proposed name "#" is appended.  The subsequent data type and cardinality are the proposed aspects of that extension.
      • If the reference is to an attribute in a referenced resource (data type is reference(resource choice)), then the format Resource.attribute(Resource.attribute) is used to indicate the actual resource referenced in the attribute.
    • Data Type - Informational.  The actual data type listed in FHIR R4.
    • Cardinality - Informational. The actual cardinalitry listed in FHIR R4.
    • Data Type Mapping - Actual Map based on v2 data type.  This map may point to a data type to data type map, or a data type to resource map.  For example, the data type XON would map to the Organization resource.
    • Vocabulary Mapping - Actual Map based on v2 referenced vocabulary to applicable FHIR vocabulary.
    • Derived Mapping - Not used and will be removed at some point.
  • Comments
    • Any comments/questions raised during the review process that require follow-up and, if still filled out at the time of ballot, ballot feedback.


Mapping Spreadsheets - Segment Tab: https://docs.google.com/spreadsheets/d/1PaFYPSSq4oplTvw_4OgOn6h2Bs_CMvCAU9CqC4tPBgk/edit#gid=1930219638

For Reference Only

  • ROL
    • ROL[PV1/PV2 historical] - do not use - will be removed from this list once other three are in Ballot Queue and did not need this.

Old confluence pages (being moved up as they are transferred into Google Sheets) 

Archived

  • No labels