HL7 V2 Global Message Profile Library
HL7 v2 GlobalMessage Profile LibraryUser's GuideProvided by theHL7 Conformance SIGJanuary 18, 2003
HL7 v2 Global Message Profile LibraryTable of ContentsGETTING STARTED . 1INTRODUCTION . 1PROFILE DOCUMENT VALIDATION . 2USERS GUIDE . 2SUBMISSION FORM . 3PURPOSE . 3FORM CONTENT . 3FORM FIELDS . 5XML DOCUMENT FIELDS . 5SUBMIT BUTTON . 7PROFILES. 8PURPOSE . 8PROCEDURE . 8SUBMISSION DETAILS. 9VIEW. 10DOWNLOAD . 11EDIT PROFILE . 12E-MAIL SUBMITTER. 13USERS OF THE PROFILE . 13ADD USER . 14WITHDRAW PROFILE . 16ARCHIVE. 18PURPOSE . 18PROCEDURE . 18SEARCH. 19PURPOSE . 19PROCEDURE . 19SORT ORDER . 20COMMENTS/SUGGESTIONS . 21PURPOSE . 21PROCEDURE . 21MESSAGE PROFILE DOCUMENT DEFINITION . 22PURPOSE . 22PROCEDURE . 22SCHEMA ELEMENT DEFINITIONS . 22SCHEMA (V2.5 BALLOT) . 31REMOTE SUBMISSION TO LIBRARY. 41PURPOSE . 41PROCEDURE . 41EXAMPLE . 42Successful submit . 42Unsuccessful submit. 42REMOTE QUERY FROM THE LIBRARY. 43PURPOSE . 43Page ii Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryPROCEDURE . 43NOTES. 44EXAMPLE . 45Example query . 45Example result . 45SAMPLE MESSAGE PROFILES. 47FULL ACK MESSAGE PROFILE . 47PARTIAL ADT A01 MESSAGE PROFILE . 51 Health Level Seven, HL7 Conformance Handbook, 2003. All rights reserved.Page iii
HL7 v2 Global Message Profile LibraryGetting StartedINTRODUCTIONThe HL7 v2 Global Message Profile Library (Library) is available for HL7 members via the members-only e reader is referred to section 2.12 of the HL7 v2.5 specification for details about Conformance using MessageProfiles. For detailed background information regarding message profiles, the reader is referred to the ConformanceSIG balloted informative document, “Message Profiling Specification, Version 2.2”, published November 30, 2000,upon which this section is based. This document is available from the HL7 Conformance SIG Web site(http://www.hl7.org).Beyond the benefits accrued by two or more parties who define and use the same message profile are the benefitsthat could be accrued to larger communities-of-interest in having a definitive pool of message profiles from which tochoose and ultimately coalesce. Ultimately, the less interface tweaking that must occur between two or more parties,by each party, multiple times, the less costly the development and maintenance. Reusing existing message profileswill reduce the ongoing need for interfaces to be tweaked for each communication between two parties. HL7 v2Global Message Profile Library provides a catalog (or pool) of message profiles. A valid message profile is assigneda unique identifier (OID), if one is not provided, and is then registered. The HL7 Global Message Profile Librarycan be found at http://www.hl7.org/memonly/conformance/.The first screen presented to the user upon entering the Library is the list of Profiles. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 1
HL7 v2 Global Message Profile LibraryPROFILE DOCUMENT VALIDATIONThe message profile is validated against a Message Profile Schema that checks to see if the rules of the schema arefollowed. A message profile must validate to the schema to be registered in the Library. A Document TypeDefinition (DTD) is also available for use; however validation to the DTD is not sufficient for registration into theLibrary. Note that the rules delineated by the Message Profile Schema constitute the normative requirements for amessage profile, whereas the rules delineated by the DTD are considered informative. (See Sections 2.12 and 2.19 ofthe HL7 V2.5 standard)The Message Work Bench (MWB) automates the development of HL7 version 2.x message profiles. It is based onthe Message Profiling Specification and the v2.5 ballot Chapter 2 Conformance Section. The MWB creates an XMLdocument that represents the message profile. It is this XML document that will be validated and registered withHL7. This application can be downloaded directly from www.hl7.org ( Special Interest Group Conformance documentation). In order to support the longevity of the MWB, work is in progress to create an open source groupthat manages this free tool.HL7 does not perform certification of implementations against a message profile. A third party certification service,such as the Australian Healthcare Messaging Laboratory (AHML), can be used to perform certifications ofimplementations against message profiles. HL7 does not formally recognize any third party certification service.For more information regarding the AHML, please see www.ahml.com.auUSERS GUIDEThe Users Guide can be viewed from many of the web pages by clicking on the “Users Guide” hyperlink. Todownload this, “right-click” on the “Users Guide” hyperlink and select the “save target as.” from the menu.Page 2 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibrarySubmission FormPURPOSEThe purpose of this form is to register the Message Profile with HL7.FORM CONTENTThe following screen appears when the Submission Form is selected.The User Guide hyperlink will open a copy of this document in another browser window.The Current schema hyperlink will open a copy of the Message Profile Schema in another browser window. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 3
HL7 v2 Global Message Profile LibraryEither of these documents may be downloaded by “right clicking” the hyperlink and select “save as” to select alocation for storing the document.The following is a fully completed form.Page 4 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryFORM FIELDSThe contents of these form fields will override the contents of the XML document.FieldDateOrganizationHL7 AffiliateSubmitter’s First NameSubmitter’s Last NameE-mailPhoneFaxCommentsExternal DocumentAssociated ProfilesDescriptionThe current date is automatically providedThe login organization is provided and may be updated.The HL7 affiliate members provide affiliate nameThe login first name is provided and may be updatedThe login last name is provided and may be updatedE-mail address for the purpose of allowing questions by otherpotential users of the profile.Phone number where submitter can be reached during normalbusiness hours.Fax number where submitter can be reached during normalbusiness hours.Further describes of the Static Message ProfileThe Xml document containing the Static Message ProfileAny previously registered profiles to which this profile should beassociated to fully communicate a dynamic interaction.XML DOCUMENT FIELDSThe following fields will be populated based on the contents of the XML tIDTriggerHL7v2xStaticDefEventTypeZ v2xStaticDefOrderControl Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.DescriptionThe version number of theHL7 standard. The userselects from a pull-downlist.The HL7 message typecode, usually MSH-9.1(see HL7 Table 0076 Message type). The userselects from a pull-downlist.The HL7 messagestructure code, usuallyMSH-9.3 (see HL7 Table0354 - Message StructureType). The user selectsfrom a pull-down list.The HL7 event type code,usually MSH-9.2 (see HL7Table 0003 - Event type)The 2nd and 3rd charactersof a Z trigger event notfound in the pull down listunder Trigger (this will bedynamically added oncethis profile is successfullyregistered).The HL7 Order controlcode, usually ORC 1.Page 5
HL7 v2 Global Message Profile LibraryFieldProfileLevelPage ceType Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.DescriptionTwo selections areallowed:o Constrainable (If anyitem within the profileis optional; notimplementable;requires furtherconstraints)o Implementation (If theprofile has every itemspecified, e.g.,implementablewithout the need ofsite negotiation).
HL7 v2 Global Message Profile LibrarySUBMIT BUTTONAfter the Submission Form is completed, click the Submit button. When the document is successfully submitted, aunique identifier (OID) will be automatically generated if not present in the profile dooucment.The identifier is a means to uniquely identify the static definition portion of a message profileNote: The registration authority represents the branch from ISO to HL7 Global Message Profile Library and isspecified as joint-iso-ccitt(2) country(16) US(840) organization(1) hl7(113883).conformance(9).Once the Message Profile Registration database is updated, the Add User screen is presented. Refer to that sectionfor details.To see a list of Profiles, click on the “Profiles” hyperlink from the horizontal menu of the tool. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 7
HL7 v2 Global Message Profile LibraryProfilesPURPOSEThis function presents a list of the active registered Message ProfilesPROCEDURESelect the “Profiles” hyperlink from the horizontal menu of the tool.The following is an example of the first screen that appears when selecting the Profiles function.The profiles are displayed sequentially by identifier. The order can be altered by selecting one or more up/downarrows in the column headings. Only active (not withdrawn) profiles will be displayed.Page 8 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibrarySUBMISSION DETAILSThe following screen is a result of clicking on the identifier hyperlink for the profile.To E-mail Submitter, click on the “e-mail” hyperlink.To display the formatted version of the profile, click on the “View” hyperlink. To view the profile using yourInternet browser’s XML parser, click on the “Download” hyperlink. Alternatively, the Profile document can bedownloaded to the local system by “right clicking” on the Download hyperlink and selecting “save target as.”.The Users of the Profile can be viewed by selecting the “Used By” hyperlink.If the user has permissions to edit or withdraw this message profile, they will see the Edit Profile and WithdrawProfile hyperlinks. Select the appropriate hyperlink. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 9
HL7 v2 Global Message Profile LibraryVIEWWhen the user selects the “View” hyperlink, a stylesheet is applied to the message profile XML document to providea formatted display. This method will be reviewed with various browsers (of different version) and operatingsystems to ensure all users can view this profile.Page 10 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryDOWNLOADWhen the user selects the “Download” hyperlink, the XML document is presented according to the browser’scapabilities. Below is how the most recent version of Microsoft Internet Explorer would display this. Users maydownload this to their hard drive by using their browser’s “file save as” capabilities. Another download option is to“right click” on the Download hyperlink and select “save target as” on the menu. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 11
HL7 v2 Global Message Profile LibraryEDIT PROFILEAn edit button on this screen, only available to submitter, other members from the submitter’s organization,Conformance SIG co-chairs, and HL7 headquarters, allows them to edit/add/modify the following fields for theProfile:oooooSubmitter informationCommentsLinks to more informationKeywordsAssociated OIDsAny other modifications will require a new profile to be submitted.Page 12 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryE-MAIL SUBMITTERWhen an e-mail address hyperlink is selected, an e-mail dialog box is generated.Note: This assumes that an e-mail client application is available on the workstation and a valid e-mail profile isselected.USERS OF THE PROFILEBy clicking on the hyperlink representing the count for the number of users of the Profile, a list of those users isdisplayed.If there are no users (hyperlink was the number 0), your will be prompted to Add User.If there are users (hyperlink was a number greater than 0), a screen of the following format will appear:A user for the Profile can be added by selecting the Add User hyperlink from Profile Users list. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 13
HL7 v2 Global Message Profile LibraryADD USERThe following screen appears when the user requests to add a user for the Profile. Only the HL7 Member-Only logininformation is supplied.To add a new user fill out the form and press the submit button. The revised list of users is displayed.Page 14 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile Library. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 15
HL7 v2 Global Message Profile LibraryWITHDRAW PROFILEThe Profile can be withdrawn by selecting the Withdraw Profile hyperlink.Profiles will not be permanently removed, as an identifier may not be deleted. They will be flagged as “withdrawn”and moved to the archive list. The following screen is displayed.This will generate an e-mail to all the users of this profile giving them the details of this withdrawal. Only thesubmitter, someone from the submitter’s organization, Conformance SIG co-chairs, and HL7 Headquarters canwithdraw a message profile.Page 16 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryThe profile submission details are re-displayed. This time, notice the withdrawal information. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 17
HL7 v2 Global Message Profile LibraryArchivePURPOSEThe purpose of this feature is to view a list of Profiles that have been withdrawnPROCEDURESelect the “Archives” hyperlink from the horizontal menu.The following screen appears.Note: There is a known issue with the Download hyperlink missing.Page 18 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibrarySearchPURPOSEThe purpose of this function is to produce a list of Profiles based on certain criteria.PROCEDURESelect the “Search” hyperlink from the horizontal menu.The following form is displayed. See the Submission Form for documentation of the fields.Fill out the form based on your search criteria and then select the Search button. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 19
HL7 v2 Global Message Profile LibraryIf there are no Profiles matching the selection criteria, an empty table is produced.As with the Submission List, you can view theoSubmission Details by selecting the “OID” hyperlink,oView the XML document by selecting the “View” hyperlink,oDownload the XML document by right-clicking the “View” hyperlink and selecting “save target as.” from themenu,oUsers of the Profile by selecting the “Used By” hyperlink.Note: There is a known issue with the Download hyperlink missing.SORT ORDERThe default order for the display is by OID. Selecting the arrow in certain column headings can alter the order.Page 20 Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryComments/SuggestionsPURPOSEThe purpose of this function is to send comments or suggestions to HL7 headquarters regarding the Global MessageProfile Library.PROCEDURESelect the “Comments/Suggestions” hyperlink from the horizontal menu. An e-mail dialog box is generated. Fill outthe e-mail and send it.Note: This assumes that a client e-mail application is available on the workstation and a valid e-mail profile isselected. Currently, the e-mail displays karenvan@hl7.org as the “mail-to” address. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 21
HL7 v2 Global Message Profile LibraryMessage Profile Document DefinitionPURPOSEThe Message Profile Document Definition is balloted with the Conformance section in Chapter 2 (as of v2.5). It isrepresented in XML Schema Language. Between versions, the HL7 Conformance SIG may allow for updates to thisschema in order to allow Message Profiles to convey more information when approved by the SIG. The newschema will be uploaded to the library .PROCEDUREOnly message profile documents that validate to this Message Profile Schema will be registered into the library.Regardless of the tools used to generate the message profile XML document, it must be well-formed and be validbased on the Message Profile SchemaSCHEMA ELEMENT DEFINITIONSThe table below shows the XML elements and attributesXML Element/GroupChild of/member ofDefinitions/Values/Reference to v2.5An unambiguous specification of one or morestandard HL7 messages that have been analyzedfor a particular use case. It prescribes a set ofprecise constraints upon one or more standardHL7 messages. (See Section 2.12.1, Def/Values/ReferenceHL7VersionVersion of HL7 2.x upon whichthis profile is basedProfileTypeCategorizes the profile: Validvalues:Constrainable ImplementableSee Section 2.12.5 ProfileTypes)IdentifierA unique identifier for thisspecific version of this profileProvides information about the life-cycle of theHL7v2xConformanceProfile, as well as authorshipand control informationATTRIBUTESPage 22NameDef/Value/ReferenceNameProvides a name that clearlyand concisely defines theexchange Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryXML Element/GroupImpNoteChild of/member ns/Values/Reference to v2.5OrgNameSubmitter OrganizationVersionThe version identifier assignedto this profile by the author.StatusStatus of this profile asassigned by the author.TopicsPublish/subscribe topicsconvey aspects of themessage profile that may beused by publish/subscribesystems. See sections2.12.1.2 and 2.12.4.2.Implementation Notes provide a generaldescription about how the element it presents isintended to be used, as well as hints on using orinterpreting eHL7v2xConformanceProfileA use case model documents the scope andrequirements for an HL7 message profile or set ofmessage profiles. (See Section 2.12.2 Use casemodel)PurposeUseCaseIdentifies the reason and/or objectives for the usecaseActorUseCaseIdentifies and defines the entities involved in theuse-case. This includes the sending and receivingapplicationsPreConditionUseCaseIdentifies a circumstance that must hold true priorto the use-case being invokedPostConditionUseCaseIdentifies a circumstance that will hold true afterthe successful completion of the use-caseEventFlowUseCaseIdentifies a step within the chain of occurrencesthat lead to the successful completion of the usecase. This includes the exchange of messagesbetween applications.DerivedEventUseCaseDerived events for this use caseEncodingsHL7v2xConformanceProfileIdentifies all of the message encodingmechanisms supported by the profile. Nontraditional encoding mechanisms may be identifiedif desired. Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 23
HL7 v2 Global Message Profile LibraryXML Element/GroupChild of/member ofDefinitions/Values/Reference to v2.5EncodingEncodingsIdentified one of the encoding mechanismssupported by this profileDynamicDefHL7v2xConformanceProfileThe dynamic definition is an interactionspecification for a conversation between 2 or moresystems. See Section 2.13.3 Dynamic eAccAckSpecifies whether “HL7 acceptacknowledgementexpected/allowed”. Validvalues: AL NE SU ERAppAckSpecifies whether “HL7application acknowledgementsexpected/allowed”. Validvalues:AL NE SU\ERMsgAckModeIdentifies the type ofacknowledgment expected bythe sender of a message.Valid values:Immediate DeferredQueryMessageTypeIdentifies whether themessage is query-related, andif so, what type of querymessage it is. Valid values:NonQuery Query Respoonse PublishQueryModeIdentifies the type of querybeing performed. Validvalues:Batch RealTime BothProvides an identifier reference to the staticdefinition for one of the messages used by theprofile.This represents a detailed profile of a singlemessage. See Section 2.12.4 Static definition)ATTRIBUTESPage 24NameDef/Value/ReferenceMsgTypeThe HL7 message typecode, as identified in MSH9.1 (see HL7 Table 0076 Message type).EventTypeThe HL7 event type code,as identified in MSH-9.2(see HL7 Table 0003 Event type)MsgStructIDThe HL7 message structurecode, as identified in MSH9.3 (see HL7 Table 0354 - Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.
HL7 v2 Global Message Profile LibraryXML Element/GroupChild of/member ofDefinitions/Values/Reference to v2.5Message Structure Type)SegmentHL7v2xStaticDefOrderControlThe HL7 Order control code,as identified in ORC 1 (seeHL7 Table 0119 - OrderControl Codes).EventDescA description of the eventcarried by this messageIdentifierA unique identifier for thisspecific version of this staticdefinition. If not specified,one will be assigned to theprofile upon submission to aregistryRoleIdentifies whether the profileis constructed from theperspective of the messagegenerator (Sender) or parser(Receiver). Default is'Sender'.Documents the characteristics of a single HL7segment within the context of a particular messageor segment groupATTRIBUTESNameDef/Value/ReferenceNameThis is the short, formalname for the segment.LongNameThe group name approvedby the technicalUsageRefers to thecircumstances underMinThis identifies theminimum number ofMaxThis identifies themaximum number of Health Level Seven, HL7 Conformance SIG, 2003. All rights reserved.Page 25
HL7 v2 Global Message Profile LibraryXML Element/GroupChild of/member ofDefinitions/Values/Reference to v2.5Section 2.12.6.1Cardinality)DataValuesFieldIdentifies an individual example value (valid onlyfor leaf level elem
HL7 v2 Global Message Profile Library User's G
HL7 Messaging Tool - EHR Vendor All new products will be listed under Your Product List. To start validating products go to the Validating EHR Projects/Versions section under Validating HL7 Messages. Validating HL7 Messages This section will go into detail on how to validate each EHR Product, Group HL7 Messages, and Practice HL7 Messages.
(EHR) system, and creating a data model for that database is challenging due to the EHR system's special nature. Because of complexity, spatial, sparseness, interrelation, temporal, . Entry PACS Billing HL7 & DICOM HL7 HL7 HL7 HL7 HL7 IJCSI International Journal of Computer Science Issues, Vol. 9, Issue 5, No 1, September 2012
6.5.2015 DHSS HESS HL7 Implementation Guide Release 1.3 7 2 General HESS Message Infrastructure 2.1 Basic HL7 Terms Table 2.1 Basic HL7 Terms Term Definition Message A message is the entire unit of data transferred between systems in a single transmission. It is a series of segments in a defined sequence, with a message type
HL7 C-CDA v1.1 MU 2014 HL7 C-CDA v2.0 HL7 C-CDA v2.1 MU 2015 2011 Edition/Stage 1 MU 2014 Edition/Stage 2 MU: – HL7 Implementation Guide for CDA Release 2: IHE Health Story Consolidation, DSTU Release 1.1 (US Realm) Draft Standard for Trial Use – HL7 Implementat
Co-Chair, HL7 Clinical Quality Information Workgroup . Kanwarpreet Sethi - Lantana Consulting Group Co-Chair, HL7 Clinical Quality Information Workgroup Presented at HIMSS17 - HL7 Educational Sessions Orlando, Florida February 20, 2017 . Health IT Enabled Quality Measurement and Improvement: The HL7 Clinical Quality Information Workgroup
This is the first HL7 interface that MCIR has developed. Query and other bidirectional interface options will be developed soon and will be documented in an updated version of this document. How to Format Data MCIR currently supports the following versions of HL7 formatted messages: HL7 v2.5.1 Preferred format. HL7 v2.3.1 Supported format
The HL7 2.5.1 Standard contains the order and structure of data fields in . This Florida Department of Health specification guide should not be used as a tutorial for either HL7 or electronic interfaces, in general. The reader and laboratory trading partners are expected to have a basic understanding of interface concepts, HL7, and electronic .
HL7 Finland (est.1995): long history in HL7 messages and IGs, active technical committees, integrated IHE and personal health SIGs, etc. One of the very first implementation of HL7 CDA (2004-5) . an embedded PDF meets the requirements of Specialized IGs
