Health Standards

Healthcare & Technology Resources

  • Blog
  • Podcasts
  • #HITsm Chat
  • About
  • Authors

Interface Documentation: Huh? What? Come Again?

September 20, 2011 By Sonal Patel Leave a Comment

As a service provider, you might have requested documentation from a vendor. As a vendor, you may be searching for documentation regarding a specific client install. Either way, you are looking for some information that helps you do your job (i.e., implementing, supporting, changing or fixing an interface).

To that end, what is the documentation needed for an interface implementation? Is there something different needed to support the interface long-term?

Let’s begin with identifying the types of documentation vendors and providers produce:

  • Project scope
    • Interface description
    • What’s the business requirement?
    • Workflow descriptions
    • What is the functionality that is being automated in an interface?
  • HL7 specifications
    • Inbound data
    • Outbound data
  • Gap analysis
    • Documents gaps between the comparison of 2 vendor specifications
  • Sample messages
  • Message flow diagrams
  • Message transformation/mapping/filtering/routing logic
  • Test plan
  • Go-live plan
  • Downtime plan
  • Run-time archive or message logs

You will rarely have access to all of these document types on a specific interface; but, honestly, you probably don’t need all these documents at any given time. Based on the task at hand, some specific information can be very helpful.

In my interfacing experience, I have found that sample messages are the most valuable during the interface development phase (see Three Things to Keep in Mind When Developing an HL7 Interface), especially when you have the proper technology. Sample messages reflect the actual data a system can export or import into their application.

For long-term support of an interface, the truth again lies in the messaging. Having access to the actual messages via archived message logs, received from an application or sent to an application makes troubleshooting easier. You can quickly identify which side of the interface needs to be addressed.

Of course, the technical aspects of an interface are only a piece of the puzzle. I always say that the work flow of an interface is typically 75% of the project. It is helpful to have the scope document with the business requirements and workflow diagrams to help build and test the interface correctly.

The reality of the interfacing world is that we will have to make “it” work without documentation sometimes. At that point, I rely on my integration tools to help document the interface for the future.

As you go forth in the interfacing world … may the force be with you.

The following two tabs change content below.
  • Bio
  • Latest Posts

Sonal Patel

Sonal N. Patel, MBA, BS, MT(ASCP) has extensive experience working in healthcare from both the provider and vendor perspective. Prior to Corepoint Health, she served as a Medical Technologist and Laboratory Supervisor at Roche Diagnostic/Golden Triangle Regional Medical Center/Baptist Memorial Hospital and also operated in several client services, support and training roles at Antrim/Sunquest/Misys Healthcare Systems.

Latest posts by Sonal Patel (see all)

  • Interface Documentation: Huh? What? Come Again? - September 20, 2011
  • Radiology Workflow: Integrated - May 10, 2011
  • HL7 Acknowledgements and Interface Pacing - January 18, 2011

Filed Under: Healthcare Integration, Healthcare IT, Healthcare Standards, HL7 Basics, HL7 Integration, HL7 Standards, Integration Insights Tagged With: HL7, interface

API White Paper

Connect

  • 
  • 
  • 
  • 
Tweets by @HealthStandards

#HITSM Chat

[#HITsm chat 11.18.16] Celebrate Passing the #HITsm Torch

November 15, 2016

Moderated by Chad Johnson, @OchoTex, HealthStandards.com Editor and Corepoint Health Senior Marketing Manager. November 18th will be the last #HITsm chat under @HealthStandards. Celebrate ‘Passing the #HITsm torch’ to @techguy @HealthcareScene.

Passing the #HITsm torch

November 10, 2016

The first #HITsm tweet chat was held almost six years ago on Jan 10, 2011. Since that time, we have hosted approximately 280 #HITsm chats. While some of you may have participated in that very first chat (only 15 actually participated), I’m proud to say that the chats and the community have continued to grow […]

View More #HITSM Chat >

Podcasts

‘Hactivist’ Fred Trotter on the Cancer Moonshot, open source data in healthcare, and more

August 3, 2016

Artificial intelligence is a topic that isn’t going away in the health IT and medical community. One reason it’s come as far as it has is thanks to open sourcing, or shared data. Today’s guest, Fred Trotter, has a lot to say about the Vice President’s Cancer Moonshot initiative – which he was recognized for […]

Sue Schade on gender equality, CIO challenges, and value-based healthcare

July 27, 2016

View More Podcasts >

Copyright © 2019 Health Standards. All Rights Reserved.