Ensemble HL7 Version 2 Development Guide - InterSystems ...

More documents

Recommendations

Info

Elements of a Routing Production • An HL7 business operation (if your design bypasses a routing process for this interface and simply relays messages from the incoming business service to the outgoing business operation) Use Ack Commit Codes True or False. If True, when constructing an ACK message for HL7 messages version 2.3 or higher, the business service places one of the “enhanced-mode” ACK commit codes in the MSA segment AcknowledgmentCode field. For a list of codes, see “The UseAckCommitCodes Setting” in the chapter “Settings for a Routing Production.” The remaining entries in the Specific Settings column are determined by the type of adapter: FTP, File, TCP, or HTTP. The following adapter settings are especially important for HL7 business services: AppendTimestamp ArchivePath CallInterval (File only) If True, the HL7 business service automatically appends a time stamp to filenames in the ArchivePath. The format for this time stamp is %f_%Q where: • %f is the name of the data source, in this case the input filename • _ is the literal underscore character, which will appear in the output filename • %Q indicates ODBC format date and time In substituting a value for the format code %f, Ensemble strips out any of the characters |,,\,/,:,[,],,&,,,;,NUL,BEL,TAB,CR,LF, replacing spaces with underscores (_) and slashes (/) with hyphens (-). When the output file is being saved on an OpenVMS system, Ensemble replaces colons with hyphens (-). Otherwise, colons (:) become dots (.). (File and FTP only) If this field is not empty, Ensemble creates a copy of each HL7 message received via this business service and saves it as a file in the specified ArchivePath. The archived filename is the same as the input filename. The number of seconds to wait before looking for more input. For further information about any setting, hovering the cursor over the setting name, or consult these references: • “Adapter Settings” in the “FTP Inbound Adapter” chapter of Using FTP Adapters with Ensemble • “Adapter Settings” in the “File Inbound Adapter” chapter of Using File Adapters with Ensemble • “Adapter Settings” in the “TCP Inbound Adapter” chapter of Using TCP Adapters with Ensemble, which describes the settings for the general-purpose TCP inbound adapter. The difference 30 Ensemble HL7 Version 2 Development Guide
HL7 Custom Schema Categories for the special-purpose adapter called EnsLib.HL7.Adapter.TCPInboundAdapter is that it has JobPerConnection set to False, which is usually appropriate for HL7. • The “Using the HTTP Inbound Adapter” chapter in Using HTTP Adapters with Ensemble 2.3.3 Integrating an HL7 Business Service To integrate a new HL7 business service into an Ensemble production, you must associate it with the routing process or business operation to which it relays messages. Additionally, if you expect the business service to receive non-standard message structures you will need to create a custom HL7 schema definition to parse and validate these messages. To do this: 1. Complete the instructions for creating any TargetConfigNames or Message Schema Category items that your HL7 business service needs. The items might be: • An HL7 routing process (for a routing interface) • An HL7 business operation (if your design bypasses a routing process for this interface and simply relays messages from the incoming business service to the outgoing business operation) • A custom HL7 schema definition, to parse the incoming HL7 messages The next several topics provide instructions for creating these items. 2. Return to the configuration diagram on the [Ensemble] > [Productions] page. Select the new HL7 business service. If the TargetConfigNames and Message Schema Category fields were previously blank, configure them now, and Apply your changes. 2.4 HL7 Custom Schema Categories The HL7 standard is easily extensible, and many of the clinical applications that produce and consume HL7 data take advantage of this feature. The common practice in customizing HL7 is to add custom segments to an otherwise standard HL7 message structure. By convention, the custom segments have names that begin with the letter Z (ZEK, ZPM, etc.), so custom segments are called Z-segments. A custom message structure often consists of a standard message with a few Z-segments added to it. If a clinical application uses no non-standard messages, there is no need to create a custom schema. However, this is rarely the case. For non-standard message structures, a custom schema is needed in order for Ensemble to be able to: • Perform structural message validation • Use segment and field path names in BPL, DTL, and routing rule syntax. Ensemble HL7 Version 2 Development Guide 31
Page 1 and 2: Ensemble HL7 Version 2 Development
Page 3 and 4: Table of Contents About This Book .
Page 5 and 6: 4.2.2 Square Bracket [] Syntax ....
Page 7 and 8: List of Figures HL7 Interface in En
Page 9: About This Book This book is one of
Page 12 and 13: Design Model for a Routing Producti
Page 27 and 28: 2 Elements of a Routing Production
Page 29 and 30: Namespaces 2. The business service
Page 31 and 32: HL7 Business Services Note: You can
Page 33 and 34: HL7 Business Services • Choose Ot
Page 35 and 36: HL7 Business Services Adapter Class
Page 37: HL7 Business Services • A standar
Page 41 and 42: HL7 Custom Schema Categories • Cl
Page 43 and 44: - Give the routing process a config
Page 45 and 46: HL7 Routing Processes • If the li
Page 47 and 48: HL7 Sequence Manager • Right-clic
Page 49 and 50: Suppose the sequence manager is pro
Page 51 and 52: HL7 Sequence Manager - MSH:13 Seque
Page 53 and 54: The following figure illustrates th
Page 55 and 56: Routing Rule Sets for HL7 On the ri
Page 57 and 58: Routing Rule Sets for HL7 • Schem
Page 59 and 60: Routing Rule Sets for HL7 Document.
Page 61 and 62: after the first one should be defin
Page 63 and 64: DTL Data Transformations for HL7 Im
Page 65 and 66: In Caché Basic, the concatenation
Page 67 and 68: Additionally, you might want to sen
Page 69 and 70: You may configure an HL7 business o
Page 71 and 72: • _ is the literal underscore cha
Page 73 and 74: Pager and Email Alerts For further
Page 75 and 76: HL7 Search Tables Built-in Search T
Page 77 and 78: • Click on the General tab. Selec
Page 79 and 80: HL7 Search Tables {1:4}_"|"_{1:3}
Page 81: HL7 Search Tables XData SearchSpec
Page 84 and 85: Settings for a Routing Production A
Page 86 and 87: Settings for a Routing Production 3
Page 88 and 89:
Settings for a Routing Production H
Page 90 and 91:
Settings for a Routing Production m
Page 92 and 93:
Settings for a Routing Production T
Page 94 and 95:
Settings for a Routing Production 2
Page 96 and 97:
Settings for a Routing Production 2
Page 98 and 99:
Settings for a Routing Production F
Page 100 and 101:
Settings for a Routing Production P
Page 102 and 103:
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Syntax for a Routing Production HL7
Page 110 and 111:
Syntax for a Routing Production •
Page 112 and 113:
Syntax for a Routing Production (mu
Page 114 and 115:
Syntax for a Routing Production 4.2
Page 116 and 117:
Syntax for a Routing Production msg
Page 118 and 119:
Page 120 and 121:
Syntax for a Routing Production HL7
Page 122 and 123:
Page 124 and 125:
Syntax for a Routing Production Whe
Page 126 and 127:
Syntax for a Routing Production Ens
Page 128 and 129:
Syntax for a Routing Production 4.4
Page 130 and 131:
Syntax for a Routing Production Att
Page 132 and 133:
Syntax for a Routing Production Alt
Page 134 and 135:
Viewing and Transforming Messages 5
Page 136 and 137:
Viewing and Transforming Messages W
Page 138 and 139:
Viewing and Transforming Messages E
Page 140 and 141:
Viewing and Transforming Messages P
Page 142 and 143:
Viewing and Transforming Messages E
Page 144 and 145:
Viewing and Transforming Messages c
Page 146 and 147:
Viewing and Transforming Messages
Page 148 and 149:
Page 150 and 151:
Viewing and Transforming Messages T
Page 152 and 153:
Page 154 and 155:
Converting Interfaces to Ensemble H
Page 156 and 157:
Converting Interfaces to Ensemble T
Page 158 and 159:
Converting Interfaces to Ensemble 4
Page 160 and 161:
Converting Interfaces to Ensemble s
Page 162 and 163:
Page 164 and 165:
show all

Ensemble HL7 Version 2 Development Guide - InterSystems ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?