On this page:
   35.52    HL7 v2.x to FHIR Mapper - Forced Namespace Mode 35.54    HL7 v2.x Mapper - Medications   

35.53HL7 v2.x Mapper - General

 

The HL7 v2.x Mapper - General configuration category includes the following configurable options:

  • Create MessageHeader for Each Message

  • Creation Mode - Practitioner

  • Patient Primary Identifier Search Parameter

  • Inferred TimeZone When Not Present

  • Mapper Bean Types

  • MessageHeader Hardcoded Destination Name

  • Process AL1 Segments

35.53.1Property: Create MessageHeader for Each Message

 
Property Name Create MessageHeader for Each Message
Property Key
Property Type BOOLEAN
Description If enabled, a MessageHeader resource will be created and stored in the repository for every HL7 v2.x message that is processed. See Creating MessageHeader for more information.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.create_message_header = false

35.53.2Property: Creation Mode - Practitioner

 
Property Name Creation Mode - Practitioner
Property Key
Property Type ENUM
Values
  • CONDITIONAL_CREATE
  • CONDITIONAL_UPDATE
Description This setting controls the create/update mode for Practitioner resources that are generated when converting from HL7 v2.x. This setting can be used to specify that resources should always be updated using values from the v2.x message (conditional update) or should only be created if they do not already exist (conditional create).
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value CONDITIONAL_UPDATE
Example Property
module.[MODULE_ID].config.creation_mode.practitioner = CONDITIONAL_UPDATE

35.53.3Property: Patient Primary Identifier Search Parameter

 
Property Name Patient Primary Identifier Search Parameter
Property Key
Property Type STRING
Description If specified, Patient resources will be created using this search parameter to match the primary identifier. Typically the default value of identifier is good for this setting.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value identifier
Example Property
module.[MODULE_ID].config.identifiers.patient.primary_identifier_search_param_name = identifier

35.53.4Property: Inferred TimeZone When Not Present

 
Property Name Inferred TimeZone When Not Present
Property Key
Property Type STRING
Description If enabled, the given timezone offset will be used when an HL7 v2.x timestamp (TS) datatype is received that does not contain a timezone offset. This is useful because many HL7 v2.x systems do not transmit an offset, assuming instead that all times they transmit are in their local timezone. Set this value to explicitly state which timezone to infer.

Values for this property should be a valid Java TimeZone identifier (e.g. America/Chicago or Australia/Canberra).

Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.infer_timezone_when_not_present = 

35.53.5Property: Mapper Bean Types

 
Property Name Mapper Bean Types
Property Key
Property Type STRING
Description A comma-separated list of bean classes that will be used to map messages as they are processed by this endpoint. Classes listed here must implement the interface ca.cdr.api.pub.hl7v2.IHl7V2MessageMapper.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.mapper_bean_types = 

35.53.6Property: MessageHeader Hardcoded Destination Name

 
Property Name MessageHeader Hardcoded Destination Name
Property Key
Property Type STRING
Description If set, supplies a hardcoded value to use for the MessageHeader.destination.name field in generated MessageHeader resources. This can be useful if you wish to place an identifier to uniquely track all messages received from a specific endpoint.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value (no default)
Example Property
module.[MODULE_ID].config.messageheader.hardcoded_destination_name = 

35.53.7Property: Process AL1 Segments

 
Property Name Process AL1 Segments
Property Key
Property Type BOOLEAN
Description If this is enabled, AL1 segments will be processed on incoming messages. Note that this can have a significant impact on performance and storage requirements.
Applies to Modules
  • HL7 v2.x Listening Endpoint
Default Value false
Example Property
module.[MODULE_ID].config.process_al1_segments = false
   35.52    HL7 v2.x to FHIR Mapper - Forced Namespace Mode 35.54    HL7 v2.x Mapper - Medications