Enabling HL7v2 Interfaces

To enable the HL7v2 messaging interfaces, the SanteDB iCDR host instance's configuration file needs to be updated to include the HL7ConfigurationSection as illustrated:

<SanteDBConfiguration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://santedb.org/configuration">
  <sections>
    <add type="SanteDB.Messaging.HL7.Configuration.Hl7ConfigurationSection, SanteDB.Messaging.HL7" />
  </sections>
  <section xsi:type="Hl7ConfigurationSection" 
          strictMetadata="false" requireAppAuth="false" 
          idReplacement="any-in-domain"  security="None">
    <!-- Classes of PLACE which can be used for a Birthplace Lookup -->
    <birthplaceClasses>
      <add>79DD4F75-68E8-4722-A7F5-8BC2E08F5CD6</add>
      <add>48B2FFB3-07DB-47BA-AD73-FC8FB8502471</add>
      <add>D9489D56-DDAC-4596-B5C6-8F41D73D8DC5</add>
      <add>FF34DFA7-C6D3-4F8B-BC9F-14BCDC13BA6C</add>
      <add>8CF4B0B0-84E5-4122-85FE-6AFA8240C218</add>
    </birthplaceClasses>
    <!-- The UUID of your local facility -->
    <facility>84039432-84E5-4122-85FE-6AFA8240C218</facility>
    <!-- The authority of your UUIDs -->
    <localAuthority>
      <domainName xmlns="http://santedb.org/model">YOUR_LOCAL_V2_AUTHORITY</domainName>
      <oid xmlns="http://santedb.org/model">1.3.6.1.4.1.52820.5.1.1.1.999</oid>
      <url xmlns="http://santedb.org/model">http://your/fhir/authority</url>
    </localAuthority>
    <!-- The SSN Authority from PID segment (map to PID-3) -->
    <ssnAuthority>
      <domainName xmlns="http://santedb.org/model">SSN</domainName>
      <oid xmlns="http://santedb.org/model">2.16.840.1.113883.4.1</oid>
      <url xmlns="http://santedb.org/model">http://hl7.org/fhir/sid/us-ssn</url>
    </ssnAuthority>
    <services>
      <!-- One or more IP/PORTS on which to bind -->
      <add address="llp://0.0.0.0:2100" name="LLP" receiveTimeout="20000">
        <!-- If you want to enable security Encryption
        <sllp checkCrl="false" requireClientCert="false">
          <serverCertificate findType="FindByThumbprint" storeName="My" storeLocation="CurrentUser" findValue="value" />
          <clientAuthorityCertificate findType="FindByThumbprint" storeName="My" storeLocation="CurrentUser" findValue="value" />
        </sllp>
        -->
        <messages>
          <add type="SanteDB.Messaging.HL7.Messages.QbpMessageHandler, SanteDB.Messaging.HL7, Version=1.10.0.0">
            <event isQuery="true" name="QBP^Q22" />
            <event isQuery="true" name="QBP^Q23" />
          </add>
          <add type="SanteDB.Messaging.HL7.Messages.AdtMessageHandler, SanteDB.Messaging.HL7, Version=1.10.0.0">
            <event isQuery="false" name="ADT^A01"/>
            <event isQuery="false" name="ADT^A04"/>
            <event isQuery="false" name="ADT^A08"/>
            <event isQuery="false" name="ADT^A40"/>
          </add>
        </messages>
      </add>
    </services>
  </section>

</SanteDBConfiguration>

Security Configuration

Anonymous User

If SanteDB is used in a context where SLLP is not used to authenticate devices, and senders do not support MSH-8 then you can set the authentication mode to none and set the @anonUser attribute. This attribute is the anonymous user account that you wish unauthenticated contexts to run under. By default, ANONYMOUS is used.

Metadata / Control Configuration

The elements which control metadata used by the HL7 message handler are:

Element	Use
@strictMetadata	When true, segment processing must only assign relationships (to organizations, facilities, etc.) when an explicit identifier matches that registered in the CDR. If false, then the segment handler will attempt name matching of places to perform linking.
@idReplacement	When set to any-in-domain , any attempt to update a patient identifier will remove the existing identifier for that patient in the domain and replace it with the provided value. This has the effect of only allowing one identifier per identity domain from a single sender.
birthplaceClasses	In HL7v2, the birthplace of patients and persons are represented as simple place names. This list provides a series of class codes which Place instances can have to resolve to a birthplace. For example, one can enable SerivceDeliveryLocation as a class code for birthplace and SanteDB will match birthplaces with hospitals and clinics.
facility	This is the value of the ServiceDeliveryLocation instance in which the instance of SanteDB is running. This information is used to populate the MSH-4 field if the iCDR is sending HL7 messages, or the MSH-6 field if matching inbound messages.
localAuthority	Contains an AssigningAuthority which is used to emit local keys and designate inbound identifiers as a local identifier. Given the example above, the internal resource UUID for a patient would be emitted in HL7 as: 9ce06884-39ff-42b6-87b4-bd6b9df24702^^^YOUR_LOCAL_V2_AUTHORITY&1.3.6.1.4.1.52820.5.1.1.1.999&ISO
ssnAuthority	Like the localAuthority , this contains the domain which the PID-19 field should be mapped to (since SanteDB's HL7 handler maps this into a PID-3 identity domain)