cdar2 ig supplement to ihe consolidated templated guide attachme… · web viewthis information...
TRANSCRIPT
AS_CDATEMPGD_R2_INFORM_20165JANDEC
HL7 Attachment Supplement Specification:
Exchange Implementation Guide Release 1For use with:
HL7 Implementation Guides for CDA® Release 2: Consolidated CDA Based Templates for Clinical Notes Volume 1 Introductory Material
DEC Jan 20165
HL7 Informative Document: Ballot
Sponsored by:Attachments Work Group
Durwin Day, Co-Editor/CoChairCraig Gabron, Co-Editor/CoChair
Robert Dieterle, Co-Editor Deborah Meisner, Co-EditorLaurie Burckhardt, Co-Editor
Copyright © 2015 Health Level Seven International ® ALL RIGHTS RESERVED. The reproduction of this material in any form is strictly forbidden without the written permission of the publisher. HL7 International and Health Level Seven are registered trademarks of Health Level Seven International. Reg. U.S. Pat & TM Off.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 1December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
I MP O R TA N T N OT E S :
HL7 licenses its standards and select IP free of charge. If you did not acquire a free license from HL7 for this document, you are not authorized to access or make any use of it. To obtain a free license, please visit http://www.HL7.org/implement/standards/index.cfm .
If you are the individual that obtained the license for this HL7 Standard, specification or other freely licensed work (in each and every instance "Specified Material"), the following describes the permitted uses of the Material.
A. HL7 INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS, who register and agree to the terms of HL7’s license, are authorized, without additional charge, to read, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part without paying license fees to HL7. INDIVIDUAL, STUDENT AND HEALTH PROFESSIONAL MEMBERS wishing to incorporate additional items of Special Material in whole or part, into products and services, or to enjoy additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS as noted below, must become ORGANIZATIONAL MEMBERS of HL7.B. HL7 ORGANIZATION MEMBERS, who register and agree to the terms of HL7's License, are authorized, without additional charge, on a perpetual (except as provided for in the full license terms governing the Material), non-exclusive and worldwide basis, the right to (a) download, copy (for internal purposes only) and share this Material with your employees and consultants for study purposes, and (b) utilize the Material for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, Compliant Products, in all cases subject to the conditions set forth in this Agreement and any relevant patent and other intellectual property rights of third parties (which may include members of HL7). No other license, sublicense, or other rights of any kind are granted under this Agreement. C. NON-MEMBERS, who register and agree to the terms of HL7’s IP policy for Specified Material, are authorized, without additional charge, to read and use the Specified Material for evaluating whether to implement, or in implementing, the Specified Material, and to use Specified Material to develop and sell products and services that implement, but do not directly incorporate, the Specified Material in whole or in part. NON-MEMBERS wishing to incorporate additional items of Specified Material in whole or part, into products and services, or to enjoy the additional authorizations granted to HL7 ORGANIZATIONAL MEMBERS, as noted above, must become ORGANIZATIONAL MEMBERS of HL7.
Ownership. Licensee agrees and acknowledges that HL7 owns all right, title, and interest, in and to the Materials. Licensee shall take no action contrary to, or inconsistent with, the foregoing.
Licensee agrees and acknowledges that HL7 may not own all right, title, and interest, in and to the Materials and that the Materials may contain and/or reference intellectual property owned by third parties (“Third Party IP”). Acceptance of these License Terms does not grant Licensee any rights with respect to Third Party IP. Licensee alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize Third Party IP in connection with the Materials or otherwise. Any actions, claims or suits brought by a third party resulting from a breach of any Third Party IP right by the Licensee remains the Licensee’s liability.
Following is a non-exhaustive list of third-party terminologies that may require a separate license:
Page 2 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Terminology Owner/ContactCurrent Procedures Terminology (CPT) code set
American Medical Association http://www.ama-assn.org/ama/pub/physician-resources/solutions-managing-your-practice/coding-billing-insurance/cpt/cpt-products-services/licensing.page?
SNOMED CT International Healthcare Terminology Standards Developing Organization (IHTSDO) http://www.ihtsdo.org/snomed-ct/get-snomed-ct or [email protected]
Logical Observation Identifiers Names & Codes (LOINC)
Regenstrief Institute
International Classification of Diseases (ICD) codes
World Health Organization (WHO)
Table of Contents1 IMPORTANT NOTES:......................................................................................................................... 2
PREFACE.................................................................................................................................................... 8
1.1 Revision History......................................................................................................................... 8
1.2 Acknowledgements.................................................................................................................... 8
2 INTRODUCTION................................................................................................................................. 9
2.1 Audience.................................................................................................................................... 9
2.2 Purpose...................................................................................................................................... 9
2.3 Scope....................................................................................................................................... 10
2.4 History...................................................................................................................................... 10
2.5 Approach.................................................................................................................................. 11
3 BACKGROUND................................................................................................................................. 12
3.1 Essential Reference Material...................................................................................................12
3.2 Understanding C-CDA.............................................................................................................12
3.2.1 Clinical Document Architecture (CDA)................................................................................12
3.3 ISO Object Identifiers (OID’s)...................................................................................................13
3.4 Structured/Unstructured Content..............................................................................................14
3.4.1 Structured Content..............................................................................................................15
3.4.2 Unstructured Content..........................................................................................................15
3.5 Content Types.......................................................................................................................... 16
3.6 Base 64 Encoding Content.......................................................................................................16
3.6.1 Standard for Base 64 Encoding..........................................................................................16
3.6.2 Uses of Base 64 Encoding..................................................................................................17
3.6.3 Base 64 Encoding Examples..............................................................................................17
4 ATTACHMENTS -- GENERAL...........................................................................................................17
4.1 Attachment Exchange..............................................................................................................17
4.1.1 Solicited and Unsolicited Attachments................................................................................17
4.1.2 Request Attachment Activity...............................................................................................18
4.1.3 Response Attachment Activity.............................................................................................19
4.1.4 Understanding Attachment Activities...................................................................................20
4.1.5 Attachment Request/Response Re-Association using Attachment Unique ID....................25
4.2 Standards to Accomplish Information Exchange of The Request and Response....................27
5 LOINC (LOGICAL OBSERVATION IDENTIFIERS NAME AND CODES).........................................28
5.1 Use of LOINC for Attachments.................................................................................................28
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 3December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
5.1.1 Obtaining LOINC and Other Resources From the Regenstrief Institute..............................29
5.2 Using the LOINC Code As An Identifier In Messages..............................................................30
5.3 Using the LOINC Database to Identify Valid Attachment Types...............................................30
5.3.1 Identifying Valid Attachment Types In The LOINC Table....................................................30
5.3.2 Identifying Valid Attachment Types Using RELMA and The Online LOINC Search Application (http://search.loinc.org).....................................................................................................31
5.4 Requesting LOINC Codes for New Attachment Types.............................................................33
5.4.1 Process for Requesting New Attachment Types.................................................................33
5.4.2 Updates to the LOINC database.........................................................................................33
6 REQUESTING/RESPONDING/SUBMITTING ATTACHMENTS.......................................................34
6.1 Unsolicited Attachment Exchange............................................................................................34
6.1.1 Unsolicited Attachments with Claims Submission...............................................................34
6.1.2 Unsolicited Attachments with Prior Authorizations..............................................................34
6.1.3 Unsolicited Attachments with Notifications..........................................................................34
6.1.4 Use of LOINC codes with Unsolicite Attachments...............................................................34
6.2 Solicited Attachment Exchange................................................................................................34
6.2.1 Request and Response for Claims Submission..................................................................34
6.2.2 Request and Response for Prior Authorizations.................................................................34
6.2.3 Use of LOINC codes with Request and Response for Attachments....................................34
6.2.4 Using “Modifier LOINC Codes” to constrain the Request....................................................34
6.3 Solicited Attachment Exchange................................................................................................35
6.4 Requesting/Responding/Submitting Attachments....................................................................35
6.4.1 Using LOINC Code to Request/Respond Attachment (Solicited)........................................35
6.4.2 Using LOINC Code to Submit Attachments (Unsolicited)....................................................37
6.4.3 Using “Modifier LOINC Codes” to Constrain The Request..................................................37
7 ATTACHMENT USE CASES.............................................................................................................39
7.1 Example – Claim Attachment...................................................................................................39
7.1.1 Claim Attachment – Solicited Attachment Example............................................................39
7.1.2 Claim Attachment – Unsolicited Attachment Example.........................................................40
7.2 Example – Prior Authorization Attachment...............................................................................41
7.2.1 Prior Authorization Attachment – Solicited Attachment Example........................................41
7.2.2 Prior Authorization Attachment – Unsolicited Attachment Example....................................42
7.3 Example – Referral Attachment...............................................................................................42
7.3.1 Referral Attachment – Solicited Attachment Example.........................................................42
7.3.2 Referral Attachment – Unsolicited Attachment Example.....................................................43
7.4 Example – Notification Attachment..........................................................................................45
7.4.1 Notification Attachment – Unsolicited Notice of Facility Discharge with Discharge Summary Example 45
Page 4 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
7.5 Example – Post Adjudicated Claim Attachment.......................................................................46
7.5.1 Post Adjudicated Claim Attachment – Solicited Attachment Example.................................46
8 IMPORTANT INFORMATION NOT PREVIOUSLY ADDRESSED IN THIS SUPPLEMENT .............48
APPENDIX A — DEFINITIONS, ABBREVIATIONS AND ACRONYMS................................................50
APPENDIX B — CONSOLIDATED CLINICAL DOCUMENT ARCHITECTURE RELEASE 2.1 (C-CDA R2.1).52
B.1 Overview of Implementation Guide..................................................................................................52
B.2 Document Templates....................................................................................................................... 52
B.3 LOINC Codes................................................................................................................................... 52
What are C-CDA Document Types?......................................................................................................53
APPENDIX C — CLINICAL DOCUMENTS FOR PAYERS – SET 1 RELEASE 1.1 (CDP1 R1.1). 56
C.1 Overview of Implementation Guide..................................................................................................56
C.2 Document Templates.......................................................................................................................56
C.3 LOINC Codes.................................................................................................................................. 56
What are C-CDA Document Types?......................................................................................................57
APPENDIX D — C-CDA DOCUMENT TRANSPORT AND PAYLOAD.................................................60
D.1 Transport Options............................................................................................................................ 60
D.2 Metadata requirements....................................................................................................................60
D.3 Overview of X12 (real-time).............................................................................................................61
D.3.1 Security Metadata..................................................................................................................... 61
D.3.2 Error Handling........................................................................................................................... 61
D. 4 Overview of a payload over CONNECT with ASC X12N Message.......................................62
D.4.1 ASC X12N 275 over CONNECT (CORE).................................................................................62
D.4.2 CONNECT SAML Assertions....................................................................................................64
D.4.3 IHE XD* Metadata..................................................................................................................... 64
D.5 Overview of a payload over CONNECT with XDR...........................................................................64
D.5.1 esMD Security Metadata...........................................................................................................71
D.5.2 Error Handling........................................................................................................................... 71
D.6 Overview of payload over Direct (X12 Message).............................................................................71
D.6.1 Overview of payload over Direct...............................................................................................72
APPENDIX E — ASC X12N STANDARDS TRANSACTION AND ERROR FLOW...............................74
APPENDIX F — FAST HEALTHCARE INTEROPERABILITY RESOURCES (FHIR)...........................76
F.1 What is FHIR.................................................................................................................................... 76
F.2 Introduction to FHIR Resources.......................................................................................................76
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 5December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
F.3 Use of FHIR to solict and exchange Attachments............................................................................76
Page 6 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Table of FiguresFigure 1: Example - Claims Attachment (Solicited)...............................................................................4042
Figure 2: Example – Claims Attachment (Unsolicited)..........................................................................4042
Figure 3: Example – Prior Authorization (Solicited)..............................................................................4143
Figure 4: Example – Prior Authorization (Unsolicited)..........................................................................4244
Figure 5: Example – Referral Attachment (Solicited)............................................................................4345
Figure 6: Example – Referral Attachment (Unsolicited)........................................................................4446
Figure 7: Example – Notification Attachment (Unsolicited)...................................................................4648
Figure 8: Example – Post Adjudicated Claim Attachment (Solicited)....................................................4648
Figure 7-1: X12 (real-time)..................................................................................................................... 6163
Figure 7-2: CONNECT with ASC X12N Specification............................................................................6365
Figure 7-3: CONNECT w/ X12 275........................................................................................................6567
Figure 7-4: Direct Message................................................................................................................... 7274
Figure 7-5: Direct Message................................................................................................................... 7274
Table of TablesTable 1: Request Attachment Activity Table.............................................................................................18
Table 2: ASC X12N Attachments Activity Table.......................................................................................22
Table 3: Attachments ID Re-association Table.........................................................................................26
Table 4: Request and Response LOINC Code Usage for Solicited Structured Attachments....................36
Table 5: Time Window Modifier LOINC Codes.........................................................................................38
Table 7-1: XD* Submission Set Metadata.................................................................................................66
Table 7-2: XD* Document Entry Metadata.................................................................................................67
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 7December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
1 . P R E FA C E
1.1 Revision HistoryThe following provides a historical view of the iterations for this document and why each major revision was made.
Date PurposeJanuary 2015 Version 1.0
March 10, 2015 Version 1.1 Updated references to C-CDA and CDP1 RCDNov 23, 2015 Version 2.0 Change Attachment use
November 30,2015
Version 3.2 move CDP1 and C-CDA Rx to Appendices, Move definitions to appendix, reorganize based on new outline
1.2 AcknowledgementsThe writers and editors of the HL7 Attachment Supplement Specification: Exchange Implementation Guide Release 1 want to acknowledge those who have provided years of hard work and dedicated efforts to bring forward the research and development needed to achieve the goal of information exchange amongst the healthcare industry stakeholders. This includes the current and past members of the Attachments Work Groups (formerly the Attachments Special Interest Group (ASIG)) and the Structured Documents Workgroup at HL7.The information needs of the industry that were identified and developed over the years became key input into the foundational content found in the HL7 Implementation Guides for CDA® Release 2: Consolidated CDA Templates.
Page 8 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
2 I N T R O D U C T I O N
The HL7 Attachment Supplement Specification: Exchange Implementation Guide Release 1 (hereafter referred to as “This Supplement”) is intended to be used in conjunction with the HL7 Implementation Guides for CDA® Release 2: Consolidated CDA Templates (hereafter referred to as C-CDA R2) to describe to HealthCare industry stakeholders how to implement components of the C-CDA R2 for the purposes described in this guide in section 2.2 below. C-CDA Implementation Guides will jointly refer to C-CDA R2, and CDA implementation guides based on C-CDA R2. The combined set of document level templates defined in the C-CDA Implementation Guides will be referred to as C-CDA Documents in this guide.
2.1 Audience
The audience for this Supplement is implementers (such as system architects and implementation developers) responsible for the exchange of Attachments between healthcare providers (hereafter known as ‘providers’), and health plans/utilization management organizations and/or their business associates (hereafter known as ‘payers’).
2.2 Purpose
This Supplement is intended to be used along with the C-CDA Implementation Guides and provides guidance to implementers as they develop the means for exchanging supporting information as defined in section 2.3.This Supplement will serve to direct implementers to the appropriate HL7 implementation standard used to format the content based on the clinical document being exchanged as an Attachment. Refer to the Sections 3.0 & 4.0 in the C-CDA Implementation Guides for additional information regarding levels of constraint, conformance statements, conformance verbs, cardinality, vocabulary conformance, and null flavor. This Supplement is independent of the method for exchange (e.g., transport, networking, connectivity, security/privacy).This Supplement will refer to healthcare supporting/additional information as Attachments. Additionally, a healthcare claim or encounter may be referred to as a Claim without mention of encounter and Healthcare Administrative Activities will include any or all of the activities as defined in section 2.3.
2.3 Scope
This Supplement is limited in focus to use of the C-CDA Documents to exchange clinical information between entities in an electronic clinical document. Examples of that exchange using existing standards are included, however, use of those standards as examples does not limit implementations to only those exchange standards.
This Supplement will also offers guidance for re-associating that clinical document with the healthcare administrative activity for which additional information was originally needed.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 9December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
This Supplement is limited in scope to those functions which support the exchange of healthcare information between providers and payers as part of the administrative business functions of both.
Page 10 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Examples of Healthcare Administrative Activities requiring this supporting information include, but are not limited to:
healthcare claim or encounter healthcare services review (e.g., prior
authorizations/precertifications, referrals, notifications) post adjudicated claim audits
2.4 History
The Administrative Simplification provision of the Health Insurance Portability and Accountability Act (HIPAA) of 1996 mandated the use of named healthcare electronic data interchange standards for the electronic conveyance of healthcare data that meets the business purposes specifically addressed under HIPAA. A Notice of Proposed Rule Making (NPRM) was issued in 2005 for Claims Attachments, but was withdrawn before a final rule was generated. In 2010, the Patient Protection and Affordable Care Act (ACA) re-instituted the original requirement under HIPAA for Attachments.
2.5 Approach
The HL7 Attachment Work Group (AWG) worked with payers and other industry stakeholders to identify the types of attachments needed to support claims and prior authorization of healthcare services.
The AWG collaborated with the Accredited Standards Committee (ASC) X12N Standard Development Organization (ASC X12) to define an electronic transaction that could be used to support the request for Attachments. The ASC X12 277 Health Care Information Status Notification Transaction Set was the most viable ASC X12 option.
The AWG determined that a proposed claims attachment standard combining the standards development efforts of ASC X12 and HL7 would be one of the possible options to support sending an Attachment. The proposed solution was the ASC X12 275 Patient Information Transaction Set with the HL7 Clinical Document embedded within the BDS/Binary segment.
The AWG determined it was in the best interest of providers and/or their vendors to support only one way for the exchange of the clinical information. Rather than one standard for the provider-to-provider information exchange and another for provider-to-payer information exchange, the AWG agreed to adapt their approach to leverage and be consistent with the C-CDA formatting of clinical documentation.
The C-CDA Documents by themselves do not fully satisfy the needs of the industry for Attachments. Additional metadata/enveloping is needed to assist in the correct pairing with a healthcare administrative activity and the Attachment itself. For this purpose, the Insurance Subcommittee of ASC X12 (ASC X12N) developed a suite of Technical Report Type 3 (TR3) documents for use with Attachments. Throughout this Supplement, references and examples of Attachment activity may cite specific ASC X12N TR3s developed for this purpose, however there is no intent by the authors of this Supplement to limit transport and messaging metadata/enveloping standards. (Refer to Appendix D).
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 11December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
3 B A C K G R O U N D
3.1 Reference Material
3.1.1 Getting Started
The Attachment Collaboration Project (joint effort with WEDI, ASC X12 and HL7) is developing a White Paper that will provide guidance on how to exchange attachments for claims and prior authorizations. The intent is to provide a single resource document for the industry to use which will identify when and where an implementer needs to obtain technical support from either HL7 or ASC X12.
This ACP White Paper intends to provide information about business, operational and technical processes to support standards and implementation specifications for Attachments (ASC X12N 275, 277, 278, and 837 TR3s and the relevant HL7 attachment standards) independent of versions or regulations.
Guidance on Implementation of Attachments for Healthcare Transactions HL7 Clinical Document Architecture (CDA) located on WEDI.
[3.1.2] HL7 Reference Material
The following list of reference materials are essential to implementing attachments and are located on the HL7.
HL7 CDA Quick Reference Guide HL7 Consolidated Clinical Document Architecture Release 2 (C-
CDA R2) HL7 Clinical Documents for Payers Set 1 (CDP1) HL7 Digital Signatures and Delegation of Rights Release 1 Logical Observation Identifiers Names and Codes (LOINC)
3.1.2[3.1.3] ASC X12N Reference Material
The version that should be used of the ASC X12N Technical Reports 3 published for the purposes of exchanging Attachments is the version named in regulation or agreed by trading partners in the absence of regulations. The following list of ASC X12N Technical Report Type 3 reference materials are essential to implementing attachments and associated transactions are located in the ASC X12 Store:
ASC X12N 277 Health Care Claim Request for Additional Information
ASC X12N 275 Additional Information to Support a Health Care Claim or Encounter
ASC X12N 278 Health Care Services Review – Request for Review and Response
ASC X12N 275 Additional Information to Support a Health Care Services Review
Page 12 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
ASC X12N 837 Health Care Claim: Professional (837-P) ASC X12N 837 Health Care Claim: Institutional (837-I) ASC X12N 837 Health Care Claim: Dental (837-D)
3.1.3[3.1.4] Additional Resources
XML for Dummies XML for Dummies 4th Edition
XML in 10 Minutes XML in 10 minutes
Various HL7, ASC X12 & WEDI presentations
3.1.4[3.1.5] Relationship of standards and Implementation Guides (IG)
The HL7 Clinical Document Architecture Release 2 (CDA R2) is based on the HL7 Reference Information Model and the W3C XML standard. Release 1.1 and 2 of the Consolidated CDA are both based on CDA R2 and are designated C-CDA R1.1 and C-CDA R2 respectively. This document, the Clinical Documents for Payers – Set 1 (CDP1), incorporates, by reference, many of the C-CDA R2 templates. C-CDA R1.1 is Draft Standard for Trial Use (DSTU). C-CDA R2 and CDP1 are balloted as DSTU. The Attachments Work Group created a Supplemental Implemenation Guide to describe how a payer requests a C-CDA document by LOINC code from a provider using an ASC X12N 277 or 278 transaction and receives it using the ASC X12N 275 transaction. This supplemental guide is an Informative Guide.
Figure 1: Relationship Of Standards and IGs
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 13December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
CDA R2 IG
Future IGs
ASC X12N277/275 TR3
ASC X12N278/275 TR3
Attachments Work Group
Supplemental Guide
(Informative)
Consolidated CDA IG R2 (DSTU)
CDP1 IG (DSTU)
Consolidated CDA IG R1.1 (DSTU)
RIM
XML (W3C Standard)
LOINC (Regenstrief)
3.2 Understanding C-CDA
This Section will explain the C-CDA Implementaiton Guides at a high level. Implementers should rely on the detail found in the individual guides to understand how to utilize each Standard.
3.2.1 Clinical Document Architecture (CDA)
The HL7 Version 3 Clinical Document Architecture (CDA®) is a document markup standard that specifies the structure and semantics of "clinical documents" for the purpose of exchange between healthcare providers and patients. It defines a clinical document as having the following six characteristics: 1) Persistence, 2) Stewardship, 3) Potential for authentication, 4) Context, 5) Wholeness and 6) Human readability.
A CDA can contain any type of clinical content -- typical CDA documents would be a Discharge Summary, Imaging Report, Admission History & Physical, Pathology ReportProgress Note and more. The most popular use is for inter-enterprise information exchange, such as is envisioned for a US Health Information Exchange (HIE).
CDA is a document markup standard that specifies the structure and semantics of a clinical document (such as a discharge summary or progress note) for the purpose of exchange. A CDA document is a defined and complete information object that can include text, images, sounds, and other multimedia content.
It can be transferred within a message and can exist independently, outside the transferring message. CDA documents are encoded in Extensible Markup Language (XML), and they derive their machine processable meaning from the RIM (HL7’s Reference Information Model), coupled with terminology.
The CDA R2 model is richly expressive, enabling the formal representation of clinical statements (such as observations, medication administrations, and adverse events) such that they can be interpreted and acted upon by a computer. On the other hand, CDA R2 offers a low bar for adoption, providing a mechanism for simply wrapping a non-XML document with the CDA header or for creating a document with a structured header and sections containing only narrative content.
The intent is to facilitate widespread adoption, while providing a mechanism for incremental semantic interoperability.
Information about the components for CDA is being presented at a high level and is intended to convey only what is necessary for the implementer to understand the application with respect to Attachments. Refer to the C-CDA Implementation Guides for technical guidance on implementation of CDA for Attachments.
A CDA document has two primary groupings of information, a header and a body:
The header (See Section 2.1 US Realm Header (V2) in the CDA R2 Volume 2 – Templates and Supporting Material for more detail)
o Identifies and classifies the document and o pProvides information on authentication, the encounter,
the patient, and the involved providers. o Note: the header will always be populated to the
specifications in C-CDA R2 or CDP1 whether the attachment is
Page 14 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
The body o Contains the clinical report, organized into sections
whose narrative content can be encoded using standard vocabularies.
o Can be represented using a nonXMLBody or a structuredBody element.
nonXMLBody is used when the content is an external file such as a TIFF image, MS RTF document, PDF, etc. The NonXMLBody class is provided for those applications that can do no more than simply wrap an existing non-XML document with the CDA Header.
structuredBody is used when the body will be XML structured content. XML structured content is always inserted into the structuredBody element, never as an external file. The StructuredBody contains one or more Section components.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 15December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
For the purposes of this Supplementthis supplement: A header paired with a structuredBody element will be referred to
as a “Structured Document”. A header paired with a nonXMLBody element will be referred to as
an “Unstructured Document”1.More information about CDA can be found on the HL7 website (www.hl7.org).
3.2.2 Consolidated Clinical Documentation Architecture (C-CDA)
The Consolidated Templated implementation guide contains a library of CDA templates, incorporating and harmonizing previous efforts from Health Level Seven (HL7), Integrating the Healthcare Enterprise (IHE), and Health Information Technology Standards Panel (HITSP). It represents harmonization of the HL7 Health Story guides, HITSP C32, related components of IHE Patient Care Coordination (IHE PCC), and Continuity of Care (CCD), and it includes all required CDA templates inFinal Rules for Stage 1 Meaningful Use and 45 CFR Part 170 – Health Information Technology: Initial Set of Standards, Implementation Specifications, and Certification Criteria for Electronic Health Record Technology; Final Rule.
The Consolidated CDA was produced and developed through the joint efforts of Health Level Seven (HL7), Integrating the Healthcare Environment (IHE), the Health Story Project, and the Office of the National Coordinator (ONC) within the US Department of Health and Human Services (HSS).
The project was carried out within the ONC’s Standards and Interoperability (S&I) Framework as the Clinical Document Architecture (CDA) Consolidation Project with a number of goals, one of which is providing a set of harmonized CDA templates for the US Realm.
In the development of the Consolidated Templates specification, the Consolidation Project team reviewed the eight existing HL7 Health Story guides, CCD, and the additional constraints from IHE, HITSP and Stage 1 Meaningful Use.
The Consolidation Project team members completed the analysis by creating a fully compliant CCD document, then layering in the additional HITSP, IHE and Stage 1 Meaningful Use constraints. When a new constraint introduced an issue, conflict or ambiguity, the item was flagged for review with the full consolidation team. The full analysis covered the CDA Header, section-level and entry-level requirements sufficient for Stage 1 Meaningful Use. The Project also reviewed document and section-level requirements for the full set of document types.
3.3 ISO Object Identifiers (OID’s)
OID is an acronym, used throughout HL7 specifications to mean ISO object identifier. ISO is the International Organization for Standardization ( http://www.iso.ch ) , and we will see below that the International Telecommunications Union (ITU, http://www.itu.int ) is also relevant. The HL7 OID registry, mentioned below, can be used to find, or create, OIDs for use in attachment implementations; and the mention of ISO and ITU is for background information only.
The CDA uses OIDs to uniquely specify where to find more information regarding a coded data value or an identifier for a person, organization, or other entity.
1 It is important to note that the header in either structured or unstructured scenarios is always considered structured and as such, available for computer processing(parsing) to occur with its content.
Page 16 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
An OID is a globally unique string consisting of numbers and dots (e.g., 2.16.840.1.113883.6.1032.16.840.1.113883.6.26090). This string expresses a tree data structure, with the left-most number representing the root and the right-most number representing a leaf.
Each branch under the root corresponds to an assigning authority. Each of these assigning authorities may, in turn, designate its own set of assigning authorities that work under its auspices, and so on down the line. Eventually, one of these authorities assigns a unique (to it as an assigning authority) number that corresponds to a leaf node on the tree.
OID’s present a systematic way to identify the organization responsible for issuing a code or entity identifier. HL7 is an assigning authority, and has the OID prefix "2.16.840.1.113883." broken down as follows:
(2) represents the OID was assigned by a joint ISO-ITU (16) represents assigning authority which is specific to the country (840) reflects the USA (1) is specific to the organization (113883) represents Health Level Seven (as the assigning authority).
Any OID that begins with this is further described by a registry maintained by the HL7 organization. For example, the OID 2.16.840.1.113883.6.2602.16.840.1.113883.6.103 90(above) was established by HL7 as a globally unique identifier for the ICD-910-CM code set for diagnoses.
Beyond that, the HL7 organization assigns any numbers - and these are maintained in a registry available on the HL7.org website. HL7 uses its registry to assign OIDs within its branch for HL7 users and vendors upon their request. HL7 is also assigning OIDs to public identifier-assigning authorities both U.S. nationally (e.g., the U.S. State driver license bureaus, U.S. Social Security Administration, US National Provider Identifier (NPI) registry, etc.) and internationally (e.g., other countries' social security administrations, citizen ID registries)
Additional reference information about OIDs, including the current directory of OIDs assigned by HL7, is available at http://www.hl7.org/oid/index.cfm . Organizations that wish to request an OID for their own use (e.g., to be able to create identifiers within a CDA document), may also obtain one from HL7 at this site.
[3.3] Structured/Unstructured Content Documents
Use of the CDA standard allows for a wide-range of implementation flexibility with respect to the implementer’s (CDA originator and consumer) technical abilities.
For most implementers, a CDA document may simply be rendered to a common internet XML aware browser using a stylesheet2, much like one might view a PDF on a personal computer application. Even in an Uunstructured Ddocument <nonXMLBody>, the Header may be partially rendered using a stylesheet. However, when exchanging information using the Uunstructured
2 A style sheet is a specification used by browsers for controlling the display of the markup language (e.g. XML or HTML), decribing how elements of a document should be displayed. The stylesheet in the C-CDA R2 (See Appendix C) and CDP1 (See Appendix X) are is provided by HL7 to the implementer as options and are not required to be used by the implementer. The implementer may choose to create their own customized stylesheet to render the information to a browser.HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 17December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Ddocument, this mechanism may not work without additional engineering. The body of this document must either be made referenceable by the browser in a URL schema it recognizes, or separately decoded into its binary format.
In the instance where the body type is in an Unstructured Document and the body content contains a media type (e.g., JPEG, GIF, PDF), that content would require additional software to interpret and render the encapsulated data using an appropriate viewer for the type of document (e.g., image viewer, adobe reader).
This requires several steps, including configuring the browser to display the non-HTML content if needed (e.g., for application/pdf, application/msword or text/rtf content), linking to externally referenced content, or linking to and decoding the embedded base-64 encoded content. In addition, considerations should be given to security concerns that might be introduced by displaying content which could include scripts.
The use of a stylesheet to render a CDA document to a browser sets a low technical bar for the receiver of a CDA document. No matter what the technical level of the originator, the receiver will have the choice of leveraging the originator’s highest level of technical sophistication or simply choose to render using a stylesheet and a browser. This will enable receivers of Attachments to interpret the content of a clinical document without having to be an expert on CDA.
Initially the limited capability of participants to support fully structured attachmentsStructured Documents and the need for further development of aattachment content requires the use of the unstructured content capability of the C-CDA based dDocuments. For Attachments, even though a Sstructured Ddocument template may be defined in C-CDA based Documents(attachment types where a document level template exists, excluding Unstructured Document), the use of the unstructured version of that document (e.g., nonXMLbody) is permitted. However, the required content defined for the equivalent structured document conformance must be present in the unstructured (nonXMLbody) document representation.
3.3.1 Structured Content
Each C-CDA Implementation Guide describes the respective document types and conformance requirements for each of the Sstructured Ddocuments listed in Appendix B and CF .of this supplement.
Conformance criteria for each of those document types, their sections and any applicable entries are found in the appropriate section of the C-CDA Implementation Guides.
3.3.2 Unstructured Content
In addition to the Sstructured Ddocument types described in Appendix B and Appendidix C there is a document which is available to be used for exchange of ANY document type. This is the Unstructured Document (described specifically in the C-CDA Implementation Guides).
Use of the unstructured document is intended to accommodate attachment types for which a structured format hasn’t been developed or is not supported by the sender. Structured Ddocument types MAY also be sent in an unstructured format (e.g., H&P Scanned Image, discharge summary PDF). It should be thought of as attachment types that would exist at the document level, and where appropriate, capable of being developed into a structured template.
In many environments much of the patient record is still captured in an unstructured format that is encapsulated within an image file or as unstructured text in an electronic file type such as MSWORD or PDF.
There is a need to raise the level of interoperability for these documents to provide full access to the a single encounter or a longitudinal patient record across a continuum of care. Until this gap is addressed, image and multi-media files will continue to be the method of sharing information in a
Page 18 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
portion of the patient record that remains difficult to access and share with all participants in a patient’s care. The Unstructured Document is here to bridge that gap.
The Unstructured Document:
Must be at the document level and should be limited to document types defined in Regenstrief’s LOINC database “external value set” (See section 5.5.1.1Section 5.3 “Using the LOINC Database to Identify Valid Attachment Types” for more information).
If a LOINC code is not available for your document type, please refer to Section 5.4.1 Process for Requesting New Attachment Types.
May include content for structured document types already defined in the C-CDA Documents Implementation Guidesas structured, but the Unstructured Document unstructured content should adhere to conformance statements for the Header.
3.3.3
[3.3.4] Supported File Formats Value Set
[3.3.5]
[3.3.6]
[3.3.7] Unstructured Document Content Types
Insert description here The following Table reflects the value set of the file formats supported by HL7 Implementation Guide for CDA®, Release 2: Unstructured Documents
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 19December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Table 1: Supported File Formats
Value Set: SupportedFileFormats 2.16.840.1.113883.11.20.7.1A value set of the file formats supported by the Unstructured Document IG.Value Set Source: http://www.hl7.orgCode Code System Code System OID Print Name
application/msword Media Type 2.16.840.1.113883.5.79 MSWORD
application/pdf Media Type 2.16.840.1.113883.5.79 PDF
text/plain Media Type 2.16.840.1.113883.5.79 Plain Text
text/rtf Media Type 2.16.840.1.113883.5.79 RTF Text
text/html Media Type 2.16.840.1.113883.5.79 HTML Text
image/gif Media Type 2.16.840.1.113883.5.79 GIF Image
image/tiff Media Type 2.16.840.1.113883.5.79 TIF Image
image/jpeg Media Type 2.16.840.1.113883.5.79 JPEG Image
image/png Media Type 2.16.840.1.113883.5.79 PNG Image
[3.4] Base 64 Encoding Content
[3.4.1] Purpose Insert esential refernce material here
[3.4.2] Standard forof Base 64 Encoding
The purpose of Base 64 Encoding is to eliminate characters and binary representation that may interfer with the messaging standards used to exchange a specific payload (in the case of this Supplement, the CDA). Base 64 Encoding uses an algorithm that transforms the payload into a specific set of 64 characters that are both members of a subset common to most encodings, and also printable. For example, MIME's Base64 implementation uses A–Z, a–z, and 0–9 for the first 62 values. Other variations share this property but differ in the symbols chosen for the last two values.Insert description here.
Standards
[3.4.3] Uses of for Base 64 Encoding
An Attachment is comprised of the CDA document, including any supporting files necessary to render the attested content of the document. Two Internet request for comments (RFCs) are needed to properly construct the mime multipart message. When supporting files are needed, the collection of information shall be organized using a MIME multipart/related package constructed according to RFC 2557. Within the MIME package, supporting files must be encoded using Base-64. RFC-4648 should be used when encoding the contents of the MIME package using Base-64. MIME Multipart/Related Messages
For additional information on the use of Base 64 Encoding and the creadtion of MIME packages, see the relevant section of the C-CDA R2 volume 1.
Insert description here.
[3.4.4] Base 64 Encoding Examples (from Wikipedia)
A quote from Thomas Hobbes' Leviathan (be aware of spaces between lines):
Page 20 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Man is distinguished, not only by his reason, but by this singular passion from other animals, which is a lust of the mind, that by a perseverance of delight in the continued and indefatigable eneration of knowledge, exceeds the short vehemence of any carnal pleasure.
is represented as a byte sequence of 8-bit-padded ASCII characters encoded in MIME's Base64 scheme as follows:
TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGludWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=
The Base64 index table:Valu
eCha
rValu
eCha
rValu
eCha
rValu
e Char0 A 16 Q 32 g 48 w1 B 17 R 33 h 49 x2 C 18 S 34 i 50 y3 D 19 T 35 j 51 z4 E 20 U 36 k 52 05 F 21 V 37 l 53 16 G 22 W 38 m 54 27 H 23 X 39 n 55 38 I 24 Y 40 o 56 49 J 25 Z 41 p 57 5
10 K 26 a 42 q 58 611 L 27 b 43 r 59 712 M 28 c 44 s 60 813 N 29 d 45 t 61 914 O 30 e 46 u 62 +15 P 31 f 47 v 63 /
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 21December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
[4 ] AT TA C H M E N T S - - G E N E R A L B U S I N E S S OV E RV I E W
[4.1] Attachment Exchange
This Supplement will touch on the business overview for additional information. For a more detailed explanation refer to the “Guidance on Implementation of Attachments for Healthcare Transactions” developed by the Attachment Collarboration Project.
In the course of doing business, payers may need additional information from a provider to determine if the service being billed or requested (prior authorization) is consistent with:
patient’s insurance benefits patient’s demographics (i.e., age, sex) general medical policies level of service being performed specific condition/diagnosis to include past history and/or
treatment that has already been completed, but was not effective
3.3.4 Claims Attachment Exchange
Upon receipt of a claim, the claims adjudication area within a payer organization may perform a review to determine if additional information is required. The payer may communicate a list of procedures and/or services that would require additional information ori In some situations the process may be automated based on predefined rules. The request for information is systematically generated and sent to the provider.
A payer, after adjudicating a claim, may decide to perform post-adjudication review. The payer may initiate a request for additional information.
3.3.5 Prior Authorization
Upon receipt of a request for prior authroization the utilization area within a payer organization may perform a review to determine if additional information is required. The payer may communicate a list of procedures and/or services that would require additional information for a prior authorization or in some situations the process may be automated based on predefined rules. The request for information is systematically generated and sent to the provider.
3.3.6 Referral
The Attachment may also be used in provider to provider exchange when a patient is referred for consultations, services, evaluations, etc. The referral is usually initiated by a primary care provider, but may be initiated by a payer or other entity. When information is not sent and additional information is needed, the “referred to” provider may request that pertinent information be sent (solicited).
Provider “A” is caring for a patient and refers that patient to a specialist (Provider “B”) for further assessment. Provider “A” sends a referral to Provider “B”. Provider “B” receives the request and, upon review, determines they need additional information from Provider “A” and sends them a request. Provider “A” responds with the Attachment.
Page 22 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
3.3.7 Notification
A Notification can be used to send unsolicited information among providers, payers, delegated UMO entities and/or other providers. This information can take the form of copies of health service reviews or notification of scheduled treatment, or the beginning and end of treatment. A participant who is the recipient of the information may acknowledge they received the data, or reject the data due to specific application layer processing, but may not respond with any review decision outcome. Notification falls into four categories:
Advance Notification used to communicate scheduled admissions or services.
Completion Notification used to communicate patient facility admission or discharge and services completion for any specific episode of care.
Information Copy used for any Health Services Review information sent to primary care provider(s), service provider(s), or other healthcare entities requiring the information for specific purposes.
Change Notification used to report changes to the detail of a previously sent notification or information copy.
The information source is the entity that knows the outcome of the service review request, and can be either a UMO or a provider. For example, in a situation where the primary care provider can authorize specialty referrals that do not require review for medical necessity, appropriateness, or level of care, the primary care provider is the information source and may have responsibility for notifying both the UMO and the service provider of the specialty referral. In cases where the UMO is the decision maker, the UMO would send a notice of certification to the requesting provider and the service provider.
3.4 Solicited and Unsolicited Attachments
[4.2] For the purposes of this Ssupplement, we will use the terms “solicited” and “unsolicited” to help clarify the scenarios for which one or more standards are to be used. The response, whether solicited or unsolicited, refers to the act of providing Attachments needed.
This guide takes no position with respect to the business reasons that initiate unsolicited attachments. However, industry best practices suggest that in the absence of business rules established in advance, attachment information should not be sent.
Solicited and unsolicited scenarios are tied closely to the response side of the attachment activity without regard to the mode of the request. They are also aligned closely with the entity establishing the Attachment re-association ID that is used to match the attachment itself with either the claim, referral, or prior authorization attachment activity (more about Attachment re-association ID in section 4.3.3 .
3.4.1[4.2.1] Solicited Attachments
A solicited Attachment refers to the act of requesting and/or responding with information which was requested after a healthcare entity determines a need for additional information to complete the healthcare administrative activity.
In the solicited scenario, the entity creating the request for additional information would assign an Attachment Unique ID used to re-associate the Attachment response to the original Attachment request. This Attachment Unique Identifier must be returned with the attachment response.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 23December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
3.4.2 Unsolicited Attachments
An unsolicited Attachment refers to the act of providing additional information that conforms to a set of rules-based criteria. invoked at the time of the submittal of a healthcare administrative activity. This information is basedThese guidelines are on advance knowledge of rules defined by the information receiverpayer through trading partner agreements or published criteria (i.e., policies, websites). The criteria may be for a certain type of claim for a specific health care provider, procedure, or service is known in advance to the provider. This Supplement takes no position with respect to the business reasons that initiate unsolicited attachments.
In the solicited scenario, the entity creating the request for Attachment additional information would assign an attachment IDAttachment Unique ID used to re-associate the Attachment response to the original aAttachment request. This Attachment Unique iIdentifier must be returned with the attachment response.
In the unsolicited scenario, the entity that is the source for the Attachmentprovider would assign a Uniquen Attachment ID. This Attachment identifier must be provided with the Attachment to be re-associated with the healthcare administrative activity.
3.5 Attachment Unique ID
An essential component of an attachment activity is the ability to re-associate the Attachment with the request through the use of an Attachment Unique ID. Depending on the attachment activity, the entity responsible for assigning an Attachment Unique ID will vary. When the Attachment is unsolicited, the Attachment Unique ID SHALL be used in both the Attachment and the enveloping metadata. When the Attachment is solicited, the Attachment Unique ID SHALL be used only in the enveloping metadata (for more information on enveloping metadata, see D.
Table 2 highlights how the Attachment Unique ID will be integrated into the attachment activity processes.
[4.3] This guide takes no position with respect to the business reasons that initiate unsolicited attachments. However, industry best practices suggest that in the absence of business rules established in advance, attachment information should not be sent.
[4.4] Request Attachment Activity
[4.4.1] Understanding Attachment Activities
This Supplement addresses the processes used in requesting additional information and responding with Attachments. Tables 2 and 3 are used to help illustrate these activities, Ssince the actor’s role will vary depending on the activity type, tablesTables 2 and 3 are used to help illustrate these activities. Each row in the tables represent an Attachment Aactivity based on a unique business flow.
Page 24 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Attachment information, by default, is considered to be at the clinical document level. In some cases, the requestor of attachment information may need information at the sub-document level (section or entry). In this case, development of guidance based on scenarios may be helpful to identify the most appropriate document type to request the needed information. Absent that guidance, it would be up to the requestor of attachment information to determine the most appropriate document type to use for the request.response.
3.5.1 Request Activity
A request for an additional information can originate in numerous ways and may be initiated by unique business events depending on the originating actor.
The Mode, method of requesting additional information, and Timing of the request is triggered by a request from the payer or based on pre-defined rules. The Unique Attachment ID is assigned to the Attachment either by the provider or the payer based on the Mode of the request.
3.5.2 Response Attachment Activity
The act of submitting additional information electronically is a response activity. A response may may be as a result of a request or based on predefined rules.
3.5.3 Attachment Unique ID
An essential component of an attachment activity is the ability to re-associate the Attachment with the request through the use of an Attachment Unique ID. Depending on the attachment activity, the entity responsible for assigning an Attachment Unique ID will vary. When the Attachment is unsolicited, the Attachment Unique ID SHALL be used in both the Attachment and the enveloping metadata. When the Attachment is solicited, the Attachment Unique ID SHALL be used only in the enveloping metadata (for more information on enveloping metadata, see Appendix D.
Table 2 highlights how the Attachment Unique ID will be integrated into the attachment activity processes.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 25December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
The table below reflects some of the more common scenarios for illustrative purposes:
Table 2: Request Attachment Activity Table
Healthcare Administrative
Activity
Request Unique Attachment ID Attachment
Activity Basis Mode Timing
Assigning Actor Reassociation
Claim
Request for additonal
information
After Claim is received and
reviewed by Payer Payer
Payer Request and provider Attachment
Solicited
Pre-defined Rules In advance of Claim submital Provider Provider Claim
and Attachment Unsolicited
Prior Authorization
Request for additional
information
After Prior Authorization is
received and reviewed by Payer
Payer Payer Request and provider Attachment
Solicited
Pre-defined Rule In advance of
Prior Authorization Request submittal
Provider Provider Prior Authorization request and Attachment
Unsolicited
Referral
Request for additional
information
After Referral is received and
reviewed by Payer Payer
Payer request and provider Attachment
Solicited
Rules Based In advance of Referral Provider
Provider referral request and additional
information submittal
Unsolicited
[4.4.2] Response Attachment Activity
The act of exchanging Attachments from an information source to an information receiver is considered a response3. The information source is considered the entity that creates the Attachment needed by the receiving entity to support the healthcare administrative activity.
3.5.4 ASC X12N Attachments Activity Attachment Scenario and Scope Attachment Activity Table 2 association to standards
Use of this table permits standards correlation to each of the Aactivity ID’s with a current ASC X12N TR3, or any other future standard(s) that perform a comparable function. Future regulation could expand to other standards comparable to the ASC X12N TR3s, to which the aActivity ID could correlate.
3
Page 26 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
As described later in tThere are multiple standards available in the industry to accomplish the exchange of information for attachment purposes (e.g., request, response, acknowledgement). Example scenarios and use cases will reference those standards, such as ASC X12N, previously developed to accomplish Attachments exchange for educational purposes ONLY. Out of scope are specific standards and methods for connectivity in moving the Attachment from point to point.
events which create the need for additional information request or Attachment response/submittal may be indicated in but are NOT in scope for this Supplement. They are present to help the implementer understand where an attachment activity may fit within the overall business process. For example, when a provider requests authorization from a payer prior to rendering a service, the act of submitting the prior authorization request is not included in scope. Only the payer’s requesting additional information and the provider’s subsequent submittal of that Attachment are included.
Table 3 (Attachments Activity Table) describes the scenarios addressed for Attachment exchange purposes. Table 3 shows the correlation to each of the Activity ID’s with an ASC X12 Transaction Set.
The version that should be used of the ASC X12N Technical Reports published for the purposes of exchanging Attachments is the version named in regulation or agreed by trading partners in the absence of regulations.
To better understand the relationship of the row values for each attachment activity, a “table interpretation template” was developed:
Table interpretation template:
Activity “Activity ID” represents the information exchange for the “Healthcare Administrative Activity” “Solicited / Unsolicited” “Originator Activity Type” for Attachments from the “Originator” to the “receiver”.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 27January 2016 © 2016 Health Level Seven International. All rights reserved
Descriptions of the Column headings and table values are: Healthcare Administrative Activity – The type of healthcare
administrative activity of the originating actor for the ‘request’ activity type.
Activity ID – A symbolic ID used to express, in abbreviated form, the attachment activity. (NOTE: This ID will be used to uniquely determine the standard(s) necessary to accomplish the attachment exchange activity described in the row of the table)
Originating Activity Type – Describes the type of activity of the originating actor.
Request – explicitly requested additional information. Response – Attachment provided electronically in response to
an explicit request. Attachment Submission – indicates the type of Attachment
(solicited or unsolicited). Attachment Activity Basis
Solicited - an explicit request for additional information - the response to an explicit request.
Unsolicited - – Attachment from the Originator Actor to the Receiver
Actor based ONLY on a “rules based” request and in the absence of an explicit request.
Actor Originator – the actor originating or initiating the attachment
activity. Receiver – the actor receiving the attachment activity.
Example Figure ID – Identifies specific Figures/Illustrations that depict the specific Healthcare Administrative Activity.
Envelope/Transaction Standard Example – Identifies examples of electronic standards available to accomplish the specific attachment activity for that table row.
. References to the Envelope Transaction Standards are generic in this table. Implementers should use the version of the Technical Report published for the purposes of exchanging Attachments based on their business requirements or regulatory mandate.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 28© 2016 Health Level Seven International. All rights reserved
January 2016
A request for an Attachment additional information can originate in numerous ways and may be initiated by unique triggering business events depending on the originating actor. The table below reflects some of the more common scenarios for illustrative purposes:
Table 22: Request Attachment Activity Table
Healthcare Administrative
Activity
Request Attachment ID Attachment
Activity Basis Mode Timing
Assigning Actor Linkage
Claim
Standard Electronic
After claim receipt and review Payer
Payer request and provider
response Solicited
Rules Based At time of claims submital4 Provider
Provider claim and additional
information submittal
Unsolicited
Prior Authorization
Standard Electronic
After prior authorization
receipt and review Payer
Payer request and provider
response Solicited
Rules Based At time of prior authorization
request5 Provider
Provider Prior Authorization request and additional
information submittal
Unsolicited
Referral
Standard Electronic
After referral receipt and review Payer
Payer request and provider
response Solicited
Rules Based At time of referral
request2Provider
Provider referral request and additional
information submittal
Unsolicited
Response Attachment Activity
The act of exchanging Attachments from an information source to an information receiver is considered a response6. The information source is considered the entity that creates the Attachment needed by the receiving entity to support the healthcare administrative activity.
Understanding Attachment Activities
Because this Ssupplement addresses all facets of the process in the requesting of additional information of and responding with Attachments, and because the actor’s role will vary depending on the activity type, a table has been developed to better illustrate these activities. Each row in the table represents a unique attachment activity that would require a unique business flow to
4 5 Document Type for “setting” and “Specialty/Training/Professional Level”6 http://healthewayinc.org/images/Content/Documents/specs/2011/caqh-core-x12-document-submission-service-specification-v1-0-508.pdf HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 29December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
describe that activity. Additionally, each row will call for a unique set of electronic exchange standards to be used. As described later in of this supplement, there are multiple standards available in the industry to accomplish the exchange of information for attachment purposes (e.g., request, response, acknowledgement). For the purposes of this supplement, eExample scenarios and use cases will reference those standards, such as ASC X12N, previously developed to accomplish Attachments exchange for example educational purposes ONLY. Out of scope are specific standards and methods for connectivity in moving the Attachment from point to point. below describes all the scenarios addressed by this supplement for attachment exchange purposes. Column headings and table values are described below:
Healthcare Administrative Activity – The type of healthcare administrative activity of the originating actor for the ‘request’ activity type.
Activity ID – A symbolic ID used to express, in abbreviated form, the attachment activity. (NOTE: This ID will be used to uniquely determine the standard(s) necessary to accomplish the attachment exchange activity described in the row of the table)
Activity Type – Describes the type of activity of the originating actor. o Request – explicitly requested additional informationAttachment, either
electronically or some other method. o Response – Attachment provided electronically in response to an explicit
request. o Attachment Submission – Attachment provided electronically in response to
an “advance rule based” request for Attachments (e.g., mutually known rules, policy or guidelines).
Attachment Activity Basis o Solicited – Attachment which is: an explicit request orfor additional information the response to an explicit request.
o Unsolicited – Attachment from the Originator Actor to the Receiver Actor based ONLY on a “rules based” request and in the absence of an explicit request.
Actor o Originator – the actor originating or initiating the attachment activity. o Receiver – the actor receiving the attachment activity.
Page 30 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Example Figure ID – Identifies specific Figures/Illustrations within this Supplement that depict the specific Healthcare Administrative Activity.
Envelope/Transaction Standard Example – Identifies examples of electronic standards available to accomplish the specific attachment activity for that table row.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 31December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Page 32 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Table 3: ASC X12N Attachments Activity Table
Healthcare Administrative
ActivityActivity
ID Originator Activity Type
Attachment Activity Basis Actor
Example Figure
ID
Envelope/Transaction
StandardExampleSolicited Unsolicited Originator Receiver
Claims Attachment
#1 Request X Payer Provider1
ASC X12N 2771
#2 Response X Provider Payer ASC X12N 2752
#3 Attachment Submission X Provider Payer 2ASC X12N
2752
Prior AuthAttachment
#4 Request X Payer Provider3
ASC X12N 2783
#5 Response X Provider Payer ASC X12N 2754
#6 Attachment Submission X Provider Payer 4 ASC X12N 2754
ReferralAttachment
#7 Request X Payer/Referring Provider
Referred To Provider
5
ASC X12N 2783
#8 Response X Referred To Provider
Payer/Referring Provider
ASC X12N 2754
#9 Attachment Submission X Referred To Provider
Payer/Referring Provider
6ASC X12N
2754
Post Adjudicated
Claim Attachment
#10 Request X Payer Provider8
ASC X12N 2771
#11 Response X Provider PayerASC X12N
2752
Notification Attachment #12 Attachment Submission X Facility provider Primary care
provider 8 ASC X12N 2754
1 ASC X12N 277 – Health Care Information Status Notification - Technical Report Type 3 for Health Care Claim Request for Additional Information2 ASC X12N 275 – Patient Information – Technical Report 3 for Additional Information to Support a Health Care Claim or Encounter3 ASC X12N 278 – Health Care Services Review Information Technical Report 3 for Health Care Services Request for Review and Response4 ASC X12N 275 – Patient Information – Technical Report 3 for Additional Information to Support a Health Care Service Review
*References to the Envelope Transaction Standards are generic in this table. Implementers should use the version of the Technical Report published for the purposes of exchanging Attachments based on their business requirements or regulatory mandate.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 33December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Page 34 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
3.5.5[4.4.3] Attachment Scenarios
To better understand the relationship of the row values for each attachment activity, a “table interpretation template” was developed:
Table interpretation template:
Activity “Activity ID” represents the information exchange for the “Healthcare Administrative Activity” “Solicited / Unsolicited” “Originator Activity Type” for Attachments from the “Originator” to the “receiver”.By substituting the row values found for each of the heading columns identified in “BOLD” type, a high level use case description can be created. The following examples are derived from the table using the template above.
By substituting the row values found for each of the heading columns identified in “BOLD” type, a high level use case description can be created. The following examples are derived from the table using the template above:
[4.4.3.1] Claim Attachment Scenarios ( Examples )
Activity #1 represents the information exchange for the Claims Attachment solicited request for additional information from the payer to the provider. Activity #2 represents the information exchange for the Claims Attachment solicited Attachment response from the provider to the payer. Activity #3 represents the information exchange for the Claims Attachment unsolicited Attachment submission from the provider to the payer.
3.5.5.1[4.4.3.2] Prior Authorization Attachment Scenarios ( Examples )
Activity #4 represents the information exchange for the P p rior A a uthorization Attachment solicited request for additional information from the payer to the provider. Activity #5 represents the information exchange for the pPrior A a uthorization Attachment solicited Attachment response from the provider to the payer. Activity #6 represents the information exchange for the P p rior A a uthorization Attachment unsolicited Attachment submission from the provider to the payer.
3.5.5.2[4.4.3.3] Referral Attachment Scenarios ( Examples )
Activity #7 represents the information exchange for the Referral Attachment solicited request for additional information from the payer/referred to provider to the referring provider.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 35December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Activity #8 represents the information exchange for the Referral Attachment solicited Attachment response from the referring provider to the payer/referred to provider. Activity #9 represents the information exchange for the Rreferral Attachment unsolicited Attachment submission from the referring provider to the payer/referred to provider.
[4.4.3.4] Notification Attachment Scenarios ()
Activity #10, represents the information exchange for the Nnotification Attachment unsolicited Attachment submissions from the facility provider to the primary care provider.
[4.4.3.5] Post Adjudicated Claims Scenarios (Examples)
Activity #1 0 1 represents the information exchange for the Post Adjudicated Claim Attachment solicited request for Attachments additional information from the payer to the provider. Activity #12 1 represents the information exchange for the Post Adjudicated Claim Attachment solicited Attachment response for Attachments from the provider to the payer. Activity #11 represents the information exchange for the Post Adjudicated Claim Attachment solicited Attachment response f from the provider to the payer.
3.5.5.3 Notification Attachment Secnarios ( Examples )
Activity #12 represents the information exchange for the notification unsolicited Attachment submissions from the facility provider to the primary care provider.
Attachment Activity Table association to standards Use of this table permits standards correlation to each of the activity ID’s with a current ASC X12N TR3, or any other future standard(s) that perform a comparable function. Future regulation could expand to other standards comparable to the ASC X12N TR3s, to which the activity ID could correlate.
[4.4.3.6] Attachment Scenario and Scope
The activities above are not meant to reflect and/or include business event activities other than those directly related to the requesting and responding with Attachments. Triggering events which create the need for Attachment request or response/submittal may be indicated in examples in Chapter 6 but are NOT in scope for this Supplement. They are present to help the implementer
Page 36 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
understand where an attachment activity may fit within the overall business process. For example, when a provider requests authorization from a payer prior to rendering a service, the act of submitting the prior authorization request is not included in scope. Only the payer’s requesting Attachments and the provider’s subsequent submittal of that Attachment are included.
Attachment Request/Response Re-Association using Attachment Unique ID
An essential component of an attachment activity is the ability to re-associate the Attachment with the request through the use of an Attachment IDAttachment Unique ID. Depending on the attachment activity, the entity responsible for assigning an Attachment IDAttachment Unique ID will vary.
When the Attachment is unsolicited, the Attachment IDAttachment Unique ID SHALL be used in both the attachment and the enveloping metadata. When the Attachment is solicited, the Attachment IDAttachment Unique ID SHALL be used only in the enveloping metadata (for more information on enveloping metadata, see Appendix A - Business Requirements for requesting and submitting attachment (Metadata)).
The table on the next page highlights how the Attachment IDAttachment Unique ID will be integrated into the attachment activity processes.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 37December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Table 3: Attachments ID Re-association Table Healthcare
Administrative Activity
Activity ID Relationship Attachment Activity
Attachment ID creator
Intended Re-association
linkage
Claim Attachment
Paired together as a solicited request for additional
information and response with an Attachment for a Claim Attachment
Activity #1 represents the information exchange for the Claims Attachment solicited request for additional information from the payer to the provider
Payer
Provider returns the ID from the request
(#1) in their Attachment
response (#2) Activity #2 represents the information exchange for the Claims Attachment solicited Attachment response from the provider to the payer
Stand alone Activity #3 represents the information exchange for the Claims Attachment unsolicited Attachment submission from the provider to the payer
Provider Provider inserts ID into both claim and
Attachment submission
Prior Authorization Attachment
Paired together as a solicited request for additional
information and response with an Attachment for
Prior Authorization Attachments
Activity #4 represents the information exchange for the Prior Authorization Attachment solicited request for additional information from the payer to the provider.
Payer
Provider returns the ID from the request
(#4) in their Attachment
response (#5) Activity #5 represents the information exchange for the Prior Authorization Attachment solicited Attachment response from the provider to the payer.
Stand alone Activity #6 represents the information exchange for the Prior Authorization Attachment unsolicited Attachment submission from the provider to the payer.
Provider
Provider inserts ID into both Prior Authorization request and Attachment submission
Referral Attachment
Paired together as a solicited request for additional
information and response with an Attachment for
Referral Attachments
Activity #7 represents the information exchange for the Referral Attachment solicited request for additional information from the payer/referred to provider to the referring provider.
Activity #8 represents the information exchange for the Referral Attachment solicited Attachment response from the referring provider to the payer/referred to provider.
Payer
Referring provider returns the ID from the request (#7) in their Attachment response (#8)
Stand alone
Activity #9 represents the information exchange for the Referral Attachment unsolicited Attachment submission from the referring provider to the payer/referred to provider. Provider
Referring provider inserts ID into both the Referral request
and Attachment submission
Notification Attachment Stand Alone
Activity #10, represents the information exchange for the Notification Attachment unsolicited Attachment submissions from the facility provider to the primary care provider.
Facility Provider (Unknown)
Post Adjudicated
Claim Attachment
Paired together as a solicited request for additional
information and response with an Attachment for
Post Adjudicated Claim
Attachments
Activity #11 represents the information exchange for the Post Adjudicated Claim Attachment solicited request for additional information from the payer to the provider
Activity #12 represents the information exchange for the Post Adjudicated Claim Attachment solicited Attachment response from the provider to the payer
Payer
Provider returns the ID from the request (#11) in their Post Adjudicated Claim Attachment response (#12)
[4.5] Standards to Accomplish Information Exchange of The Request and Response
The authors of this Supplement acknowledge that there may be more than one standard that could accomplish the information exchange.They further acknowledge the development of a full suite of standard transactions developed by ASC X12N. For the purposes of this document, references to requests and responses to requests in examples and/or use cases will include a reference to the specific ASC X12N transaction that could be used7. Non-Normative examples for the use of standard enveloping, messaging and transports to request and exchange CDA Attachments are included in Appendix D. As the technologies mature, we expect additional standards to be developed and are open to adapting this supplement to include them as well.
7 http://exchange-specifications.wikispaces.com/file/view/ESMD_XDR_Production_Specification_v1.0.pdf HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 39December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
[5 ] L O I N C ( L O G I C A L O B S E RVAT I O N I D E N T I F I E R S N A M E A N D C O D E S )
Since its inception, Regenstrief has developed LOINC as an open standard. Regenstrief welcomes requests for new LOINC terms. It is because of submissions from the LOINC community that the vocabulary has been able to grow and adapt so quickly. Regenstrief is also always happy to receive specific suggestions about revisions or enhancements to existing content like synonyms and term descriptions as well. The general process for how to request these enhancements to LOINC are described on the LOINC website:
http://loinc.org/submissions/
3.6[5.1] Use of LOINC for Attachments
The HL7 encoding of Attachments makes extensive use of the code set Logical Observation Identifier Names and Codes (LOINC®). LOINC provides a universal set of codes and names for identifying laboratory and clinical tests, measures, documents, and other clinical observations. LOINC is an openly developed vocabulary standard used worldwide to facilitate the exchange and pooling of clinical results for care delivery, outcomes management, public health reporting, and research purposes. LOINC achieves these aims by creating a unique identifier code and a structured name for each observation. When used in conjunction with widely adopted messaging standards, LOINC can be an essential ingredient for efficient electronic processing and storage of clinical data that comes from many independent sources. LOINC is a controlled terminology that contains unique identifiers and “fully specified” names constructed in a formal structure that distinguishes among tests and observations that are clinically different. LOINC creates codes and a formal name for each concept that corresponds to a single kind of document, observation, measurement, or test result. For example, LOINC code 18842-5 (Discharge Summary) identifies a document with a formal name:Discharge summarization note:Find:Pt{Setting}:Doc:{Provider}
The display name (called the LOINC Long Common Name) for this term is the familiar “Discharge Summary”.The formal LOINC name is “fully-specified” in the sense that it contains the features necessary to disambiguate among similar clinically distinct observations. The fully-specified name is constructed according to a six-part semantic model that produces an aggregate or pre-coordinated expression that intentionally does not capture all possible information about the testing procedure or result – only enough to unambiguously identify it.
Page 40 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
More information about the LOINC naming conventions can be found in the LOINC Users’ Guide and other resources available from the LOINC website ( http://loinc.org ). In the context of Attachments, LOINC codes are used for several purposes. At a high level, LOINC codes are used to identify the specific kind of information being communicated in both a request and response (e.g., a discharge summary or diagnostic imaging report (DIR)). LOINC codes may also be used to request a specific C-CDA Document by specifying the LOINC code that corresponds to the specific document ID (see Appendix B and C for a complete list). This allows the requester to ask for a specific Attachmentdocument, for example, the C-CDA R2.1 Op Note, and not just an Op Note. This can then be responded to by the provider by supplying the Op Note from either of the C-CDA Implementation Guides.. LOINC codes may also be used to specify certain modifier variables in fulfilling the request for information (e.g. variables that indicate a modification to the default time period). In attachment responses that use C-CDA Document. LOINC codes are used to identify the Attachment Dcoument Type (Document), sections, and sometimes the individual entries (tests or observations). While a LOINC code can identify information at the section and sometimes the entry level, a request for Attachments additional information should always be at the Document level. In a structured document, the section/entry LOINC code may be helpful to the recipient in extracting/parsing information within the document.
In this way, LOINC codes are used to identify: An electronic Attachment in its entirety (e.g.,Discharge Summary Report), as an Attachment Type Identifier.A specific document level template (e.g. C-CDA R2 Op Note versus the CDP1 Enhanced Op Note) Attachment Document Identifier.A category of clinical report (e.g., send any reports of CAT scans of the head that are related to the claim or a specific service), as an Attachment Type Identifier appearing in the C-CDA Header.The implicit scope of a request activity (e.g., to modify a request for information for a period 30 days prior to treatment) as a Modifier LOINC Code.
3.6.1[5.1.1] Obtaining LOINC and Other Resources From the Regenstrief Institute
LOINC is produced, distributed, and copyrighted by the Regenstrief Institute, and is made available for both commercial and non-commercial use without charge under the license at http://loinc.org/terms-of-use . LOINC is published in regular releases, typically twice per year (in June and December).
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 41December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
The LOINC database and many other resources are available from the LOINC website: http://loinc.org
Regenstrief also develops and distributes the RELMA desktop mapping program. RELMA is available from the LOINC website at no cost and provides tools for browsing the LOINC database and mapping local terms to LOINC. In addition, Regenstrief also provides the online LOINC search application (http://search.loinc.org) that enables searching of the LOINC database from a web browser.The LOINC website has a variety of useful documentation resources including Users’ Guides for LOINC and RELMA, an FAQ, and some online tutorials that are available to download for offline review. From the LOINC website, you can also subscribe to the LOINC mailing list and find out about upcoming meetings and training events.
3.7[5.2] Using the LOINC Code As An Identifier In Messages
Each term in the LOINC database is assigned a unique, permanent code called the LOINC code. This is the code that systems should use to identify test results in electronic reports. The LOINC code has no intrinsic structure except that the last character in the code is a Mod-10 check digit. Consistent with the use of LOINC allowed by the LOINC License, the HL7 Attachment Supplement Specification ithis supplement guide requires that LOINC codes be used as published in the LOINC database, without leading zeroes and with the hyphen that precedes the check digit (e.g., "8709-8" and "10154-3").Along with the code, the HL7 Attachment Supplement Specification i this supplemental guide strongly recommends that one of the published LOINC names also be transmitted in the message. For most purposes, the LOINC Long Common Name is the best name to include in electronic messages.
3.8[5.3] Using the LOINC Database to Identify Valid Attachment Types
The AWG has reached out to the industry stakeholders to identify the types of Attachments that are currently needed. However, we expect that as the exchange of Attachments exchange matures, the need for new Attachment Ttypes will grow. Rather than including Attachment Types in this supplement as a “static” value set and requiring publication of a new version of this supplement before new types can be used, the Attachments Types will be implemented as a “dynamic” external value set, external to this supplement.The LOINC database, maintained and managed by the Regenstrief Institute, will maintain the content of the external value set of LOINC codes available for usage in the exchange of Attachments , and is further described below.Page 42 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Regenstrief provides specialized Attachment features in LOINC, RELMA, and the online LOINC Search application.
Additional information about the use of the RELMA program and the LOINC database for Attachment purposes and can be found at:
http://loinc.org/attachments
[5.3.1] Identifying Valid Attachment Types In The LOINC Tablee
[5.3.2]
The LOINC Table (available in several file formats) contains a field called [HL7_ATTACHMENT_STRUCTURE]. This field can be populated by one of these values UNSTRUCTURED or STRUCTURED.
3.8.1.1[5.3.2.1] UNSTRUCTURED LOINC Terms
LOINC terms with this value are approved by the HL7 AWG for use as an unstructured Attachment ONLY.
When sent as an Attachment, implementers SHALL use the Unstructured Document template of the C-CDA R2.1 (see section 1.1.24 in C-CDA R2 : Volume 2 Templates and Supporting Material). Conformant Unstructured Documents must carry the document-level templateId asserting conformance with the C-CDA R2.1 guide.
SHALL contain exactly one [1..1] templateId (CONF:7710) such that ita. SHALL contain exactly one [1..1] @root="2.16.840.1.113883.10.20.22.1.10"
(CONF:10054).
Implementers SHALL NOT use LOINC codes where the [HL7_ATTACHMENT_STRUCTURE] is Null or STRUCTURED as an Unstructured Document Attachment (see section 1.1.24 in C-CDA R2 : Volume 2 Templates and Supporting Material). Over time, HL7 may develop additional guides for communicating Attachments in a structured way. As new implementation guides are developed by HL7 for these Attachment Types, Regenstrief will update the value of the [HL7_ATTACHMENT_STRUCTURE] field to reflect the presence of a guide for structured reporting.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 43December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
3.8.1.2[5.3.2.2] STRUCTURED LOINC Terms
LOINC terms with this value are approved by the HL7 AWG for sending as structured content using the C-CDA Documents. This does not mean that they must always be sent as fully structured content, but rather that such a structured specification exists and is approved for use. As indicated in the C-CDA Implementation Guides, any particular Attachment Type can be sent in a manner that conforms to CDA Level 1 (nonXMLBody), CDA Level 2 (structuredBody with sections that contain a narrative block), or CDA Level 3 (structuredBody containing sections that contain a narrative block and coded entries).If the Attachment is sent as CDA Level 1 (nonXMLBody) or CDA Level 2 (structuredBody with sections that contain a narrative block), it must include the required content defined for the fully structured document (CDA Level 3). That is, the expected information content in the documents is the same in both cases.
3.8.2[5.3.3] Identifying Valid Attachment Types Using RELMA and The Online LOINC Search Application (http://search.loinc.org)
[5.3.4]
Both the RELMA desktop mapping program and the online LOINC search application http://search.loinc.org provide many functions for searching and browsing the LOINC database. Both applications are maintained and enhanced by the Regenstrief Institute on a regular basis, with new releases made available on the LOINC website. The following sub-sections provide a basic overview of how to use these tools to identify valid Attachment types, but the most current information is available at:http://loinc.org/attachments
3.8.2.1[5.3.4.1] Searching RELMA
From the Search tab or the Mapping tab, a query on the HL7_ATTACHMENT_STRUCTURE field will return all of the LOINC codes of that kind (e.g. UNSTRUCTURED or STRUCTURED). RELMA uses a Google-like search syntax, so a search for keywords can be combined with a search on a particular field in the LOINC database. For example, to search for all the LOINC terms with value in HL7_ATTACHMENT_STRUCTURE of “UNSTRUCTURED” containing the word “consent”, you could enter this query in the search box:consent HL7ATTACHMENTSTRUCTURE:unstructured
As with all search results in RELMA, the rows in the search results grid can be highlighted and then exported (to a CSV file, the clipboard, or other options).
Page 44 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
3.8.2.2[5.3.4.2] Browsing RELMA
[5.3.4.3]
The RELMA program also provides a convenient viewer for browsing the LOINC terms used in Attachments. The Attachments viewer is available from the “HIPAA” menu.From the main Attachments viewer, three sub-sections are available: Structured, Unstructured, and Request Modifier Codes.The Structured tab presents the high level Attachment Type classifications from the C-CDA R2 and CDP1 and this supplement, the set of LOINC document codes in that classification, and a linkage to the set of allowed section and entry-level codes where appropriate.The Unstructured tab lists all of the LOINC codes that are approved by the HL7 Attachments WG for use as an unstructured Attachment ONLY (e.g., they have a value of UNSTRUCTURED in the HL7_ATTACHMENT_STRUCTURE field).The Request Modifier Codes tab lists all the LOINC codes that can be used as request modifiers, as described in Section 5.4.3 of this supplement.
3.8.2.3[5.3.4.4] Identifying Valid Attachment Types Using The Online LOINC Search Application ( http://search.loinc.org )
The search syntax of the online LOINC search application is the same as that of RELMA. This powerful search syntax can search on keywords anywhere in the LOINC records or with a particular field. For example, to search for all the LOINC terms with value in HL7_ATTACHMENT_STRUCTURE of “UNSTRUCTURED” you could enter this query in the search box:HL7ATTACHMENTSTRUCTURE:unstructured
Similar to RELMA, the rows in the search results grid of the online search application can be highlighted and then exported to a CSV file.
3.9[5.4] Requesting LOINC Codes for New Attachment Types
3.9.1[5.4.1] Process for Requesting New Attachment Types
To request a new Attachment Type, initial contact should be made to the HL7 Attachments WG via any of the work group Co-Chairs found at the following link: (http://www.hl7.org/special/Committees/claims/leadership.cfm)
Regenstrief Institute assigns LOINC codes upon request from various agencies. In the context of attachments, the LOINC codes for new Attachment Types (initially Unstructured) are received by the AWG which forwards appropriate requests to the Regenstrief for consideration. Requests go through a review process to ensure the concept has not been previously added and the meaning
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 45December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
is clear. Some complex requests are discussed and decided by the LOINC Committee before they are completed by Regenstrief.
The AWG, having initially received a request considered as unstructured, would coordinate with the submitter of the new Attachment Type request to assist in the development of content (Sections/Entries) necessary to advance the Attachment from Unstructured to Structured formatting.
3.9.2[5.4.2] Updates to the LOINC database
With each release (semi-annually), the LOINC database contains additional new terms and some edits to existing terms. LOINC development follows best practices for terminology system development by never reusing or deleting codes. If a LOINC term is identified as erroneous or a duplicate of a previous term it is flagged as “deprecated” in the database, but the record is not removed. Changes in concept status are made very judiciously.
There are various mechanisms for staying abreast of LOINC updates that are available from the LOINC website. You can join the LOINC announcement email list (http://loinc.org/mailing-lists ), subscribe to the LOINC news RSS feed ( http://feeds.feedburner.com/LOINCNews ), follow on Twitter (@LOINC), or check the website for other new features.
Page 46 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
4 AT TA C H M E N T B U S IN E S S F L O W S
The examples in this Supplement will provide typical business flows for each of the attachment activities consistent with Table 3 Attachment Activity Types). Each specific activity will be identified and correlated back to an entry in the table using the “Attachment Activity ID #”. Some of the examples may include information exchanges that are not covered in this supplement but necessary to reflect the complete business flow. These activities will be clearly marked. As previously noted, where the ASC X12 Transaction Sets are shown it should not be construed to be limited to these standards. The examples in this section are intended for illustrative purposes only and should and are not all inclusive.
4.1 Use of LOINC in Attachment Scenarios
The LOINC codeset plays a critical role in the requesting/responding/submitting of Attachments, especially when the recipients EHR system is capable of interpreting a codified request and generating/creating the Attachments being requested automatically and without human intervention. In C-CDA Documents, the LOINC populated in the Document Type Code is used to identify the requested Attachment. In the context of Attachments, LOINC codes are used for several purposes. At a high level, LOINC codes are used to identify the specific kind of information being communicated in both a request and response (e.g., a discharge summary or diagnostic imaging report (DIR)). LOINC codes may also be used to request a specific C-CDA Document by specifying the LOINC code that corresponds to the specific document ID (see Appendix B and C for a complete list). This allows the requester to ask for a specific document, for example, the C-CDA R2.1 Op Note, and not just an Op Note. This can then be responded to by the provider by supplying the Op Note from either of the C-CDA Implementation Guides.. LOINC codes may also be used to specify certain modifier variables in fulfilling the request for information (e.g. variables that indicate a modification to the default time period). In attachment responses that use C-CDA Document. LOINC codes are used to identify the Dcoument Type, sections, and sometimes the individual entries (tests or observations). While a LOINC code can identify information at the section and sometimes the entry level, a request for additional information should always be at the Document level. In a structured document, the section/entry LOINC code may be helpful to the recipient in extracting/parsing information within the document.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 47December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
4.2 Solicited Attachment Exchange
When requesting additional information, a single LOINC is used to codify the specific document type being requested. In C-CDA Documents, there could be multiple LOINC codes which represent a single document type (e.g., Operative Note) in general or that are further specialized (depending on “setting” and “Specialty/Training/Professional Level”). The LOINC Codes that are valid for each C-CDA Document type are defined in the respective C-CDA Implementation Guide Those tables identify the general LOINC code as "”recommended", and LOINC codes specialized by speciality/training/professional level as “”ValueSets”. The exception is Consultation Notes that may represent the "preferred" code as ‘Root Level Document Type Code’ and "additional codes" as either Specialized by Setting, Specialized by Setting and Specialty or Specialized by Specialty…this is being corrected in an upcoming version.
Examples of those clinical document types, their recommended LOINC Codes are found in Appendix B .
As mentioned in C-CDA, use of the "recommended" LOINC is preferred but not required. For the purposes of Attachments, the use of the "recommended" LOINC is preferred as the single LOINC used in the request for additional information. However, use of the "Value Set" LOINC code in the request may also be permitted if the requestor deems it appropriate for their business purposes.
To accommodate both Payer/UMO needs for additional information and the flexibility afforded the EHR Systems by C-CDA, special rules for requesting and responding have been developed for Attachments as described in Table 5 below.
For solicited unstructured Attachment type request and response, the LOINC Code used in the request SHALL be returned in the response. Information on locating valid unstructured LOINC codes from the Regenstrief LOINC database is available in Section 4.
Page 48 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Table 4: Request and Response LOINC Code Usage for Solicited Structured Attachments
Request LOINC
Responding EHR System Payer/UMO System
“Recommended” LOINC
Respond with "recommended" LOINC if able. If EHR system only capable of creating specialized LOINC, respond with “value set” LOINC code closest to matching request for that document type for “setting” and “Specialty/Training/Professional Level”
If response contains "recommended" LOINC code, consider response a match to request. If response not a match, cross-walk “value set” LOINC code to ‘recommended’ code for document type and consider a match if identical to the Request LOINC.
“Value Set” LOINC
Respond with same "value set" LOINC as in the request if able. If unable, respond with other "value set" LOINC or "recommended" LOINC closest to the matching request for that document type
If response contains "value set" LOINC Code identical to request, consider response a match to request. If response not a match, cross-walk "value set" LOINC Code to "recommended" and/or other "value set" LOINC code for document type and consider a match if either the "recommended" or "value set" LOINC for document type found.
4.2.1 Claim Attachment – Solicited Scenario
When a provider submits a claim for payment, a payer may determine that additional information is needed to complete the adjudication. The payer initiates a request for that additional information. The provider receives that request, and responds to the payer with the Attachment requested ( solicited ) .
The diagram below depicts the business flow of the example above for a solicited claim attachment.
Arrow #1 The claim submitted by provider to a payer. (Claim submission is not covered in this Supplement as it only acts as a triggering event for an Attachment.)
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 49December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Arrow #2 The request for additional information from the provider. (ASC X12N 277). ( Attachment Activity #1 )
Arrow #3 The provider’s response with an Attachment (ASC X12N 275). ( Attachment Activity #2 )
Figure 2: Example - Claims Attachment (Solicited)
4.2.2 Prior Authorization Attachment – Solicited Scenario
When a provider submits a request for prior authorization, a payer may determine that additional information is needed to complete review. The payer initiates a request for that additional information. The provider receives that request, and responds to the payer with the Attachment requested ( solicited ) .
The diagram below depicts the business flow of the example above for a solicited Prior Authorization Attachment.
Arrow #1 The Service Authorization Request is submitted by a provider to a payer. (Prior Authorization Request is not covered in this Supplement as it only acts as a triggering event for an Attachment.)
Arrow #2 (Attachment Activity #4) A request for additional information in support of a service authorization request from the payer to the provider (ASC X12N 278).
Arrow #3 (Attachment Activity #5)The provider’s response with an Attachment (ASC X12N 275).
Figure 2: Example – Prior Authorization (Solicited)
Page 50 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
4.2.3 Referral Attachment – Solicited Scenario
When a provider submits a Referral to another provider additional information is needed to complete review. The payer initiates a request for that additional information. The provider receives that request, and responds to the payer with the Attachment requested ( solicited ) .
The diagram below depicts the business flow of the example above for an Solicited Referral Attachment.
Arrow #1 represents a Referral Request which is submitted from provider “A”(referring) to a provider “B”(referred too). (The Referral is not covered in this supplement as it only acts as a triggering event for an attachment.)
Arrow #2 (Attachment Activity #7) represents a request for additional information in support of a referral request from the provider “B” to provider “A” (ASC X12N 278).
Arrow #3 (Attachment Activity #8) represents provider “A” response with an Attachment to provider “B” (ASC X12N 275).
Figure 3: Example – Referral Attachment (Solicited)
4.2.4 Post Adjudicated Claim Attachment – Solicited Scenario
A payer, after adjudicating a claim, may decide to perform post-adjudication review. The payer may initiate a request for additional information.
The diagram below depicts the business flow of the example above for a solicited claim Attachment.
Arrow #1 The claim is submitted from a provider to a payer. (Claim submission is not covered in this supplement as it only acts as a triggering event for an Attachment.)
Arrow #2 The remittance advice is returned by the payer to the provider. (Remittance Advice is not covered in this supplement as it only acts as a triggering event for an Attachment.)
Arrow #3 (Attachment Activity #10) Request for additional information is submitted by the payer from the provider. This is not necessarily an immediate may occur anytime following the adjudication of the claim. (ASC X12N 277)
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 51December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Arrow #4 (Attachment Activity #11) represents the provider’s response with an Attachment (ASC X12N 275).
Figure 4: Example – Post Adjudicated Claim Attachment (Solicited)
4.3 Unsolicited Attachment Exchange
When the conditions for submitting additional information are of a consistent and recurring nature, the payer may make these conditions known in advance to the provider so that the provider may submit the Attachment without waiting for a request (unsolicited). When submitting an Attachment in the unsolicited model, the specific LOINC code to be used as the Attachment Type ID follows these rules:
In the C-CDA Implementation Guides there are LOINC codes specified as “Recommended” and “Value Sets”. For structured documents and their unstructured counterparts, the “Attachment Type ID” SHOULD be the “Recommended” LOINC Code, but the “Value Set” LOINC Codes are permitted.
For unstructured documents that do not have a structured counterpart, refer to section 5.5.1.1 for determining valid LOINC codes for unstructured Attachments.
4.3.1 Claim Attachment – Unsolicited
A provider submits a claim to a payer and knows in advance that additional information is needed to complete the adjucation, the provider may submit the Attachment without waiting for the request (unsolicited).
The diagram below depicts the business flow of the example above for an unsolicited claim Attachment.
Arrow #1 A claim is submitted from a provider to a payer. (Claim submission is not covered in this supplement as it only acts as a triggering event for an Attachment.)
Arrow #2 Provider submits additional information previously agreed to between payer and provider as an Attachment (ASC X12N 275). (Attachment Activity #3)
Page 52 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Figure 5: Example – Claims Attachment (Unsolicited)
4.3.2 Prior Authorization Attachment – Unsolicited Scenario
A provider submits a request for prior authorization to a payer and knows in advance that additional information is needed to complete the approval, the provider may submit the Attachment without waiting for the request (unsolicited).
The diagram below depicts the business flow of the example above for an unsolicited Prior Authorization Attachment.
Arrow #1 A Service Authorization Request submitted from a provider to a payer (ASC X12N 278).
Arrow #2 (Attachment Activity #6) Submission of additional information as an Attachment (ASC X12N 275).
Figure 6: Example – Prior Authorization (Unsolicited)
4.3.3 Referral Attachment – Unsolicited Scenario
A provider submits a referral to another provider or a payer and knows in advance that additional information is needed, the provider may submit the Attachment without waiting for the request (unsolicited).
The diagram below depicts the business flow of the example above for an unsolicited Prior Authorization Attachment.
Arrow #1 A referral is submitted from a provider to another provider or payer (ASC X12N 278).
Arrow #2 (Attachment Activity #9) Submission of additonal informationas and Attachment (ASC X12N 275).
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 53December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Figure 73: Example – Referral Attachment (Unsolicited)
Notification – Unsolicited Scenario
4.3.4[5.4.3]
A provider submits an notifiction to another provider along with additional information as needed.
In the example below, a facility provider discharges a patient of a primary care provider, and forwards a notification to that effect.
The diagram below depicts the business flow of the example above for a notification Attachment.
Arrow #1 (Attachment Activity #10) represents the Attachment information from the provider. (if electronic, ASC X12N 275)
Figure 8: Example – Notification Attachment (Unsolicited)
Page 54 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
[6 ] R E Q U E S T I N G /R E S P O N D I N G / S U B M I T T I N G AT TA C H M E N T S
[6.1] Unsolicited Attachment Exchange
Insert information here
Unsolicited Attachments with Claims SubmissionInsert information here
Unsolicited Attachments with Prior AuthorizationsInsert information here
Unsolicited Attachments with NotificationsInsert information here
Use of LOINC codes with Unsolicite AttachmentsInsert information here
[6.2] Solicited Attachment Exchange
Insert information here
Request and Response for Claims SubmissionInsert information here
Request and Response for Prior AuthorizationsInsert information here
Use of LOINC codes with Request and Response for AttachmentsInsert information here
Using “Modifier LOINC Codes” to constrain the RequestInsert information here
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 55December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
[6.3] Solicited Attachment Exchange
The LOINC codeset plays a critical role in the requesting/responding/submitting of Attachments, especially when the recipients EHR system is capable of interpreting a codified request and generating/creating the Attachments being requested automatically and without human intervention. In C-CDA Documents, the LOINC populated in the Document Type Code is used to identify the requested Attachment. A LOINC/Document TypeCode may be used to:
[a)] Identify the specific document type constituting the Attachment being requested.
[b)] Identify which document (s) to respond with when multiple document types exist that could satisfy the request. These LOINC codes, Known as “Modifier LOINC Codes”, may be used to “modify” the request in “a” above. More about these may be found in Section 4.4.4, “Using Modifier LOINC Codes to Constrain the Request.
A LOINC Document ID Code may be used to: [a)] Identify the specific document template that should be used to
generate the Attachment.
[6.4] Requesting/Responding/Submitting Attachments
The LOINC codeset plays a critical role in the requesting/responding/submitting of Attachments, especially when the recipients EHR system is capable of interpreting a codified request and generating/creating the Attachments being requested automatically and without human intervention. In C-CDA Documents, the LOINC populated in the Document Type Code is used to identify the requested Attachmentadditional information. A LOINC/Document TypeCode may be used to:
[c)] Identify the specific document type constituting the Attachment additional information being requested.
[d)] Identify which document (s) to respond with when multiple document types exist that could satisfy the request. These LOINC codes, Known as “Modifier LOINC Codes”, may be used to “modify” the request in “a” above. More about these may be found in Section 4.4.4, “Using Modifier LOINC Codes to Constrain the Request.
A LOINC Document ID Code may be used to: [b)] Identify the specific document template that should be used to
generate the Attachment. Page 56 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
[6.4.1] Using LOINC Code to Request/Respond Attachment (Solicited)
When requesting an Attachmentadditional information, a single LOINC is used to codify the specific document type being requested. In C-CDA Documents, there could be multiple LOINC codes which represent a single document type (e.g., Operative Note) in general or that are further specialized (depending on “setting” and “Specialty/Training/Professional Level”). The LOINC Codes that are valid for each C-CDA Document type are defined in the respective C-CDA Implementation Guide Those tables identify the general LOINC code as "”recommended", and LOINC codes specialized by speciality/training/professional level as “”ValueSets”8. Examples of those clinical document types, their recommended LOINC Codes are found in Appendix B and Appendix C. As mentioned in C-CDA, use of the "recommended" LOINC is preferred but not required. For the purposes of Attachments, the use of the "recommended" LOINC is preferred as the single LOINC used in the request for an Attachmentadditional information. However, use of the "Value Set" LOINC code in the request may also be permitted if the requestor deems it appropriate for their business purposes. To accommodate both Payer/UMO needs for Attachments additional information and the flexibility afforded the EHR Systems by C-CDA, special rules for requesting and responding have been developed for Attachments. Special request/response rules for solicited Structured Attachments are described in Table 5 below.
Table 5: Request and Response LOINC Code Usage for Solicited Structured Attachments
Request LOINC Responding EHR System Payer/UMO System
“Recommended” LOINC
Respond with "recommended" LOINC if able. If EHR system only capable of creating specialized LOINC, respond with “value set” LOINC code closest to matching request for that document type9.
If response contains "recommended" LOINC code, consider response a match to request. If response not a match, cross-walk “value set” LOINC code to ‘recommended’ code for document type and consider a match if identical to the Request LOINC.
“Value Set” Respond with same If response contains "value set" 8 Nationwide Health Information Network Electronic Submission of Medical Docmentation: esMD XDR Production Specification, Version 1.09 Nationwide Health Information Network Electronic Submission of Medical Docmentation: esMD XDR Production Specification, Version 1.0HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 57December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
LOINC
"value set" LOINC as in the request if able. If unable, respond with other "value set" LOINC or "recommended" LOINC closest to the matching request for that document typeError! Bookmark not defined.14.
LOINC Code identical to request, consider response a match to request. If response not a match, cross-walk "value set" LOINC Code to "recommended" and/or other "value set" LOINC code for document type and consider a match if either the "recommended" or "value set" LOINC for document type found.
For solicited unstructured Attachment type request and response, the LOINC Code used in the request SHALL be returned in the response. Information on locating valid unstructured LOINC codes from the Regenstrief LOINC database is available in section 5.5.1.1.
[6.4.2] Using LOINC Code to Submit Attachments (Unsolicited)
When submitting Attachment in an unsolicited model, the specific LOINC code to be used as the Attachment Type ID follows these rules:
In the C-CDA Implementation Guides there are LOINC codes specified as “Recommended” and “Value Sets”. For structured documents and their unstructured counterparts, the “Attachment Type ID” SHOULD be the “Recommended” LOINC Code, but the “Value Set” LOINC Codes are permitted.
For unstructured documents that do not have a structured counterpart, refer to section 5.5.1.1 for determining valid LOINC codes for unstructured Attachments.
[6.4.3] Using “Modifier LOINC Codes” to Constrain The Request
Modifier LOINC Codes are used to further inform the recipient of the request for an Attachmentadditional information. if a specific “Time Window” or “Item Selection” criteria should be applied to constrain which document types within that time window or item selection criteria should be responded with. Below you will find a table of “Time Window” Modifier LOINC Codes and “Item Selection” Modifier LOINC Codes. These should be considered as illustrative
Page 58 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
purposes, with the full set of LOINC modifier codes available for use indicated as such on the LOINC database.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 59December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Table 6: Time Window Modifier LOINC Codes
LOINCcode Long Description Example (if appropriate)
18789-8 Include all data of the selected type within the date window associated with the service
NOTE: This is the default value; it will be assumed if no time window modifier code is included
Tests performed during a hospital stay or a note written to describe a clinic visit
18790-6 Include all data of the selected type on or before the date of service
A pathology report to verify the diagnosis for the claim, or per-operative test results
18791-4 Include all data of the selected type within or aligned to a service
Radiology report for test performed during a visit or ordered during the visit and performed within five days
18792-2 Include all data of the selected type on or after the date of service
Status on follow-up
18803-7 Include all data of the selected type that represents observations made 30 days or fewer before the starting date of service
18804-5 Include all data of the selected type that represents observations made three months or fewer before the starting date of service
18805-2 Include all data of the selected type that represents observations made six months or fewer before the starting date of service
18806-0 Include all data of the selected type that represents observations made nine months or fewer before the starting date of service
18807-8 Include all data of the selected type that represents observations made one year or less before the starting date of service
53033-7 Include all data of the selected type that represents observations made two years or less before the starting date of service
18793-0 Use no fixed time limit on data—any of the selected type are relevant no matter when obtained
Page 60 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
[7 ] AT TA C H M E N T U S E C A S E S
The following sections indicate examples of attachment activities covered by this Supplement. These examples will provide typical business flows for each of these attachment activities. Where these examples depict information exchange consistent with an attachment activity (see Table 2: Attachment Activity Types), those specific activities will be identified and correlated back to an entry in that table using their “Attachment Activity ID #”. Some of the examples may include information exchanges that are considered out of scope for this supplement but necessary to reflect the complete business flow. Those considered out of scope will be clearly marked. As previously noted, where attachment activities are indicated the corresponding ASC X12N standard will also be indicated for example purposes, but should not be construed to be limited ONLY to that ASC X12N standard. Is it assumed for these standard references, the attachment activity will be an electronic standard. However, it may be possible for the request activity to be non-electronic (e.g., manual, paper, phone call, etc), provided that the necessary metadata (see Appendix A) is communicated for inclusion in the electronic response. In the sub-chapter sections below, you will find general examples for the solicited and unsolicited scenarios where Attachments are used in support of a healthcare claim or encounter, prior authorizations, referrals, notifications and post-adjudicated claims review/audits. These examples are intended for illustrative purposes only and should not be construed as exhaustive.
[7.1] Example – Claim Attachment
When a provider submits a claim to a payer, the claim may meet a condition(s) which requires an Attachmentadditional information to complete the adjudication of the claim. When the conditions are of a consistent and recurring nature, the payer may make these conditions known in advance to the provider so that the provider may submit the Attachment with the claim (unsolicited). When the condition is of a more “ad hoc” basis, upon receipt/review of the claim the payer may request additional information n Attachment from the provider directly related to that claim (solicited).
[7.1.1] Claim Attachment – Solicited Attachment Example
Example Scenario: A provider submits a healthcare claim/encounter to a payer who, upon review, determines that it needs additional information from the provider to complete the adjudication of the claim. The payer initiates a request for that additional information. The provider receives that request, and responds to the payer with the Attachment needed.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 61December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
The diagram below depicts the business flow of the example above for a solicited claim attachment.
Arrow #1 represents a claim which is submitted from a provider to a payer. Arrow #2 (Attachment Activity #1) represents the request for additional information from the provider. (if electronic, ASC X12N 27766)Arrow #3 (Attachment Activity #2) represents the provider’s response with an Attachment (ASC X12N 2757 7).
Figure 4: Example - Claims Attachment (Solicited)
(OUT OF SCOPE: Information exchange depicted by Arrows#1 is considered out of scope for this supplement as it only acts as a triggering event for additional information needed.)
[7.1.2] Claim Attachment – Unsolicited Attachment Example
Example Scenario: A payer has provided instructions to providers when specific additional information is needed for pre-defined conditions found on a claim. The provider submits a claim to the payer and the supplemental information in addition to the claim.
The diagram below depicts the business flow of the example above for an unsolicited claim Attachment.
Arrow #1 represents a claim which is submitted from a provider to a payer.
Arrow #2 (Attachment Activity #3) represents the provider’s submittal of an additional information Attachment previously agreed to between payer and provider as an Attachment (ASC X12N 27577).
Page 62 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Figure 5: Example – Claims Attachment (Unsolicited)
[7.2] Example – Prior Authorization Attachment
Often healthcare services require specific authorization of coverage in order to secure reimbursement. Depending on the service to be provided and the specifics of patient’s condition/diagnosis, additional patient-specific criteria (e.g. age, sex) and plan coverage, clinical or other information might be needed to support approval of the service.
The need for authorization may be known to the healthcare provider based on:
contracts with the payer, eligibility, formulary or benefit inquiries, prior experience with providing the service for patients covered
by the plan. Alternatively the provider may learn of the need for authorization by virtue of a service denial orcommunication from the payer.
[7.2.1] Prior Authorization Attachment – Solicited Attachment Example
Example Scenario: When the provider is not aware that additional information is needed, only the request for authorization will be sent. The payer/utilization management organization (UMO) receives the request for authorization and upon review, determines that it needs additional information from the provider. The payer/UMO initiates a request for the required documentation. The provider responds to the payer with the Attachment needed. The diagram below depicts the business flow of the example above for an solicited prior authorization attachment.
Arrow #1 represents a Service Authorization Request which is submitted from a provider to a payer (ASC X12N 27888).
Arrow #2 (Attachment Activity #4) represents a request for additional information in support of a service authorization request from the payer to the provider (ASC X12N 2788 8).
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 63December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Arrow #3 (Attachment Activity #5) represents the provider’s response with an Attachment (ASC X12N 2759 9).
Figure 6: Example – Prior Authorization (Solicited)
(OUT OF SCOPE: Information exchange depicted by Arrow #1 is considered out of scope for this supplement as it only acts as a triggering event for additional information needed.)
Prior Authorization Attachment – Unsolicited Attachment ExampleExample Scenario: When the requirement is known, the provider may submit the request at the time the service is planned. This request for prior authorization would be accompanied by the required Attachment in support of the request. The diagram below depicts the business flow of the example above for an unsolicited Prior Authorization Attachment.
Arrow #1 represents a Service Authorization Request which is submitted from a provider to a payer (ASC X12N 2788 8).
Arrow #2 (Attachment Activity #6) represents the provider’s response with an submission of additional information as an Attachment (ASC X12N 2759 9).
Figure 7: Example – Prior Authorization (Unsolicited)
Page 64 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
[7.3] Example – Referral Attachment
[7.4] Patients may be referred to other providers for consultations, services, evaluations, etc. The referral is usually initiated from a care provider, but may be initiated by a payer or other entity. The initiator of the referral may provide clinical information for use by the “referred to” provider (unsolicited). When information is not sent and additional information is needed, the “referred to” provider may request that pertinent information be sent (solicited).
The following diagrams depict the referral processes.
Referral Attachment – Solicited Attachment ExampleExample Scenario: Provider “A” is caring for a patient and refers that patient to a specialist (Provider “B”) for further assessment. Provider “A” sends a referral to Provider “B”. Provider “B” receives the request and, upon review, determines they need additional information from Provider “A” and sends them a request. Provider “A” responds with the Attachment. The diagram below depicts the business flow of the example above for an Solicited Referral Attachment.
Arrow #1 represents a Referral Request which is submitted from provider “A”(referring) to a provider “B”(referred too) (ASC X12N 2788 8).
Arrow #2 (Attachment Activity #7) represents a request for additional information in support of a referral request from the provider “B” to provider “A” (ASC X12N 2788 8).
Arrow #3 (Attachment Activity #8) represents provider “A” response with an Attachment to provider “B” (ASC X12N 2759 9).
Figure 8: Example – Referral Attachment (Solicited)
(OUT OF SCOPE: Information exchange depicted by Arrows #1 is considered out of scope for this supplement as it only acts as a triggering event for additional information needed.)
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 65December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Referral Attachment – Unsolicited Attachment ExampleExample Scenario: Provider “A” is caring for a patient and needs to refer that patient to a specialist (Provider “B”) for further assessment. Provider “A” forwards a referral along with any necessary medical records as Attachments to provider “B”. The diagram below depicts the business flow of the example above for an unsolicited Prior Authorization Attachment.
Arrow #1 represents a Referral which is submitted from a provider “A” to provider “B” (ASC X12N 2788 8).
Arrow #2 (Attachment Activity #9) represents the submittal of medical records from provider “A” to provider “B” as an Attachment (ASC X12N 2759 9).
Figure 9: Example – Referral Attachment (Unsolicited)
Page 66 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
[7.5] Example – Notification Attachment
Notification can be used to send unsolicited information among providers, payers, delegated UMO entities and/or other providers. This information can take the form of copies of health service reviews or notification of scheduled treatment, or the beginning and end of treatment. A participant who is the recipient of the information may acknowledge they received the data, or reject the data due to specific application layer processing, but may not respond with any review decision outcome. Notification falls into four categories: Advance Notification used to communicate scheduled admissions or services. Completion Notification used to communicate patient facility admission or discharge and services completion for any specific episode of care. Information Copy used for any Health Services Review information sent to primary care provider(s), service provider(s), or other healthcare entities requiring the information for specific purposes. Change Notification used to report changes to the detail of a previously sent notification or information copy.
The information source is the entity that knows the outcome of the service review request, and can be either a UMO or a provider. For example, in a situation where the primary care provider can authorize specialty referrals that do not require review for medical necessity, appropriateness, or level of care, the primary care provider is the information source and may have responsibility for notifying both the UMO and the service provider of the specialty referral. In cases where the UMO is the decision maker, the UMO would send a notice of certification to the requesting provider and the service provider.
Notification Attachment – Unsolicited Notice of Facility Discharge with Discharge Summary Example
Example Scenario – A facility provider discharges a patient of a primary care provider, and forwards a notification to that effect. The diagram below depicts the business flow of the example above for a notification Attachment.
Arrow #1 (Attachment Activity #10) represents the submission of request for additional information from the provider as an Attachment. (if electronic, ASC X12N 2759 9)
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 67December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Figure 10: Example – Notification Attachment (Unsolicited)
[7.6] Example – Post Adjudicated Claim Attachment
After the adjudication of a claim or encounter, a payer may elect or be requested to review that claim or encounter to be sure the adjudication was consistent with applicable medical policy. This may include a scenario where additional information from the provider of service may be needed.
Post Adjudicated Claim Attachment – Solicited Attachment Example
Example Scenario: A payer, after adjudicating a claim/encounter, reviews that claim and decides to perform some type of post-adjudication re-consideration of the original disposition. The payer initiates a request for that additional information. The provider receives that request, and responds to the payer with an Attachment . The diagram below depicts the business flow of the example above for a solicited claim Attachment.
Arrow #1 represents a claim which is submitted from a provider to a payer.
Arrow #2 represents a payers remittance advice to the provider. Arrow #3 ( Attachment Activity #11 ) represents the request for additional
information from the provider. (if electronic, ASC X12N 2776 6) Arrow #4 (Attachment Activity #12) represents the provider’s response
with an Attachment (ASC X12N 2757 7).
Page 68 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Figure 11: Example – Post Adjudicated Claim Attachment (Solicited)
(OUT OF SCOPE: Information exchange depicted by Arrows #1 and #2 are considered out of scope for this supplement as they only act as a triggering event for an Attachment.)
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 69December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
[8 ] I MP O R TA N T I N F O R M AT I O N N O T P R E V I O U S LY A D D R E S S E D I N T H I S S U P P L E ME N T
Information in this section should be moved to another section or deleted In Chapter 6, use cases are presented describing anticipated scenarios depicting attachment activities. While business rules are not included in those scenarios, the authors of this supplement believe there are some industry “best practices” that enhance the attachment activity, and may be addressed in mutual trading partner agreements, companion guides, operating rules or regulations. Examples of these business rules include, but are not limited to the following:
[1.] The C-CDA Implementation Guides offer specific document types in structured format along with an unstructured format suitable for other document types not defined in the structured formats. .
[2.] Timeliness considerations for responses to requests for attachment information may be unique to the stakeholders needs, scenarios, etc. Establishing standard timeliness guidance should be avoided. However, establishing reasonable expectations of minimum and maximum time between request and response may be appropriate.
[a.] For solicited requests, consideration should be given to the request envelope including a “respond-by” date for the response to be completed on or before that date to successfully complete the attachment activity.
[b.] For unsolicited responses, policy should be developed to guide payers in claims and prior authorization attachment activities and providers in referral attachment activities what to do if the attachment is received but the claim, prior authorization or referral never arrives and/or cannot be re-associated with the claim, prior authorization or referral itself.
[c.] Guidance should be developed to communicate the ‘in advance’ payer rules for unsolicited attachment activity. This may include payers publishing on their provider web-sites information or other routine provider communications defining the requirements for unsolicited attachment submission(s).
[d.] Proactively defined criteria and situations should be identified where non-conformance with ‘in advance’ rules for unsolicited attachment activity could result in a HIPAA disclosure violation. Examples could include a response attachment activity that exceeded the request (patient
Page 70 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
complete medical record) or response attachment activity not consistent with ‘in advance’ rules.
[3.] Attachment information, by default, is considered to be at the clinical document level. In some cases, the requestor of attachment information may need information at the sub-document level (section or entry). In this case, development of guidance based on scenarios may be helpful to identify the most appropriate document type to request the needed information. Absent that guidance, it would be up to the requestor of attachment information to determine the most appropriate document type to use for the request.
[4.] Use of the unstructured document is intended to accommodate attachment types for which a structured format hasn’t been developed. Structured document types MAY also be sent in an unstructured format (e.g., H&P Scanned Image, discharge summary PDF). It should be thought of as attachment types that would exist at the document level, and where appropriate, capable of being developed into a structured template.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 71December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
[APPENDIX A —] D E F I N I T I O N S , A B B R E V I AT I O N S A N D A C R O N Y M S .
AIS – Additional Information SpecificationASC X12N 277 – Health Care Information Status Notification - Technical Report Type 3 for Health Care Claim Request for Additional InformationASC X12N 275 – Patient Information – Technical Report 3 for Additional Information to Support a Health Care Claim or EncounterASC X12N 278 – Health Care Services Review Information Technical Report 3 for Health Care Services Request for Review and ResponseASC X12N 275 – Patient Information – Technical Report 3 for Additional Information to Support a Health Care Service ReviewAttachments - The additional information needed in support of a healthcare administrative activityAttachment Submission - Refers to additional information submitted to a payer but done so based on advance knowledge of this information need (e.g., rules based on medical policy) rather than in response to a near-term request from the payer Attachment Type – Refers to the type of document (i.e., CCD, History and Physical, Discharge Summary) to be exchangedAttachment Type Identifier – Refers to the LOINC code used to identify the Attachment TypeAttachment Unique ID – A unique identifer assigned to the Request for Attachment and/or the Attachment used for linking the request to the response. AWG – HL7 Attachment Work GroupC-CDA - Consolidated Clinical Document ArchitetureC-CDA Documents – Document level templates defined in the C-CDA R2 and CDP1C-CDA Implementation Guides – C-CDA R2 and CDP1C-CDA R1.1 – HL7 Implementation Guides for CDA Release 2: IHE Health Story Consolidation, DSTU Release 1.1 C-CDA R2 - HL7 Implementation Guides for CDA Release 2: Consolidated CDA Templates for Clinical Notes Volume 1 Introductory Material and Volume 2 Templates and Supporting MaterialCDA – Clinical Document Architecture
Page 72 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
CDP1 - HL7 Implementation Guides for CDA Release 2: Additional CDA R2 Documentation Templates -- Clinical Documents for Payers – Set 1 Claim - May represent a healthcare claim or a healthcare encounter.CMS – Center for Medicare & Medicaid Services. DSTU – Draft Standard for Trial Use – an HL7 designation for a standard or implementation guide that is on a path to become a normative standard. esMD - Electronic Submission of Medial Documentation – a CMS and ONC S&I initiative to identify specific standards to support the electronic exchange of medical documentation for administrative purposes. GIF – Graphics Interchange Format is a digital bitmap image format Healthcare Administrative Activity - Healthcare activities where the need for Attachments may be required (e.g., Claims, Referrals, Prior Authorizations, etc). This includes but is not limited to establishing coverage, conforming with treatment protocols, providing historical documentation for future treatment or other administrative functionsHTML -- Hypertext Markup Language, a standardized system for tagging text files to achieve font, color, graphic, and hyperlink effects on World Wide Web pages. JPEG – Joint Photographic Exerts Group is a compressed digital photography Image compressed using the Joint Photographic Experts Group methodLOINC – Logical Observation Identifiers, Names and Codes (http://loinc.org).Mod-10 – Algorithm applied to a series of numbers to arrive at a single (0-9) digit (check digit). When used in LOINC codes, the algorithm is applied to the digits to left of the hyphen to compute the check digit to the right of the hyphenModifier – Refers to the “Item Selection” or “Time Window” value used to further constrain an Attachment Type requestModifier LOINC Code – Refers to the LOINC Code used as the modifier in a request for an Attachment TypeMSWORD – Microsoft Word file format Object Identifier (OID) - An ISO Object Identifier (OID) is a globally unique string consisting of numbers and dots (e.g., 2.16.840.1.113883.3.1). This string expresses a tree data structure, with the left-most number representing the root and the right-most number representing a leafONC – Office of the National Coordinator S&I – Standards and Interoperability – initiatives supported by ONC to identify and promote standards for interoperability
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 73December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Payer - Refers to a healthcare entity, such as a health insurance company or UMO, that receives and process claims, prior authorizations and referralsPDF – Portable Document Format is a file format developed by Adobe as a means of distributing compact, platform-independent documentsPlain Text – text with no embedded formatting codes PNG – Portable Network Graphics is a bitmapped image format that employs lossless data compression. RTF – Rich Text Format -- a proprietary document file format with published specification developed by Microsoft Corporation Structured Document – a CDA header paired with a structuredBody elementTIFF – Tagged Image Format used for scanned images UMO – Utilization Management Organization Unstructured Document – a CDA header paired with a nonXMLbody element
Page 74 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
APPENDIX A —[APPENDIX B —] C O N S O L I D AT E D C L I N I C A L D O C U ME N T A R C H I T E C T U R E R E L E A S E 2 . 1 (C - C D A R 2 . 1 ) .
Note: information in this Appendix needs to be limited ot CDA R2 and reorganized based on the outline below.Note: The second release of the C-CDA named C-CDA R2 was split into two volumes. This two-volume implementation guide (IG) contains an overview of Clinical Document Architecture (CDA) markup standards, design, and use (Volume 1) and a consolidated library of CDA templates for clinical notes applicable to the US Realm (Volume 2). These two volumes comprise a Draft Standard for Trial Use (DSTU). The C-CDA R2 replaces the HL7 Implementation Guides for CDA Release 2: IHE Health Story Consolidation, DSTU Release 1.1.
B.1 Overview of Implementation Guide
Insert Implementation Guide Overview here
B.2 Document Templates
Insert Document Template description here
B.3 LOINC Codes
Insert LOINC Code mapping here
Table xx: Clinical Document Types with Recommended LOINC Code for Requests
Clinical document Type
"Recommended" LOINC
LOINC Long Description
C-CDA R2 Table
ReferenceValueSet
Care Plan 52521-2Overall Plan of Care/Advance Care Directive
Consultation Note 11488-4 Consult Note Table #28 ConsultDocumentType
CCD 34133-9Summarization of Episode Note
Diagnostic Imaging Report 18748-4
Diagnostic imaging Report
LOINC Imaging Document Codes
Discharge 18842-5 Discharge Table #37 DischargeSummaryTypeCode
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 75December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Clinical document Type
"Recommended" LOINC
LOINC Long Description
C-CDA R2 Table
ReferenceValueSet
Summary Summary
Enhanced Encounter 77601-3
Enhanced Encounter
LOINC code for Enhanced Encounter
History and Physical 34117-2
History and Physical note
Table #41 HPDocumentType
Interval 77600-5 Interval LOINC code for Interval Document
Operative Note 11504-8
Provider-unspecified Operation Note
Table #44SurgicalOperationNoteDocumentTypeCode
Procedure Note 28570-0
Provider-unspecified Procedure Note
Table #48 ProcedureNoteDocumentTypeCodes
Progress Note 11506-3
Provider-unspecified Progress Note
Table# 51 ProgressNoteDocumentTypeCode
Referral Note 57133-1 Referral Note Table# 54 ReferralDocumentType
Transfer Summary 18761-7
Provider-unspecified Transfer Summary
Table# 57 TransferDocumentType
What are C-CDA Document Types?
C-CDA Implementaiton Gudes define clinical information in a format based on CDA, constrained by conformance statements consistent with industry best practices for specific types of clinical documents. Some broadly used clinical document types have been more fully developed in CDA than others. Examples of those clinical document types are: In the C-CDA R2
Continuity of Care Document (CCD) Consultation Note Diagnostic Imaging Report (DIR) Discharge Summary History and Physical Operative Note
Page 76 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Procedure Note Progress Note Care Plan Referral Note Transfer Summary Patient Generated Document
In the CDP1 Enhanced Encounter Document Enhanced Discharge Document Enhanced Operative Note Document Enhanced Procedure Document Interval Document
Other clinical information not listed above may also be exchanged using C-CDA R2 by taking advantage of the “Unstructured Document”, as described in Section 1.1.24 of the C-CDA R2: Volume 1 Introductory Material. Throughout the C-CDA R2 implementers will see references to sending and receiving EHR systems. This is because the C-CDA R2 was written from the perspective of exchange between EHR systems. For the purposes of this supplement there is no assumption that exchange will occur between two EHR systems. Instead, as you will see in the use case portion of this supplement (Chapter 6), the additional information a payer is seeking may exist in a provider’s electronic repository, such as an EHR system, and may/may not be passed through a practice management system or be sourced directly from the EHR. Section 1 of the C-CDA R2: Volume 1 Introductory Material describes at a high level how templates are used to represent the organization of CDA structure in a document. Metadata found in the Header as well as specific clinical information found in the Body components as Documents, Sections within those documents, and entries within those sections are explained are described in Sections 1-4 of the C-CDA R2: Volume 2 Templates and Supporting Material and Sections 5-7 of the CDP1.
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 77December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Table xx: LOINC Codes for Specific C-CDA Documents
GuideDocument Template LOINC
(example)LOINC Long Description
None specified (default) 61000-n No specific document format requested
C-CDA R2
Continuity of Care Document (CCD) urn:hl7ii:2.16.840.1.113883.10.20.22.1.2:2014-06-09
61001-n CCDAR2: Continuity of Care Document
C-CDA R2
Consultation Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.4:2014-06-09
61003-n CCDAR2: Consultation Note
C-CDA R2
Diagnostic Imaging Report (DIR) urn:hl7ii:2.16.840.1.113883.10.20.22.1.5:2014-06-09
61004-n CCDAR2: Diagnostic Imaging Report
C-CDA R2
Discharge Summary urn:hl7ii:2.16.840.1.113883.10.20.22.1.8:2014-06-09
61005-n CCDAR2: Discharge Summary
C-CDA R2
History and Physical urn:hl7ii:2.16.840.1.113883.10.20.22.1.3:2014-06-09
61006-n CCDAR2: History and Physicial
C-CDA R2
Operative Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.7:2014-06-09
61007-n CCDAR2: Operative Note
C-CDA R2
Procedure Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.6:2014-06-09
61008-n CCDAR2: Procedure Note
C-CDA R2
Progress Note
urn:hl7ii:2.16.840.1.113883.10.20.22.1.9:2014-06-09
61009-n CCDAR2: Progress Note
C-CDA R2
Care Plan
urn:oid:2.16.840.1.113883.10.20.22.1.15
61010-n CCDAR2: Care Plan
C-CDA R2
Referral Note urn:oid:2.16.840.1.113883.10.20.22.1.1461011-n
CCDAR2: Referral Note
C-CDA R2
Transfer Summary urn:oid:2.16.840.1.113883.10.20.22.1.13 61012-n
CCDAR2: Transfer Summary
CDP1 Enhanced Encouner Document urn:oid:2.16.840.1.113883.10.20.35.1.1 62001-n
CDP1: Enhanced Encouner Document
CDP1 Enhanced Discharge Document urn:oid:2.16.840.1.113883.10.20.35.1.2
62002-n CDP1: Enhanced Discharge Document
CDP1 Enhanced Operative Note Document urn:oid:2.16.840.1.113883.10.20.35.1.3
62003-n CDP1: Enhanced Operative Note
CDP1 Enhanced Procedure Document urn:oid:2.16.840.1.113883.10.20.35.1.4
62004-n CDP1: Enhanced Procedure Note
CDP1 Interval Document 62005-n CDP1: Interval NotePage 78 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
GuideDocument Template LOINC
(example)LOINC Long Description
urn:oid:2.16.840.1.113883.10.20.35.1.5
The requester should only specify a format if a specific document is preferred. Provider may return any appropriate document type consistant with curent regulation or, in the absence of applicable regulations, with trading partner agreement
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 79December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
APPENDIX B —[APPENDIX C —] C L I N I C A L D O C U M E N T S F O R PAY E R S – S E T 1 R E L E A S E 1 . 1 (C D P 1 R 1 . 1 ) .
Note: information in this Appendix needs to be limited to CDP1 and reorganized based on the outline below.In the Fall of 2013, additional work was done by the Electronic Submission of Medial Documentation (esMD) Initiative to map existing CMS Medicare Fee For Service (FFS) and other use cases where an enhanced set of information is required to be supported in the proposed C-CDA R2 templates. The resulting analysis revealed the need for additional, highly constrained document templates to augment those defined by the C-CDA R2. This work resulted in the creation of documents defined in the Clinical Documents for Payers – Set 1 (CDP1).
C.1 Overview of Implementation Guide
Insert Implementation Guide Overview here
C.2 Document Templates
Insert Document Template description here
C.3 LOINC Codes
Insert LOINC Code mapping here
Table xx: Clinical Document Types with Recommended LOINC Code for Requests
Clinical document Type
"Recommended" LOINC
LOINC Long Description
C-CDA R2 Table
ReferenceValueSet
Care Plan 52521-2Overall Plan of Care/Advance Care Directive
Consultation Note 11488-4 Consult Note Table #28 ConsultDocumentType
CCD 34133-9Summarization of Episode Note
Diagnostic Imaging Report 18748-4
Diagnostic imaging Report
LOINC Imaging Document Codes
Discharge Summary 18842-5
Discharge Summary
Table #37 DischargeSummaryTypeCode
Page 80 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Clinical document Type
"Recommended" LOINC
LOINC Long Description
C-CDA R2 Table
ReferenceValueSet
Enhanced Encounter 77601-3
Enhanced Encounter
LOINC code for Enhanced Encounter
History and Physical 34117-2
History and Physical note
Table #41 HPDocumentType
Interval 77600-5 Interval LOINC code for Interval Document
Operative Note 11504-8
Provider-unspecified Operation Note
Table #44SurgicalOperationNoteDocumentTypeCode
Procedure Note 28570-0
Provider-unspecified Procedure Note
Table #48 ProcedureNoteDocumentTypeCodes
Progress Note 11506-3
Provider-unspecified Progress Note
Table# 51 ProgressNoteDocumentTypeCode
Referral Note 57133-1 Referral Note Table# 54 ReferralDocumentType
Transfer Summary 18761-7
Provider-unspecified Transfer Summary
Table# 57 TransferDocumentType
What are C-CDA Document Types?
C-CDA Implementaiton Gudes define clinical information in a format based on CDA, constrained by conformance statements consistent with industry best practices for specific types of clinical documents. Some broadly used clinical document types have been more fully developed in CDA than others. Examples of those clinical document types are: In the C-CDA R2
Continuity of Care Document (CCD) Consultation Note Diagnostic Imaging Report (DIR) Discharge Summary History and Physical Operative Note Procedure Note
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 81December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Progress Note Care Plan Referral Note Transfer Summary Patient Generated Document
In the CDP1 Enhanced Encounter Document Enhanced Discharge Document Enhanced Operative Note Document Enhanced Procedure Document Interval Document
Other clinical information not listed above may also be exchanged using C-CDA R2 by taking advantage of the “Unstructured Document”, as described in Section 1.1.24 of the C-CDA R2: Volume 1 Introductory Material. Throughout the C-CDA R2 implementers will see references to sending and receiving EHR systems. This is because the C-CDA R2 was written from the perspective of exchange between EHR systems. For the purposes of this supplement there is no assumption that exchange will occur between two EHR systems. Instead, as you will see in the use case portion of this supplement (Chapter 6), the additional information a payer is seeking may exist in a provider’s electronic repository, such as an EHR system, and may/may not be passed through a practice management system or be sourced directly from the EHR. Section 1 of the C-CDA R2: Volume 1 Introductory Material describes at a high level how templates are used to represent the organization of CDA structure in a document. Metadata found in the Header as well as specific clinical information found in the Body components as Documents, Sections within those documents, and entries within those sections are explained are described in Sections 1-4 of the C-CDA R2: Volume 2 Templates and Supporting Material and Sections 5-7 of the CDP1.
Table xx: LOINC Codes for Specific C-CDA Documents
GuideDocument Template LOINC
(example)LOINC Long Description
None specified (default) 61000-n No specific document format requested
C-CDA Continuity of Care Document (CCD) 61001-n CCDAR2: Continuity Page 82 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
GuideDocument Template LOINC
(example)LOINC Long Description
R2 urn:hl7ii:2.16.840.1.113883.10.20.22.1.2:2014-06-09 of Care DocumentC-CDA R2
Consultation Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.4:2014-06-09
61003-n CCDAR2: Consultation Note
C-CDA R2
Diagnostic Imaging Report (DIR) urn:hl7ii:2.16.840.1.113883.10.20.22.1.5:2014-06-09
61004-n CCDAR2: Diagnostic Imaging Report
C-CDA R2
Discharge Summary urn:hl7ii:2.16.840.1.113883.10.20.22.1.8:2014-06-09
61005-n CCDAR2: Discharge Summary
C-CDA R2
History and Physical urn:hl7ii:2.16.840.1.113883.10.20.22.1.3:2014-06-09
61006-n CCDAR2: History and Physicial
C-CDA R2
Operative Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.7:2014-06-09
61007-n CCDAR2: Operative Note
C-CDA R2
Procedure Note urn:hl7ii:2.16.840.1.113883.10.20.22.1.6:2014-06-09
61008-n CCDAR2: Procedure Note
C-CDA R2
Progress Note
urn:hl7ii:2.16.840.1.113883.10.20.22.1.9:2014-06-09
61009-n CCDAR2: Progress Note
C-CDA R2
Care Plan
urn:oid:2.16.840.1.113883.10.20.22.1.15
61010-n CCDAR2: Care Plan
C-CDA R2
Referral Note urn:oid:2.16.840.1.113883.10.20.22.1.1461011-n
CCDAR2: Referral Note
C-CDA R2
Transfer Summary urn:oid:2.16.840.1.113883.10.20.22.1.13 61012-n
CCDAR2: Transfer Summary
CDP1 Enhanced Encouner Document urn:oid:2.16.840.1.113883.10.20.35.1.1 62001-n
CDP1: Enhanced Encouner Document
CDP1 Enhanced Discharge Document urn:oid:2.16.840.1.113883.10.20.35.1.2
62002-n CDP1: Enhanced Discharge Document
CDP1 Enhanced Operative Note Document urn:oid:2.16.840.1.113883.10.20.35.1.3
62003-n CDP1: Enhanced Operative Note
CDP1 Enhanced Procedure Document urn:oid:2.16.840.1.113883.10.20.35.1.4
62004-n CDP1: Enhanced Procedure Note
CDP1 Interval Document urn:oid:2.16.840.1.113883.10.20.35.1.5
62005-n CDP1: Interval Note
The requester should only specify a format if a specific document is preferred. Provider may return any appropriate document type consistant with curent
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 83December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
regulation or, in the absence of applicable regulations, with trading partner agreement
Page 84 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
APPENDIX C —[APPENDIX D —] C -C D A D OC U ME N T T R A N S P O RT A N D PAY L O A DThis appendix covers standards based approaches to sending a C-CDA Document using electronic transactions. This Appendix will use CDA any C-CDA Document.
D.1 Transport OptionsX12 275, CONNECT w/ X12 275 (X12 message), CONNECT (XDR), Direct (X12 message), and Direct are five transport and payload mechanisms covered in this appendix.
Transport Message/Metadata Clinical PayloadX12 (real-time) (SOAP) ASC X12N 275 with CAQH CORE CDACONNECT (SOAP) ASC X12N 275 with CAQH CORE CDACONNECT (SOAP) XDR CDADirect (SMTP) ASC X12N 275 (X12 MIME) CDADirect (SMTP) XML MIME CDA
D.2 Metadata requirements
When an EHR or other patient record system creates any clinical document (Attachment) consistent with the C-CDA Implementation Guide Standards, it does so without regard to the recipient or that recipient’s purpose for obtaining that Attachment. Because of this, the recipient may need additional information (metadata) to better understand which healthcare attachment activity for which the Attachment is intended.The following metadata SHALL accompany the attachment information being exchanged:
Requestor (Payer/UMO) Name and Identifier (plan ID, HPID, etc) Request receiver Name and ID (ETIN, etc) Provider of Service Name and ID (NPI) Attachment Control ID (payer or provider assigned, depending on
solicited/unsolictied) Attachment Information ID needed (LOINC Code), both in request
and response Date Requested and Response Due Date Payer Contact Information Date of Service/Encounter
In addition to the metadata above, the following MAY be included if the situation indicates:HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 85December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Patient Control Number (assigned by provider on claim) Patient Medical Record Number (assigned by provider on claim) Property and Casualty Claim Number Case Reference ID Attachment Request Tracking ID
.
D.3 Overview of X12 (real-time)This section defines how a transaction may be submitted with the X12 275. Submission under this mechanism is constrained to real-time transmissions (batch transmissions are out of scope):
Figure 8-12: X12 (real-time)
D.3.1 Security MetadataWhen using the Phase II CAQH CORE Rule 270: Connectivity Rule 2.2.0, the Security Metadata must be placed in the Body element of the SOAP envelope, as illustrated below (example is for using standards defined by the HL7 Digital Signature and Delegation of Rights DSTU and applied to transaction as specified in the S&I PPA Implementation Guide):
<securityMetadata><digitalSignature>...</digitalSignature><delegationofRights>...</delegationofRights >
</securityMetadata>Page 86 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
ASC X12N EnvelopeInterchange/functional Groups
X12
<SOAP Body>
</SOAP Body>
</SOAP Header>
<SOAP Header>
SOAP Envelope over HTTP
ASC X12N 275 with CDA
Security Metadata (optional)
D.3.2 Error HandlingEnvelope level errors shall be handled in accordance with Phase II CAQH CORE Rule 270: Connectivity Rule Version 2.2.0. To handle CORE-compliant envelope processing status and error codes, two fields called errorCode and errorMessage are included in the CORE-compliant Envelope. errorMessage is a free form text field that describes the error for the purpose of troubleshooting/logging. When an error occurs, PayloadType is set to CoreEnvelopeError.
Errors in processing security metadata shall be treated as CORE envelope level errors. The CORE envelope error codes will use the security specific error codes identified in Error: Reference source not found. Error: Reference source not found shows the error, the error code, and a description of information which may populate the attributes of the CORE errorMessage field
X12 Interchange Envelope Conformance errors in the transaction shall be communicated in an X12 TA1 response. The possible TA1 error codes are located in the ASC X12N TA1 005010X231A1 Implementation Specification.
X12 Standard Conformance & Implementation Guide Conformance errors in the transaction shall be communicated in an X12 999 response. The possible 999 error codes are located in the ASC X12N 999 005010X231A1 Implementation Specification.
Application processing errors in the transaction shall be communicated in an X12 824 response. The possible 824 error codes are located in the ASC X12N 824 005010X186A1 Implementation Specification. When the error has been caused by a specific segment or segments, the response should identify the segment or segments that caused the error. It is the responsibility of the responder to select an appropriate error code from the Insurance Business Process Application Error Codes.
The relevant ASC X12N Implementation Guides for error and acknowledgment handling are available at http://store.x12.org/store/healthcare-5010-original-guides.
The Insurance Business Process Application Error Codes are maintained by the Washington Publishing Company and are available at http://www.wpc-edi.com/reference/codelists/healthcare/insurance-business-process-application-error-codes/.
D. 4 Overview of a payload over CONNECT with ASC X12N MessageThis section defines how a CDA document may be sent over CONNECT with the CAQH CORE ASC X12N Document Submission Service Interface Specification
D.4.1 ASC X12N 275 over CONNECT (CORE)Healtheway (previously the Nationwide Health Information Network (NHIN)) adopted the Phase II CAQH CORE Rule 270: Connectivity Rule Version 2.2.0 to exchange ASC X12N Administrative Transactions between one or more Health Information Exchanges via the Internet. CONNECT is the open-source solution used by CMS supporting Exchange participants. The “CAQH CORE X12 Document Submission Service Interface Specification”10 defines specific constraints on the use of the CAQH CORE Connectivity Rule. Error: Reference source not found below presents the components of a request or response
10
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 87December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
message using 275 and CONNECT with the NHIN CAQH CORE X12 Document Submission Service Interface Specification.Specific CONNECT implementations may provide support for X12 transactions with a CAQH CORE wrapper without an XDR wrapper. Implementations of CONNECT should be capable of sending and receiving CAQH CORE-wrapped X12 transactions with an XDR wrapper, and optionally without an XDR wrapper based on trading partner agreements.
CDA transactions using XDR specifications shall conform with NHIN Document Submission v2.0 transmissions. The XDR XML body element will contain a reference to the 275, where the metadata information block is encapsulated with the XDR submission set and its document attributes. XDR submission specifications (i.e., submission set & document metadata attributes) for esMD are available in Section 3.2 (Submission Specifications) within the NHIN esMD XDR Specification.11
Figure 8-13: CONNECT with ASC X12N Specification
Note: Per specifications, encoding for XDR may be indicated in the metadata, and encoding must be Base64.12
11 A style sheet is a specification used by browsers for controlling the display of the markup language (e.g. XML or HTML), decribing how elements of a document should be displayed. The stylesheet in the C-CDA R2 (See Appendix C) and CDP1 (See Appendix X) are is provided by HL7 to the implementer as options and are not required to be used by the implementer. The implementer may choose to create their own customized stylesheet to render the information to a browser.12
Page 88 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
D.4.2 CONNECT SAML AssertionsSAML assertions for transactions with CMS must conform to the “Implementation Guide for Health Information Handlers for Electronic Submission of Medical Documentation Project,” section 5.3.5.5: esMD SAML Assertions Details, which states:
The CONNECT SAML Assertions define the exchange of metadata used to characterize the initiator of a request so that it may be evaluated by the Payer Gateway in local authorization decisions. The purpose of this SAML Assertion exchange is to provide the Payer Gateway with the information needed to make an authorization decision using the policy enforcement point for the requested esMD function. Each initiating SOAP message must convey information regarding the Registration Requestor’s attributes and authentication using SAML 2.0 Assertions.
SAML assertions for transactions with Commercial Payers must conform to the eHealth Exchange Authorization Framework Specification v3.0.
D.4.3 IHE XD* MetadataSystems using an HPD Plus DSMLv2 document payload over CONNECT or Direct should adopt the IHE Cross Enterprise Document Reliable Interchange (XDR) profile with XDS Repository Submission Request Provide and Register Document set – b (ITI-41) transaction metadata.
Cross-Enterprise Document Reliable Interchange (XDR) provides document interchange using a reliable messaging system. This permits direct document interchange between EHRs, PHRs, and other healthcare IT systems in the absence of a document sharing infrastructure such as XDS Registry and Repositories.
Cross-Enterprise Document Media Interchange (XDM) provides document interchange using a common file and directory structure over several standard media, including email. This permits the use of person-to-person email to convey documents. XDM defines no new metadata but leverages the existing XDS metadata.
D.5 Overview of a payload over CONNECT with XDRThis section defines how a transaction may be sent over CONNECT with the eHealth Exchange CAQH CORE X12 Document Submission Service Interface Specification.
The Nationwide Health Information Network has adopted the Phase II CAQH CORE Rule 270: Connectivity Rule Version 2.2.0 to exchange ASC X12N Administrative Transactions between one or more Health Information Exchanges via the Internet. The “CAQH CORE X12 Document Submission Service Interface Specification” defines CONNECT specific constraints on the use of the CAQH CORE Connectivity Rule. The figure below presents the components of a transaction using CONNECT with the NwHIN Exchange CAQH CORE X12 Document Submission Service Interface Specification:
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 89December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Figure 8-14: CONNECT w/ X12 275
Note: Per specifications, encoding for XDR may be indicated in the metadata, and encoding must be Base64.13
13 Page 90 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
Table 8-7: XD* Submission Set Metadata
S.No Existing or Extension
XD* Metadata Attribute Definition14 Data Type Require
d15
1 Existing Author Represents the humans and/or machines that authored the document. This attribute contains the following sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty, authorTelecommunication
R2
1.1 Existing authorInstitution (sub-attribute of author)
XON.1 - Name of the Provider or Agent sending the request XON.10 - ID of the Provider or Agent sending the request
XON R2
1.2 Existing authorPerson (sub-attribute of author)
Contact person for administrative questionsXCN.2 - Last NameXCN.3 - First NameXCN.4 - Middle NameXCN.5 - SuffixXCN.6 - Prefix
XCN O
1.3 Existing authorTelecommunication
Telephone/fax/email for esMD administrative questionsXTN.1 - [NNN] [(999)]999-9999 [X99999] [B99999] [C any text]XTN.4 - Email AddressXTN.6 - area codeXTN.7 - phone numberXTN.8 - extension
XTN O
2 Existing Comments Description of reason for the replacement, follow up, or termination for a prior request
O
3 Existing contentTypeCode
The code specifying the type of clinical activity that resulted in placing these XDS Documents in this XDS-Submission Set. These values are to be drawn for a vocabulary defined by the XDS Affinity Domain.
R2
4 Existing contentTypeCodeDisplayName
R2
5 Existing entryUUID A unique ID or a globally unique identifier within the document submission request for the SubmissionSet. Intervening portal generates this as part of generating the XDR/XDM message
UUID R
6 Existing intendedRecipient
Intended Recipient represents the organization(s) or person(s) for whom the Document Submission set is intended.
XON/XCN R2
14 Document Type for “setting” and “Specialty/Training/Professional Level”15 http://healthewayinc.org/images/Content/Documents/specs/2011/caqh-core-x12-document-submission-service-specification-v1-0-508.pdf HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 91December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
The Intended Recipient for the Registration Request will be a Payer or Payer Contractor to whom the Provider or Agent sends the message. This Intended Recipient will be identified by the Unique Payer ID.
For Payer, use XON datatype:XON.1 - Organization NameXON.10 - Organization NPI or Alternate ID
7 Existing patientID The patientId represents the subject of care of the document. R28 Existing sourceID Globally unique identifier, in OID format R9 Existing submissionTime Point in Time at the Document Source when the Submission Set was
created and issued for registration to the Document Registry. Shall have a single value.
This shall be provided by the Document Source (in case of e-mail with significant delay).
Timestamp should be to at least the second
DTM R
10 Existing title Represents the title of the Submission Set. O11 Existing uniqueID A globally unique identifier, in OID format, assigned by the Sender to
the submission set in the transmission. The length of this Unique Identifier shall not exceed 128 bytes.
R
Table 8-8: XD* Document Entry Metadata
S.No Existing or Extension
XD* Metadata Attribute Definition Data Type Require
d16
1 Existing author Represents the humans and/or machines that authored the document. This attribute contains the following sub-attributes: authorInstitution, authorPerson, authorRole, authorSpecialty. Note that the sender information is carried in the Submission Set author attribute, not necessarily this one.
R2
1.1 Existing authorInstitution (sub-attribute of author)
XON.1 - Name of the Provider or Agent XON.10 - ID of the Provider or Agent f
XON R2
1.2 Existing authorPerson Contact person for esMD administrative questions XCN O16 http://exchange-specifications.wikispaces.com/file/view/ESMD_XDR_Production_Specification_v1.0.pdf Page 92 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
(sub-attribute of author)
XCN.2 - Last NameXCN.3 - First NameXCN.4 - Middle NameXCN.5 - SuffixXCN.6 - Prefix
2 Existing classCode The code specifying the particular kind of document. Supports environments where content is provided without context, for example a PDF document or a patient's document as patients do not understanding coding systems. Could consider a well-known class code which identifies the entry as a "directed" entry.
XDR/XDM - R2
3 Existing classCodeDisplayName
The name to be displayed for communicating to a human the meaning of the classCode. Shall have a single value for each value of classCode.
XDR/XDM - R2
4 Existing comments Description of reason for the replacement, follow up, or termination for a prior request
O
5 Existing confidentialityCode
The code specifying the level of confidentiality of the Document. XDR/XDM - R2
6 Existing creationTime Represents the time the author created the document in the Document Source. Shall have a single value. If the creation time of the document is unknown it is better to specify nothing than use a value that is misleading.
DTM XDR/XDM - R2
7 Existing entryUUID A unique ID or a globally unique identifier within the document submission request for the SubmissionSet. Intervening portal generates this as part of generating the XDR/XDM message
UUID R
8 Existing formatCode Globally unique code for specifying the format of the document. XDR/XDM - R2
9 Existing formatCodeDisplayName
The name to be displayed for communicating to human readers the meaning of the formatCode.
XDR/XDM - R2
10 Existing hash Hash key of the request/response XML document. SHA1 XDR - OXDM - R
11 Existing healthcareFacilityTypeCode
This code represents the type of organizational setting of the clinical encounter during which the documented act occurred.
XDR/XDM - R2
12 Existing healthcareFacilityTypeCodeDisplayName
The name to be displayed for communicating to a human the meaning of the healthcareFacilityTypeCode. Shall have a single value corresponding to the healthcareFacilityTypeCode.
XDR/XDM - R2
13 Existing languageCode Specifies the human language of character data in the document. The values of the attribute are language identifiers as described by the IETF (Internet Engineering Task Force) RFC 3066.
XDR/XDM - R2
14 Existing mimeType MIME type of the document in the Repository. Shall have a single R
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 93December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
value.15 Existing patientID The patientId represents the subject of care of the document. XDR/XDM
- R216 Existing practiceSettingC
odeThe code specifying the clinical specialty where the act that resulted in the document was performed.
XDR/XDM - R2
17 Existing practiceSettingCodeDisplayName
The name to be displayed for communicating to a human the meaning of the practiceSettingCode. Shall have a single value corresponding to the practiceSettingCode.
XDR/XDM - R2
18 Existing sourcePatientId The sourcePatientId represents the subject of care medical record Identifier (e.g., Patient Id) in the local patient Identifier Domain of the Document Source. It shall contain two parts:Authority Domain IdAn Id in the above domain (e.g., Patient Id).
XDR/XDM - R2
19 Existing title Represents the title of the document. Max length shall be 128 bytes in UTF-8 format.
O
20 Existing typeCode The code specifying the precise kind of document R221 Existing typeCodeDispla
yNameThe name to be displayed for communicating to a human the meaning of the typeCode. Shall have a single value corresponding to the typeCode.
R2
22 Existing uniqueID Globally unique identifier for the document in submission-set assigned by the Document Source in OID format. Shall have a single value.
A globally unique identifier assigned to each document in the SubmissionSet. The length of the Unique Identifier shall not exceed 128 bytes. The structure and format of this ID shall be consistent with the specification corresponding to the format attribute. This ID will be generated based on the UUID.Generated based on the UUID. The same ID will be returned with the response message.
R
23 Existing URI Required in XDM to address the location in the zip package of the document
XDR - OXDM - R
Page 94 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
D.5.1 esMD Security MetadataWhen using CONNECT, the Security Metadata must be placed in the Body element of the SOAP envelope. Refer to illustration in section : D.3.1 Security Metadata.
D.5.2 Error HandlingXD* error codes are defined in Section 4 of Integrating the Healthcare Enterprise’s (IHE’s) Information Technology Industry (ITI) Technical Framework, Volume 3. For errors related to processing the XD* metadata, the esMD Response to a Registration Request will use the XD* error codes.
For errors related to processing the esMD Security metadata in the context of Provider Registration, the esMD Response to a Registration Request will use the esMD security specific error codes identified in Error: Reference source not found. Error: Reference source not found shows the esMD error, the esMD error code, and a description of information which will populate the fields of the ebRS RegistryResponse.
Application processing errors shall be communicated in an ebRS RegistryResponse using the Insurance Business Process Application Error Codes. It is the responsibility of the responder to select an appropriate error code from the Insurance Business Process Application Error Codes; codes that are highly relevant to the esMD Registration Request are identified in Section Error: Reference source not found, Error: Reference source not found.
The ebRS RegistryResponse errorCode field must contain the selected esMD error or Insurance Business Process Application Error Codes. When the error has been caused by a specific HPD Plus attribute, the ebRS RegistryResponse location field should identify the Object Class and Attribute that caused the error.
D.6 Overview of payload over Direct (X12 Message)This section defines how a transaction may be sent using Direct. The figure below presents the components of a transaction over Direct:
Figure 8-15: Direct Message
Note: XDM and XDR metadata allow for indication of encoding method. This method must be Base64.17 XDM is optional in cases where more than one clinical document is included in Attachment 1.
D.6.1 Overview of payload over DirectThis section defines how a transaction may be sent Direct. The figure below presents the components of a transaction over Direct:
Figure 8-16: Direct Message
Note: XDM and XDR metadata allow for indication of encoding method. This method must be Base64.18 XDM is optional in cases where more than one clinical document is included in Attachment 1.
17 Nationwide Health Information Network Electronic Submission of Medical Docmentation: esMD XDR Production Specification, Version 1.018 Nationwide Health Information Network Electronic Submission of Medical Docmentation: esMD XDR Production Specification, Version 1.0
Page 96 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 97December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
APPENDIX D —[APPENDIX E —] A S C X 1 2N S TA N D A R D S T R A N S A C T I O N A N D E R R O R F L O W
ASC X12N has created several standards for enveloping the Attachment
Page 98 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 99December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012
Page 100 HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1© 2015 Health Level Seven International. All rights reserved. December 2015
APPENDIX E —[APPENDIX F —] FA S T H E A LT H C A R E I N T E R O P E R A B I L I T Y R E S O U R C E S ( F H I R )
F.1 What is FHIR
Insert Implementation Guide Overview here
F.2 Introduction to FHIR Resources
Insert Document Template description here
F.3 Use of FHIR to solict and exchange Attachments
Insert LOINC Code mapping here
HL7 Attachment Supplement Specification: Exchange Implementation Guide, Release 1 Page 101December 2015 © 2015 Health Level Seven International. All rights reserved.
May 2012