{"text_format":"1","workbook":"xlsx","n_sheets":57,"sheets":["Table of Contents","Introduction","Scope","Message Transport","Onboarding Process","Requirements Specific to WA","Message and Data Validation","Application Conformance Symbols","HL7 Data Types","FAQs","VXU","MSH","PID","PD1","NK1","IN1","ORC","RXA","RXR","OBX","NTE","Sample VXUs","Query (QBP)","Z34 - Complete History","Z44 - Eval History & Forecast","Query MSH","Query QPD","Query RCP","Z31 - Return List of Candidates","Z32 - Return Complete History","Z33 - Return with No Matches","Z42 - ReturnHistory & Forecast ","Response MSH","Response MSA","Response QAK","Response QPD","Z32 - MSA","Z32 - QAK","Z32 - QPD","Z44 - QPD","Z44 - RCP","Z42 - MSA","Z42 - QAK","Z42 - QPD","Sample Queries & Responses","ERR","Error Codes","Demographics Crosswalk","Vaccination Crosswalk","PAIS Crosswalk","Value Sets","NIP001","NIP002","NIP003","NIP004","CDC Information","Document History"],"not_rendered":{"charts":0,"images":10,"macros":1,"external_links":0,"defined_names":15,"comments":13,"pivot_tables":0},"unopened":[],"bounds":{"document_bytes":16777216,"sheet_cells":100000,"rows_first":2000,"rows_last":500,"rows_between":2000,"halvings":0,"cell_chars":16384,"cell_head_chars":4096},"cells_cut":0,"cells_raw":0,"read":"whole","date_system":"1900"}

{"sheet":"Table of Contents","index":0,"n_rows":33,"n_cols":10,"rows_kept":33,"cut":false,"hidden":false,"merged":[[1,1,1,9],[32,1,32,9]]}
[]
[null,"Table of Contents"]
[]
[null,"GENERAL INFORMATION",null,"VXU MESSAGE SEGMENTS",null,"QUERIES",null,"ERRORS",null,"ADDITIONAL INFORMATION"]
[null,"Introduction",null,"VXU",null,"Z34 Query - Complete History",null,"ERR",null,"CDC Information"]
[null,"Scope",null,"MSH",null,"Z44 Query  - Eval History & Forecast",null,"Error Codes"]
[null,"Message Transport",null,"PID",null,"Query MSH"]
[null,"Onboarding Process",null,"PD1",null,"Query QPD",null,"CROSSWALKS"]
[null,"Requirements Specific to WA",null,"NK1",null,"Query RCP",null,"Demographics Crosswalk"]
[null,"Message and Data Validation",null,"IN1",null,null,null,"Vaccination Crosswalk"]
[null,"Application Conformance Symbols",null,"ORC",null,"RESPONSES",null,"PAIS Crosswalk"]
[null,"HL7 Data Types",null,"RXA",null,"Z31 Response - Return List of Candidates"]
[null,"FAQs",null,"RXR",null,"Z32 Response - Return Complete History",null,"VALUE SETS"]
[null,null,null,"OBX",null,"Z33 Response - Return with No Matches",null,"Value Sets"]
[null,null,null,"NTE",null,"Z42- Response - Eval History & Forecast",null,"NIP001"]
[null,null,null,"Sample VXUs",null,"Response MSH",null,"NIP002"]
[null,null,null,null,null,"Response MSA",null,"NIP003"]
[null,null,null,null,null,"Response QAK",null,"NIP004"]
[null,null,null,null,null,"Response QPD"]
[null,null,null,null,null,"Sample Queries & Responses"]
[]
[null,null,null,null,null,"NOTES:"]
[null,null,null,null,null,"1. There are 2 types of queries"]
[null,null,null,null,null,"with each having the following "]
[null,null,null,null,null,"segments: MSH, QPD & RCD"]
[]
[null,null,null,null,null,"2. There are 4 types of responses."]
[null,null,null,null,null,"with each having the following: "]
[null,null,null,null,null,"segments: MSH, MSA, QAK & QPD"]
[]
[null,null,null,null,null,"The table of contents has been set-up to only list each segment-type once for queries & responses."]
[null,null,null,null,null,null,null,null,null,"HL7 WAIIS Implentation Guide\nDOH 348-650 May 2022"]
[null,"To request this document in another format, call 1-800-525-0127. Deaf or hard of hearing customers, please call 711 (Washington Relay) or email civil.rights@doh.wa.gov."]

{"sheet":"Introduction","index":1,"n_rows":19,"n_cols":4,"rows_kept":19,"cut":false,"hidden":false,"merged":[[38,0,38,20],[39,0,39,20],[1,1,1,2],[1,3,1,4],[2,1,2,2],[2,3,2,4]]}
[]
[null,"Welcome to the Washington State Immunization Information System (WAIIS) Health Level Seven (HL7) 2.5.1 Implementation Guide"]
[]
[]
[]
[]
[]
[null,"The WAIIS is a secure web-based application developed and supported by STChealth. The WAIIS supports bi-directional data exchange using Health Level 7 (HL7) messaging.","STChealth"]
[]
[null,"OneHealthPort (OHP), the State Health Information Exchange (HIE), is the preferred method for all data exchange with the Department of Health. Message transport is available via web services (CDC WSDL). Real-time data submission is preferred; however, batch submission may be accepted.","HIE"]
[]
[null,"In addition to this guide, the following documents define the WAIIS HL7 data exchange standards:"]
[null,"HL7 Version 2.5.1 Implementation Guide for Immunization Messaging, Release 1.5 2018 Update - This document combines the original HL7 2.5.1 Release 1.5 Implementation Guide and Release 1.5 Addendum, as well as additional guidance published by AIRA. The purpose of this document is to provide a single document containing essential HL7 information, so that implementers and developers have a convenient single set of information to work from. ","CDC 2.5.1"]
[null,"OneHealthPort Connectivity Implementation Guide - This document defines how to establish connectivity to the OneHealthPort HIE to securely exchange clinical, public health reporting, and administrative information with the Department of Health.","Guide"]
[null,"CDC SOAP Web Services (PDF) This document defines transport, security, and SOAP operations, parameters, and faults for SOAP-based HL7 submissions and queries to an IIS - This specification contains the SOAP WSDL, which should be implemented without modification.","CDC SOAP"]
[]
[null,"We follow the same process for all interface projects regardless of whether a provider is intending to submit data to meet a measure under a Promoting Interoperability Program objective. For Promoting Interoperability Program questions, please refer to our website or send an email to IISMeaningfulUse@doh.wa.gov.","Website","IISMeaningfulUse"]
[null,"To participate in the WAIIS, you must have an Information Sharing Agreement in place. For information about participating in the IIS please visit the Immunization Information System webpage.","IIS Webpage"]
[null,"WAIIS Information Sharing Agreement Exchange of Immunization Data  (PDF)","ISA"]

{"sheet":"Scope","index":2,"n_rows":38,"n_cols":2,"rows_kept":38,"cut":false,"hidden":false,"merged":[[46,0,46,20],[47,0,47,20]]}
[]
[null,"In order for different health information systems to exchange data, the structure and content of the data to be exchanged must be standardized. Three controlling documents define how HL7 data exchange interfaces works."]
[]
[null,"They are arranged in a hierarchy of documents, each refining and constraining the HL7 Standard."]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[]
[null,"The first document is the HL7 2.5.1 standard developed by Health Level Seven, a not-for-profit ANSi-accredited standards developing organization. The standard defines \nthe structure and content of immunization messages, but leaves many specific implementation details undecided. Beneficial information on HL7 and a copy of the HL7 \nmessage standard can be obtained from the HL7 website at http://www.hl7.org/."]
[]
[null,"The second document is the CDC's HL7 2.5.1 Implementation Guide for Immunization Messaging, Release 1.5 (CDC IG). This guide gives specific instructions regarding how to report to immunization information systems, but still leaves some implementation decisions to each state IIS. This guide and other technical information can be obtained from the CDC website at https://repository.immregistries.org/files/resources/5bef530428317/hl7_2_5_1_release_1_5__2018_update.pdf."]
[]
[null,"This document, the WAIIS HL7 Implementation Guide, is the third. It finalizes all implementation decisions and defines exactly what WAIIS will and will not accept.  This guide is arranged by tabs, with one for each segment that we expect to see with each incoming message. \n\nEach tab has an example and notes that may assist in message construction/workflow improvement. Each table has the same headers, which explain what is included within the message. In cases where this guide differs from the CDC IG, the column header of \"WA Usage\" indicates Washington's preference for reporting the data element.  This guide also provides the WAIIS' limitations, identified on each tab in the WAIIS Limit column with character limit or not captured. While reading this guide, you can hover over the elements that have triangles to see more details. \n"]
[]
[null,"Please note the differences in messages sent for administered vaccines versus those sent for historically reported vaccines. Certain elements are required for administered vaccines that are not applicable when reporting historical records. \n\nWe suggest that all organizations review their codes for vaccines and manufacturers on a regular basis. A link to the CDC code set website is on the CDC Information tab of this guide. \n\nWe have the ability to synch vaccine inventory with WAIIS. Please review the needed elements required to decrement each administered dose. If these elements are not present, then decrementing cannot be automatically completed."]
[null,"     a. Sending and receiving immunization histories for individuals\n     b. Sending and receiving demographic information about the individuals\n     c. Requesting immunization histories for individuals\n     d. Responding to requests for immunization histories by returning immunization histories\n     e. Acknowledging receipt of immunization histories and requests for immunization histories\n     f. Reporting errors in the messaging process\n     g. Sending observations about an immunization event (this may include funding, reactions, forecasts, and evaluations)"]
[]
[null,"This document is intended to facilitate the exchange of immunization records between Electronic Health Records (EHR) and the Health Information Exchange (HIE) and the WAIIS. This includes:"]
[null,"     a. Sending and receiving immunization histories for individuals\n     b. Sending and receiving demographic information about the individuals\n     c. Requesting immunization histories for individuals\n     d. Responding to requests for immunization histories by returning immunization histories\n     e. Acknowledging receipt of immunization histories and requests for immunization histories\n     f. Reporting errors in the messaging process\n     g. Sending observations about an immunization event (this may include funding, reactions, forecasts, and evaluations)"]
[]
[null,"It is important to note this guide adheres to the CDC IG on several key aspects, including:"]
[null,"     a. Data type specifications from Chapter 4 of the IG have not been redefined and usage has not been changed\n     b. Standardized vocabulary is supported as specified in the IG\n     c. To the extent possible, data sets and business rules will adhere to the IG"]
[]
[null,"NOTE: The PV1 segment is used to convey visit specific information. The primary use in immunization messages in previous releases was to carry information about the client's eligibility status. This is now recorded in the immunization event (dose administered) level. Use of this segment for the purpose of reporting client eligibility for a funding program at the visit level is not supported in this Implementation Guide."]

{"sheet":"Message Transport","index":3,"n_rows":26,"n_cols":2,"rows_kept":26,"cut":false,"hidden":false,"merged":[[15,4,15,9],[21,4,21,9]]}
[]
[null,"Request Encoding"]
[null,"When the sending application sends PHC Hub an HL7 message via an HTTPS POST command, it must have the following fields:\n•        USERID - Assigned by the PHC Hub administrator\n•        PASSWORD - Assigned by the PHC Hub administrator\n•        MESSAGEDATA - The HL7 messages\n"]
[null,"HL7 messages may be sent one at a time (one for every HTTPS request) or grouped in a batch. Batch messages do not have any special separators or wrappers, but the standard HL7 batch protocol may be used. The batch is formatted as follows: [FHS] { [BHS] { [MSH] ... ] } [BTS] } [FTS]"]
[null,"Messages can fail if: \n•        The message is of an unsupported message type (MSH-9) \n•        The message has an unsupported event code (MSH-9) \n•        The message has an unsupported processing ID (MSH-11) \n•        The message has an unsupported version ID (MSH-12) \n•        The message is unable to be processed for reasons unrelated to format or content "]
[null,"If one of the above events causes a message to be rejected, the QBP response will include Z23 in MSH21. If an error of a different type occurs, PHC Hub will return a Z33 (ACK) response profile."]
[]
[null,"Response Encoding"]
[null,"PHC Hub returns acknowledgements to the sending system. Requests with multiple messages can have multiple acknowledgements, one for each request message. Acknowledgements are returned as defined in the account configuration. "]
[null,"The available options are:\n•        Always - Always send a response for a message\n•        Never - Never send a response for a message\n•        On Error - Send responses only for those messages that have errors and are not accepted\n•        Determined by Message - Use the incoming message's MSH segment to determine the response option (Always, Never, or Only on Error)\n\n"]
[null,"Acknowledgements from the HL7 interface are always in HL7 format. HL7 acknowledgements can indicate any one of the following:\n•        Authentication error - The HL7 user making the request is not allowed to because the username and password are incorrect or the account does not have permission to accept HL7 messages.\n•        Message parsing error - The HL7 parser is unable to read the incoming message because it doesn't conform to HL7 standards.\n•        Message content error - PHC Hub cannot accept the data because of missing or incorrect information.\n•        Message processing exception - PHC Hub cannot process the message because of an unexpected problem.\n•        Message accepted - PHC Hub has accepted the data and is either holding it for review or submitting it to the IIS for processing. \n"]
[]
[null,"TCP/IP "]
[null,"PHC Hub does not support TCP/IP connections or polling a local directory for files to upload. "]
[]
[null,"CDC WSDL "]
[null,"The standard interface defines the contract between the trading partners. SOAP (Simple Object Access Protocol) web services use the Web Services Definition Language (WSDL) to achieve this. The WSDL for the SOAP web service is used as the contract between the sender and the receiver to pass the HL7 message as a string of data. The WSDL tells a program that knows about SOAP exactly how to use the web service. If a tool is available that understands SOAP web services, the following URL is all that is needed to set up the web service. Please review the EHR documentation to determine all needed steps to set up the web service.  PHC Hub supports the Simple Object Access Protocol (SOAP) standard interface, the Web Services Definition Language (WSDL), and other transport solutions as endorsed by the CDC.\n\n"]
[null,{"$f":"HYPERLINK(\"https://www.cdc.gov/vaccines/programs/iis/technical-guidance/soap/services.html\",\"The CDC WSDL URL is https://www.cdc.gov/vaccines/programs/iis/technical-guidance/soap/services.html \")","v":"The CDC WSDL URL is https://www.cdc.gov/vaccines/programs/iis/technical-guidance/soap/services.html "}]
[null,"The WSDL URL is /soa/ws/HL7Service.wsdl"]
[null,"The first part of the URL depends on the environment (Test or Prod). For example https://waiis.doh.wa.gov/phchub/soa/ws/HL7Service.wsdl "]
[]
[null,"OneHealthPort Health Information Exchange (HIE)"]
[null,"The Washington State Department of Health (DOH) operates the Washington Immunization Information System (WAIIS), which includes reported information on immunizations administered throughout the lifetime of Washington residents. Information in the registry is available to all licensed healthcare providers in Washington to support immunization activities."]
[null,"The OneHealthPort Health Information Exchange (OHP HIE) supports synchronous (web service) access to WAIIS for purposes of reporting immunization information as well as queries for information from the registry."]
[null,"The OHP HIE will programmatically prepare messages for delivery to WAIIS. Acknowledgements and Responses from WAIIS will be delivered back to the submitting organization. For detailed guidance on connecting through the HIE, please click on the link below."]
[null,"OHP-HIE Connectivity Implementation Guide"]

{"sheet":"Onboarding Process","index":4,"n_rows":44,"n_cols":2,"rows_kept":44,"cut":false,"hidden":false,"merged":[[20,4,20,9]]}
[]
[null,"It is essential that the provider’s IT staff and clinical staff be involved in the entire interface project process to ensure differing needs are addressed, roles are clearly defined and understood, and clear expectations are set. Clinic workflow and data entry practices may need to change to ensure complete and accurate data is submitted. Additional training may be needed to ensure ongoing interface monitoring and data quality controls are established. We follow the same process for all interface projects. The length of the project is determined by how responsive providers and vendors are to action requests and how quickly issues are resolved."]
[null,"Failure to respond to action requests and to maintain forward movement through the onboarding process may affect your promoting interoperability active engagement status. We may suspend a project if the provider or vendor fails to respond to an action request within 30 days. We may close a project and remove the organization from the project queue if the provider or vendor fails to make progress over a 60-day period (e.g. no improvement in addressing data quality issues or unresolved connectivity issues)."]
[]
[]
[]
[]
[null,"Step 1 - Registration of Intent to Exchange Data"]
[null,"If you are seeking Promoting Interoperability (PI) credit and/or to connect to multiple state registries, use the Public Health Data Exchange Registration Form."]
[null,"Public Health Data Exchange Registration Form"]
[null,"If you only want to connect to the IIS (with no PI credit) send an email to IISDataExchange@doh.wa.gov with the following information:"]
[null,"IIS Data Exchange"]
[null,"Organization/Practice Name:\nAddress: \nPrimary Contact: \nPhone Number:\nEmail Address:\nEHR name and version number:\nEHR Vendor Name:\nEHR Vendor Contact:\nVendor Phone Number:\nVendor Email Address:\nNumber of vaccines administered in the last 12 months:"]
[null,"We add organizations to our interface project wait list when we receive the registration of intent. They will stay on the wait list until we have the appropriate staff available to begin an interface project. We prioritize interface projects based on criteria established to meet key immunization program requirements, including participation in the Childhood or Adult Vaccine Programs, and/or a pandemic vaccine response."]
[]
[null,"Step 2 - Invitation to Onboard"]
[null,"When we have the appropriate staff available to begin an interface project, we send you an email invitation to begin onboarding. With the invitation, you’ll receive an HL7 Interface Discovery Questionnaire to fill out and return."]
[null,"Department of Health policy states that all data exchange with the agency will route through the state HIE. To participate in the OneHealthPort HIE, organizations must sign a participation agreement and pay an annual subscription. The contracting process with OneHealthPort may begin at any time. Connectivity with the OneHealthPort HIE should begin during the Discovery phase and must be completed before Testing and Validation may begin."]
[null,"Contracting"]
[]
[null,"Step 3 - Discovery"]
[null,"When we receive the completed questionnaire, we schedule an onboarding kick-off meeting that may include an EHR demonstration. During this meeting we review the onboarding process and define project participant roles and responsibilities. The provider staff, (with support from their EHR vendor), may be asked to demonstrate how they use the EHR in their practice to capture patient and immunization information. The demonstration helps us to identify potential issues or challenges with message content, data quality, and clinic workflow."]
[null,"Once any issues/challenges have been addressed, you send us a test message for review. We review the message for HL7 version 2.5.1 format compliance and Washington State requirements. When the format is approved, HL7 account credentials will be provided and data may be sent to the QA system for testing and validation."]
[]
[null,"Step 4: Testing and Validation"]
[null,"You must send production (live) data for testing and validation. All messages route through our data quality and validation application, Public Health Connection Hub (PHC Hub). Throughout testing, you establish on-going submission of data to the IIS QA/Test system just like you will in the production system. During testing, it is important to send vaccine administration records for as many different vaccines (CVX codes) as possible, historical vaccine records, and vaccines for all age groups. If your EHR can send messages to update records and delete records, you’ll also want to test these functions."]
[null,"You are expected to establish routine interface monitoring practices as well. We also monitor the messages, set up automatic delivery of data quality reports, and work with you and your vendor to resolve any issues."]
[null,"Once message format and content are deemed acceptable, we complete a Data Quality Analysis Report (DQA). Messages must meet the established thresholds for completeness and accuracy of all key data elements before the interface is approved for production. Once approved for production, a “go-live” date is scheduled."]
[]
[null,"Step 5: Production"]
[null,"When the interface has been approved for production, we assign HL7 Account credentials for the WAIIS production system. We’ll send a final prep email to outline go-live steps and on-going responsibilities, which includes Managing Inventory with an Interface (PDF). We continue to closely monitor your interface for up to 90 days after you go live to be sure any issues are promptly resolved. You are responsible for:"]
[null,"Consistently reviewing the warning/error report and promptly fixing any issues in your EHR and in the IIS."]
[null,"Keeping your EHR application up to date."]
[null,"Ensuring CVX and MVX code tables and VIS publication dates are current with CDC-provided updates."]
[null,"Ensuring the interface continues to function (especially after a power outage, or when you install/upgrade servers and software)."]
[null,"Managing Inventory with an Interface"]
[null,"After 90 days, we monitor your interface on a periodic basis and contact you if we discover any unresolved issues. We may suspend on-going submission if issues are not resolved within 60 days."]
[]
[null,"Adding New Facilities"]
[null,"Multi-site organizations may need to add new facilities to an existing interface. We require all new facilities to complete data validation in our QA/Test system using production data before they begin submitting data in the production IIS. This testing helps to ensure quality data is submitted and, helps to ensure successful inventory management for providers receiving state-supplied vaccine. The Adding Facilities to an Interface document explains the process for adding a new facility to an existing interface. Please contact IISDataExchange@doh.wa.gov for further instructions."]
[null,"Adding Facilities"]
[]
[null,"Healthcare Organizations Providing EHR Services to Other Healthcare Providers (e.g. Community Partners)"]
[null,"If you provide EHR services to another organization enrolled in the IIS, but you have not acquired the clinic/practice, then that Org ID and Facility ID will remain separate and must use a separate Import Profile and HL7 User Name/Password to submit data. This is considered a new interface project for that organization and they are required to go through our standard interface onboarding process. The EHR hosting organization in this case would be considered the EHR vendor."]

{"sheet":"Requirements Specific to WA","index":5,"n_rows":18,"n_cols":2,"rows_kept":18,"cut":false,"hidden":false,"merged":[]}
[]
[null,"Online Vaccine Management and Reporting"]
[null,"For providers participating in the Washington Childhood Vaccine Program (VFC) it is critically important to include accurate vaccine and VFC eligibility information in the messages for successful vaccine inventory management and accountability reporting."]
[null,"Changes to the vaccine supply, including the introduction of new vaccines and vaccine coding changes must be closely monitored. For example, new influenza vaccine products are added to the public and private vaccine supply every flu season. An interface must accurately reflect the vaccine products being administered in the practice and included in their vaccine inventory. For additional information see"]
[null,"CDC IIS Code Sets"]
[null,"WA Common Vaccine Codes"]
[]
[null,"VFC Eligibility and Funding Source"]
[null,"Washington is a “universal” state, meaning that all patients under 19 years of age are eligible to receive state-supplied vaccines, even if they are covered by private insurance. While private insurance coverage for children is not a “VFC eligible” category according to federal guidelines, it is an eligibility category in Washington State. (V25=Private Insurance). An “ineligible” status (V01=Not VFC Eligible) should never be submitted for a patient under 19 years of age."]
[null,"We also provide some federal- and state-supplied vaccines for adults that must be correctly coded for a vaccine record to process. An eligibility status and funding source code are both required for all administered vaccination records submitted to the WAIIS. Please refer to the guide below for the most current WAIIS eligibility and funding source information."]
[null,"Eligibility for Publicly Funded Vaccines: A Guide for Providers (PDF)"]
[]
[null,"Unverified Vaccine Data"]
[null,"The WAIIS does not accept any patient or parent reported vaccine information without documentation or medical evidence to support the administration of vaccine. This is consistent with ACIP and the Centers for Disease Control guidance. Vaccination dates should never be defaulted to a specific date and no partial vaccination dates are accepted."]
[null,"If your organization captures patient or parent reported vaccine information in your EHR, the WAIIS will not accept historical data from your organization."]
[]
[null,"Privacy of Data"]
[null,"The WAIIS does not accept or store social security numbers. Do not send this data in your messages."]

{"sheet":"Message and Data Validation","index":6,"n_rows":11,"n_cols":2,"rows_kept":11,"cut":false,"hidden":false,"merged":[]}
[]
[null,"We use PHC Hub for message validation and data quality review for all interfaces with the WAIIS. This application provides improved interface monitoring tools, including automated error and warning report delivery. This in turn supports more efficient issue resolution and improved data quality for all WAIIS users."]
[]
[null,"Each interface is associated with an Import Profile within PHC Hub. The profile defines how key data elements will be reviewed and analyzed to ensure strict data quality standards are met before being sent to the WAIIS for processing. For selected data elements, we set the Import Profile to perform one of the following actions:"]
[null,"Ignore the data element if missing, incomplete, or invalid and accept the message."]
[null,"Warn the submitter of missing, incomplete, or invalid data elements and accept the message. Providers are encouraged to correct issues in the EHR and resubmit the message; or manually corrected the issue in both the EHR and the IIS; and, whenever possible, adjust workflow and/or data submission practices to avoid similar warnings in the future."]
[null,"Error the message if required data elements are missing, incomplete or invalid. Submitter must correct issues and resubmit the message. Providers must adjust workflow and/or data submission practices to avoid similar errors in the future."]
[]
[null,"During the testing and validation stage of your interface project, you’ll receive the Provider Detail Error/Warning Report via email. Errors and warnings are determined by the Import Profile settings in PHC Hub. We use this report to help identify and resolve issues before your interface is approved for production."]
[null,"Provider Detail Error Report Guide (PDF)"]
[null,"After your interface is moved to production you’ll continue to receive the Provider Detail Error/Warning Report. You are expected to use this report to quickly identify issues and address problems to ensure quality data continues to be submitted in the WAIIS."]

{"sheet":"Application Conformance Symbols","index":7,"n_rows":7,"n_cols":5,"rows_kept":7,"cut":false,"hidden":false,"merged":[[4,3,4,4]]}
[]
[null,"Symbol","Definition","Implementation Requirement","Operation Requirement"]
[null,"R","Required","The application SHALL implement \"R\" elements.","The application SHALL populate “R” elements with a non-empty value."]
[null,"RE","Required but may be empty ","The application SHALL implement “RE” elements.","The application SHALL populate “RE” elements with a non-empty value if there is relevant data. The term “relevant” has a confounding interpretation in this definition."]
[null,"C(a/b)","Conditional","An element with a conditional usage code has an associated condition predicate that determines the operational requirements (usage code) of the element. If the condition predicate associated with the element is true, follow the rules for a which shall be one of “R”, “RE”, “O” or X”:\n\nIf the condition predicate associated with the element is false, follow the rules for b which shall be one of “R”, “RE”, “O” or X”. a and b can be valued the same.\n\nNote: when C(O/X) or similar is used a condition predicate will not be provided."]
[null,"X","Not supported in this guide","The application (or as configured) SHALL NOT implement “X” elements.","The application SHALL NOT populate “X” elements."]
[null,"O","Optional","None. The usage indicator for this element has not yet been defined. For an implementation profile all optional elements must be profiled to R, RE, C(a/b), or X.","Not Applicable"]

{"sheet":"HL7 Data Types","index":8,"n_rows":35,"n_cols":4,"rows_kept":35,"cut":false,"hidden":false,"merged":[]}
[]
[null,"Data Type","Data Type Name","Definition"]
[null,"CE","Coded Element","This data type transmits codes and the text associated with the code."]
[null,"CE_TX","Text only CE data type","The CE_TX data type definition is used to transmit text only notes in RXA-9 (Administration Notes). "]
[null,"CQ","Composite Quantity with Units","This data type carries a quantity and attendant units. Its’ primary use in this Guide will be for indicating the maximum number of records to return in a query response."]
[null,"CWE","Coded with Exceptions","Specifies a coded element and its associated detail. The CWE data type is used when 1) more than one table may be applicable or 2) the specified HL7 or externally defined table may be extended with local values or 3)."]
[null,"CX","Extended Composite ID with Check Digit","This data type is used for specifying an identifier with its associated administrative detail."]
[null,"DT","Date","Specifies the century and year with optional precision to month and day."]
[null,"DT_D","Date with Precision to Day","Specifies the century and year with optional precision to month and day."]
[null,"DTM","Date/Time","The number of characters populated (excluding the time zone specification) specifies the precision. \nFormat: YYYY[MM[DD[HH[MM[SS[.S[S[S[S]]]]]]]]][+/-ZZZZ]. "]
[null,"EI","Entity Identifier","The entity identifier defines a given entity within a specified series of identifiers."]
[null,"ERL","Error Location","This data type identifies the segment and its constituent where an error has occurred."]
[null,"FN","Family Name","This data type contains a person’s family name (i.e. surname ). "]
[null,"FT","Formatted text","These are the escape sequences for the message delimiters (i.e., |^&~\\  ). "]
[null,"HD","Hierarchic Designator","HD identifies an (administrative or system or application or other) entity that has responsibility for managing or assigning a defined set of instance identifiers (such as placer or filler number, patient identifiers, provider identifiers, etc.)."]
[null,"ID","Coded Values for HL7 Tables","This data type is used for coded values from an HL7 table."]
[null,"IS","Coded Value for User-Defined Tables","This data type is used for codes from User-defined Tables."]
[null,"LA2","Location with Address Variation 2","Specifies a location and its address."]
[null,"MSG","Message Type","This field contains the message type, trigger event, and the message structure ID for the message."]
[null,"NM","Numeric","A number represented as a series of ASCII numeric characters consisting of an optional leading sign (+ or -), the digits and an optional decimal point."]
[null,"PT","Processing Type","This data type indicates whether to process a message as defined in HL7 Application (level 7) Processing rules. "]
[null,"SAD","Street Address","This data type specifies an entity's street address and associated detail."]
[null,"SI","Sequence ID","A non-negative integer in the form of a NM field. "]
[null,"ST","String","String data is left justified with trailing blanks optional. Any displayable (printable) ACSII characters (hexadecimal values between 20 and 7E, inclusive, or ASCII decimal values between 32 and 126), except the defined escape characters and defined delimiter characters. "]
[null,"TS","Time Stamp","Specifies a point in time. "]
[null,"TS_M","Time Stamp with Optional Precision to the Day and No Time Zone","Specifies a point in time. This data type requires a precision to the month. Precision to the day is optional."]
[null,"TS_NZ","Time Stamp with Precision to the Day and No Time Zone","Specifies a point in time. This data type requires a precision to the day. No Time zone is included."]
[null,"TS_Z","Time Stamp Requiring Time Zone","Specifies a point in time. This data type requires a precision to the second and requires that the time zone be included."]
[null,"VID","Version Identifier","This specifies the HL7 version. "]
[null,"XAD","Extended Address","This data type specifies the address of a person, place or organization plus associated information."]
[null,"XCN","Extended Composite ID Number and Name for Persons","This data type identifies a person using a unique id and name. The ID is associated with an entity such as an organization, which assigns the ID. This data type is used where there is a need to specify the ID number and name of a person"]
[null,"XON","Extended Name and ID Number for Organizations","This data type identifies an organization using a unique id and name. The ID is associated with an entity such as an organization, which assigns the ID."]
[null,"XPN","Extended Person Name","This is used for representing a person’s name."]
[null,"XPN_M","Extended Person Name - Maiden Name","This is used for representing a mother’s maiden name"]
[null,"XTN","Extended Telephone Number","This contains the extended telephone number."]

{"sheet":"FAQs","index":9,"n_rows":18,"n_cols":4,"rows_kept":18,"cut":false,"hidden":false,"merged":[]}
[]
[null,"Question","Answer","Links"]
[null,"How do I access the WAIIS Webpage, Secure Access Washington (SAW)","For users that currently have an IIS account and are looking to access the IIS via SAW follow the guide. For all other questions regarding obtaining access to the IIS see the following page www.doh.wa.gov/WAIIS","SAW Registration Guide"]
[null,"Who do I contact at OneHealthPort (OHP) for participation agreements, fees, and certificates?","Visit the OHP webpage where you'll find a HIE overview and links to contracting information,  transactions/transport information, and contact information for any additional questions. ","OHP HIE Overview"]
[null,"Are we required to use the OneHealthPort HIE to exchange data with DOH?","Department of Health policy states that all data exchange with the department is expected to route through the state HIE.\nHaving a HIE participation agreement with OneHealthPort does factor into the interface project prioritization process. "]
[null,"Can we send real patient or test data to validate VXU interface testing.","In an effort to ensure the interface meets WAIIS field requirements, we discourage the use of simplified test data, e.g. \"Jane Doe.\" Test data can be used to validate initial message formatting. WA will not allow an interface to move to production without live production data going through the validation process in the QA/Test environment. "]
[null,"Does the WAIIS provide test patients to use, VXU and/or QBP query?","Test patient data should be created by the testing provider via VXU or direct entry in the QA/Test environment."]
[null,"How many messages are required to complete testing and validation?","There is no set number of messages required. During testing, you will establish on-going submission of data to the QA system just like you will in the production system. It is important to send vaccine administration records for as many different vaccines (CVX codes) as possible, historical vaccine records, and vaccines for all age groups. If your EHR can send messages to update records and delete records, you’ll also want to test these functions."]
[null,"If I do not have a patient MRN, can I look up patients using an RX number?","You'll need to work with your EHR vendor to match the patients using MRN. The IIS does not see or capture RX numbers. "]
[null,"What NDC code should be used - Unit of Sale or Unit of Use?","NDC Unit of Sale"]
[null,"Can a forecast be included with a response RSP for QBP type Z34?","To receive a query response that includes a forecast use the Z42 type message format."]
[null,"How do I get my WAIIS lot inventory to decrement?","Multiple fields are used to successfully decrement the inventory; Vaccine CVX, Lot Number, Manufacturer MVX, Vaccine Eligibility and Vaccine Funding Source (OBX). The data submitted in these fields needs to be an exact match with the values in the WAIIS. Common issues include inconsistently matched funding source fields; public vs private."]
[null,"Do we need to register for Promoting Interoperability (prev. Meaningful Use) to exchange data with WAIIS?","Submitting a Public Health Data Exchange Registration Form is the first step in preparing to meet the reporting measures for exchanging data with public health agencies for Promoting Interoperability and the Quality Payment Program. You are not required to register for Promoting Interoperability to exchange data with the WAIIS.","Public Health Data Exchange for Promoting Interoperability "]
[null,"We're changing/updating our EHR system. Do we have to go back through the data validation process if we're already submitting data to the WAIIS?","Yes - changing an EHR system is considered a new connection and you will be required to complete the interface onboarding process. You are expected meet all current HL7 version 2.5.1, Release 1.5 and state requirements, some of which may have changed since your current/previous interface was established. ","HL7 v 2.5.1 Rel 1.5"]
[null,"How do we add new facilities to an existing interface?","We require all new facilities to complete data validation in our QA/Test environment using production data before they begin submitting data in the production IIS.  See the Adding Facilities to an Interface reference guide","Adding Facilities"]
[null,"How do we add query functionality (QBP) to an existing interface?","We require queries to be tested in our QA/Test environment before they are submitted in the production IIS. Please send an email to IISDataExchange@doh.wa.gov for more information.","IIS Data Exchange"]
[null,"Does WAIIS establish interfaces with schools or school districts?","The WAIIS is not prioritizing data exchange with school information systems at this time. Our focus continues to be onboarding healthcare providers who administer vaccinations.  As an alternative, you may want to consider participating in the WA IIS School Module. For more information please visit the School Module website or send an email to SchoolModule@doh.wa.gov.","School Module"]
[null,"Does WAIIS establish query-only interfaces?","The WAIIS is not prioritizing query-only interfaces at this time. Our preference is for organizations to establish bi-directional interfaces to submit and query immunization data."]

{"sheet":"VXU","index":10,"n_rows":15,"n_cols":6,"rows_kept":15,"cut":false,"hidden":false,"merged":[[1,1,1,6],[2,1,2,6],[25,0,25,10]]}
[]
[null,"Sample Message:"]
[null,"MSH|^~\\&|HEALTHLAND^2.16.840.1.113883.3.4272.14.1^ISO|7uycso03^1.3.6.1.4.1.38630.2.1.1.60^OID|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|20160909130000||VXU^V04^VXU_V04|123456|P|2.5.1|||ER|AL|||||Z22^CDCPHINVS|MAGNOLIA_PED_CLINIC|SIISCLIENT1724|\nPID|1||A69532^^^^MR||SMITH^MICK^D^^^^L||20140708|M||2106-3^White^HL70005|123 MAIN STREET^^CHEYENNE^WY^82002||^PRN^PH^^^406^5551234|||||||||2186-5^not Hispanic or Latino^CDCREC|\nPD1|||||||||||02^Reminder/Recall - any method^HL70215|Y|20160825|||A|||||\nNK1|1|SMITH^WALT|FTH^FATHER^HL70063|\nIN1|1|PL02585|C8909|CIGNA||||||||||5|\nORC|RE|365412^^^|56789^^^|||||||SIISCLIENT3363^SMITH^MAGGIE||SIISCLIENT3396^WILSON^MATT|||||SIISCLIENT1724|\nRXA|0|1|201609080000|201609080000|20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A||\nRXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163|\nOBX|1|CE|64994-7^Vaccine funding program eligibility category^LN|0|V04^VFC eligible-American Indian^HL70064||||||F|||20160406|||VXC40^Eligibility captured at the immunization level^CDCPHINVS\nOBX|2|CE|30963-3^Vaccine purchased with^LN||VXC51^Federal funds^||||||F||||\nOBX|3|CE|30956-7^vaccine type^LN|1|20^DTaP^CVX||||||F\nOBX|4|TS|29768-9^Date vaccine information statement published^LN|1|20070515||||||F\nOBX|5|TS|29769-7^Date vaccine information statement presented^LN|1|20160908||||||F\nNTE|||NTE COMMENT||"]
[]
[null,"Segment","Segment Header","WA Usage","CDC Usage","Comment"]
[null,"MSH","Message Header ","R","R","Every message begins with an MSH."]
[null,"PID","Patient Identification ","R","R","Every VXU has one PID segment. "]
[null,"PD1","Patient Demographic ","RE","RE","Every PID segment in VXU may have one or less PD1 segment."]
[null,"NK1","Next of Kin ","RE","RE","The PID segment in a VXU may have zero or more NK1 segments."]
[null,"IN1","Insurance","O","R","The insurance group may not repeat."]
[null,"ORC","Common Order ","R","R","The order group in a VXU must have one ORC segments."]
[null,"RXA","Pharmacy/Treatment Administration","R","R","Each ORC segment in a VXU must have one RXA segment. Every RXA requires an ORC segment."]
[null,"RXR","Pharmacy/Treatment Route ","RE","RE","Every RXA segment in a VXU may have zero or one RXR segments."]
[null,"OBX","Observation ","R","R","Every RXA segment in a VXU may have zero or more observation groups. The observation result segment has many uses. It carries observations about the object of its parent segment. In the VXU/RSP it is associated with the RXA or immunization record. The basic format is a question (OBX-3) and an answer (OBX-5)."]
[null,"NTE","Note","RE","O","Every OBX segment in a VXU may have zero or one NTE segment."]

{"sheet":"MSH","index":11,"n_rows":36,"n_cols":10,"rows_kept":36,"cut":false,"hidden":false,"merged":[[1,1,1,3],[4,1,4,3],[39,2,39,4],[40,2,40,3],[7,1,8,1],[7,2,7,3],[8,2,8,3],[38,1,38,3],[5,2,5,9]]}
[]
[null,"DIRECT CONNECTION"]
[null,"Sample:","MSH|^~\\&|HEALTHLAND|SIISCLIENT1724|IIS|IIS|20160909130000||VXU^V04^VXU_V04|123456|P|2.5.1|||ER|AL|||||Z22^CDCPHINVS|MAGNOLIA_PED_CLINIC|SIISCLIENT1724|"]
[]
[null,"HIE CONNECTION"]
[null,"Sample:","MSH|^~\\&|HEALTHLAND^2.16.840.1.113883.3.4272.14.1^ISO|7uycso03^1.3.6.1.4.1.38630.2.1.1.60^OID|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|20160909130000||VXU^V04^VXU_V04|123456|P|2.5.1|||ER|AL|||||Z22^CDCPHINVS|MAGNOLIA_PED_CLINIC|SIISCLIENT1724|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"MSH",1,"|","Field Separator","ST","R","R","Not captured","This field contains the separator between the segment ID and the first real field, MSH-2-encoding characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. \nConformance Statement: IZ-12: The MSH.1 (Field Separator) SHALL be valued “|\""]
[null,"MSH",2,"^~\\&","Encoding Characters","ST","R","R","Not captured","This field contains the four characters in the following order: the component separator, repetition separator, escape character, and subcomponent separator. Required values are ^~\\& (ASCII 94, 126, 92, and 38, respectively).\nConformance Statement: IZ-13: The MSH.2 (Encoding Characters) SHALL be valued “^~\\& “"]
[null,"MSH",3,"Heartland","Sending Application","HD","RE","RE","Not captured","This field uniquely identifies the sending application."]
[null,"MSH",4,"SIISCLIENT1724","Sending Facility","HD","RE","RE",50,"This field identifies the organization responsible for the operations of the sending application. "]
[null,"MSH",5,"IIS","Receiving Application","HD","RE","RE","Not captured","This field uniquely identifies the receiving application. The value is locally defined and often assigned by the IIS."]
[null,"MSH",6,"IIS","Receiving Facility","HD","RE","RE",25,"This field identifies the organization responsible for the operations of the receiving application. Locally defined codes may be added to accommodate local needs. "]
[null,"MSH",7,20141121100000,"Date/Time Of Message","TS_Z","R","R","Not captured","This field contains the date/time that the sending system created the message. The degree of precision must be at least to the minute. The time zone must be specified and will be used throughout the message as the default time zone.\n(Format YYYYMMDDHHMM)."]
[null,"MSH",8,null,"Security","ST","O","O","Not captured"]
[null,"MSH",9,"VXU^VO4^VXU_V04","Message Type","MSG","R","R","Not captured","This field contains the message type, trigger event, and the message structure ID for the message. \nConformance: IZ-17: MSH-9 (Message Type) SHALL contain the constant value “VXU^VO4^VXU_V04”"]
[null,"MSH",10,123456,"Message Control ID","ST","R","R","Not captured","This field contains the identifier assigned by the sending application (MSH.3) that uniquely identifies a message instance. This identifier is unique within the scope of the sending facility (MSH.4), sending application (MSH.3), and the YYYYMMDD portion of message date (MSH.7). The receiving system echoes this ID back to the sending system in the Message acknowledgment segment (MSA). The content and format of the data sent in this field is the responsibility of the sender. The receiver returns exactly what was sent in response messages."]
[null,"MSH",11,"P","Processing ID ","PT","R","R","Not captured","If ‘D’ is sent in MSH-11, PHC Hub will return a 202 and the text: The only Processing ID used to submit HL7 messages to the IIS is ‘P’ and an ERR-8 of Debug mode cannot be used."]
[null,"MSH",12,"2.5.1","Version ID","VID","R","R","Not captured","This field contains the identifier of the version of the HL7 messaging standard used in constructing, interpreting, and validating the message. Only the first component need be populated.\nIZ-15: The MSH-12 (Version ID) SHALL be valued 2.5.1 "]
[null,"MSH",13,null,"Sequence Number","NM","O","O","Not captured"]
[null,"MSH",14,null,"Continuation Pointer","ST","O","O","Not captured"]
[null,"MSH",15,"ER","Accept Acknowledgement Type","ID","R","R","Not captured","This field identifies the conditions under which accept acknowledgments are required to be returned in response to this message. Accept acknowledgement indicates if the message was safely received or not.\nConformance: IZ-42: The value of MSH-15 (Accept Acknowledgement) SHALL be one of the following:\nAL - Always\nNE - Never\nER - Error/Reject conditions only\nSU - Successful completion only\n"]
[null,"MSH",16,"AL","Application Acknowledgment Type","ID","R","R","Not captured","This field contains the conditions under which application acknowledgments are required to be returned in response to this message.\nConformance: IZ-41: The value of MSH-16 (Application Acknowledgement Type) SHALL be one of the following:\nAL - Always\nNE - Never\nER - Error/Reject conditions only\nSU - Successful completion only\n"]
[null,"MSH",17,null,"Country Code","ID","O","O","Not captured"]
[null,"MSH",18,null,"Character Set","ID","O","O","Not captured"]
[null,"MSH",19,null,"Principal Language of Message","CE","O","O","Not captured"]
[null,"MSH",20,null,"Alternate Character Set Handling Scheme","ID","O","O","Not captured"]
[null,"MSH",21,"Z22^CDCPHINVS","Message Profile Identifier (EI) 01598","EI","R","R","Not captured","Sites may use this field to assert adherence to, or reference, a message profile. Message profiles contain detailed explanations of grammar, syntax, and usage for a particular message or set of messages. \nConformance: IZ-43: One occurrence of MSH-21 (Message Profile Identifier) SHALL contain the constant value \"Z22^CDCPHINVS\""]
[null,"MSH",22,null,"Sending Responsible Organization","XON","RE","RE",50,"Definition: Business organization that originated and is accountable for the content of the message."]
[null,"MSH",23,null,"Receiving Responsible Organization","XON","RE","RE",25,"Definition: Business organization that is the intended receiver of the message and is accountable for acting on the data conveyed by the transaction."]
[null,"MSH",24,null,"Sending Network Address","HD","O","O","Not captured"]
[null,"MSH",25,null,"Receiving Network Address","HD","O","O","Not captured"]

{"sheet":"PID","index":12,"n_rows":46,"n_cols":10,"rows_kept":46,"cut":false,"hidden":false,"merged":[[53,2,53,4],[1,2,1,9],[3,1,4,1],[3,2,3,3],[4,2,4,3],[48,1,48,3],[49,1,49,3],[50,2,50,4],[51,2,51,3],[52,2,52,3]]}
[]
[null,"Sample:","PID|1||A69532^^^^MR||SMITH^MICK^D^^^^L||20140708|M||2106-3^White^HL70005|123 MAIN STREET^^CHEYENNE^WY^82002||^PRN^PH^^^406^5551234|||||||||2186-5^not Hispanic or Latino^CDCREC|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"PID",1,1,"Set ID - PID","SI","R","R",null,"This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one, for the second occurrence, the sequence number shall be two, etc.\nConformance: IZ-46: PID-1 (Set ID) SHALL have the literal value \"1\"."]
[null,"PID",2,null,"Patient ID","CX","X","X","Not captured"]
[null,"PID",3,"A69532^^^^MR","Patient Identifier List","CX","R","R",30,"This field contains the list of identifiers (one or more) used by the healthcare facility to uniquely identify a patient (e.g., medical record number, billing number, birth registry, national unique individual identifier, etc.)."]
[null,"PID",4,null,"Alternate Patient ID - 00106","CX","X","X","Not captured"]
[null,"PID",5,"SMITH^MICK^D^^^^L","Patient Name","XPN","R","R","First  Name = 48\nMiddle Name = 48\nLast Name = 48","This field contains the names of the patient, The primary or legal name of the patient is reported first. Therefore, the name type code in this field should be “L - Legal”. \nRefer to HL7 Table 0200 - Name Type for valid values.\nContains characters other than A-Z, a-z, single quote, dash, period, or space"]
[null,"PID",6,"JONES^^^^^^M","Mother’s Maiden Name","XPN_M","RE","RE","First  Name = 48\nMiddle Name = 48\nLast Name = 48","This field contains the family name under which the mother was born (i.e., before marriage). It is used to distinguish between patients with the same last name."]
[null,"PID",7,20140101,"Date of Birth","TS_NZ","R","R",null,"This field contains the patient’s date and time of birth."]
[null,"PID",8,"M","Administrative Sex","IS","R ","R ",1,"This field contains the patient’s sex."]
[null,"PID",9,null,"Patient Alias","XPN","X","X","First  Name = 48\nMiddle Name = 48\nLast Name = 48"]
[null,"PID",10,"2106-3^White^HL70005","Race","CE","RE","RE",20,"This field refers to the patient’s race."]
[null,"PID",11,"123 MAIN STREET^^CHEYENNE^WY^82002","Patient Address","XAD","RE","RE","STREET=  45\nCITY = 30\nSTATE = 5\nZIP = 5 or 9","This field contains the mailing address of the patient. "]
[null,"PID",12,null,"County Code","IS","X","X","Not captured","PID-11.9 should be used for HL7 2.5.1. \nExpected value are numeric 5-digit FIPS 6-4 county codes. "]
[null,"PID",13,"^PRN^PH^^^406^5551234","Phone Number - Home","XTN","RE","RE","7 or 10","This field contains the patient’s personal phone numbers. \nEach type of telecommunication shall be in its’ own repetition. For example, if a person has a phone number and an email address, they shall each have a repetition. \n"]
[null,"PID",14,null,"Phone Number - Business","XTN","O","O","7 or 10","This field contains the patient’s business telephone numbers."]
[null,"PID",15,"ENG^ENGLISH^HL70296","Primary Language","CE","O","O",30]
[null,"PID",16,null,"Marital Status","CE","O","O","Not captured"]
[null,"PID",17,null,"Religion","CE","O","O","Not captured"]
[null,"PID",18,null,"Patient Account Number","CX","O","O","Not captured"]
[null,"PID",19,null,"SSN Number - Patient","ST","X","X",9]
[null,"PID",20,null,"Driver's License Number - Patient","DLN","X","X","Not captured"]
[null,"PID",21,null,"Mother's Identifier","CX","X","X","Not captured"]
[null,"PID",22,"2186-5^not Hispanic or Latino^HL70189","Ethnic Group","CE","RE","RE",37,"This field further defines the patient’s ancestry."]
[null,"PID",23,null,"Birth Place","ST","C(RE/O)","O",100,"In Iweb, Birth Country and Birth State can be populated based on entering the value 'BDL' in PID-11.7."]
[null,"PID",24,null,"Multiple Birth indicator","ID","RE","RE",1,"This field indicates whether the patient was part of a multiple birth. \n Yes/No Indicator for valid values.\nY = the patient was part of a multiple birth\nN = the patient was a single birth\nEmpty = field multiple birth status is undetermined."]
[null,"PID",25,null,"Birth Order","NM","C(RE/O)","C(RE/O)",1,"When a patient was part of a multiple birth, a value (number) indicating the patient’s birth order is entered in this field. If PID-24 is populated, then this field should be populated."]
[null,"PID",26,null,"Citizenship","CE","O","O","Not captured"]
[null,"PID",27,null,"Veterans Military Status","CE","O","O","Not captured"]
[null,"PID",28,null,"Nationality","CE","O","O","Not captured"]
[null,"PID",29,null,"Patient Death Date and Time","TS","C(RE/X)","C(RE/X)",14,"This field contains the date and time at which the patient death occurred."]
[null,"PID",30,null,"Patient Death Indicator","ID","RE","RE",1,"This field indicates whether the patient is deceased. \n Yes/no Indicator for valid values.\nY = the patient is deceased\nN = the patient is not deceased\nEmpty = status is undetermined"]
[null,"PID",31,null,"Identity Unknown Indicator","ID","O","O","Not captured"]
[null,"PID",32,null,"Identity Reliability Code","IS","O","O","Not captured"]
[null,"PID",33,null,"Last Update Date/Time","TS","O","O","Not captured"]
[null,"PID",34,null,"Last Update Facility","HD","O","O","Not captured"]
[null,"PID",35,null,"Species Code","CE","O","O","Not captured"]
[null,"PID",36,null,"Breed Code","CE","O","O","Not captured"]
[null,"PID",37,null,"Strain","ST","O","O","Not captured"]
[null,"PID",38,null,"Production Class Code","CE","O","O","Not captured"]
[null,"PID",39,null,"Tribal Citizenship","CWE","O","O","Not captured"]

{"sheet":"PD1","index":13,"n_rows":28,"n_cols":10,"rows_kept":28,"cut":false,"hidden":false,"merged":[[31,2,31,4],[32,2,32,3],[33,2,33,3],[34,2,34,4],[3,1,4,1],[3,2,3,3],[4,2,4,3],[30,1,30,3]]}
[]
[null,"Sample:","PD1|||||||||||02^Reminder/Recall - any method^HL70215|Y|20160825|||A|||||"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"PD1",1,null,"Living Dependency","IS","O","O","Not captured"]
[null,"PD1",2,null,"Living Arrangement","IS","O","O","Not captured"]
[null,"PD1",3,null,"Patient Primary Facility","XON","O","O",50]
[null,"PD1",4,null,"Patient Primary Care Provider name & ID No.","XCN","X","X","First  Name = 48\nMiddle Name = 48\nLast Name = 48"]
[null,"PD1",5,null,"Student Indicator","IS","O","O","Not captured"]
[null,"PD1",6,null,"Handicap","IS","O","O","Not captured"]
[null,"PD1",7,null,"Living Will Code","IS","O","O","Not captured"]
[null,"PD1",8,null,"Organ Donor Code","IS","O","O","Not captured"]
[null,"PD1",9,null,"Separate Bill","ID","O","O","Not captured"]
[null,"PD1",10,null,"Duplicate Patient","CX","O","O","Not captured"]
[null,"PD1",11,"02^Reminder/Recall - any method^HL70215","Publicity Code","CE","RE","RE",2,"This field contains a user-defined code indicating what level of publicity is allowed (e.g., No Publicity, Family Only) for the patient. In the context of immunization messages, this refers to how a person wishes to be contacted in a reminder or recall situation. "]
[null,"PD1",12,"Y","Protection Indicator","ID","RE","RE",1,"This field identifies whether a person’s information may be shared with others. \nY - Protect the data (Do not share data)\nN - Not necessary to protect the data (Sharing is OK)\nEmpty - No determination has been made"]
[null,"PD1",13,20160825,"Protection Indicator Effective Date","DT_D","C(RE/X)","C(RE/X)",null,"This field indicates the effective date for PD1-12 - Protection Indicator."]
[null,"PD1",14,null,"Place of Worship","XON","O","O","Not captured"]
[null,"PD1",15,null,"Advance Directive Code","CE","O","O","Not captured"]
[null,"PD1",16,"A","Immunization Registry Status","IS","RE","RE",1,"This field identifies the current status of the patient in relation to the sending provider organization. \n"]
[null,"PD1",17,null,"Immunization Registry Status Effective Date","DT_D","C(RE/X)","C(RE/X)","Not captured","This field indicates the effective date for the registry status reported in PD1-16 - Immunization Registry"]
[null,"PD1",18,null,"Publicity Code Effective Date","DT_D","C(RE/X)","C(RE/X)","Not captured","This is the effective date for PD1-11 - Publicity Code."]
[null,"PD1",19,null,"Military Branch","IS","O","O","Not captured"]
[null,"PD1",20,null,"Military Rank/Grade","IS","O","O","Not captured"]
[null,"PD1",21,null,"Military Status","IS","O","O","Not captured"]

{"sheet":"NK1","index":14,"n_rows":48,"n_cols":10,"rows_kept":48,"cut":false,"hidden":false,"merged":[[53,2,53,3],[54,2,54,4],[5,1,6,1],[5,2,5,3],[6,2,6,3],[50,1,50,3],[51,2,51,4],[52,2,52,3]]}
[]
[null,"Sample:","NK1|1|SMITH^WALT|FTH^FATHER^HL70063|"]
[]
[null,"Notes:","NK1 segments are conditional based on patients age, only 18 and under. IWeb will only accept the first valid NK1 segment."]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"NK1",1,"1","Set ID - NK1","SI","R","R",null,"This field contains the number that identifies this transaction. For the first occurrence of the segment, the sequence number shall be one, for the second occurrence, the sequence number shall be two, etc."]
[null,"NK1",2,"SMITH^WALT","Name","XPN","R","R","First Name = 48 Last Name = 48","This field contains the name of the next of kin or associated party. Multiple names for the same person are allowed, but the legal name must be sent in the first sequence. \nRefer to HL7 Table 0200 - Name Type for valid values."]
[null,"NK1",3,"FTH^Father^HL70063","Relationship","CE","R","R",3,"This field contains the actual personal relationship that the next of kin/associated party has to the patient. \nCurrently MTH, FTH, and GRD are the only options inserted into the IIS.\nThere is an internal CR that will update the functionality. \nThe following relationship codes will be accepted and available in the UI:\nhttps://phinvads.cdc.gov/vads/ViewValueSet.action?oid=2.16.840.1.114222.4.11.3365 \n\n"]
[null,"NK1",4,null,"Address","XAD","RE","RE","STREET = 45\nCITY = 30\nSTATE = 5\nZIP = 5 or 9","This field contains the address of the next of kin/associated party. "]
[null,"NK1",5,null,"Phone Number","XTN","RE","RE",9,"This field contains the telephone number of the next of kin/associated party. Only one phone number is captured.\n"]
[null,"NK1",6,null,"Business Phone Number","XTN","O","O",9]
[null,"NK1",7,null,"Contact Role","CE","O","O","Not captured"]
[null,"NK1",8,null,"Start Date","DT","O","O","Not captured"]
[null,"NK1",9,null,"End Date","DT","O","O","Not captured"]
[null,"NK1",10,null,"Next of Kin / Associated Parties Job Title","ST","O","O","Not captured"]
[null,"NK1",11,null,"Next of Kin / Associated Parties Job Code/Class","JCC","O","O","Not captured"]
[null,"NK1",12,null,"Next of Kin / Associated Parties Employee Number","CX","O","O","Not captured"]
[null,"NK1",13,null,"Organization Name - NK1","XON","O","O","Not captured"]
[null,"NK1",14,null,"Marital Status","CE","O","O","Not captured"]
[null,"NK1",15,null,"Administrative Sex","IS","O","O","Not captured"]
[null,"NK1",16,null,"Date/Time of Birth","TS","O","O","Not captured"]
[null,"NK1",17,null,"Living Dependency","IS","O","O","Not captured"]
[null,"NK1",18,null,"Ambulatory Status","IS","O","O","Not captured"]
[null,"NK1",19,null,"Citizenship","CE","O","O","Not captured"]
[null,"NK1",20,null,"Primary Language","CE","O","O","Not captured"]
[null,"NK1",21,null,"Living Arrangement","IS","O","O","Not captured"]
[null,"NK1",22,null,"Publicity Code","CE","O","O","Not captured"]
[null,"NK1",23,null,"Protection Indicator","ID","O","O","Not captured"]
[null,"NK1",24,null,"Student Indicator","IS","O","O","Not captured"]
[null,"NK1",25,null,"Religion","CE","O","O","Not captured"]
[null,"NK1",26,null,"Mother's Maiden Name","XPN","O","O","Last Name = 48"]
[null,"NK1",27,null,"Nationality","CE","O","O","Not captured"]
[null,"NK1",28,null,"Ethnic Group","CE","O","O","Not captured"]
[null,"NK1",29,null,"Contact Reason","CE","O","O","Not captured"]
[null,"NK1",30,null,"Contact Person's Name","XPN","O","O","Not captured"]
[null,"NK1",31,null,"Contact Person's Telephone Number","XTN","O","O","Not captured"]
[null,"NK1",32,null,"Contact Person's Address","XAD","O","O","Not captured"]
[null,"NK1",33,null,"Next of Kin/Associated Party's Identifiers","CX","O","O","Not captured"]
[null,"NK1",34,null,"Job Status","IS","O","O","Not captured"]
[null,"NK1",35,null,"Race","CE","O","O","Not captured"]
[null,"NK1",36,null,"Handicap","IS","O","O","Not captured"]
[null,"NK1",37,null,"Contact Person Social Security Number","ST","O","O","Not captured"]
[null,"NK1",38,null,"Next of Kin Birth Place","ST","O","O","Not captured"]
[null,"NK1",39,null,"VIP Indicator","IS","O","O","Not captured"]

{"sheet":"IN1","index":15,"n_rows":60,"n_cols":10,"rows_kept":60,"cut":false,"hidden":false,"merged":[[1,2,1,4],[3,1,4,1],[3,2,3,3],[4,2,4,3]]}
[]
[null,"Sample:","IN1|1|PL02585|C8909|CIGNA||||||||||5|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"IN1",1,"IN1","Set ID - IN1","SI","R","R","Not captured","1N1-1 - set ID contains the number that identifies this transaction. For the first occurrence the sequence number shall be 1, for the second occurrence it shall be 2, etc."]
[null,"IN1",2,"PL02585","Insurance Plan ID","CE","R","R","Not captured","This field contains a unique identifier for the insurance plan. \nRefer to User-defined Table 0072 - Insurance Plan ID for suggested values."]
[null,"IN1",3,"C8909","Insurance Company ID","CX","R","R","Not captured","This field contains unique identifiers for the insurance company."]
[null,"IN1",4,"CIGNA","Insurance Company Name","XON","O","O","Not captured"]
[null,"IN1",5,null,"Insurance Company Address","XAD","O","O","Not captured"]
[null,"IN1",6,null,"Insurance Co Contact Person","XPN","O","O","Not captured"]
[null,"IN1",7,null,"Insurance Co Phone Number","XTN","O","O","Not captured"]
[null,"IN1",8,null,"Group Number","ST","O","O","Not captured"]
[null,"IN1",9,null,"Group Name","XON","O","O","Not captured"]
[null,"IN1",10,null,"Insured's Group Emp ID","CX","O","O","Not captured"]
[null,"IN1",11,null,"Insured's Group Emp Nam","XON","O","O","Not captured"]
[null,"IN1",12,null,"Plan Effective Date","DT","O","O","Not captured"]
[null,"IN1",13,null,"Plan Expiration Date","DT","O","O","Not captured"]
[null,"IN1",14,null,"Authorization Information","AUI","O","O","Not captured"]
[null,"IN1",15,5,"Plan Type","IS","R","R","Not captured","This field contains the coding structure that identifies the various plan types, for example, Medicare, Medicaid, Blue Cross, HMO, etc.\nRefer to User-defined Table 0086 - Plan ID for suggested values."]
[null,"IN1",16,null,"Name of Insured","XPN","O","O","Not captured"]
[null,"IN1",17,null,"Insured's Relationship To Patient","CE","O","O","Not captured"]
[null,"IN1",18,null,"Insured's Date of Birth","TS","O","O","Not captured"]
[null,"IN1",19,null,"Insured's Address","XAD","O","O","Not captured"]
[null,"IN1",20,null,"Assignment of Benefits","IS","O","O","Not captured"]
[null,"IN1",21,null,"Coordination of Benefits","IS","O","O","Not captured"]
[null,"IN1",22,null,"Coord Of Ben. Priority","ST","O","O","Not captured"]
[null,"IN1",23,null,"Notice of Admission Flag","ID","O","O","Not captured"]
[null,"IN1",24,null,"Notice of Admission Date","DT","O","O","Not captured"]
[null,"IN1",25,null,"Report of Eligibility Flag","ID","O","O","Not captured"]
[null,"IN1",26,null,"Report of Eligibility Date","DT","O","O","Not captured"]
[null,"IN1",27,null,"Release Information Code","IS","O","O","Not captured"]
[null,"IN1",28,null,"Pre-Admit Cert (PAC)","ST","O","O","Not captured"]
[null,"IN1",29,null,"Verification Date/Time","TS_NZ","RE","RE","Not captured","This field contains the date/time that the healthcare provider verified that the patient has the indicated benefits."]
[null,"IN1",30,null,"Verification By","XCN","O","O","Not captured"]
[null,"IN1",31,null,"Type of Agreement Code","IS","O","O","Not captured"]
[null,"IN1",32,null,"Billing Status","IS","O","O","Not captured"]
[null,"IN1",33,null,"Lifetime Reserve Days","NM","O","O","Not captured"]
[null,"IN1",34,null,"Delay Before L.R. Day","NM","O","O","Not captured"]
[null,"IN1",35,null,"Company Plan Code","IS","O","O","Not captured"]
[null,"IN1",36,null,"Policy Number","ST","O","O","Not captured"]
[null,"IN1",37,null,"Policy Deductible","CP","O","O","Not captured"]
[null,"IN1",38,null,"Policy Limit - Amount","CP","X","X","Not captured"]
[null,"IN1",39,null,"Policy Limit - Days","NM","O","O","Not captured"]
[null,"IN1",40,null,"Room Rate - Semi-Private","CP","X","X","Not captured"]
[null,"IN1",41,null,"Room Rate - Private","CP","X","X","Not captured"]
[null,"IN1",42,null,"Insured's Employment Status","CE","O","O","Not captured"]
[null,"IN1",43,null,"Insured's Administrative Sex","IS","O","O","Not captured"]
[null,"IN1",44,null,"Insured's Employer's Address","XAD","O","O","Not captured"]
[null,"IN1",45,null,"Verification Status","ST","O","O","Not captured"]
[null,"IN1",46,null,"Prior Insurance Plan ID","IS","O","O","Not captured"]
[null,"IN1",47,null,"Coverage Type","IS","O","O","Not captured"]
[null,"IN1",48,null,"Handicap","IS","O","O","Not captured"]
[null,"IN1",49,null,"Insured's ID Number","CX","O","O","Not captured"]
[null,"IN1",50,null,"Signature Code","IS","O","O","Not captured"]
[null,"IN1",51,null,"Signature Code Date","DT","O","O","Not captured"]
[null,"IN1",52,null,"Insured's Birth Place","ST","O","O","Not captured"]
[null,"IN1",53,null,"VIP Indicator","IS","O","O","Not captured"]

{"sheet":"ORC","index":16,"n_rows":38,"n_cols":10,"rows_kept":38,"cut":false,"hidden":false,"merged":[[43,2,43,3],[44,2,44,4],[1,2,1,8],[3,1,4,1],[3,2,3,3],[4,2,4,3],[40,1,40,3],[41,2,41,4],[42,2,42,3]]}
[]
[null,"Sample:","ORC|RE|365412^^^|56789^^^|||||||SIISCLIENT3363^SMITH^MAGGIE||SIISCLIENT3396^WILSON^MATT|||||SIISCLIENT1724|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"ORC",1,"RE","Order Control","ID","R","R","Not captured","Determines the function of the order segment. The value for VXU and RSP shall be RE."]
[null,"ORC",2,365412,"Placer Order Number","EI","RE","RE","Not captured","The placer order number is used to uniquely identify this order among all orders sent by a provider organization.\nORC-2 is a system identifier assigned by the placer software application. "]
[null,"ORC",3,56789,"Filler Order Number","EI","R","R",null,"The filler order number is used to uniquely identify this order among all orders sent by a provider organization that filled the order. This shall be the unique identifier of the sending system in a given transaction. \nA Vaccination ID is the same as the ORC-3 Filler Order Number. In easy terms, IWEB allows a provider to uniquely identify a vaccination by providing an id for it. We use that id and the providers id as a paired primary key to store and retrieve that vaccine. \nIn the case where an RXA is conveying information about an immunization which was not given (e.g. refusal) the filler order number shall be 9999."]
[null,"ORC",4,null,"Placer Group Number","EI","O","O","Not captured"]
[null,"ORC",5,null,"Order Status","ID","O","O","Not captured"]
[null,"ORC",6,null,"Response Flag","ID","O","O","Not captured"]
[null,"ORC",7,null,"Quantity/Timing","TQ","O","X","Not captured"]
[null,"ORC",8,null,"Parent","EIP","O","O","Not captured"]
[null,"ORC",9,null,"Date/Time of Transaction","TS","O","O","Not captured"]
[null,"ORC",10,"SIISCLIENT3361^MAGNOLIA^IRENE","Entered By","XCN","RE","RE","Not captured","This identifies the individual that entered this particular order. It may be used in conjunction with an RXA to indicate who recorded a particular immunization."]
[null,"ORC",11,null,"Verified By","XCN","O","O","Not captured"]
[null,"ORC",12,"SIISCLIENT3361^MAGNOLIA^IRENE","Ordering Provider","XCN","RE","C(RE/O)",null,"This field contains the identity of the person who is responsible for creating the request (i.e., ordering physician)."]
[null,"ORC",13,null,"Enterer's Location","PL","O","O","Not captured"]
[null,"ORC",14,null,"Call Back Phone Number","XTN","O","O","Not captured"]
[null,"ORC",15,null,"Order Effective Date/Time","TS","O","O","Not captured"]
[null,"ORC",16,null,"Order Control Code Reason","CE","O","O","Not captured"]
[null,"ORC",17,"SIISCLIENT1724","Entering Organization","CE","RE","RE",null,"This field identifies the organization that the enterer belonged to at the time he/she enters/maintains the order."]
[null,"ORC",18,null,"Entering Device","CE","RE","O","Not captured"]
[null,"ORC",19,null,"Action By","XCN","O","O","Not captured"]
[null,"ORC",20,null,"Advanced Beneficiary Notice Code","CE","O","O","Not captured"]
[null,"ORC",21,null,"Ordering Facility Name","XON","O","O","Not captured"]
[null,"ORC",22,null,"Ordering Facility Address","XAD","O","O","Not captured"]
[null,"ORC",23,null,"Ordering Facility Phone Number","XTN","O","O","Not captured"]
[null,"ORC",24,null,"Ordering Provider Address","XAD","O","O","Not captured"]
[null,"ORC",25,null,"Order Status Modifier","CWE","O","O","Not captured"]
[null,"ORC",26,null,"Advanced Beneficiary Notice Override Reason","CWE","O","O","Not captured"]
[null,"ORC",27,null,"Filler's Expected Availability Date/Time","TS","O","O","Not captured"]
[null,"ORC",28,null,"Confidentiality Code","CWE","O","O","Not captured","This field allows a system to indicate if special privacy rules apply to the RXA that is associated with this ORC. "]
[null,"ORC",29,null,"Order Type","CWE","O","O","Not captured"]
[null,"ORC",30,null,"Enterer Authorization Mode","CNE","O","O","Not captured"]
[null,"ORC",31,null,"Parent Universal Service identifier","CWE","O","O","Not captured"]

{"sheet":"RXA","index":17,"n_rows":33,"n_cols":10,"rows_kept":33,"cut":false,"hidden":false,"merged":[[38,2,38,3],[39,2,39,4],[1,2,1,9],[3,1,4,1],[3,2,3,3],[4,2,4,3],[35,1,35,3],[36,2,36,4],[37,2,37,3]]}
[]
[null,"Sample:","RXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A||"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"RXA",1,0,"Give Sub-ID Counter","NM","R","R",null,"Conformance: IZ-28: RXA-1 (Give Sub-id counter) SHALL be valued \"0\" (zero)."]
[null,"RXA",2,1,"Administration Sub-ID Counter","NM","R","R",null,"This field is used to track multiple RXA under an ORC. Since each ORC has only one RXA in immunization messages, constrain to 1. This should not be used for indicating dose number, which belongs in an OBX"]
[null,"RXA",3,2014112100000,"Date/Time Start of Administration","TS_NZ","R","R",null,"The date this vaccination occurred.  In the case of refusal or deferral, this is the date that the refusal or deferral was recorded.  In the case of a forecast dose, this is the date the forecast was made. "]
[null,"RXA",4,null,"Date/Time End of Administration","TS","O","O","Not captured","In the context of immunization, this is equivalent to the Start date/time. If populated it should be = RXA-3"]
[null,"RXA",5,"110^DTaP-HepB-IPV^CVX","Administered Code","CE","R","R",null,"This field identifies the medical substance administered.  If the substance administered is a vaccine, CVX codes required (see CVX Table - Codes for vaccines administered).  \nThe second set of three components could be used to represent the same vaccine using a different coding system.  NDC codes are preferred.\nConformance: IZ-49: If RXA-5.3 is valued \"998\" then RXA-6 SHALL be valued \"999\"."]
[null,"RXA",6,0.5,"Administered Amount","NM","R","R",null,"This field records the amount of pharmaceutical administered. When the administered amount is unknown, record value “999” in this field.\nConformance: IZ-48: If RXA-20 is valued \"RE\" then RXA-6 SHALL be valued \"999\".\nConformance: IZ-49: If RXA-5.3 is valued \"998\" then RXA-6 SHALL be valued \"999\".\nConformance: IZ-49: If the first instance of RXA-9.1 is not valued \"00\" then RXA-6 (administered amount) SHALL be valued \"999\"."]
[null,"RXA",7,"mL^milliliters^UCUM","Administered Units","CE",null,"C(R/O)","Not captured","This field is conditional because it is required if the administered amount code does not imply units. "]
[null,"RXA",8,null,"Administered Dosage Form","CE","O","O","Not captured"]
[null,"RXA",9,"00^New immunization record^NIP001","Administration Notes","varies","R","C(R/O)",254,"This field is used to indicate whether this immunization record is based on a historical record or was given by the reporting provider.\nIt should contain the information source (see NIP-defined Table 0001 - Immunization Information Source).  \nThe first component shall contain the code, the second the free text and the third shall contain the name of the code system (NIP001). \n\nConformance: IZ-31: If RXA-20 is valued \"CP\" or \"PA\" then RXA-9.1 (admin notes) SHALL be valued one of the codes listed in NIP001 in the first occurrence of this field and the following repetition should be empty or valued with text notes.\nConformance: IZ-47: If RXA-20 is NOT valued \"CP\" or \"PA\" then the first occurence of RXA-9.1 (admin notes) SHALL be empty and the following repetitions should be empty or valued with text notes."]
[null,"RXA",10,null,"Administering Provider","XCN","RE","C(RE/O)",null,"This field is intended to contain the name and provider ID of the person physically administering the pharmaceutical"]
[null,"RXA",11,"^^^SIISCLIENT1724","Administered- at Location","LA2","R","C(RE/O)",25,"The name and address of the facility that administered the immunization. \nComponent 4: The facility name/identifier\nSubcomponent 1: identifier"]
[null,"RXA",12,null,"Administered Per (Time Unit)","ST","O","O","Not captured"]
[null,"RXA",13,null,"Administered Strength","NM","O","O","Not captured"]
[null,"RXA",14,null,"Administered Strength Units","CE","O","O","Not captured"]
[null,"RXA",15,"ABC123","Substance Lot Number","ST","R","C(R/O)",20,"This field contains the lot number of the medical substance administered. It may remain empty if the dose is from a historical record.\nNote: The lot number is the number printed on the label attached to the container holding the substance and on the packaging which houses the container. If two lot numbers are associated with a product that is a combination of different components, they may be included in this field. The first repetition should be the vaccine."]
[null,"RXA",16,20141231,"Substance Expiration Date","TS","R","C(RE/O)",null,"This field contains the expiration date of the medical substance administered. It may remain empty if the dose is from a historical record."]
[null,"RXA",17,"SKB^GlaxoSmithKline^HL70227","Substance Manufacturer Name","CE","R","C(R/O)",500,"This field contains the manufacturer of the medical substance administered.\nNote: For vaccines, code system MVX should be used to code this field."]
[null,"RXA",18,null,"Substance/Treatment Refusal Reason","CE","O","C(R/X)","Refusal reason in RXA-18 is captured when RXA-20 is valued 'RE'.","This field contains the reason the patient refused the medical substance/treatment. Any entry in the field indicates that the patient did not take the substance.\nConformance: IZ-32: If the RXA-18 (Refusal Reason) is populated, RXA-20 SHALL be valued \"RE\""]
[null,"RXA",19,null,"Indication","CE","O","O","Not captured"]
[null,"RXA",20,"CP","Completion Status","ID","RE","RE","IF RXA-20 is valued anything other than 'RE',  refusal reason is ignored, not processed and not forwarded to IIS ","This field indicates if the dose was successfully given. It must be populated with RE if RXA-18 is populated.                                                                                                       CP = Complete, a vaccine.\nRE = Refusal, a deferral in IWeb.\nPA = Partially administered, a compromised vaccine in IWeb.\nNA = Not administered, not forwarded to IWeb."]
[null,"RXA",21,"A","Action Code - RXA","ID","R","C(R/O)",null,"This field indicates the action expected by the sending system. It can facilitate update or deletion of immunization records. If this field is empty, no action is indicated.\nThe action code U (update) is used to indicate to a subordinate receiver that a previously sent immunization should be changed. "]
[null,"RXA",22,null,"System Entry Date/Time","TS",null,"O","Not captured"]
[null,"RXA",23,null,"Administered Drug Strength Volume","NM",null,"O","Not captured"]
[null,"RXA",24,null,"Administered Drug Strength Volume Units","CWE",null,"O","Not captured"]
[null,"RXA",25,null,"Administered Barcode Identifier","CWE",null,"O","Not captured"]
[null,"RXA",26,null,"Pharmacy Order Type","ID",null,"O","Not captured"]

{"sheet":"RXR","index":18,"n_rows":13,"n_cols":10,"rows_kept":13,"cut":false,"hidden":false,"merged":[[1,2,1,4],[3,1,4,1],[3,2,3,3],[4,2,4,3],[15,1,15,3]]}
[]
[null,"Sample:","RXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"RXR",1,"IM^Intramuscular^HL70162","Route","CE","R","R",50,"This field is the route of administration."]
[null,"RXR",2,"LT^Left Thigh^HL70163","Administration Site","CWE","RE","RE",50,"This field contains the site of the administration route. Required for all vaccines except oral or nasal vaccines."]
[null,"RXR",3,null,"Administration Device","CE","O","O","Not captured"]
[null,"RXR",4,null,"Administration Method","CWE","O","O","Not captured"]
[null,"RXR",5,null,"Routing Instruction","CE","O","O","Not captured"]
[null,"RXR",6,null,"Administration Site Modifier","CWE","O","O","Not captured"]

{"sheet":"OBX","index":19,"n_rows":93,"n_cols":10,"rows_kept":93,"cut":false,"hidden":false,"merged":[[3,1,4,1],[3,2,3,3],[4,2,4,3],[1,2,1,9]]}
[]
[null,"Sample:","OBX|1|ST|64994-7^VACCINE FUNDING PROGRAM ELIGIBILITY CATEGORY^NIP003|1|V02^VFC eligible - Medicaid^HL70064||||||F|||20141117|||VXC40^Eligibility captured at the immunization level^CDCPHINVS\nOBX|2|CE|30963-3^VACCINE FUNDING SOURCE^LN|1|VXC51^Federal Funds^CDCPHINVS||||||F|||20141117\nOBX|3|CE|30956-7^VACCINE TYPE^NIP003|1|20^DTaP||||||F|\nOBX|4|DT|29769-7^DATE VACCINE INFORMATION STATEMENT PRESENTED^LN||20141117||||||F|||20141117\nOBX|5|DT|29768-9^DATE VACCINE INFORMATION STATEMENT PUBLISHED^LN||20130509||||||F|||20141117"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"OBX",1,"1","Set ID – OBX","SI","R","R",null,"This field contains the sequence number. The first instance shall be set to 1 and each subsequent instance shall be the next number in sequence. Numbering is not restarted within a message. That is, if a message had 3 order groups and each had 3 OBX, the last OBX in the message would have a value of 9 for this field.\nConformance: IZ-20: The Value of OBX-1 (Set ID-OBX) SHALL be valued sequentially starting with the value “1” within a message."]
[null,"OBX",2,"ST","Value Type","ID","R","R",null,"This field contains the format of the observation value in OBX. If the value is CE then the result must be a coded entry.\nConformance: IZ-21: The value of OBX-2 (Value Type) SHALL be one of the following: CE, NM, ST, DT, ID or TS"]
[null,"OBX",3,"64994-7^FUNDING PGM ELIG^NIP003","Observation Identifier","CE","R","R",null,"This field contains a unique identifier for the observation. The format is that of the Coded Element (CE). This indicates what this observation refers to. It poses the question that is answered by OBX-5.\nConformance: \nIZ-35: If OBX-3.1 is \"64994-7\" and OBX-2 is \"CE\" then the value set for OBX-5 shall be HL70064.\nIZ-36: If OBX-3.1 is “69764-9” and OBX-2 is “CE” then the value set for OBX-5 shall be PHVS_VISBarcodes_II.\nIZ-37: If OBX-3.1 is “30956-7” and OBX-2 is “CE” then the value set for OBX-5 shall be CVX."]
[null,"OBX",4,1,"Observation Sub-ID","ST","R","R",null,"This field is used to group related observations by setting the value to the same number. \nConformance: IZ-44: The value of OBX-4 SHALL be a positive integer."]
[null,"OBX",5,"V02^VFC eligible - Medicaid^HL70064","Observation Value","**varies**","R","R",null,"This field contains the value observed by the observation producer. OBX-2-value type contains the data type for this field according to which observation value is formatted.\nThis is the observation value and answers the question posed by OBX-3."]
[null,"OBX",6,null,"Units","CE","O","C(R/O)","Not captured","If OBX-2(Value Type) is valued “NM”, a value should be entered here.\nNote: If there is not a unit of measure available while the Condition Predicated is true, then the value “NA” SHALL be used in CE.1 and “HL70353” in CE.3"]
[null,"OBX",7,null,"References Range","ST","O","O","Not captured"]
[null,"OBX",8,null,"Abnormal Flags","IS","O","O","Not captured"]
[null,"OBX",9,null,"Probability","NM","O","O","Not captured"]
[null,"OBX",10,null,"Nature of Abnormal Test","ID","O","O","Not captured"]
[null,"OBX",11,"F","Observation Result Status","ID","R","R","Not captured","This field contains the observation result status. The expected value is F or final.\nConformance: IZ-22: The value of OBX-11 (Observation Result Status) SHALL be “F”"]
[null,"OBX",12,null,"Effective Date of Reference Range Values","TS","O","O","Not captured"]
[null,"OBX",13,null,"User Defined Access Checks","ST","O","O","Not captured"]
[null,"OBX",14,20141117,"Date/Time of the Observation","TS_NZ","RE","RE","Not captured","Records the time of the observation. It is the physiologically relevant date-time or the closest approximation to that date-time of the observation."]
[null,"OBX",15,null,"Producer's Reference","CE","O","O","Not captured"]
[null,"OBX",16,null,"Responsible Observer","XCN","O","O","Not captured"]
[null,"OBX",17,"VXC40^Eligibility captured at the immunization level^CDCPHINVS","Observation Method","CE","RE","C(R/O)","Not captured","If OBX-3.1 is “64994-7”; 64994 “-7” is a LOINC meaning “funding program eligibility”. This\nfield is used to distinguish between eligibility that is captured at the visit level versus\nat the immunization event level."]
[null,"OBX",18,null,"Equipment Instance Identifier","EI","O","O","Not captured"]
[null,"OBX",19,null,"Date/Time of the Analysis","TS","O","O","Not captured"]
[null,"OBX",20,null,"Reserved for harmonization with V2.6",null,null,"X","Not captured"]
[null,"OBX",21,null,"Reserved for harmonization with V2.6",null,null,"X","Not captured"]
[null,"OBX",22,null,"Reserved for harmonization with V2.6",null,null,"X","Not captured"]
[null,"OBX",23,null,"Performing Organization Name","XON",null,"O","Not captured"]
[null,"OBX",24,null,"Performing Organization Address","XAD",null,"O","Not captured"]
[null,"OBX",25,null,"Performing Organization Medical Director","XCN",null,"O","Not captured"]
[]
[null,"OBX 2"]
[null,"OBX",1,2,"Set ID – OBX","SI","R","R"]
[null,"OBX",2,"CE","Value Type","ID","R","R"]
[null,"OBX",3,"30963-3^VACCINE FUNDING SOURCE^NIP003","Observation Identifier","CE","R","R"]
[null,"OBX",4,1,"Observation Sub-ID","ST","R","R"]
[null,"OBX",5,"VXC51^Federal Funds^CDCPHINVS","Observation Value","*varies*","R","R"]
[null,"OBX",6,null,"Units",null,"O","C(R/O)"]
[null,"OBX",7,null,"Reference Ranges",null,"O","O"]
[null,"OBX",8,null,"Abnormal Flags",null,"O","O"]
[null,"OBX",9,null,"Probability ",null,"O","O"]
[null,"OBX",10,null,"Nature of abnormal test",null,"O","O"]
[null,"OBX",11,"F","Observation Result Status","ID","R","R"]
[null,"OBX",12,null,"Date Last Observed Normal Values",null,"O","O"]
[null,"OBX",13,null,"User Defined Access Checks",null,"O","O"]
[null,"OBX",14,20141117,"Date/Time of the observation","TS_NZ","RE","RE"]
[]
[null,"OBX 3"]
[null,"OBX",1,3,"Set ID – OBX","SI","R","R"]
[null,"OBX",2,"CE","Value Type","ID","R","R"]
[null,"OBX",3,"30956-7^VACCINE TYPE^NIP003","Observation Identifier","CE","R","R"]
[null,"OBX",4,1,"Observation Sub-ID","ST","R","R"]
[null,"OBX",5,"20^DTaP","Observation Value","**varies**","R","R"]
[null,"OBX",6,null,"Units",null,"O","C(R/O)"]
[null,"OBX",7,null,"Reference Ranges",null,"O","O"]
[null,"OBX",8,null,"Abnormal Flags",null,"O","O"]
[null,"OBX",9,null,"Probability ",null,"O","O"]
[null,"OBX",10,null,"Nature of abnormal test",null,"O","O"]
[null,"OBX",11,"F","Observation Result Status",null,"R","R"]
[]
[null,"OBX 4"]
[null,"OBX",1,4,"Set ID – OBX","SI","R","R"]
[null,"OBX",2,"TS","Value Type","ID","R","R"]
[null,"OBX",3,"29769-7^DATE VIS PRESENTED^NIP003","Observation Identifier","CE","R","R"]
[null,"OBX",4,1,"Observation Sub-ID","ST","R","R"]
[null,"OBX",5,20141117,"Observation Value","**varies**","R","R"]
[null,"OBX",6,null,"Units",null,"O","C(R/O)"]
[null,"OBX",7,null,"Reference Ranges",null,"O","O"]
[null,"OBX",8,null,"Abnormal Flags",null,"O","O"]
[null,"OBX",9,null,"Probability ",null,"O","O"]
[null,"OBX",10,null,"Nature of abnormal test",null,"O","O"]
[null,"OBX",11,"F","Observation Result Status",null,"R","R"]
[null,"OBX",12,null,"Date Last Observed Normal Values",null,"O","O"]
[null,"OBX",13,null,"User Defined Access Checks",null,"O","O"]
[null,"OBX",14,20141117,"Date/Time of the observation",null,"RE","RE"]
[]
[null,"OBX 5"]
[null,"OBX",1,5,"Set ID – OBX","SI","R","R"]
[null,"OBX",2,"TS","Value Type","ID","R","R"]
[null,"OBX",3,"29768-9^DATE VIS PUBLISHED^NIP003","Observation Identifier","CE","R","R"]
[null,"OBX",4,1,"Observation Sub-ID","ST","R","R"]
[null,"OBX",5,20130509,"Observation Value","**varies**","R","R"]
[null,"OBX",6,null,"Units",null,"O","C(R/O)"]
[null,"OBX",7,null,"Reference Ranges",null,"O","O"]
[null,"OBX",8,null,"Abnormal Flags",null,"O","O"]
[null,"OBX",9,null,"Probability ",null,"O","O"]
[null,"OBX",10,null,"Nature of abnormal test",null,"O","O"]
[null,"OBX",11,"F","Observation Result Status",null,"R","R"]
[null,"OBX",12,null,"Date Last Observed Normal Values",null,"O","O"]
[null,"OBX",13,null,"User Defined Access Checks",null,"O","O","`"]
[null,"OBX",14,20141117,"Date/Time of the observation",null,"RE","RE"]

{"sheet":"NTE","index":20,"n_rows":11,"n_cols":10,"rows_kept":11,"cut":false,"hidden":false,"merged":[[3,1,4,1],[3,2,3,3],[4,2,4,3],[13,1,13,3]]}
[]
[null,"Sample:","NTE|||NTE COMMENT||"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","IWeb Limit","Notes"]
[null,"NTE",1,null,"Set ID - NTE","SI",null,"O","Not captured"]
[null,"NTE",2,null,"Source of Comment","ID",null,"O","Not captured"]
[null,"NTE",3,"NTE COMMENT","Comment","FT",null,"R",254,"This field contains the comment contained in the segment."]
[null,"NTE",4,null,"Comment Type","CE",null,"O","Not captured"]

{"sheet":"Sample VXUs","index":21,"n_rows":11,"n_cols":3,"rows_kept":11,"cut":false,"hidden":false,"merged":[]}
[]
[null,"2.5.1 Message"]
[null,null,"MSH|^~\\&|HEALTHLAND|7uycso03^1.3.6.1.4.1.38630.2.1.1.60^OID|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|20160909130000||VXU^V04^VXU_V04|123456|P|2.5.1|||ER|AL|||||Z22^CDCPHINVS|MAGNOLIA_PED_CLINIC|SIISCLIENT1724|\nPID|1||A69532^^^^MR||SMITH^MICK^D^^^^L||20140708|M||2106-3^White^HL70005|123 MAIN STREET^^CHEYENNE^WY^82002||^PRN^PH^^^406^5551234|||||||||2186-5^not Hispanic or Latino^CDCREC|\nPD1|||||||||||02^Reminder/Recall - any method^HL70215|Y|20160825|||A|||||\nNK1|1|SMITH^WALT|FTH^FATHER^HL70063|\nIN1|1|PL02585|C8909|CIGNA||||||||||5|\nORC|RE|365412^^^|56789^^^|||||||SIISCLIENT3363^SMITH^MAGGIE||SIISCLIENT3396^WILSON^MATT|||||SIISCLIENT1724|\nRXA|0|1|201609080000|201609080000|20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A||\nRXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163|\nOBX|1|CE|64994-7^Vaccine funding program eligibility category^LN|0|V04^VFC eligible-American Indian^HL70064||||||F|||20160406|||VXC40^Eligibility captured at the immunization level^CDCPHINVS\nOBX|2|CE|30963-3^Vaccine purchased with^LN||VXC51^Federal funds^||||||F||||\nOBX|3|CE|30956-7^vaccine type^LN|1|20^DTaP^CVX||||||F\nOBX|4|TS|29768-9^Date vaccine information statement published^LN|1|20070515||||||F\nOBX|5|TS|29769-7^Date vaccine information statement presented^LN|1|201609068||||||F\nNTE|||NTE COMMENT||\nRXA|0|1|201407080000||20^DTaP^CVX|999|||01^Historical immunization|^^^3724|||||||||C|A||"]
[]
[]
[null,"ACK Message"]
[null,null,"MSH|^~\\&|IIS^^|3724^^||SIISCLIENT1724|20160914052524||ACK^V04^ACK|3974462967.100000008|P|2.5.1|||||||||Z22^CDCPHINVS^^| \nMSA|AA|123456| \nERR|||0|I||||Patient A69532 \"MICK SMITH\" with 2 vaccinations accepted into vaccination staging table| \nERR||OBX^^|999^Application Error^HL70357|W||||vfc eligibility and funding source are inconsistent| \nERR||RXA^^15|103^Table value not found^HL70357|W||||vaccination lot is unrecognized|"]
[]
[]
[null,"VXU Message\nWith Contraindications "]
[null,null,"MSH|^~\\&|HEALTHLAND|7uycso03^1.3.6.1.4.1.38630.2.1.1.60^OID|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|20160909130000||VXU^V04^VXU_V04|123456|P|2.5.1|||ER|AL|||||Z22^CDCPHINVS|MAGNOLIA_PED_CLINIC|SIISCLIENT1724|\nPID|1||A69532^^^^MR||SMITH^MICK^D^^^^L||20140708|M||2106-3^White^HL70005|123 MAIN STREET^^CHEYENNE^WY^82002||^PRN^PH^^^406^5551234|| EN^ENGLISH^HL70296|||||||2186-5^not Hispanic or Latino^HL70189|\nPD1|||||||||||02^Reminder/Recall - any method^HL70215|Y|20160825|||A|||||\nNK1|1|SMITH^WALT|FTH^FATHER^HL70063|\nIN1|1|PL02585|C8909|CIGNA||||||||||5|\nORC|RE|365412^^^|56789^^^|||||||SIISCLIENT3363^SMITH^MAGGIE||SIISCLIENT3396^WILSON^MATT|\nRXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A||\nRXR|IM^Intramuscular^HL70162|RT^Right Thigh^HL70163\nOBX|1|CE|64994-7^Vaccine funding program eligibility category^LN|0|V04^VFC eligible-American Indian^HL70064||||||F|||20160406|||VXC40^Eligibility captured at the immunization level^CDCPHINVS\nOBX|2|CE|30963-3^Vaccine purchased with^LN||VXC1^Federal funds^||||||F||||\nOBX|3|CE|30956-7^vaccine type^LN|1|48^HIB^CVX||||||F\nOBX|4|TS|29768-9^Date vaccine information statement published^LN|1|20070515||||||F\nOBX|5|TS|29769-7^Date vaccine information statement presented^LN|1|201609068||||||F\nNTE|||NTE COMMENT|\nORC|RE|365412^^^|56790^^^|\nRXA|0|1|201407080000||20^DTaP^CVX|999|||01^Historical immunization|^^^3724|||||||||C|A||\nORC|RE|365412^^^|56791^^^|\nRXA|0|1|20160722||998^No vaccine administered^CVX|999||||||||NA|\nOBX|6|CE|30945-0^Vaccination contraindication^LN|1|91930004^allergy to eggs^SCT||||||F|||20160522"]

{"sheet":"Query (QBP)","index":22,"n_rows":24,"n_cols":4,"rows_kept":24,"cut":false,"hidden":false,"merged":[[23,1,23,2],[1,1,1,5],[2,1,2,5],[16,0,16,9],[12,1,12,5],[22,1,22,2],[22,3,22,5],[19,1,19,2],[20,3,20,5],[18,1,18,4]]}
[]
[null,"Sample Message:"]
[null,"MSH|^~\\&|Athena|Big Horn Pediatrics|| |20210312233551|117311|QBP^Q11^QBP_Q11|12|P|2.5.1|||ER|AL|||||Z34^CDCPHINVS||\nQPD|Z34^Request Immunization History^HL70471|243|3988867^^^^MR|ANDREWS^RUBEN^NEIL||20120610|F|303 Bacztdesi Bs^^MEXGELAR^WA^73026|\nRCP|I|1^RD&records&HL70126|R^Real Time^HL70394"]
[]
[null,"Segment","Segment Header","Usage"]
[null,"MSH","Message Header ","R"]
[null,"QPD","Query Parameter Definition","R"]
[null,"RCP","Response Control Parameter","R"]
[]
[]
[null,"The WAIIS requires queries to be at the individual patient level at the time of service (no batch queries). Matches are found as follows:"]
[null,"1. Search for a match by patient ID. If a match is found, a complete record is returned."]
[null,"2. If no match was found by patient ID, then the patient demographic data is used to perform an advanced search to find an exact match or any single high confidence match. The following fields are considered by the advanced search:"]
[null,"Patient First Name, Last Name, Birth Date"]
[null,"Patient First Name, Last Name (Exact)"]
[null,"Patient Birth Date"]
[]
[]
[null,"Below are the possible responses to query messages."]
[null,"Outcome of Query",null,"Response Message"]
[null,"No match found",null,"RSP - Response indicates that the message was successfully processed and that no patients matched the criteria submitted in the query."]
[null,"Exactly one high confidence match found",null,"RSP - Response includes a complete immunization history."]
[null,"At least one lower confidence match is found, but less than or equal to the maximum number allowed",null,"RSP - Response returns a list of candidates including one PID segment with associated PD1 and NK1 segments for each potential match. No immunization history is returned."]
[null,"An error or errors prevented the completion of the request",null,"ACK - Response indicates that the message was not successfully processed."]

{"sheet":"Z34 - Complete History","index":23,"n_rows":23,"n_cols":8,"rows_kept":23,"cut":false,"hidden":false,"merged":[[1,1,1,3]]}
[]
[null,"Profile Z34 - Request Complete Immunization History is a constrainable profile that supports request of an immunization history of an individual. It has a set partner profiles which return the requested history, a list of candidate patients or an acknowledgement that no matches are found.\n\nThe goal of this query is to request a complete immunization history. This will support transferring a person’s immunization records from one information system to another. The response will be very similar to a VXU message in content. \n\nA complete immunization history consists of:\n      • demographic information about the patient\n      • a list of the immunizations received\n      • a list of any patient conditions that impact immunization (i.e. allergies, contraindications, history of vaccine preventable disease) "]
[]
[]
[null,"Query Statement ID\n (Query ID = Z34)","Z34",null,"QBP^Q11^QBP_Q11","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"Type","Query",null,"MSH","Message Header Segment","R"]
[null,"Query Name","Request Immunization History",null,"[{SFT}]","Software Segment","O","Local profile may specify"]
[null,"Query Trigger = MSH-9","QBP^Q11^QBP_Q11",null,"QPD","Query Parameter Definition","R"]
[null,"Query Mode","Both",null,"RCP","Response Control Parameter","R"]
[null,"Response Trigger = MSH-9","RSP^K11^RSP_K11",null,"[DSC]","Continuation Pointer","X","Not supported"]
[null,"Query Characteristics","The query parameters may include demographic and address data. No sorting is expected.\nThis profile does not specify the logic used when searching for matching clients/patients. The query parameter contents may be used for simple query or as input for probabilistic search algorithms. The search methodology should be specified by local implementations."]
[null,"Purpose","The purpose is to request a complete immunization history for one client."]
[null,"Response Characteristics","• In the case where no candidates are found, the acknowledgement response will indicate that no candidates were found.\n• In the case where exactly one high-confidence candidate is found, an immunization history may be returned.\n• In the case where one or more clients could match the criteria sent, a list of candidates may be returned to allow for refinement of the query. If the number of candidates exceeds the maximum number requested or allowed for return, the acknowledgement response will indicate too many matches and no records will be returned.\n• In the case where one high confidence candidate is found, but that candidate does not allow sharing of data, the acknowledgement response will indicate no candidates were found.\n• In the case where receiving system can’t process the query, the receiving system will indicate an error in an acknowledgement."]
[]
[]
[null,"Outcome of Query","Response Message"]
[null,"No match found","Response indicates that message was successfully processed and that no clients matched the criteria that were sent in the query. See Acknowledgement Profile (Z33)."]
[null,"Exactly one high confidence match found","Response includes a complete immunization history. \nSee Profile Return Immunization History (Z32)."]
[null,"At least one lower confidence match is found, but <= maximum number allowed.","If state law allows, the Response returns one PID with associated PD1 and NK1 segments for each potential match. No immunization history is returned.\nSee Profile Return Candidate List (Z31)."]
[null,"More than the maximum number allowed is found. ","Response indicates that the message was successfully processed, but that too many potential matches were found. See Return Acknowledgement Profile (Z33)The maximum number allowed is the lower of the maximum number requested and the maximum number that the receiving system will return."]
[null,"Message is not well formed and has fatal errors","Response indicates that the message was not successfully processed and may indicate errors. See Return Acknowledgement Profile (Z33)."]
[null,"Message was rejected because one of the following occurred:\n• Unsupported message type \n• Unsupported event code\n• Unsupported processing ID\n• Unable to process for reasons unrelated for format or content","Return ACK message with errors."]
[null,"Message can’t be identified as an HL7 message.","No HL7 message is returned."]

{"sheet":"Z44 - Eval History & Forecast","index":24,"n_rows":13,"n_cols":8,"rows_kept":13,"cut":false,"hidden":false,"merged":[[1,1,1,4]]}
[]
[null,"Profile Z44 – Request Evaluated History and Forecast is a constrainable profile that supports request of an immunization evaluated immunization history and forecast of an individual. It has a set partner profiles which return the requested history or an acknowledgement that no matches were found. \n\nThe goal of this query is to request a evaluated immunization history and forecast of next doses due. \n\nAn evaluated immunization history and forecast consists of: \n     •Limited demographic information about the individual\n     •The history of immunizations administered with validation by a clinical decision support engine\n     •Forecast of what the person is due to receive next and the dates when due "]
[]
[]
[null,"Query Statement ID\n (Query ID = Z44)","Z44",null,"QBP^Q11^QBP_Q11","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"Type","Query",null,"MSH","Message Header Segment","R"]
[null,"Query Name","Request Evaluated History and Forecast",null,"[{SFT}]","Software Segment","O","Local profile may specify"]
[null,"Query Trigger = MSH-9","QBP^Q11^QBP_Q11",null,"QPD","Query Parameter Definition","R"]
[null,"Query Mode","Both",null,"RCP","Response Control Parameter","R"]
[null,"Response Trigger = MSH-9","RSP^K11^RSP_K11",null,"[DSC]","Continuation Pointer","X","Not supported"]
[null,"Query Characteristics","The query parameters may include demographic and address data. No sorting is expected.\nThis profile does not specify the logic used when searching for matching clients/patients. The query parameter contents may be used for simple query or as input for probabilistic search algorithms. The search methodology should be specified by local implementations."]
[null,"Purpose","The purpose is to request a complete immunization history and forecast for one client."]
[null,"Response Characteristics","• In the case where no candidates are found, the acknowledgement response will indicate that no candidates were found.\n•In the case where exactly one high-confidence candidate is found, an evaluated immunization history and forecast will be returned.\n•In the case where one or more clients are a lower-confidence match for the criteria sent, the acknowledgement response will indicate no matches and no records will be returned.\n•In the case where receiving system can’t process the query, the receiving system will indicate an error in an acknowledgement."]

{"sheet":"Query MSH","index":25,"n_rows":30,"n_cols":9,"rows_kept":30,"cut":false,"hidden":false,"merged":[[3,1,4,1],[3,2,3,3],[4,2,4,3],[1,2,1,8]]}
[]
[null,"Sample:","MSH|^~\\&|HEALTHLAND|7uycso03^1.3.6.1.4.1.38630.2.1.1.60^OID|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|20141121100000||QBP^Q11^QBP_Q11|123456|P|2.5.1|||ER|AL|||||Z34^CDCPHINVS|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"MSH",1,"|","Field Separator","ST","R","R","This field contains the separator between the segment ID and the first real field, MSH-2-encoding characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. \nConformance Statement: IZ-12: The MSH.1 (Field Separator) SHALL be valued “|\""]
[null,"MSH",2,"^~\\&","Encoding Characters","ST","R","R","This field contains the four characters in the following order: the component separator, repetition separator, escape character, and subcomponent separator. Required values are ^~\\& (ASCII 94, 126, 92, and 38, respectively).\nConformance Statement: IZ-13: The MSH.2 (Encoding Characters) SHALL be valued “^~\\& “"]
[null,"MSH",3,"Heartland","Sending Application","HD","RE","RE","This field uniquely identifies the sending application."]
[null,"MSH",4,"SIISCLIENT1724","Sending Facility","HD","RE","RE","This field identifies the organization responsible for the operations of the sending application. "]
[null,"MSH",5,"IIS","Receiving Application","HD","RE","RE","This field uniquely identifies the receiving application. The value is locally defined and often assigned by the IIS."]
[null,"MSH",6,"IIS","Receiving Facility","HD","RE","RE","This field identifies the organization responsible for the operations of the receiving application. Locally defined codes may be added to accommodate local needs. "]
[null,"MSH",7,20141121100000,"Date/Time Of Message","TS_Z","R","R","This field contains the date/time that the sending system created the message. The degree of precision must be at least to the minute. The time zone must be specified and will be used throughout the message as the default time zone.\nConformance: IZ-14: MSH-7 (Date/time of Message) SHALL have a degree of precision that must be at least to the minute. (Format YYYYMMDDHHMM)."]
[null,"MSH",8,null,"Security","ST","O","O"]
[null,"MSH",9,"QBP^Q11^QBP_Q11","Message Type","MSG","R","R","This field contains the message type, trigger event, and the message structure ID for the message. \nConformance: IZ-55: MSH-9 (Message Type) SHALL contain the constant value “QBP^Q11^QBP_Q11”"]
[null,"MSH",10,123456,"Message Control ID","ST","R","R","This field contains the identifier assigned by the sending application (MSH.3) that uniquely identifies a message instance. This identifier is unique within the scope of the sending facility (MSH.4), sending application (MSH.3), and the YYYYMMDD portion of message date (MSH.7). The receiving system echoes this ID back to the sending system in the Message acknowledgment segment (MSA). The content and format of the data sent in this field is the responsibility of the sender. The receiver returns exactly what was sent in response messages."]
[null,"MSH",11,"P","Processing ID","PT","R","R","If ‘D’ is sent in MSH-11, PHC Hub will return a 202 and the text: The only Processing ID used to submit HL7 messages to the IIS is ‘P’ and an ERR-8 of Debug mode cannot be used."]
[null,"MSH",12,"2.5.1","Version ID","VID","R","R","This field contains the identifier of the version of the HL7 messaging standard used in constructing, interpreting, and validating the message. Only the first component need be populated.\nIZ-15: The MSH-12 (Version ID) SHALL be valued 2.5.1 "]
[null,"MSH",13,null,"Sequence Number","NM","O","O"]
[null,"MSH",14,null,"Continuation Pointer","ST","O","O"]
[null,"MSH",15,"ER","Accept Acknowledgement Type","ID","R","R","Conformance: IZ-57: The value of MSH-15 (Accept Acknowledgement) SHALL have a value of \"ER\". ER - Error/Reject conditions only"]
[null,"MSH",16,"AL","Application Acknowledgment Type","ID","R","R","Conformance: IZ-58: The value of MSH-16 (Application Acknowledgement Type) SHALL have a value of \"AL\"; AL - Always"]
[null,"MSH",17,null,"Country Code","ID","O","O"]
[null,"MSH",18,null,"Character Set","ID","O","O"]
[null,"MSH",19,null,"Principal Language of Message","CE","O","O"]
[null,"MSH",20,null,"Alternate Character Set Handling Scheme","ID","O","O"]
[null,"MSH",21,"Z34^CDCPHINVS","Message Profile Identifier","EI","R","R","Sites may use this field to assert adherence to, or reference, a message profile. Message profiles contain detailed explanations of grammar, syntax, and usage for a particular message or set of messages. \nConformance: IZ-56: One occurrence of MSH-21 (Message Profile Identifier) SHALL contain the constant value \"Z34^CDCPHINVS\""]
[null,"MSH",22,null,"Sending Responsible Organization","XON","RE","RE","Definition: Business organization that originated and is accountable for the content of the message."]
[null,"MSH",23,null,"Receiving Responsible Organization","XON","RE","RE","Definition: Business organization that is the intended receiver of the message and is accountable for acting on the data conveyed by the transaction."]

{"sheet":"Query QPD","index":26,"n_rows":39,"n_cols":9,"rows_kept":39,"cut":false,"hidden":false,"merged":[[1,2,1,8],[3,2,3,8],[5,1,6,1],[5,2,5,3],[6,2,6,3]]}
[]
[null,"Sample:","QPD|Z34^Request Complete Immunization History^CDCPHINVS|37374859|A69532^^^^MR|SMITH^MICK^D^^^^L|JONES^MARY^^^^^M|20140708|M|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|^PRN^PH^^^406^5551234|"]
[]
[null,"Notes:","Local implementations will specify which fields are required in the QPD. All fields have a usage of RE (required, but may be empty). This means that sending systems may populate any or all of these fields. Receiving systems must accept values in any of these fields, but may specify which are required and which will be ignored."]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"QPD",1,"Z34^Request Complete Immunization History^CDCPHINVS","MessageQueryName","CE","R","R","Conformance Statement:\nIZ-67: QPD-1 (Message Query Name) SHALL be valued \"Z34^Request Immunization History^CDCPHINV"]
[null,"QPD",2,37374859,"Query Tag","ST","R","R","Unique to each query message instance."]
[null,"QPD",3,"|A69532^^^^MR|","Patient List (PID-3)","CX","RE","RE","The combination of values for Patientlist.ID, patientlst.identifiercode and Patientlist.AssigningAuthority are intended to allow unique identification of a client, if the data are found in the responding system."]
[null,"QPD",null,"A69532","     ID","ST","R","R","If this field, PID.3.1, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,null,"     Assigning Authority","HD","R","R","If this field, PID.3.4, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,"MR","     Identifier Type Code","IS","R","R","If this field, PID.3.5, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",4,"|SMITH^MICK^D^^^^L|","Patient Name (PID-5)","XPN","R","R","If this field, PID.5, is not valued, then the query will return an error, since this is a required field."]
[null,"QPD",null,"SMITH","     Family Name","FN","R","R","If this field, PID.5.1, is not valued, then patient name is considered to contain no value. "]
[null,"QPD",null,"MICK","     Given Name","ST","R","R","If this field, PID.5.2, is not valued, then patient name is considered to contain no value. Given name is required."]
[null,"QPD",null,"D","     Second or further names","ST","RE","RE","If this field, PID.5.3, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,null,"     Suffix","ST","RE","RE","If this field, PID.5.4, is not valued, then all values for this field are considered a match,"]
[null,"QPD",5,"|JONES^MARY^^^^^M|","Patient Mother Maiden Name (PID-6)","XPN_M","RE","RE","If this field, PID.6, is not valued, Mother’s maiden name is not considered when seeking matching clients."]
[null,"QPD",null,"JONES","     Family Name","FN","R","R","If this field, PID.6.1, is not valued, then mother’s maiden name is considered to contain no value. "]
[null,"QPD",null,"MARY","     Given Name","ST","RE","RE","If this field, PID.6.2, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"M","     Name Type Code","ID","RE","RE","If the field, PID-6.7, is not valued, then all values for this field are considered a match."]
[null,"QPD",6,20140708,"Patient Date of Birth (PID-7)","TS_NZ","R","R","If this field, PID.7, is not valued to an accuracy of at least day, then this field is considered not valued."]
[null,"QPD",7,"M","Patient Sex (PID-8)","IS","RE","RE","If this field, PID.8, is not valued, then all values for this field are considered a match."]
[null,"QPD",8,"|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|","Patient Address (PID-11)","XAD","RE","RE","If this field, PID.11, is not valued, then address will not be considered when seeking matching clients."]
[null,"QPD",null,"123 MAIN STREET","     Street Address","SAD","RE","RE","If this field, PID.11.1, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"CHEYENNE","     City","ST","RE","RE","If this field, PID.11.3, is not valued, then address is considered to contain no value."]
[null,"QPD",null,"WY","     State","ST","RE","RE","If this field, PID.11.4, is not valued, then address is considered to contain no value."]
[null,"QPD",null,82002,"     ZIP","ST","RE","RE","If this field, PID.11.5, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"BDL","     Address Type","IS","RE","RE","If this field, PID.11.7 is not valued, then it shall default to L, legal address."]
[null,"QPD",9,"|^PRN^PH^^^406^5551234|","Patient Home Phone (PID-13)","XTN","RE","RE","This field will be considered the Home phone. If this field, PID.13, is not valued, then phone number is not considered when seeking matching clients."]
[null,"QPD",null,406,"     Area Code","NM","RE","RE","If this field, PID.13.6, is not valued, then all values for this field shall be considered matches."]
[null,"QPD",null,5551234,"     Local Number","NM","RE","RE","If this field, PID.13.7, is not valued, then address is considered to contain no value."]
[null,"QPD",10,null,"Patient Multiple Birth Indicator (PID-24)","ID","RE","RE","If this field, PID.24, is not valued, then Multiple Birth Indicator is not considered when seeking matching clients."]
[null,"QPD",11,null,"Patient Birth Order (PID-25)","NM","RE","RE","If this field, PID.25, is not valued, then birth order is not considered when seeking matching clients."]
[null,"QPD",12,null,"Client Last Updated Date (PID-33)","TS ","O","O","If this field, PID.33, is not valued, then client last updated date is not considered when seeking matching clients."]
[null,"QPD",13,null,"Client Last Update Facility (PID-34)","HD","O","O","If this field, PID.34, is not valued, then client last updating facility is not considered when seeking matching clients."]

{"sheet":"Query RCP","index":27,"n_rows":16,"n_cols":9,"rows_kept":16,"cut":false,"hidden":false,"merged":[[1,2,1,3],[3,2,3,8],[5,1,6,1],[5,2,5,3],[6,2,6,3]]}
[]
[null,"Sample:","RCP|I|5^RD&RECORDS&HL70126"]
[]
[null,"Notes:","The RCP segment is used to restrict the amount of data that should be returned in response to query. It lists the segments to be returned."]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"RCP",1,"I","Query Priority","ID","RE","RE","Definition: This field contains the time frame in which the response is expected. Refer to HL7 Table 0091 - Query priority for valid values. Table values and subsequent fields specify time frames for response. Only “I” ( for immediate shall) be used for this field."]
[null,"RCP",2,"5^RD&RECORDS&HL70126","Quantity Limited Request","CQ","RE","RE","Definition: This field contains the maximum length of the response that can be accepted by the requesting system. Valid entries are numerical values (in the first component) given in the units specified in the second component. Default is LI (lines). The expected type is records, so the second component is constrained to RD.\nNote that this field is the maximum total records to return. The Version 2.5.1 standard indicates the maximum number to return in each batch. No batching of responses is permitted in this Guide."]
[null,"RCP",3,null,"Response Modality","CE","O","O"]
[null,"RCP",4,null,"Execution and Delivery Time","TS","O","O"]
[null,"RCP",5,null,"Modify Indicator","ID","O","O"]
[null,"RCP",6,null,"Sort-by Field","SRT","O","O"]
[null,"RCP",7,null,"Segment Group Inclusion","ID","O","O"]

{"sheet":"Z31 - Return List of Candidates","index":28,"n_rows":22,"n_cols":5,"rows_kept":22,"cut":false,"hidden":false,"merged":[[1,1,1,4],[6,1,6,4],[8,1,8,2],[4,1,4,4]]}
[]
[null,"Profile Z31 – Return List of Candidates is a constrainable profile that supports return of a list of candidate patients of interest. \nIt is a response to the Z34-Request Immunization History. \n\nThe goal of this response is to return a complete list of candidate patents in response to a request for a person’s record. This will support re-query by the initiator, based on selection of a member of the list."]
[]
[]
[null,"Profile Z31 – Return List of Candidates is a constrainable profile that supports return of a list of candidate patients of interest.  It is a response to the Z34-Request Immunization History. \n\nThe goal of this response is to return a complete list of candidate patents in response to a request for a person’s record. This will support re-query by the initiator, based on selection of a member of the list."]
[]
[null,"By default, responses will be sent in HL7 2.5.1 format. This change will cause the response to the following types of messages to default to 2.5.1 for the following types of messages:\n     • Messages with an invalid HL7 version\n     • Messages with an unspecified HL7 version\n     • Messages with an unfamiliar/unrecognized HL7 version\n     • Messages that are unread due to early rejection (wrong username, unlogged responses)"]
[]
[null,"Return List of Candidates History Response Grammar RSP^K11"]
[null,"Segment","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"MSH","Message Header Segment","R","When PHC Hub responds to HL7 message using version 2.5.1, the MSH header's date/time should include time zone; formatted as YYYYMMDDHHMMSS+-ZZZZ.  The default for MSH-15 and MSH-16 (Acknowledgement types) has been set to \"NE\" for ACK messages."]
[null,"MSA","Message Acknowledgement Segment","R"]
[null,"[ERR]","Error","RE","If errors exist, then this segment is populated."]
[null,"QAK","Query Acknowledgement Segment","R"]
[null,"QPD","Query Parameter Definition Segment","R","Query Parameter Definition - Matches the information in the requesting QBP message.\n\nBy default, PHC Hub will insert “L” as the name code in the response to messages without a specified name code in QPD-4.7. If the message specifies a valid name code, PHC Hub will echo it back in the response. \n\nWhen an address is included in a query response, it must include address type. This change populates QPD 8.7 to specify the kind or type of address as defined by HL7 Table 0190 - Address Type. By default, if QPD-8.7 is not valued, then it should default to L.  If QPD-8.7 is valued in the query, the response should echo the value."]
[null,null,"Response begin","R"]
[null,"     {","Begin patient identifier list","R"]
[null,"          PID",null,"R","Query responses contain 3 digits in PID-11 Example: United States = USA"]
[null,"         [PD1]",null,"RE"]
[null,"         [{NI1}]",null,"RE"]
[null,null,"End Patient Identifier"]
[null,"{","Response end"]

{"sheet":"Z32 - Return Complete History","index":29,"n_rows":26,"n_cols":5,"rows_kept":26,"cut":false,"hidden":false,"merged":[[1,1,1,4],[3,1,3,4],[5,1,5,3]]}
[]
[null,"Profile Z32 – Return Complete Immunization History is a constrainable profile that supports return of an immunization history of an individual. \nIt is a response to the Z34-Request Immunization History query. \n\nThe goal of this response is to return a complete immunization history in response to a request for a person’s record. This will support transferring a person’s immunization records from one information system to another. The response will be very similar to a VXU message in content."]
[]
[null,"By default, responses will be sent in HL7 2.5.1 format. This change will cause the response to the following types of messages to default to 2.5.1 for the following types of messages:\n     • Messages with an invalid HL7 version\n     • Messages with an unspecified HL7 version\n     • Messages with an unfamiliar/unrecognized HL7 version\n     • Messages that are unread due to early rejection (wrong username, unlogged responses)"]
[]
[null,"Return Complete Immunization History Response Grammar RSP^K11"]
[null,"Segment","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"MSH","Message Header Segment","R","When PHC Hub responds to HL7 message using version 2.5.1, the MSH header's date/time should include time zone; formatted as YYYYMMDDHHMMSS+-ZZZZ.  The default for MSH-15 and MSH-16 (Acknowledgement types) has been set to \"NE\" for ACK messages."]
[null,"MSA","Message Acknowledgement Segment","R"]
[null,"[ERR]","Error","RE","If errors exist, then this segment is populated."]
[null,"QAK","Query Acknowledgement Segment","R"]
[null,"QPD","Query Parameter Definition Segment","R","Query Parameter Definition - Matches the information in the requesting QBP message.\n\nBy default, PHC Hub will insert “L” as the name code in the response to messages without a specified name code in QPD-4.7. If the message specifies a valid name code, PHC Hub will echo it back in the response.\n\nWhen an address is included in a query response, it must include address type. This change populates QPD 8.7 to specify the kind or type of address as defined by HL7 Table 0190 - Address Type. By default, if QPD-8.7 is not valued, then it should default to L.  If QPD-8.7 is valued in the query, the response should echo the value."]
[null,"PID",null,"R","Query responses contain 3 digits in PID-11 Example: United States = USA"]
[null,"[PD1]",null,"RE"]
[null,"     [{NI1}]",null,"RE"]
[null,"     [PV1]",null,"O"]
[null,"     [IN1]",null,"O"]
[null,"     [{","Begin order","RE"]
[null,"          ORC",null,"R","Required if client has immunization records (RXA). There is one ORC for each RXA."]
[null,"               RXA",null,"R","Completion status of “CP” will be included in query responses unless the setting \"Suppress \"CP\" in RXA20, send blank for complete vaccinations instead.\" has been enabled."]
[null,"                    [RXR]",null,"RE"]
[null,"                    [{","Begin Observation","RE"]
[null,"                         OBX",null,"R"]
[null,"                         [NTE]",null,"RE"]
[null,"                    }]","End Observation"]
[null,"     }]","End Order"]

{"sheet":"Z33 - Return with No Matches","index":30,"n_rows":15,"n_cols":5,"rows_kept":15,"cut":false,"hidden":false,"merged":[[1,1,1,4],[6,1,6,4],[8,1,8,2],[4,1,4,4]]}
[]
[null,"Profile Z33 – Return Acknowledgment is a constrainable profile that supports return of an acknowledgement indicating not patients being returned in response to the Z34-Request Immunization History.\n\nThe goal of this profile is to return an acknowledgment message. It will indicate that either the message could be parsed, but there was an error processing the message or that no candidates were found. No demographic or immunization history will be returned.\n\nAn acknowledgement is returned when one of the 3 cases occur.  \n     1. An error has occurred when processing the query.\n     2. No high confidence matches are found. This includes when a match is found but is not allowed to be shared for privacy reasons or the receiving system does not support the profile Z31-Return list of candidates.\n     3. Too many matches are found and so none will be returned."]
[]
[]
[null,"Profile Z33 – Return Acknowledgment is a constrainable profile that supports return of an acknowledgement indicating not patients being returned in response to the Z34-Request Immunization History.\n\nThe goal of this profile is to return an acknowledgment message. It will indicate that either the message could be parsed, but there was an error processing the message or that no candidates were found. No demographic or immunization history will be returned.\n\nAn acknowledgement is returned when one of the 3 cases occur. \n     1. An error has occurred when processing the query.\n     2. No high confidence matches are found. This includes when a match is found but is not allowed to be shared for privacy reasons or the receiving system does not support the profile Z31-Return list of candidates.\n     3. Too many matches are found and so none will be returned."]
[]
[null,"By default, responses will be sent in HL7 2.5.1 format. This change will cause the response to the following types of messages to default to 2.5.1 for the following types of messages:\n     • Messages with an invalid HL7 version\n     • Messages with an unspecified HL7 version\n     • Messages with an unfamiliar/unrecognized HL7 version\n     • Messages that are unread due to early rejection (wrong username, unlogged responses)"]
[]
[null,"Return Acknowledgment Response Grammar RSP^K11"]
[null,"Segment","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"MSH","Message Header Segment","R","When PHC Hub responds to HL7 message using version 2.5.1, the MSH header's date/time should include time zone; formatted as YYYYMMDDHHMMSS+-ZZZZ.  The default for MSH-15 and MSH-16 (Acknowledgement types) has been set to \"NE\" for ACK messages."]
[null,"MSA","Message Acknowledgement Segment","R"]
[null,"[ERR]","Error","RE","If errors exist, then this segment is populated."]
[null,"QAK","Query Acknowledgement Segment","R"]
[null,"QPD","Query Parameter Definition Segment","R","Query Parameter Definition - Matches the information in the requesting QBP message.\n\nBy default, PHC Hub will insert “L” as the name code in the response to messages without a specified name code in QPD-4.7. If the message specifies a valid name code, PHC Hub will echo it back in the response.\n\nWhen an address is included in a query response, it must include address type. This change populates QPD 8.7 to specify the kind or type of address as defined by HL7 Table 0190 - Address Type. By default, if QPD-8.7 is not valued, then it should default to L.  If QPD-8.7 is valued in the query, the response should echo the value."]

{"sheet":"Z42 - ReturnHistory & Forecast ","index":31,"n_rows":18,"n_cols":5,"rows_kept":18,"cut":false,"hidden":false,"merged":[[1,1,1,4]]}
[]
[null,"Profile Z42 – Return Complete Immunization History and Forecast is a constrainable profile that supports return of an immunization history and forecast of an individual. It is a response to the Z44-Request Immunization History query.\n\nThe goal of this response is to return an evaluated immunization history and forecast. It is not intended to support transfer of complete immunization history. \nIt is a partner to Profile Z44, Request Evaluated History and Forecast."]
[]
[null,"Segment","Query Grammar:\nQBP Message","Usage","Notes"]
[null,"MSH","Message Header Segment","R","When PHC Hub responds to HL7 message using version 2.5.1, the MSH header's date/time should include time zone; formatted as YYYYMMDDHHMMSS+-ZZZZ.  The default for MSH-15 and MSH-16 (Acknowledgement types) has been set to \"NE\" for ACK messages."]
[null,"MSA","Message Acknowledgement Segment","R"]
[null,"[ERR]","Error","RE","If errors exist, then this segment is populated."]
[null,"QAK","Query Acknowledgement Segment","R"]
[null,"QPD","Query Parameter Definition Segment","R","Query Parameter Definition - Matches the information in the requesting QBP message.\n\nBy default, PHC Hub will insert “L” as the name code in the response to messages without a specified name code in QPD-4.7. If the message specifies a valid name code, PHC Hub will echo it back in the response.\n\nWhen an address is included in a query response, it must include address type. This change populates QPD 8.7 to specify the kind or type of address as defined by HL7 Table 0190 - Address Type. By default, if QPD-8.7 is not valued, then it should default to L.  If QPD-8.7 is valued in the query, the response should echo the value."]
[null,"PID",null,"R","Query responses contain 3 digits in PID-11 Example: United States = USA"]
[null,"     {","Immunization History and Forecast Group","R"]
[null,"          ORC",null,"O","Required if client has immunization records (RXA). There is one ORC for each RXA."]
[null,"               RXA",null,"R","Completion status of “CP” will be included in query responses unless the setting \"Suppress \"CP\" in RXA20, send blank for complete vaccinations instead.\" has been enabled."]
[null,"                    [RXR]",null,"RE"]
[null,"                    [{","Begin Observation","R"]
[null,"                         OBX",null,"R"]
[null,"                    }]","End Observation"]
[null,"     }","End Immunization History"]

{"sheet":"Response MSH","index":32,"n_rows":30,"n_cols":9,"rows_kept":30,"cut":false,"hidden":false,"merged":[[1,2,1,8],[31,2,31,4],[32,2,32,3],[3,1,4,1],[3,2,3,3],[4,2,4,3],[30,1,30,3]]}
[]
[null,"Sample:","MSH|^~\\&|HEALTHLAND^2.16.840.1.113883.3.4272.14.1^ISO|SIISCLIENT1724|IIS|IIS|20141121100000||RSP^K11^RSP_K11|123456|P|2.5.1|||NE|NE|||||Z32^CDCPHINVS|"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"MSH",1,"|","Field Separator","ST","R","R","This field contains the separator between the segment ID and the first real field, MSH-2-encoding characters. As such it serves as the separator and defines the character to be used as a separator for the rest of the message. \nConformance Statement: IZ-12: The MSH.1 (Field Separator) SHALL be valued “|\""]
[null,"MSH",2,"^~\\&","Encoding Characters","ST","R","R","This field contains the four characters in the following order: the component separator, repetition separator, escape character, and subcomponent separator. Required values are ^~\\& (ASCII 94, 126, 92, and 38, respectively).\nConformance Statement: IZ-13: The MSH.2 (Encoding Characters) SHALL be valued “^~\\& “"]
[null,"MSH",3,"Heartland","Sending Application","HD","RE","RE","This field uniquely identifies the sending application."]
[null,"MSH",4,"SIISCLIENT1724","Sending Facility","HD","RE","RE","This field identifies the organization responsible for the operations of the sending application. "]
[null,"MSH",5,"IIS","Receiving Application","HD","RE","RE","This field uniquely identifies the receiving application. The value is locally defined and often assigned by the IIS."]
[null,"MSH",6,"IIS","Receiving Facility","HD","RE","RE","This field identifies the organization responsible for the operations of the receiving application. Locally defined codes may be added to accommodate local needs. "]
[null,"MSH",7,20141121100000,"Date/Time Of Message","TS_Z","R","R","This field contains the date/time that the sending system created the message. The degree of precision must be at least to the minute. The time zone must be specified and will be used throughout the message as the default time zone.\nConformance: IZ-14: MSH-7 (Date/time of Message) SHALL have a degree of precision that must be at least to the minute. (Format YYYYMMDDHHMM)."]
[null,"MSH",8,null,"Security","ST","O","O"]
[null,"MSH",9,"RSP^K11^RSP_K11","Message Type","MSG","R","R","This field contains the message type, trigger event, and the message structure ID for the message. \nConformance: IZ-59: MSH-9 (Message Type) SHALL contain the constant value “RSP^K11^RSP_K11”"]
[null,"MSH",10,123456,"Message Control ID","ST","R","R","This field contains the identifier assigned by the sending application (MSH.3) that uniquely identifies a message instance. This identifier is unique within the scope of the sending facility (MSH.4), sending application (MSH.3), and the YYYYMMDD portion of message date (MSH.7). The receiving system echoes this ID back to the sending system in the Message acknowledgment segment (MSA). The content and format of the data sent in this field is the responsibility of the sender. The receiver returns exactly what was sent in response messages."]
[null,"MSH",11,"P","Processing ID","PT","R","R","If ‘D’ is sent in MSH-11, PHC Hub will return a 202 and the text: The only Processing ID used to submit HL7 messages to the IIS is ‘P’ and an ERR-8 of Debug mode cannot be used."]
[null,"MSH",12,"2.5.1","Version ID","VID","R","R","This field contains the identifier of the version of the HL7 messaging standard used in constructing, interpreting, and validating the message. Only the first component need be populated.\nIZ-15: The MSH-12 (Version ID) SHALL be valued 2.5.1 "]
[null,"MSH",13,null,"Sequence Number","NM","O","O"]
[null,"MSH",14,null,"Continuation Pointer","ST","O","O"]
[null,"MSH",15,"NE","Accept Acknowledgement Type","ID","R","R","This field identifies the conditions under which accept acknowledgments are required to be returned in response to this message. Accept acknowledgement indicates if the message was safely received or not.\nConformance: IZ-53: The value of MSH-15 (Accept Acknowledgement) SHALL have a value of \"NE\". NE - Never\n"]
[null,"MSH",16,"NE","Application Acknowledgment Type","ID","R","R","This field contains the conditions under which application acknowledgments are required to be returned in response to this message.\nConformance: IZ-52: The value of MSH-16 (Application Acknowledgement Type) SHALL have a value of \"NE\" NE - Never"]
[null,"MSH",17,null,"Country Code","ID","O","O"]
[null,"MSH",18,null,"Character Set","ID","O","O"]
[null,"MSH",19,null,"Principal Language of Message","CE","O","O"]
[null,"MSH",20,null,"Alternate Character Set Handling Scheme","ID","O","O"]
[null,"MSH",21,"Z32^CDCPHINVS","Message Profile Identifier","EI","R","R","Sites may use this field to assert adherence to, or reference, a message profile. Message profiles contain detailed explanations of grammar, syntax, and usage for a particular message or set of messages. \nConformance: IZ-60: One occurrence of MSH-21 (Message Profile Identifier) SHALL contain the constant value \"Z32^CDCPHINVS\""]
[null,"MSH",22,null,"Sending Responsible Organization","XON","RE","RE","Definition: Business organization that originated and is accountable for the content of the message."]
[null,"MSH",23,null,"Receiving Responsible Organization","XON","RE","RE","Definition: Business organization that is the intended receiver of the message and is accountable for acting on the data conveyed by the transaction."]

{"sheet":"Response MSA","index":33,"n_rows":13,"n_cols":9,"rows_kept":13,"cut":false,"hidden":false,"merged":[[16,2,16,4],[17,2,17,3],[1,2,1,3],[3,1,4,1],[3,2,3,3],[4,2,4,3],[15,1,15,3]]}
[]
[null,"Sample:","MSA|AA|793543"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"MSA",1,"AA","Acknowledgment Code","ID","R","R","MSA-1 will contain AA when a message contains no errors or warnings. \nMSA-1 will contain AE if the message contains an error and/or warning. \nMSA-1 will contain AR for unsupported message type, unsupported event code, unsupported processing ID and any transaction that cannot be processed for a reason that is not related to format or content. (effective v.521)"]
[null,"MSA",2,793543,"Message Control ID","ST","R","R","This field contains the message control ID of the message sent by the sending system. It allows the sending system to associate this response with the message for which it is intended. This field echoes the message control id sent in MSH-10 by the initiating system."]
[null,"MSA",3,null,"Text Message","ST","X","X"]
[null,"MSA",4,null,"Expected Sequence Number","NM",0,0]
[null,"MSA",5,null,"Delayed Acknowledgment Type",null,0,0]
[null,"MSA",6,null,"Error Condition","CE","X","X"]

{"sheet":"Response QAK","index":34,"n_rows":13,"n_cols":9,"rows_kept":13,"cut":false,"hidden":false,"merged":[[16,2,16,4],[17,2,17,3],[1,2,1,4],[3,1,4,1],[3,2,3,3],[4,2,4,3],[15,1,15,3]]}
[]
[null,"Sample:","QAK|37374859|OK|Z34^Request Immunization History^CDCPHINVS"]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"QAK",1,37374859,"Query Tag","ST","R","R","This field contains the value sent in QPD-2 (query tag) by the initiating system, and will be used to match response messages to the originating query. \nThe responding system is required to echo it back as the first field in the query acknowledgement segment (QAK)."]
[null,"QAK",2,"OK","Query Response Status","ID","R","R","Definition: This field allows the responding system to return a precise response status. It is especially useful in the case where no data is found that matches the query parameters, but where there is also no error. \nIt is defined with HL7 Table 0208 - Query Response Status. "]
[null,"QAK",3,"Z34^Request Immunization History^CDCPHINVS","Message Query Name","CE","R","R","Definition: This field contains the name of the query. This shall mirror the QPD-1 (Message Query Name) found in the query message that is being responded to."]
[null,"QAK",4,null,"Hit Count","NM","O","O"]
[null,"QAK",5,null,"This Payload","NM","O","O"]
[null,"QAK",6,null,"Hits Remaining","NM","O","O"]

{"sheet":"Response QPD","index":35,"n_rows":39,"n_cols":9,"rows_kept":39,"cut":false,"hidden":false,"merged":[[1,2,1,8],[3,2,3,8],[5,1,6,1],[5,2,5,3],[6,2,6,3]]}
[]
[null,"Sample:","QPD|Z34^Request Complete Immunization History^CDCPHINVS|37374859|A69532^^^^MR|SMITH^MICK^D^^^^L|JONES^MARY^^^^^M|20140708|M|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|^PRN^PH^^^406^5551234|"]
[]
[null,"Notes:","Local implementations will specify which fields are required in the QPD. All fields have a usage of RE (required, but may be empty). This means that sending systems may populate any or all of these fields. Receiving systems must accept values in any of these fields, but may specify which are required and which will be ignored."]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Example Segment","Element Name","Data Type","WA Usage","CDC Usage","Notes"]
[null,"QPD",1,"Z34^Request Complete Immunization History^CDCPHINVS","MessageQueryName","CE","R","R","Conformance Statement:\nIZ-67: QPD-1 (Message Query Name) SHALL be valued \"Z34^Request Immunization History^CDCPHINV"]
[null,"QPD",2,37374859,"Query Tag","ST","R","R","Unique to each query message instance."]
[null,"QPD",3,"|A69532^^^^MR|","Patient List (PID-3)","CX","RE","RE","The combination of values for Patientlist.ID, patientlst.identifiercode and Patientlist.AssigningAuthority are intended to allow unique identification of a client, if the data are found in the responding system."]
[null,"QPD",null,"A69532","     ID","ST","R","R","If this field, PID.3.1, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,null,"     Assigning Authority","HD","R","R","If this field, PID.3.4, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,"MR","     Identifier Type Code","IS","R","R","If this field, PID.3.5, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",4,"|SMITH^MICK^D^^^^L|","Patient Name (PID-5)","XPN","R","R","If this field, PID.5, is not valued, then the query will return an error, since this is a required field."]
[null,"QPD",null,"SMITH","     Family Name","FN","R","R","If this field, PID.5.1, is not valued, then patient name is considered to contain no value. "]
[null,"QPD",null,"MICK","     Given Name","ST","R","R","If this field, PID.5.2, is not valued, then patient name is considered to contain no value. Given name is required."]
[null,"QPD",null,"D","     Second or further names","ST","R","R","If this field, PID.5.3, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,null,"     Suffix","ST","R","R","If this field, PID.5.4, is not valued, then all values for this field are considered a match,"]
[null,"QPD",5,"|JONES^MARY^^^^^M|","Patient Mother Maiden Name (PID-6)","XPN_M","RE","RE","If this field, PID.6, is not valued, Mother’s maiden name is not considered when seeking matching clients."]
[null,"QPD",null,"JONES","     Family Name","FN","R","R","If this field, PID.6.1, is not valued, then mother’s maiden name is considered to contain no value. "]
[null,"QPD",null,"MARY","     Given Name","ST","RE","RE","If this field, PID.6.2, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"M","     Name Type Code","ID","RE","RE","If the field, PID-6.7, is not valued, then all values for this field are considered a match."]
[null,"QPD",6,20140708,"Patient Date of Birth (PID-7)","TS_NZ","RE","RE","If this field, PID.7, is not valued to an accuracy of at least day, then this field is considered not valued."]
[null,"QPD",7,"M","Patient Sex (PID-8)","IS","RE","RE","If this field, PID.8, is not valued, then all values for this field are considered a match."]
[null,"QPD",8,"|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|","Patient Address (PID-11)","XAD","RE","RE","If this field, PID.11, is not valued, then address will not be considered when seeking matching clients."]
[null,"QPD",null,"123 MAIN STREET","     Street Address","SAD","RE","RE","If this field, PID.11.1, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"CHEYENNE","     City","ST","RE","RE","If this field, PID.11.3, is not valued, then address is considered to contain no value."]
[null,"QPD",null,"WY","     State","ST","RE","RE","If this field, PID.11.4, is not valued, then address is considered to contain no value."]
[null,"QPD",null,82002,"     ZIP","ST","RE","RE","If this field, PID.11.5, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"BDL","     Address Type","IS","RE","RE","If this field, PID.11.7 is not valued, then it shall default to L, legal address."]
[null,"QPD",9,"|^PRN^PH^^^406^5551234|","Patient Home Phone (PID-13)","XTN","RE","RE","This field will be considered the Home phone. If this field, PID.13, is not valued, then phone number is not considered when seeking matching clients."]
[null,"QPD",null,406,"     Area Code","NM","RE","RE","If this field, PID.13.6, is not valued, then all values for this field shall be considered matches."]
[null,"QPD",null,5551234,"     Local Number","NM","RE","RE","If this field, PID.13.7, is not valued, then address is considered to contain no value."]
[null,"QPD",10,null,"Patient Multiple Birth Indicator (PID-24)","ID","RE","RE","If this field, PID.24, is not valued, then Multiple Birth Indicator is not considered when seeking matching clients."]
[null,"QPD",11,null,"Patient Birth Order (PID-25)","NM","RE","RE","If this field, PID.25, is not valued, then birth order is not considered when seeking matching clients."]
[null,"QPD",12,null,"Client Last Updated Date (PID-33)","TS ","O","O","f this field, PID.33, is not valued, then client last updated date is not considered when seeking matching clients."]
[null,"QPD",13,null,"Client Last Update Facility (PID-34)","HD","O","O","If this field, PID.34, is not valued, then client last updating facility is not considered when seeking matching clients."]

{"sheet":"Z32 - MSA","index":36,"n_rows":11,"n_cols":8,"rows_kept":11,"cut":false,"hidden":true,"merged":[[1,2,1,3],[13,1,13,3],[14,2,14,4],[15,2,15,3]]}
[]
[null,"Sample:","MSA|AA|793543"]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage","Notes"]
[null,"MSA",1,"AA","Acknowledgment Code","ID","R","MSA 1 will contain AA when a message contains no errors or warnings. \nMSA will contain AE if the message contains an error and/or warning. \nMSA-1 will contain AR for unsupported message type, unsupported event code, unsupported processing ID \nand any transaction that cannot be processed for a reason that is not related to format or content. (effective v.521)"]
[null,"MSA",2,793543,"Message Control ID","ST","R","This field contains the message control ID of the message sent by the sending system. It allows the sending system to associate this response with the message for which it is intended. This field echoes the message control id sent in MSH-10 by the initiating system."]
[null,"MSA",3,null,"Text Message","ST","X"]
[null,"MSA",4,null,"Expected Sequence Number","HD",0]
[null,"MSA",5,null,"Delayed Acknowledgment Type","HD",0]
[null,"MSA",6,null,"Error Condition","HD","X"]

{"sheet":"Z32 - QAK","index":37,"n_rows":11,"n_cols":8,"rows_kept":11,"cut":false,"hidden":true,"merged":[[1,2,1,4],[13,1,13,3],[14,2,14,4],[15,2,15,3]]}
[]
[null,"Sample:","QAK|37374859|OK|Z34^Request Immunization History^CDCPHINVS"]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage","Definitions"]
[null,"QAK",1,37374859,"Query Tag","ST","R","This field contains the value sent in QPD-2 (query tag) by the initiating system, and will be used to match response messages to the originating query. \nThe responding system is required to echo it back as the first field in the query acknowledgement segment (QAK)."]
[null,"QAK",2,"OK","Query Response Status","ID","RE","Definition: This field allows the responding system to return a precise response status. It is especially useful in the case where no data is found that matches the query parameters, but where there is also no error. It is defined with HL7 Table 0208 - Query Response Status. "]
[null,"QAK",3,"Z34^Request Immunization History^CDCPHINVS","Message Query Name","CE","R","Definition: This field contains the name of the query. This shall mirror the QPD-1 (Message Query Name) found in the query message that is being responded to."]
[null,"QAK",4,null,"Hit Count","NM","O"]
[null,"QAK",5,null,"This Payload","NM","O"]
[null,"QAK",6,null,"Hits Remaining","NM","O"]

{"sheet":"Z32 - QPD","index":38,"n_rows":37,"n_cols":8,"rows_kept":37,"cut":false,"hidden":true,"merged":[[1,2,1,7],[3,2,3,7]]}
[]
[null,"Sample:","QPD|Z34^Request Complete Immunization History^CDCPHINVS|37374859|A69532^^^^MR|SMITH^MICK^D^^^^L|JONES^MARY^^^^^M|20140708|M|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|406^5551234|"]
[]
[null,"Note:","Local implementations will specify which fields are required in the QPD. All fields have a usage of RE (required, but may be empty). This means that sending systems may populate any or all of these fields. Receiving systems must accept values in any of these fields, but may specify which are required and which will be ignored."]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage","Description"]
[null,"QPD",1,"Z34^Request Complete Immunization History^CDCPHINVS","MessageQueryName","CE","R"]
[null,"QPD",2,37374859,"Query Tag","ST","R","Unique to each query message instance."]
[null,"QPD",3,"|A69532^^^^MR|","Patient List (PID-3)","CX","RE","The combination of values for Patientlist.ID, patientlst.identifiercode and Patientlist.AssigningAuthority are intended to allow unique identification of a client, if the data are found in the responding system."]
[null,"QPD",null,"A69532","     ID","ST","R","If this field, PID.3.1, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,null,"     Assigning Authority","HD","R","If this field, PID.3.4, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",null,"MR","     Identifier Type Code","IS","R","If this field, PID.3.5, is not valued, PatientList is not considered when seeking matching clients."]
[null,"QPD",4,"|SMITH^MICK^D^^^^L|","Patient Name (PID-5)","XPN","R","If this field, PID.5, is not valued, then the query will return an error, since this is a required field."]
[null,"QPD",null,"SMITH","     Family Name","FN","R","If this field, PID.5.1, is not valued, then patient name is considered to contain no value. "]
[null,"QPD",null,"MICK","     Given Name","ST","R","If this field, PID.5.2, is not valued, then patient name is considered to contain no value. Given name is required."]
[null,"QPD",null,"D","     Second or further names","ST","R","If this field, PID.5.3, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,null,"     Suffix","ST","R","If this field, PID.5.4, is not valued, then all values for this field are considered a match,"]
[null,"QPD",5,"|JONES^MARY^^^^^M|","Patient Mother Maiden Name (PID-6)","XPN_M","RE","If this field, PID.6, is not valued, Mother’s maiden name is not considered when seeking matching clients."]
[null,"QPD",null,"JONES","     Family Name","FN","R","If this field, PID.6.1, is not valued, then mother’s maiden name is considered to contain no value. "]
[null,"QPD",null,"MARY","     Given Name","ST","RE","If this field, PID.6.2, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"M","     Name Type Code","ID","RE","If the field, PID-6.7, is not valued, then all values for this field are considered a match."]
[null,"QPD",6,20140708,"Patient Date of Birth (PID-7)","TS_NZ","RE","If this field, PID.7, is not valued to an accuracy of at least day, then this field is considered not valued."]
[null,"QPD",7,"M","Patient Sex (PID-8)","IS","RE","If this field, PID.8, is not valued, then all values for this field are considered a match."]
[null,"QPD",8,"|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|","Patient Address (PID-11)","XAD","RE","If this field, PID.11, is not valued, then address will not be considered when seeking matching clients."]
[null,"QPD",null,"123 MAIN STREET","     Street Address","SAD","RE","If this field, PID.11.1, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"CHEYENNE","     City","ST","RE","If this field, PID.11.3, is not valued, then address is considered to contain no value."]
[null,"QPD",null,"WY","     State","ST","RE","If this field, PID.11.4, is not valued, then address is considered to contain no value."]
[null,"QPD",null,82002,"     ZIP","ST","RE","If this field, PID.11.5, is not valued, then all values for this field are considered a match."]
[null,"QPD",null,"BDL","     Address Type","IS","RE","If this field, PID.11.7 is not valued, then it shall default to L, legal address."]
[null,"QPD",9,"|406^5551234|","Patient Home Phone (PID-13)","XTN","RE","This field will be considered the Home phone. If this field, PID.13, is not valued, then phone number is not considered when seeking matching clients."]
[null,"QPD",null,406,"     Area Code","NM",null,"If this field, PID.13.6, is not valued, then all values for this field shall be considered matches."]
[null,"QPD",null,5551234,"     Local Number","NM",null,"If this field, PID.13.7, is not valued, then address is considered to contain no value."]
[null,"QPD",10,null,"Patient Multiple Birth Indicator (PID-24)","ID","RE","If this field, PID.24, is not valued, then Multiple Birth Indicator is not considered when seeking matching clients."]
[null,"QPD",11,null,"Patient Birth Order (PID-25)","NM","RE","If this field, PID.25, is not valued, then birth order is not considered when seeking matching clients."]
[null,"QPD",12,null,"Client Last Updated Date (PID-33)","TS ","O","f this field, PID.33, is not valued, then client last updated date is not considered when seeking matching clients."]
[null,"QPD",13,null,"Client Last Update Facility (PID-34)","HD","O","If this field, PID.34, is not valued, then client last updating facility is not considered when seeking matching clients."]

{"sheet":"Z44 - QPD","index":39,"n_rows":37,"n_cols":7,"rows_kept":37,"cut":false,"hidden":true,"merged":[[1,2,1,9],[3,2,3,9]]}
[]
[null,"Sample:","QPD|Z44^Request Complete Immunization History^CDCPHINVS|37374859|A69532^^^^MR|SMITH^MICK^D^^^^L|JONES^MARY^^^^^M|20140708|M|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|406^5551234|"]
[]
[null,"Note:","Local implementations will specify which fields are required in the QPD. All fields have a usage of RE (required, but may be empty). This means that sending systems may populate any or all of these fields. Receiving systems must accept values in any of these fields, but may specify which are required and which will be ignored."]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage"]
[null,"QPD",1,"Z44^Request Complete Immunization History^CDCPHINVS","MessageQueryName","CE","R"]
[null,"QPD",2,37374859,"Query Tag","ST","R"]
[null,"QPD",3,"|A69532^^^^MR|","Patient List (PID-3)","CX","RE"]
[null,"QPD",null,"A69532","     ID","ST","R"]
[null,"QPD",null,null,"     Assigning Authority","HD","R"]
[null,"QPD",null,"MR","     Identifier Type Code","IS","R"]
[null,"QPD",4,"|SMITH^MICK^D^^^^L|","Patient Name (PID-5)","XPN","R"]
[null,"QPD",null,"SMITH","     Family Name","FN","R"]
[null,"QPD",null,"MICK","     Given Name","ST","R"]
[null,"QPD",null,"D","     Second or further names","ST","R"]
[null,"QPD",null,null,"     Suffix","ST","R"]
[null,"QPD",5,"|JONES^MARY^^^^^M|","Patient Mother Maiden Name (PID-6)","XPN_M","RE"]
[null,"QPD",null,"JONES","     Family Name","FN","R"]
[null,"QPD",null,"MARY","     Given Name","ST","RE"]
[null,"QPD",null,"M","     Name Type Code","ID","RE"]
[null,"QPD",6,20140708,"Patient Date of Birth (PID-7)","TS_NZ","RE"]
[null,"QPD",7,"M","Patient Sex (PID-8)","IS","RE"]
[null,"QPD",8,"|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|","Patient Address (PID-11)","XAD","RE"]
[null,"QPD",null,"123 MAIN STREET","     Street Address","SAD","RE"]
[null,"QPD",null,"CHEYENNE","     City","ST","RE"]
[null,"QPD",null,"WY","     State","ST","RE"]
[null,"QPD",null,82002,"     ZIP","ST","RE"]
[null,"QPD",null,"BDL","     Address Type","IS","RE"]
[null,"QPD",9,"|406^5551234|","Patient Home Phone (PID-13)","XTN","RE"]
[null,"QPD",null,406,"     Area Code","NM"]
[null,"QPD",null,5551234,"     Local Number","NM"]
[null,"QPD",10,null,"Patient Multiple Birth Indicator (PID-24)","ID","RE"]
[null,"QPD",11,null,"Patient Birth Order (PID-25)","NM","RE"]
[null,"QPD",12,null,"Client Last Updated Date (PID-33)","TS ","O"]
[null,"QPD",13,null,"Client Last Update Facility (PID-34)","HD","O"]

{"sheet":"Z44 - RCP","index":40,"n_rows":12,"n_cols":7,"rows_kept":12,"cut":false,"hidden":true,"merged":[[1,2,1,3]]}
[]
[null,"Sample:","RCP|I|5^RD&RECORDS&HL70126"]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage"]
[null,"RCP",1,"I","Query Priority","ID","RE"]
[null,"RCP",2,"5^RD&RECORDS&HL70126","Quantity Limited Request","CQ","RE"]
[null,"RCP",3,null,"Response Modality","CE","O"]
[null,"RCP",4,null,"Execution and Delivery Time","TS","O"]
[null,"RCP",5,null,"Modify Indicator","ID","O"]
[null,"RCP",6,null,"Sort-by Field","SRT","O"]
[null,"RCP",7,null,"Segment Group Inclusion","ID","O"]

{"sheet":"Z42 - MSA","index":41,"n_rows":11,"n_cols":7,"rows_kept":11,"cut":false,"hidden":true,"merged":[[1,2,1,3],[13,1,13,3],[14,2,14,4],[15,2,15,3]]}
[]
[null,"Sample:","MSA|AA|793543"]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage"]
[null,"MSA",1,"AA","Acknowledgment Code","ID","R"]
[null,"MSA",2,793543,"Message Control ID","ST","R"]
[null,"MSA",3,null,"Text Message","ST","RE"]
[null,"MSA",4,null,"Expected Sequence Number","HD","RE"]
[null,"MSA",5,null,"Delayed Acknowledgment Type","HD","RE"]
[null,"MSA",6,null,"Error Condition","HD","RE"]

{"sheet":"Z42 - QAK","index":42,"n_rows":11,"n_cols":7,"rows_kept":11,"cut":false,"hidden":true,"merged":[[1,2,1,4],[13,1,13,3],[14,2,14,4],[15,2,15,3]]}
[]
[null,"Sample:","QAK|37374859|OK|Z44^Request Evaluated Immunization History ^CDCPHINVS"]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage"]
[null,"QAK",1,37374859,"Query Tag","ST","R"]
[null,"QAK",2,"OK","Query Response Status","ID","RE"]
[null,"QAK",3,"Z44^Request Evaluated Immunization History^CDCPHINVS","Message Query Name","CE","R"]
[null,"QAK",4,null,"Hit Count","NM","O"]
[null,"QAK",5,null,"This Payload","NM","O"]
[null,"QAK",6,null,"Hits Remaining","NM","O"]

{"sheet":"Z42 - QPD","index":43,"n_rows":37,"n_cols":7,"rows_kept":37,"cut":false,"hidden":true,"merged":[[1,2,1,8],[3,2,3,8]]}
[]
[null,"Sample:","QPD|Z34^Request Evaluated Immunization History^CDCPHINVS|37374859|A69532^^^^MR|SMITH^MICK^D^^^^L|JONES^MARY^^^^^M|20140708|M|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|406^5551234|"]
[]
[null,"Note:","Local implementations will specify which fields are required in the QPD. All fields have a usage of RE (required, but may be empty). This means that sending systems may populate any or all of these fields. Receiving systems must accept values in any of these fields, but may specify which are required and which will be ignored."]
[]
[]
[null,"Segment","SEQ","Example Segment","Element Name","DataType","Usage"]
[null,"QPD",1,"Z34^Request Evaluated  Immunization History^CDCPHINVS","MessageQueryName","CE","R"]
[null,"QPD",2,37374859,"Query Tag","ST","R"]
[null,"QPD",3,"|A69532^^^^MR|","Patient List (PID-3)","CX","RE"]
[null,"QPD",null,"A69532","     ID","ST","R"]
[null,"QPD",null,null,"     Assigning Authority","HD","R"]
[null,"QPD",null,"MR","     Identifier Type Code","IS","R"]
[null,"QPD",4,"|SMITH^MICK^D^^^^L|","Patient Name (PID-5)","XPN","R"]
[null,"QPD",null,"SMITH","     Family Name","FN","R"]
[null,"QPD",null,"MICK","     Given Name","ST","R"]
[null,"QPD",null,"D","     Second or further names","ST","R"]
[null,"QPD",null,null,"     Suffix","ST","R"]
[null,"QPD",5,"|JONES^MARY^^^^^M|","Patient Mother Maiden Name (PID-6)","XPN_M","RE"]
[null,"QPD",null,"JONES","     Family Name","FN","R"]
[null,"QPD",null,"MARY","     Given Name","ST","RE"]
[null,"QPD",null,"M","     Name Type Code","ID","RE"]
[null,"QPD",6,20140708,"Patient Date of Birth (PID-7)","TS_NZ","RE"]
[null,"QPD",7,"M","Patient Sex (PID-8)","IS","RE"]
[null,"QPD",8,"|123 MAIN STREET^^CHEYENNE^WY^82002^BDL|","Patient Address (PID-11)","XAD","RE"]
[null,"QPD",null,"123 MAIN STREET","     Street Address","SAD","RE"]
[null,"QPD",null,"CHEYENNE","     City","ST","RE"]
[null,"QPD",null,"WY","     State","ST","RE"]
[null,"QPD",null,82002,"     ZIP","ST","RE"]
[null,"QPD",null,"BDL","     Address Type","IS","RE"]
[null,"QPD",9,"|406^5551234|","Patient Home Phone (PID-13)","XTN","RE"]
[null,"QPD",null,406,"     Area Code","NM"]
[null,"QPD",null,5551234,"     Local Number","NM"]
[null,"QPD",10,null,"Patient Multiple Birth Indicator (PID-24)","ID","RE"]
[null,"QPD",11,null,"Patient Birth Order (PID-25)","NM","RE"]
[null,"QPD",12,null,"Client Last Updated Date (PID-33)","TS ","O"]
[null,"QPD",13,null,"Client Last Update Facility (PID-34)","HD","O"]

{"sheet":"Sample Queries & Responses","index":44,"n_rows":17,"n_cols":3,"rows_kept":17,"cut":false,"hidden":false,"merged":[]}
[]
[null,"QBP Message "]
[null,null,"MSH|^~\\&|Athena|Big Horn Pediatrics|||20210312233551|117311|QBP^Q11^QBP_Q11|12|P|2.5.1|||ER|AL|||||Z34^CDCPHINVS|\nQPD|Z34^Request Immunization History^HL70471|243|3988867^^^^MR|ANDREWS^RUBEN^NEIL||20120610|F|303 Bacztdesi Bs^^MEXGELAR^WA^73026|\nRCP|I|1^RD^HL70126|R^Real Time^HL70394"]
[]
[]
[null,"RSP Message\nExact Match"]
[null,null,"MSH|^~\\&|^^|MA0000^^|^^|GA0000^^|20111105122535||RSP^K11^RSP_K11|1320521135996.100000002|P|2.5.1|||||||||Z32^CDCPHINVS^^| \nMSA|AA|19970522GA40|| \nQAK|||Z34^Request Immunization History^HL70471| \nQPD|Z34^Request Immunization History^HL70471|19970522GA05||FLOYD^FRANK^^^^^L|MALIFICENT|20030123|M|L| \nPID|1||25^^^^SR~0001||FLOYD^FRANK^^^^^L||20030123|M|||612 S WRIGHT CT^^KENNEWICK^WASHINGTON^99366^United States^M||^PRN^PH^^^509^4210355|||||||||||||||||N|\nPD1|||^^^^^^SR|21^MATT^SHAKY^K^^^^^^^^^SR~1679652135|||||||02^Reminder/recall -any method^HL70215|||||A^Active^HL70441| \nPV1||R||||||||||||||||||V01|\nNK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063| \nORC|RE||25.34.20100723| \nRXA|0|999|20100723|20100723|83^Hep A, ped/adol, 2 dose^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^ABC Pediatrics||||AHAVB379AA||SKB^GlaxoSmithKline^HL70227||||A|20111105122536\nRXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163| "]
[]
[]
[null,"RSP Message\nMultiple Matches "]
[null,null,"MSH|^~\\&|^^|MA0000^^|^^|GA0000^^|20111104153354||RSP^K11^RSP_K11|1320446034070.100000002|T|2.5.1|||||||||Z31^CDCPHINVS^^| \nMSA|AA|19970522GA40|| \nQAK|||Z34^Request Immunization History^HL70471| \nQPD|Z34^Request Immunization History^HL70471|19970522GA05||^JOHN^^^^^L|Que^MALIF^^^^^M|20030123|M|L| \nPID|1||25^^^^SR||FLOYD^FRANK^^^^^L||20030123| \nNK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063| \nPID|2||85^^^^SR||HENRY^JOHN^^^^^L||20011010| \nNK1|1|^MARY|GRD^Guardian^HL70063| \nPID|3||26^^^^SR||KENNEDY^JOHN^FITZGERALD^^^^L||19900607| \nNK1|1|KENNEDY^JACQUELINE^LEE|GRD^Guardian^HL70063| \n"]
[]
[]
[null,"RSP Message\nWith Forecast Information "]
[null,null,"MSH|^~\\&|^^|MA0000^^|^^|GA0000^^|20111105122535||RSP^K11^RSP_K11|1320521135996.100000002|P|2.5.1|||||||||Z32^CDCPHINVS^^| \nMSA|AA|19970522GA40|| \nQAK|||Z34^Request Immunization History^HL70471| \nQPD|Z34^Request Immunization History^HL70471|19970522GA05||FLOYD^FRANK^^^^^L|MALIFICENT|20030123|M|L| \nPID|1||25^^^^SR~0001||FLOYD^FRANK^^^^^L||20030123|M|||612 S WRIGHT CT^^KENNEWICK^WASHINGTON^99366^United States^M||^PRN^PH^^^509^4210355|||||||||||||||||N|\nPD1|||^^^^^^SR|21^MATT^SHAKY^K^^^^^^^^^SR~1679652135|||||||02^Reminder/recall -any method^HL70215|||||A^Active^HL70441| \nPV1||R||||||||||||||||||V01|\nNK1|1|FLOYD^MALIFICENT|GRD^Guardian^HL70063| \nORC|RE||25.34.20100723| \nRXA|0|999|20100723|20100723|83^Hep A, ped/adol, 2 dose^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^ABC Pediatrics||||AHAVB379AA||SKB^GlaxoSmithKline^HL70227||||A|20111105122536\nRXR|IM^Intramuscular^HL70162|LT^Left Thigh^HL70163| \nORC|RE||25.34.20100723| \nRXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|  \nOBX|1|CE|30956-7^vaccine type^LN||20^DTaP^CVX||||||F| \nOBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F| \nOBX|1|NM|30973-2^Dose number in series^LN||4||||||F| \nOBX|1|TS|30980-7^Date vaccination due^LN||20121206||||||F| \nOBX|1|TS|30981-5^Earliest date to give^LN||20121206||||||F| \nOBX|1|TS|59777-3^Latest date next dose should be given^LN||20161101||||||F| \nOBX|1|TS|59778-1^Date dose is overdue^LN||20130106||||||F| \nOBX|1|CE|59783-1^Status in immunization series^LN||U^Up to Date^STC0002||||||F| \n"]
[null,null,"RXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|\nOBX|1|CE|30956-7^vaccine type^LN||48^Hib^CVX||||||F| \nOBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F| \nOBX|1|NM|30973-2^Dose number in series^LN||1||||||F| \nOBX|1|TS|30980-7^Date vaccination due^LN||20100102||||||F| \nOBX|1|TS|30981-5^Earliest date to give^LN||20091214||||||F| \nOBX|1|TS|59777-3^Latest date next dose should be given^LN||20141101||||||F| \nOBX|1|TS|59778-1^Date dose is overdue^LN||20100202||||||F| \nOBX|1|CE|59783-1^Status in immunization series^LN||P^Past Due^STC0002||||||F| \nORC|RE||9999| \nRXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144|\nOBX|1|CE|30956-7^vaccine type^LN||114^MCV4^CVX||||||F| \nOBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F| \nOBX|1|NM|30973-2^Dose number in series^LN||1||||||F| \nOBX|1|TS|30980-7^Date vaccination due^LN||20201102||||||F| \nOBX|1|TS|30981-5^Earliest date to give^LN||20201102||||||F| \nOBX|1|TS|59777-3^Latest date next dose should be given^LN||20641101||||||F| \nOBX|1|TS|59778-1^Date dose is overdue^LN||20211102||||||F| \nOBX|1|CE|59783-1^Status in immunization series^LN||U^Up to Date^STC0002||||||F| "]
[null,null,"ORC|RE||9999| \nRXA|0|999|20120727112142|20120727112142|998^no vaccine administered^CVX|0||||||||||||||||20120727112144| RXR|OTH^Other/Miscellaneous^HL70162| \nOBX|1|CE|30956-7^vaccine type^LN||133^Pneumococcal^CVX||||||F| \nOBX|1|CE|59779-9^Immunization Schedule used^LN||VXC16^ACIP^CDCPHINVS||||||F| \nOBX|1|NM|30973-2^Dose number in series^LN||1||||||F| \nOBX|1|TS|30980-7^Date vaccination due^LN||20100102||||||F| \nOBX|1|TS|30981-5^Earliest date to give^LN||20091214||||||F| \nOBX|1|TS|59777-3^Latest date next dose should be given^LN||20151001||||||F| \nOBX|1|TS|59778-1^Date dose is overdue^LN||20100202||||||F| \nOBX|8|CE|59783-1^Status in immunization series^LN|1|P^Past Due^99002||||||F|  "]

{"sheet":"ERR","index":45,"n_rows":43,"n_cols":7,"rows_kept":43,"cut":false,"hidden":false,"merged":[[1,2,1,6],[3,2,3,6],[5,1,6,1],[5,2,5,3],[6,2,6,3]]}
[]
[null,"Sample:","MSH|^~\\&|WADOHIIS^2.16.840.1.113883.3.237.4.15^OID|dn1fro00^1.3.6.1.4.1.38630.2.1.1.19^ISO|EMR^^|ql9exf00^1.3.6.1.4.1.38630.2.1.1.372^OID|20190715122729-0700||ACK^V04^ACK|8091289971.100002553|P|2.5.1|||NE|NE|||||Z22^CDCPHINVS^^|\nMSA|AE|10946|\nERR||RXA^1^11^^4|103^Table value not found^HL70357|E||||vaccination facility id is unrecognized administered|\nERR||RXA|100^Segment sequence error^HL70357|E||||vaccination facility id is unrecognized administered - Message Rejected|\nERR||PD1^^11|101^Required field missing^HL70357|W||||patient publicity code is missing|\nERR||PID^1^10|101^Required field missing^HL70357|W||||patient race is missing|\nERR||RXA^1^17|101^Required field missing^HL70357|W||||vaccination manufacturer is missing|\nERR||RXA^1^15|103^Table value not found^HL70357|W||||vaccination lot is unrecognized|\nERR||PID^1|999^Application Error^HL70357|W||||patient is eligible for vfc but no guardian|"]
[]
[null,"Notes:","Messages can fail if:\n• The message is of an unsupported message type (MSH-9)\n• The message has an unsupported event code (MSH-9)\n• The message has an unsupported processing ID (MSH-11)\n• The message has an unsupported version ID (MSH-12)\n• The message is unable to be processed for reasons unrelated to format or content\nIf one of the above events causes a message to be rejected, the QBP response will include Z23 in MSH-21. If an error of a different type occurs, PHC Hub will return a Z33 (ACK) response profile."]
[]
[null,"Notes:","HL7 Data Type Legend"]
[null,null,"Conformance Symbols"]
[]
[null,"Segment","SEQ","Element Name","DataType","Usage","Notes"]
[null,"ERR",1,"Error Code and Location","ELD","X"]
[null,"ERR",2,"Error Location","ERL","RE","When practical/meaningful, the location of the identified error will be returned in ERR 2.2.  When a value is returned in ERR 2.2, it will contain the segment set id or, if none, the segment sequence number. If a value is returned in ERR 2.2, it uses the segment set ID first. \nIf  the relevant segment does not have a set ID or is blank, the sequence number of the segment is returned. For example, when the second RXA segment returns an ERR with a value in 2.2, ERR-2.2 shows 2. If the set id does not match the sequence number, the set id is still used as it clearly identifies the segment taking the error. \nSet ids can be found in PID-1, NK1-1, and IN1-1 segments."]
[null,"ERR",3,"HL7 Error Code","CWE","R","When ERR 3.1 is 0, ERR 3.2 shows “Message Accepted” and 3.3 shows the name of the coding system. \nA Query Response with No Patient Return will contain “Message Accepted” in ERR 3.2 and the name of the coding system in 3.3. \nWhen an invalid entry is made in MSH-9.2, a 201, unsupported event code, is returned."]
[null,"ERR",4,"Severity","ID","R"]
[null,"ERR",5,"Application Error Code","CWE","RE"]
[null,"ERR",6,"Application Error Parameter","ST","O"]
[null,"ERR",7,"Diagnostic Information","TX","O"]
[null,"ERR",8,"User Message","TX","RE"]
[null,"ERR",9,"Inform Person Indicator","IS","O"]
[null,"ERR",10,"Override Type","CWE","O"]
[null,"ERR",11,"Override Reason Code","CWE","O"]
[null,"ERR",12,"Help Desk Contact Point","XTN","O"]
[]
[]
[]
[null,"Sample Application Error (AR/Reject)"]
[null,"MSH|^~\\&|^^|^^|EHR Application^^|Organization ID^^|20160315082336||"]
[null,"ACK^V04^ACK|2217135816.100118681|P|2.5.1|"]
[null,"MSA|AR|9408382|"]
[null,"ERR||^^^^|100^Segment sequence error^HL70357|E||||Message segment 'RXR' was not expected after segment '*', expecting segments 'ORC', 'RXA', 'OBX', '*', 'NTE', or 'end of message' - Message Rejected|"]
[]
[null,"Sample Processing Error (AE/Error)"]
[null,"MSH|^~\\&|^^|^^|EHR Application^^|Organization ID^^|201606040000-0500||"]
[null,"ACK^V04^ACK|13434534|P|2.5.1|"]
[null,"MSA|AE|9299381|"]
[null,"ERR||PID-11.1|101^Required field missing^HL70357|E||||patient address street is missing – Message Rejected|"]
[null,"ERR||PID-11.3|101^Required field missing^HL70357|E||||patient address city is missing – Message Rejected|"]
[]
[null,"Sample Segment Error (AE/Error)"]
[null,"MSH|^~\\&|^^|^^|EHR Application^^|Organization ID^^|201606040000-0500||ACK^V04^ACK|49348812|P|2.5.1"]
[null,"MSA|AE|9299381|"]
[null,"ERR||RXA^1^5|103^table value not found^HL70357|E|5^table value not found^HL70533|||Vaccine code not recognized—field rejected"]
[null,"ERR||RXA^1^5|101^required field missing^HL70357|E|7^required data missing^HL70533|||RXA-5 is required segment rejected"]
[null,"ERR||RXA|100^required segment missing^HL70357|E||||RXA is required segment segment-group rejected"]

{"sheet":"Error Codes","index":46,"n_rows":83,"n_cols":7,"rows_kept":83,"cut":false,"hidden":false,"merged":[]}
[]
[null,"ERR-3 (HL70357)","Concept","Applies to","Description","Action"]
[null,100,"Segment Sequence Error","Any segment","The message segments were not in the proper order, or required segments are missing.","Review interface configuration or database contents"]
[null,101,"Required field missing","Any required element","A required field is missing from a segment based on the defined usage in the profile","Review interface configuration or database contents"]
[null,102,"Data type error","Any element","The field contained data of the wrong data type, e.g., an NM field contained “FOO”.","Review interface configuration or database contents"]
[null,103,"Table value not found","Not recommended for use. Use an application error from HL70533 (ERR-5).","A field of data type ID or IS was compared against the corresponding table, and no match was found.","n/a"]
[null,104,"Value too long","Any element","A value exceeded the normative length, or the length that the application is able to safely handle.","Review database contents"]
[null,200,"Unsupported message type","MSH-9","The Message Type is not supported.","Review interface configuration"]
[null,201,"Unsupported event code","MSH-9","The Event Code is not supported.","Review interface configuration"]
[null,202,"Unsupported processing id","MSH-11","The Processing ID is not supported.","Review interface configuration"]
[null,203,"Unsupported version id","MSH-12","The Version ID is not supported.","Review interface configuration"]
[null,204,"Unknown key identifier","Not recommended for use. Use an application error from HL70533 (ERR-5).","The ID of the patient, order, etc., was not found. Used for transactions other than additions, e.g., transfer of a non-existent patient.","N/A"]
[null,205,"Duplicate key identifier","Not recommended for use. Use an application error from HL70533 (ERR-5).","The ID of the patient, order, etc., already exists. Used in response to addition transactions (Admit, New Order, etc.).","N/A"]
[null,206,"Application record locked",null,"The transaction could not be performed at the application storage level, e.g., database locked.","Resubmit message, if problem persists check with the IIS that locks have been released"]
[null,207,"Application internal error","Used when an application error is being reported in ERR-5","A catchall for internal errors not explicitly covered by other codes.","See ERR-5 error set"]
[]
[null,"ERR-5 (HL70533)","Class","Concept","Applies to","Description","Action"]
[null,1,"Existing","Illogical Date error","Not recommended for use. Use a more granular application error instead.","Date conflicts with another date in the message.","N/A"]
[null,2,"Existing","Invalid Date","DT and DTM data types, including formatting issues (not enough digit, etc.), bad characters and invalid values (e.g. 20161342) but not conflicting dates (future dates, etc.) which will have more granular errors.","Date is not valid or lacks required precision.","Review interface configuration or database contents"]
[null,3,"Existing","Illogical Value error","Not recommended for use. Use a more granular application error instead.","The value conflicts with other data in the message","N/A"]
[null,4,"Existing","Invalid value","Number and text type data types","The value is not valid. This applies for fields that are not associated with a table of values.","Review interface configuration or database contents"]
[null,5,"Existing","Table value not found","CE, CNE, CWE, IS, ID and PT data types, this is a code mapping error.","Indicates that the coded value is not found in the associated table.","Review interface configuration or mapping tables"]
[null,6,"Existing","Required observation missing","Not recommended for use. Use a more granular application error instead.","A required observation, such as VFC eligibility status, is missing.","N/A"]
[null,7,"Existing","Required Data Missing","Any critical field","This error would be applied at the application level and may be used when data is sent but could not be interpreted.","Review interface configuration or mapping tables"]
[null,2000,"Conflicting Data","Conflicting Start and End Date of Administration","RXA-3;RXA-4","Indicates that the dates in RXA-3 and RXA-4 are not identical.","Review interface configuration or database contents"]
[null,2001,"Conflicting Data","Conflicting Administration Date and Expiration Date","RXA-3;RXA-16","Indicates a conflict between the administration date in RXA-3 and the expiration date in RXA-16. In other words it indicates that an expired vaccine was administered.","Review patient record to confirm accuracy of dates (and recall patient if necessary)"]
[null,2002,"Conflicting Data","Conflicting Date of Birth and Date of Death","PID-7;PID-29","Indicates that the date of birth messaged in PID-7 is after the date of death messaged in PID-29.","Review patient record to confirm accuracy of dates"]
[null,2003,"Conflicting Data","Conflicting Codes in a Field","Any coded element where an alternate ID can be sent","Indicates that if an ID and an alternate ID are messaged in the same field, that the receiving system has mapped those two codes to different, non-homologous concepts.","Review interface configuration or mapping tables"]
[null,2004,"Conflicting Data","Conflicting Query Identifiers","MSH-21 and QPD-1","Indicates that the profile in MSH-21 does not match the query in QPD-1.","Review interface configuration"]
[null,2005,"Conflicting Data","Conflicting Facilities","MSH-4, MSH-22, ORC-17 and RXA-11","Indicates that the facilities in MSH-4, MSH-11, ORC-17 and/or RXA-11 do not match","Review interface configuration or database contents"]
[null,2006,"Conflicting Data","Conflicting Patient IDs","PID-3","Used when multiple IDs are messaged in PID-3 to indicate that the individual IDs are associated with different patient records in the IIS.","Review patient records with IIS MPI expert to identify records to merge/unmerge"]
[null,2007,"Conflicting Data","Conflicting Patient Status and Patient Death Information","PD1-16, PID-29 and PID-30","Indicates a conflict between PID-29 and PID-30 or between PD1-16 and either PID field. In other words, one element indicates the patient is deceased and another element indicates the patient is not deceased.","Review patient record to confirm accuracy of patient status and/or dates"]
[null,2008,"Conflicting Data","Conflicting Completion Status and Refusal Reason","RXA-18;RXA-20","Indicates that either a refusal reason was messaged in RXA-18 when the completion status in RXA-20 was not RE or a valid refusal reason was not messaged when the completion status was RE.","Review patient record to confirm accuracy of the dose status"]
[null,2009,"Conflicting Data","Conflicting Lot Number and Funding Source","RXA-16;OBX segment","Indicates that the lot number messaged in RXA-15 conflicts with the funding source messaged in an OBX segment. In other words, the lot number is associated with a funding source (public, private, etc.) but a different funding source is reported in an OBX segment.","Review patient and/or lot records to confirm accuracy of the lot numbers and funding sources"]
[null,2010,"Conflicting Data","Conflicting vaccine ID and Manufacturer","RXA-5;RXA-17","Indicates that the manufacturer messaged in RXA-17 is not valid for the vaccine identifier messaged in RXA-5.","Review patient record to confirm accuracy of the dose data or vaccine mapping table"]
[null,2011,"Conflicting Data","Conflicting Vaccine and Lot Number","RXA-5;RXA-15","Indicates that the lot number messaged in RXA-15 is not valid for the vaccine messaged in RXA-5.","Review patient record to confirm accuracy of the dose data or vaccine mapping table"]
[null,2012,"Conflicting Data","Conflicting Eligibility Information","Eligibility Status; OBX segment","Indicates that the eligibility code in an OBX segment conflicts with other data in the message (age, race, etc.)","Review patient record to confirm accuracy of the eligibility data"]
[null,2013,"Conflicting Data","Conflicting Funding Source Data","Funding Source; OBX segment","Indicates that the funding source code in an OBX segment conflicts with other data in the message (eligibility, age etc)","Review patient record to confirm accuracy of the funding data"]
[null,2014,"Conflicting Data","Conflicting Vaccine and Amount Data","RXA-5;RXA-6;RXA-7","Indicates that the administration amount is inconsistent with the vaccine administered","Review patient record to confirm accuracy of the dose data"]
[null,2015,"Conflicting Data","Conflicting Dose Status and Eligibility","RXA-9; OBX segment","Indicates that patient eligibility data should not be sent for historical doses","Review patient record to confirm accuracy of the eligibility data"]
[null,2016,"Conflicting Data","Conflicting Vaccine and Route Data","RXA-5;RXA-6;RXR-1","Indicates that the administration route is inconsistent with the vaccine administered","Review patient record to confirm accuracy of the dose data"]
[null,2017,"Conflicting Data","Conflicting Vaccine and Site Data","RXA-5;RXA-6;RXR-2","Indicates that the administration site is inconsistent with the vaccine administered","Review patient record to confirm accuracy of the dose data"]
[null,2100,"Inappropriate Date","Future Date","Any date field","Indicates that any date field is in the future. Specific errors for date transmitted in an OBX are also provided.","Review patient record to confirm accuracy of the dose data"]
[null,2101,"Inappropriate Date","Future Contraindication Effective Date","Contraindication","Indicates that a contraindication effective date messaged in OBX-5 is in the future","Review patient record to confirm accuracy of the dose data"]
[null,2102,"Inappropriate Date","Future VIS Given Date","VIS","Indicates that a VIS given date messaged in OBX-5 is in the future","Review patient record to confirm accuracy of the dose data"]
[null,2103,"Inappropriate Date","Future VIS Publication Date","VIS","Indicates that a VIS publication date messaged in OBX-5 is in the future","Review patient record to confirm accuracy of the dose data"]
[null,2104,"Inappropriate Date","Historical Dose Given on Submission Date","RXA-3;RXA-9","Indicates that a historical dose is being reported for the current date.","Review patient record to confirm accuracy of the dose status"]
[null,2200,"Invalid Data","Invalid Coding System","CWE.3 and any other \"coding system\" element in a complex codeable data type (CE, CWE, CNE, etc.)","Indicates that an unknown coding system was received in a coded field","Review interface configuration or mapping tables"]
[null,2201,"Invalid Data","Invalid Name (Baby)","PID-5","Indicates that a patient name was received that indicates that a temporary baby name was messaged.","Review patient record to confirm accuracy of the patient data, message may need to be retriggered after a legal name is documented"]
[null,2202,"Invalid Data","Invalid Address","XAD data type","Indicates individual components of the address are valid, but overall, the address is invalid (conflict between elements, non-existent address, etc.)","Review patient record to confirm accuracy of the address data"]
[null,2203,"Invalid Data","Invalid Telecommunication Number","XTN data type","Indicates individual components of the phone number or email are valid, but overall, the number or email address is invalid (conflict between elements, non-existent number etc.)","Review patient record to confirm accuracy of the communication data"]
[null,2204,"Invalid Data","Vaccination Date Too Long Ago","RXA-3","Indicates that the administration being reported occurred too far in the past.","Review patient record to confirm accuracy of the dose data"]
[null,2205,"Invalid Data","Unknown Profile ID","MSH-21","Indicates that an unrecognized or unsupported profile identifier is being used.","Review interface configuration"]
[null,2206,"Invalid Data","Invalid Comment","OBX segment","Indicates that an invalid comment was received. Comments should be clinically relevant and should not include data that can be sent discreetly elsewhere in the message.","Review interface configuration"]
[null,2207,"Invalid Data","Invalid Value Set","OBX segment","Indicates that for a particular observation ID (OBX-3), an invalid value set was used in OBX-5","Review interface configuration"]
[null,2208,"Invalid Data","Invalid Assigning Authority","Any field using a assigning authority","Indicates that an invalid assigning authority was received","Review interface configuration"]
[null,2209,"Invalid Data","Invalid ID Type","Any field using an ID type","Indicates that an invalid ID type was received","Review interface configuration"]
[null,2210,"Invalid Data","Invalid Observation Method","OBX-17","Indicates that the observation method for patient eligibility is invalid","Review interface configuration"]
[null,2300,"Lookup","No Matching Dose Found","Any send immunization event (VXU) delete message which doesn't match to a dose","Indicates that no matching doses were found using the data in the message.","Review patient immunization history with IIS to identify missing doses"]
[null,2301,"Lookup","No Matching Provider Found","Any send immunization event (VXU) message which doesn't match to a provider","Indicates that no matching providers were found using the data in the message.","Review provider build and mapping"]
[null,2302,"Lookup","Multiple Matching Doses Found","Any send immunization event (VXU) delete message which matches to multiple doses","Indicates that multiple matching doses were found using the data in the message.","Review patient immunization history with IIS to identify duplicate doses"]
[null,2303,"Lookup","Multiple Matching Patients Found","Any send immunization event (VXU) message which matches to multiple patients","Indicates that multiple matching patients were found using the data in the message.","Review patient record with IIS to identify duplicate records"]
[null,2304,"Lookup","Multiple Matching Providers Found","Any send immunization event (VXU) message which matches to multiple providers","Indicates that multiple matching providers were found using the data in the message.","Review provider build and mapping"]
[null,2305,"Lookup","Patient Out of Jurisdiction",null,"Indicates that the patient found is  not in the jurisdiction.","Review patient record with IIS"]
[null,2306,"Lookup","Patient Too Old","PID-7","Indicates that the patient found is too old.","Review interface configuration"]
[null,2307,"Lookup","Lot Not Found","RXA-15","Indicates that the lot number messaged in RXA-15 couldn't be linked to a lot.","Review patient and/or lot records to confirm accuracy of the lot numbers"]
[null,2308,"Lookup","Action Code Mismatch","RXA-21","Indicates that an add message was received for existing dose or update message was received for a new dose","Review patient immunization history with IIS to identify missing doses"]
[null,2309,"Lookup","No matching patient found, new patient record was created","Any send immunization event (VXU) message which doesn't match to a patient","Indicates that no matching patient was found using the data in the message but that the receiving system created a new patient record.","Typically, no action is required"]
[null,2310,"Lookup","No matching patient found, please establish patient record first","Any send immunization event (VXU) message which doesn't match to a patient","Indicates that no matching patient was found using the data in the message. Action must be taken to establish a patient record before immunization data can be submitted (e.g., the patient must consent to be in the registry).","Investigate why the patient record is not in the receiving system and create the patient record if appropriate."]
[null,2400,"Message Construction","Eligibility in PV1","PV1 segment","Indicates that eligibility data was messaged in the PV1 segment rather than in an OBX segment.","Review interface configuration"]
[null,2401,"Message Construction","Unsupported Field Populated","Any field","Indicates that data was sent in an unsupported field. While OK to raise an error, this probably should not prevent processing of the message.","Review interface configuration"]
[null,2500,"Missing Data","Missing Eligibility Information","OBX segment","Indicates that the patient eligibility status was not messaged.","Review patient record to confirm accuracy of the eligibility data"]
[null,2501,"Missing Data","Missing Funding Source Information","OBX segment","Indicates that the funding source of the vaccine administered was not messaged.","Review patient record to confirm accuracy of the funding source data"]
[null,2502,"Missing Data","Missing Parent/Guardian/Responsible Person","NK1 segment","Indicates that the patient parent/guardian/responsible person was not messaged.","Review patient record to confirm accuracy of the next of kin data"]
[null,2503,"Missing Data","Missing VIS Barcode","OBX segment","Indicates that the barcoded ID of the VIS was not messaged.","Review patient record to confirm accuracy of the VIS data"]
[null,2504,"Missing Data","Missing VIS Given Date","OBX segment","Indicates that the VIS given date was not messaged.","Review patient record to confirm accuracy of the VIS data"]
[null,2505,"Missing Data","Missing VIS Information","OBX segment","Indicates that the ID of the VIS was not messaged.","Review patient record to confirm accuracy of the VIS data"]
[null,2506,"Missing Data","Missing VIS Publication Date","OBX segment","Indicates that the VIS publication date was not messaged.","Review patient record to confirm accuracy of the VIS data"]
[null,2600,"Processing Error","Data truncated","any field that can be truncated","Indicates that during the process of the message data was truncated","Review interface configuration"]
[null,2601,"Processing Error","Inventory Management Error","Inventory","Indicates an application level error when executing inventory management functionality.","Review inventory data with IIS"]
[null,2602,"Processing Error","Interface Cannot Delete",null,"Indicates that the record indicated by the message cannot be deleted via an HL7 message","Review patient immunization history with IIS"]
[null,2700,"Data Sharing","Protected Patient Found","Single, high threshold match found with query criteria","Indicates that the patient found has requested protection of their data.","Discuss the importance of data sharing with the patient"]
[null,2701,"Data Sharing","Potentially Protected Patient Found","Single, high threshold match found with query criteria","Indicates that the patient found has an unknown status regarding the protection of their data.","Discuss the importance of data sharing with the patient"]

{"sheet":"Demographics Crosswalk","index":47,"n_rows":43,"n_cols":15,"rows_kept":43,"cut":false,"hidden":false,"merged":[[1,1,1,14],[29,14,31,14],[41,14,42,14]]}
[]
[null,"IWeb and HL7 Crosswalk for Patient Details "]
[]
[null,null,null,null,null,null,null,null,null,null,null,null,"IWeb Field","Corresponding HL7 Field","Special Notes"]
[null,null,null,null,null,null,null,null,null,null,null,null,"First Name","PID-5.2"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Middle Name","PID-5.3"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Last Name","PID-5.1"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Suffix","PID-5.4"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Birth Date","PID-7"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Birth File #","PID-3.1","(If 3.5 is BR)"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Sex","PID-8","User Defined Table 0001"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Mother Maiden Name","PID-6"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Race","PID-10","User Defined Table 0005"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Ethnicity","PID-22"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Language","PID-15.1"]
[null,null,null,null,null,null,null,null,null,null,null,null,"SSN","PID-3.1","(If 3.5 is SS)"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Medicaid #","PID-3.1","(If 3.5 is MA)"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Multiple Birth Indicator","PID-24"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Multiple Birth ","PID-25"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Reminder/Recall Publicity Code","PD1-11"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Address 1","PID-11.1","User Defined Table 0190"]
[null,null,null,null,null,null,null,null,null,null,null,null,"City","PID-11.3"]
[null,null,null,null,null,null,null,null,null,null,null,null,"State","PID-11.4"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Postal Code","PID-11.5"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Country","PID-11.6"]
[null,null,null,null,null,null,null,null,null,null,null,null,"County/Parish","PID-11.9"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Phone","PID-13"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Work Phone","PID-14"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Email","PID-13"]
[null,null,null,null,null,null,null,null,null,null,null,null,"†Guardian 1 First","NK1-2.2","These IWeb fields are only populated from HL7 when the value of NK1-3.1 is a guardian-type code (FTH, MTH, GRD)"]
[null,null,null,null,null,null,null,null,null,null,null,null,"†Guardian 1 Middle","NK1-2.3"]
[null,null,null,null,null,null,null,null,null,null,null,null,"†Guardian 1 Last","NK1-2.1"]
[null,null,null,null,null,null,null,null,null,null,null,null,"†Guardian Phone","NK1-6.6 and NK1-6.7 ","Area Code and Phone number"]
[null,null,null,null,null,null,null,null,null,null,null,null,"(Alias) First Name","PID-9.2"]
[null,null,null,null,null,null,null,null,null,null,null,null,"(Alias) Last Name","PID-9.1"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Physician Last Name","RXA-10.2"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Physician First Name","RXA-10.3"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Physician Professional Suffix","RXA-10.21"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Facility","RXA-11.4.1"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Birth Facility","PID-23"]
[null,null,null,null,null,null,null,null,null,null,null,null,"Date of Death","PID-29"]
[null,null,null,null,null,null,null,null,null,null,null,null,"*Birth Country","PID-11.6","These IWeb fields are only populated from HL7 when the value of PID-11.7 is “BDL”"]
[null,null,null,null,null,null,null,null,null,null,null,null,"*Birth State","PID-11.4"]

{"sheet":"Vaccination Crosswalk","index":48,"n_rows":25,"n_cols":11,"rows_kept":25,"cut":false,"hidden":false,"merged":[[1,1,1,10]]}
[]
[null,"IWeb and HL7 Crosswalk for Vaccination Details (including Contraindications and Deferrals)"]
[]
[null,null,null,null,null,null,null,null,"IWeb Field","Corresponding HL7 Field","Special Notes"]
[null,null,null,null,null,null,null,null,"Vaccine","RXA-5"]
[null,null,null,null,null,null,null,null,"Date Administered","RXA-3","Or date refusal was recorded"]
[null,null,null,null,null,null,null,null,"Historical","RXA-9"]
[null,null,null,null,null,null,null,null,"Manufacturer","RXA-17"]
[null,null,null,null,null,null,null,null,"Lot Number","RXA-15"]
[null,null,null,null,null,null,null,null,"Funding Source","OBX-5","Only when OBX-3.1 is valued as 30963-3"]
[null,null,null,null,null,null,null,null,"Vaccinator Last Name","RXA-10.2"]
[null,null,null,null,null,null,null,null,"Vaccinator First Name","RXA-10.3"]
[null,null,null,null,null,null,null,null,"Vaccinator Middle Name","RXA-10.4"]
[null,null,null,null,null,null,null,null,"Vaccinator Professional Suffix","RXA-21"]
[null,null,null,null,null,null,null,null,"Facility","RXA-11.4.1"]
[null,null,null,null,null,null,null,null,"Anatomical Site","RXR-2","User Defined Table 0163"]
[null,null,null,null,null,null,null,null,"Anatomical Route","RXR-1","User Defined Table 0162"]
[null,null,null,null,null,null,null,null,"Dose Size","RXA-6"]
[null,null,null,null,null,null,null,null,"Volume (CC)","RXA-7"]
[null,null,null,null,null,null,null,null,"VFC Status","OBX-5","Only when OBX-3.1 is valued as 64994-7, User Defined Table 0064"]
[null,null,null,null,null,null,null,null,"Dates of VIS Publications","OBX-5","Only when OBX-3.1 is valued as 29768-9, CDC-defined NIP003"]
[null,null,null,null,null,null,null,null,"Date VIS Form Given","OBX-5","Only when OBX-3.1 is valued as 29769-7, CDC-defined NIP003"]
[null,null,null,null,null,null,null,null,"Comments","NTE-3"]
[null,null,null,null,null,null,null,null,"Completion status","RXA-20"]
[null,null,null,null,null,null,null,null,"Refusal Reason","RXA-18","Only when RXA-20 is valued 'RE, CDC-defined NIP002"]

{"sheet":"PAIS Crosswalk","index":49,"n_rows":18,"n_cols":5,"rows_kept":18,"cut":false,"hidden":false,"merged":[[1,1,1,4]]}
[]
[null,"IWeb and HL7 Crosswalk for Patient Active/Inactive Status"]
[]
[null,"HL7 PID-30 Value","HL7 PD1-16 Value","MIROW Description","IWeb (as of version 5.17.5)"]
[null,"N","A","Active","Active"]
[null,"N","P","Permanently inactive","Inactive"]
[null,"N","I","Inactive - unspecified","Inactive"]
[null,"N","M","Inactive- no longer a patient","Inactive"]
[null,"N","L","Inactive - lost to follow-up","Inactive"]
[null,"N","U","N/A","Inactive"]
[null,"N","(blank)",null,"·       If already an existing patient: No change in status\n·       If a new patient: Active"]
[null,"Y","A","Active","Deceased"]
[null,"Y","P","Permanently inactive","Deceased"]
[null,"Y","I","Inactive - unspecified","Deceased"]
[null,"Y","M","Inactive- no longer a patient","Deceased"]
[null,"Y","L","Inactive - lost to follow-up","Deceased"]
[null,"Y","U","N/A","Deceased"]
[null,"Y","(blank)",null,"Deceased"]

{"sheet":"Value Sets","index":50,"n_rows":831,"n_cols":5,"rows_kept":831,"cut":false,"hidden":false,"merged":[[810,1,810,2],[816,1,816,2],[823,1,823,2],[389,1,389,2],[397,1,397,2],[416,1,416,2],[463,1,463,2],[468,1,468,2],[473,1,473,2],[374,1,374,2],[382,1,382,2],[541,1,541,2],[549,1,549,2],[800,1,800,2],[359,1,359,2],[364,1,364,2],[369,1,369,2],[329,1,329,2],[338,1,338,2],[354,1,354,2],[203,1,203,2],[215,1,215,2],[227,1,227,2],[240,1,240,2],[322,1,322,2],[141,1,141,2],[149,1,149,2],[162,1,162,2],[178,1,178,2],[186,1,186,2],[109,1,109,2],[116,1,116,2],[121,1,121,2],[127,1,127,2],[132,1,132,2],[81,1,81,2],[86,1,86,2],[91,1,91,2],[99,1,99,2],[104,1,104,2],[37,1,37,2],[43,1,43,2],[62,1,62,2],[72,1,72,2],[1,1,1,2],[9,1,9,2],[16,1,16,2],[27,1,27,2]]}
[]
[null,"Values",null,"User-defined Table 0001 - Sex","This code reflects the self-reported gender. Use in PID-8, NK1-15. "]
[null,"IWeb ","CDC ","Description","Definitions"]
[null,"F","F","Female","Person reports that she is female."]
[null,"M","M","Male","Person reports that he is male."]
[null,"U","U","Unknown/undifferentiated","No assertion Is made about the gender of the person."]
[null,"O",null,"Other"]
[]
[]
[null,"Values",null,"HL7-defined Table 0003 - Event Type","This code indicates the trigger event. "]
[null,"IWeb ","CDC ","Description","Definitions"]
[null,"Q11","Q11","QBP - Query by parameter requesting an RSP segment pattern response","https://phinvads.cdc.gov/vads/ViewValueSet.action?id=DBB644DC-0FB7-DF11-9BDD-0015173D1785"]
[null,"K11","K11","RSP - Segment pattern response in response to QBP^Q11"]
[null,"V04","V04","VXU - Unsolicited vaccination record update"]
[]
[]
[null,"Values",null,"User-defined Table 0005 - Race","Use in PID-10. This code represents the client's self-reported race."]
[null,"IWeb ","CDC ","Description","Definitions"]
[null,"1002-5","1002-5","American Indian or Alaska Native"]
[null,"2028-9","2028-9","Asian"]
[null,"2076-8","2076-8","Native Hawaiian or Other Pacific Islander"]
[null,"2054-5","2054-5","Black or African-American"]
[null,"2106-3","2106-3","White"]
[null,"2131-1","2131-1","Other Race"]
[null,"UNK","<empty field>","Unknown/undetermined"]
[]
[]
[null,"Values",null,"HL7-defined Table 0008 - Acknowledgement Code","Use in MSA-1. This code indicates the type of acknowledgement expected."]
[null,"IWeb ","CDC ","Description","Definitions"]
[null,"AA","AA","Original mode: Application Accept\nEnhanced mode: Application acknowledgment: Accept","Message was accepted without error."]
[null,"AE","AE","Original mode: Application Error\nEnhanced mode: Application acknowledgment: Error","Message was processed and errors are being imported."]
[null,"AR","AR","Original mode: Application Reject\nEnhanced mode: Application acknowledgment: Reject","Message was rejected because one of the following occurred:  Unsupported message type, Unsupported event code, Unsupported processing ID, Unable to process for reasons unrelated for format or content"]
[null,null,"CA","Enhanced mode: Accept acknowledgment: Commit Accept","Not supported"]
[null,null,"CE","Enhanced mode: Accept acknowledgment: Commit Error","Not supported"]
[null,null,"CR","Enhanced mode: Accept acknowledgment: Commit Reject","Not supported"]
[]
[]
[null,"Values",null,"User-defined Table 0010 - Physician ID","Use in RXA-10"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"NIP*","NIP*","*See National Provider Identifier Recommended"]
[null,"Iweb ID",null,"ID assigned to physician or vaccinator"]
[]
[]
[null,"Values",null,"User-defined Table 0063 - Relationship","Use in NK1-3, IN1-17"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"FTH","FTH","Father"]
[null,"GRD","GRD","Guardian"]
[null,"MTH","MTH","Mother"]
[null,"PAR","PAR","Parent"]
[null,"GRD","BRO","Brother"]
[null,"GRD","CVG","Caregiver"]
[null,"GRD","CHD","Child"]
[null,"GRD","FCH","Foster Child"]
[null,"GRD","GRP","Grandparent"]
[null,"GRD","OTH","Other Race"]
[null,"GRD","SCH","Stepchild"]
[null,"GRD","SEL","Self"]
[null,"GRD","SIB","Sibling"]
[null,"GRD","SIS","Sister"]
[null,"GRD","SPO","Spouse"]
[]
[]
[null,"Values",null,"User-defined Table 0064 - Financial Class","Use in OBX-5 for client eligibility for a funding program at the dose administered level."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"V01","V01","Not VFC eligible","Client does not qualify for VFC because they do not have one of the statuses below. (V02-V05)"]
[null,"V02","V02","VFC eligible-Medicaid/Medicaid Managed Care","Client is currently on Medicaid and < 19 years old and the vaccine administered is eligible for VFC funding."]
[null,"V03","V03","VFC eligible- Uninsured","Client does not have private insurance coverage and < 19 years old and the vaccine administered is eligible for VFC funding."]
[null,"V04","V04","VFC eligible- American Indian/Alaskan Native","Client is a member of a federally recognized tribe and < 19 years old and the vaccine administered is eligible for VFC funding."]
[null,"V05","V05","VFC eligible-Federally Qualified Health Center Patient (under-insured)","Client has insurance, but insurance does not cover vaccines, limits the vaccines covered, or caps vaccine coverage at a certain amount and so client is eligible for VFC coverage at a Federally Qualified Health Center. The client must be receiving the immunizations at the FQHC or a FQHC designated clinic and < 19 years old and the vaccine administered is eligible for VFC funding."]
[null,"V25","V25","Local-specific eligibility","Client is eligible for state supplied vaccine based on local specific rules and the vaccine administered is eligible for state funding. It should only be used if the state has not published local codes for these programs."]
[]
[]
[null,"Values",null,"HL7-defined Table 0076 - Message Type","Use in MSH-9, first component. Only these values are expected."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"ACK","ACK","General acknowledgment"]
[null,"Not supported","ADT","ADT message","Not supported"]
[null,"QBP","QBP","Query by Parameter"]
[null,"RSP","RSP","Response to Query by parameter"]
[null,"VXU","VXU","Unsolicited vaccination record update"]
[]
[]
[null,"Values",null,"HL7-defined Table 0078 - Abnormal Flags","Fields using this code set are expected to be empty."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"<empty>","<empty>","Expected to be empty"]
[]
[]
[null,"Values",null,"HL7-defined Table 0085 - Observation result status codes interpretation","Use in OBX-11"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"F","F","Final"]
[]
[]
[null,"Values",null,"User-defined Table 0086 - Plan Type ID","The values in this value set are drawn from the PHVS_SourceOfPaymentTypology_PHDSC"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,5,5,"Private Insurance"]
[null,2,2,"Medicaid"]
[null,1,1,"Medicare"]
[null,81,81,"Self pay"]
[]
[]
[null,"Values",null,"HL7-defined Table 0091 - Query Priority","Fields using this code set are expected to be I or empty, which indicates Immediate processing is expected. \n\n\n"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"I","I","Immediate Processing"]
[]
[]
[null,"Values",null,"HL7-defined Table 0102 - Delayed Acknowledgement Type","Use in MSA-5. Fields using this code set are expected to be empty. "]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"<empty>","Expected to be empty"]
[]
[]
[null,"Values",null,"HL7-defined Table 0103 - Processing ID","Use in MSH-11."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"Not supported","D","Debugging","Not supported"]
[null,"P","P","Production"]
[null,"T","T","Training"]
[]
[]
[null,"Values",null,"HL7-defined Table 0104 - Version ID","Use in MSH-12. Only these values are expected."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"2.5.1","2.5.1","Release 2.5.1 April 2007"]
[]
[]
[null,"Values",null,"HL7-defined Table 0119 - Order Control Codes","Use in ORC-1."]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"Not supported","OK","Order accepted & OK","Not supported"]
[null,"RE","RE","Observations to follow"]
[]
[]
[null,"Values",null,"HL7-defined Table 0126 - Quantity Limited Request","Use in RCP-2"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"RD","RD","Records"]
[]
[]
[null,"Values",null,"HL7-defined Table 0136 - Yes/No Indicator","Use in PID-24,30; PD1-12"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"Y","Y","Yes"]
[null,"N","N","No"]
[null,"|\"\"|","|\"\"|","Nullify the value","Nullify the value recorded in the receiving system database."]
[null,"||","||","Means do nothing to existing values","Make no changes to the record in the receiving data base. The sending system has no information on this field."]
[null,"<empty>","<empty>","Means do nothing to existing values","Make no changes to the record in the receiving data base. The sending system has no information on this field."]
[]
[]
[null,"Values",null,"HL7-defined Table 0155 - Accept/Application Acknowledgement Conditions","Use in MSH-15 and 16"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"AL","AL","Always"]
[null,"NE","NE","Never"]
[null,"ER","ER","Error/Reject conditions only"]
[null,"SU","SU","Successful completion only"]
[]
[]
[null,"Values",null,"NCIT/HL7-defined Table 0162 - Route of Administration","Use in RXR-1"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"C38238/ID","C38238/ID","Intradermal","Within or introduced between the layers of the skin"]
[null,"C28161/IM","C28161/IM","Intramuscular","Within or into the substance of a muscle"]
[null,"C38284/NS","C38284/NS","Nasal","Given by nose"]
[null,"C38276/IV","C38276/IV","Intravenous","Administered into a vein"]
[null,"C38288/PO","C38288/PO","Oral","Administered by mouth"]
[null,"OTH","OTH","Other/Miscellaneous"]
[null,"C38676","C38676","Percutaneous","Made, done, or effected through the skin"]
[null,"C38299/SC","C38299/SC","Subcutaneous","Under the skin or between skin and muscles."]
[null,"C38305/TD","C38305/TD","Transdermal","Describes something, especially a drug, that is introduced into the body through the skin"]
[]
[]
[null,"Values",null,"HL7-defined Table 0163 - Administrative Site","Use in RXR-2"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"LT","LT","Left Thigh"]
[null,"LA","LA","Left Arm"]
[null,"LD","LD","Left Deltoid"]
[null,"LG","LG","Left Gluteus Medius"]
[null,"LVL","LVL","Left Vastus Lateralis"]
[null,"LLFA","LLFA","Left Lower Forearm"]
[null,"RA","RA","Right Arm"]
[null,"RT","RT","Right Thigh"]
[null,"RVL","RVL","Right Vastus Lateralis"]
[null,"RG","RG","Right Gluteus Medius"]
[null,"RD","RD","Right Deltoid"]
[null,"RLFA","RLFA","Right Lower Forearm"]
[]
[]
[null,"Values",null,"CDCREC Value Set (Replaced Table 0189 - Ethnic Group)","Use in PID-22"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"2135-2","2135-2","Hispanic or Latino"]
[null,"2186-5","2186-5","not Hispanic or Latino"]
[null,"UNK","<empty>","Unknown"]
[null,"2131-1",null,"Other"]
[]
[]
[null,"Values",null,"HL7-defined Table 0190 - Address Type","Use in all XAD data types; including PID-11)"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"C","C","Current or Temporary"]
[null,"P","P","Permanent"]
[null,"M","M","Mailing"]
[null,"B","B","Firm/Business"]
[null,"O","O","Office"]
[null,"H","H","Home"]
[null,"N","N","Birth (nee)"]
[null,"F","F","Country of Origin"]
[null,"L","L","Legal Address"]
[null,"BDL","BDL","Birth Delivery Location [use for birth country and state]"]
[null,"BR","BR","Residence at Birth [use for residence at birth]"]
[null,"RH","RH","Registry Home"]
[null,"BA","BA","Bad Address"]
[]
[]
[null,"Values",null,"HL7-defined Table 0200 - Name Type","Use in all XCN, XPN data types; including PID-5, 6, 9"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"A","A","Alias name","This is a nickname or other assumed name."]
[null,"L","L","Legal name","This a person’s official name. It is the primary name recorded in the IIS."]
[null,"D","D","Display name","This is the preferred name displayed on a user interface."]
[null,"M","M","Maiden name","This is a woman’s name before marriage."]
[null,"C","C","Adopted name","This is the name of a person after adoption."]
[null,"B","B","Name at birth","This is name recorded at birth (prior to adoption)."]
[null,"P","P","Name of partner/spouse","This is the name of the partner or spouse."]
[null,"U","U","Unspecified","This is a name of unspecified type."]
[]
[]
[null,"Values",null,"HL7-defined Table 0201 - Telecommunication use code","Use in all XTN data types including PID-13,14"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"PRN","PRN","Primary residence number"]
[null,"ORN","ORN","Other residence number"]
[null,"WPN","WPN","Work number"]
[null,"VHN","VHN","Vacation home number"]
[null,"ASN","ASN","Answering service number"]
[null,"EMR","EMR","Emergency number"]
[null,"NET","NET","Network (email) address"]
[null,"BPN","BPN","Beeper number"]
[]
[]
[null,"Values",null,"HL7-defined Table 0202 - Telecommunication equipment type","Use in all XTN data types including PID-13,14"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"PH","PH","Telephone"]
[null,"FX","FX","Fax"]
[null,"MD","MD","Modem"]
[null,"CP","CP","Cellular Phone"]
[null,"BP","BP","Beeper"]
[null,"Internet","Internet","Internet address: Use only if telecommunication use code is NET"]
[null,"X.400","X.400","X.400 email address: Use only if telecommunication use code is NET"]
[null,"TDD","TDD","Telecommunications Device for the Deaf"]
[null,"TTY","TTY","Teletypewriter"]
[]
[]
[null,"Values",null,"HL7-defined Table 0203 - Identifier Type","Use in all CX, XCN type codes; including PID-2,3,4,18,21 and RXA-10"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"AN","AN","Account number","An identifier that is unique to an account."]
[null,"Not supported","ANON","Anonymous identifier","Not supported"]
[null,"Not supported","ANC","Account number Creditor","Not supported"]
[null,"Not supported","AND","Account number debitor","Not supported"]
[null,"Not supported","ANT","Temporary Account Number","Not supported"]
[null,"Not supported","APRN","Advanced Practice Registered Nurse number","Not supported"]
[null,"Not supported","BA","Bank Account Number","Not supported"]
[null,"Not supported","BC","Bank Card Number","Not supported"]
[null,"BR","BR","Birth registry number"]
[null,"Not supported","CC","Cost Center number","Not supported"]
[null,"Not supported","CY","County number","Not supported"]
[null,"Not supported","DDS","Dentist license number","Not supported"]
[null,"Not supported","DEA","Drug Enforcement Administration registration number","Not supported"]
[null,"Not supported","DFN","Drug Furnishing or prescriptive authority Number","Not supported"]
[null,"DL","DL","Driver’s license number"]
[null,"DN","DN","Doctor number"]
[null,"Not supported","DPM","Podiatrist license number","Not supported"]
[null,"Not supported","DO","Osteopathic License number","Not supported"]
[null,"Not supported","DR","Donor Registration Number","Not supported"]
[null,"EI","EI","Employee number","A number that uniquely identifies an employee to an employer."]
[null,"EN","EN","Employer number"]
[null,"FI","FI","Facility ID"]
[null,"GI","GI","Guarantor internal identifier","Class: Financial"]
[null,null,"GL","General ledger number","Class: Financial"]
[null,"GN","GN","Guarantor external identifier","Class: Financial"]
[null,"Not supported","HC","Health Card Number","Not supported"]
[null,"Not supported","JHN","Jurisdictional health number (Canada)","Not supported"]
[null,"Not supported","IND","Indigenous/Aboriginal","Not supported"]
[null,"Not supported","LI","Labor and industries number","Not supported"]
[null,"LN","LN","License number"]
[null,"LR","LR","Local Registry ID"]
[null,"MA","MA","Patient Medicaid number","Class: Insurance"]
[null,"Not supported","MB","Member Number","Not supported"]
[null,"MC","MC","Patient's Medicare number","Class: Insurance"]
[null,"Not supported","MCD","Practitioner Medicaid number","Not supported"]
[null,"Not supported","MCN","Microchip Number","Not supported"]
[null,"Not supported","MCR","Practitioner Medicare number","Not supported"]
[null,"Not supported","MD","Medical License number","Not supported"]
[null,"Not supported","MI","Military ID number","Not supported"]
[null,"MR","MR","Medical record number","An identifier that is unique to a patient within a set of medical records, not necessarily unique within an application.  Preferred identifier to be sent."]
[null,"Not supported","MRT","Temporary Medical Record Number","Not supported"]
[null,"NE","NE","National employer identifier","In the US, the Assigning Authority for this value is typically CMS, but it may be used by all providers and insurance companies in HIPAA related transactions."]
[null,"NH","NH","National Health Plan Identifier","Class: Insurance\nUsed for the UK NHS national identifier. In the US, the Assigning Authority for this value is typically CMS, but it may be used by all providers and insurance companies in HIPAA related transactions."]
[null,"NI","NI","National unique individual identifier","Class: Insurance\nIn the US, the Assigning Authority for this value is typically CMS, but it may be used by all providers and insurance companies in HIPAA related transactions."]
[null,"Not supported","NII","National Insurance Organization Identifier","Not supported"]
[null,"Not supported","NIIP","National Insurance Payor Identifier (Payor)","Not supported"]
[null,"Not supported","NNxxx","National Person Identifier where the xxx is the ISO table 3166 3-character (alphabetic) country code","Not supported"]
[null,"Not supported","NP","Nurse practitioner number","Not supported"]
[null,"NPI","NPI","National provider identifier","Class: Insurance\nIn the US, the Assigning Authority for this value is typically CMS, but it may be used by all providers and insurance companies in HIPAA related transactions."]
[null,"Not supported","OD","Optometrist license number","Not supported"]
[null,"Not supported","PA","Physician Assistant number","Not supported"]
[null,"Not supported","PCN","Penitentiary/correctional institution Number","Not supported"]
[null,"Not supported","PE","Living Subject Enterprise Number","Not supported"]
[null,"Not supported","PEN","Pension Number","Not supported"]
[null,"PI","PI","Patient internal identifier","A number that is unique to a patient within an Assigning Authority."]
[null,"PN","PN","Person number","A number that is unique to a living subject within an Assigning Authority."]
[null,"Not supported","PNT","Temporary Living Subject Number","Not supported"]
[null,"Not supported","PPN","Passport number","Not supported"]
[null,"Not supported","PRC","Permanent Resident Card Number","Not supported"]
[null,"PRN","PRN","Provider number","A number that is unique to an individual provider, a provider group or an organization within an Assigning Authority.  Use case: This allows PRN to represent either an individual (a nurse) or a group/organization (orthopedic surgery team)."]
[null,"PT","PT","Patient external identifier"]
[null,"Not supported","QA","QA number","Not supported"]
[null,"Not supported","RI","Resource identifier","Not supported"]
[null,"Not supported","RPH","Pharmacist license number","Not supported"]
[null,"Not supported","RN","Registered Nurse Number","Not supported"]
[null,"RR","RR","Railroad Retirement number"]
[null,"RRI","RRI","Regional registry ID"]
[null,"Not supported","SL","State license","Not supported"]
[null,"Not supported","SN","Subscriber Number","Not supported"]
[null,"SR","SR","State registry ID"]
[null,"SS","SS","Social Security number"]
[null,"Not supported","TAX","Tax ID number","Not supported"]
[null,"U","U","Unspecified identifier"]
[null,"UPIN","UPIN","Medicare/CMS (formerly HCFA)’s Universal Physician Identification numbers","Class: Insurance"]
[null,"VN","VN","Visit number"]
[null,"WC","WC","WIC identifier"]
[null,"Not supported","WCN","Workers’ Comp Number","Not supported"]
[null,"XX","XX","Organization identifier"]
[]
[]
[null,"Values",null,"User-defined Table 0204 - Organizational name type","Values suggested by HL7 Use in all XON data types"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"L","L","Legal name","This a person’s official name. It is the primary name recorded in the IIS."]
[null,"D","D","Display name","This is the preferred name displayed on a user interface."]
[null,"A","A","Alias name","This is a nickname or other assumed name"]
[]
[]
[null,"Values",null,"User-defined Table 0208 - Query Response Status","Use in QAK-2"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"OK","OK","Data found, no errors (this is the default)","Similar to AA in table HL70008"]
[null,"NF","NF","No data found, no errors"]
[null,"AE","AE","Application error","Query had an error in content of format."]
[null,"AR","AR","Application reject","Message was rejected because of one of the following occurred: Unsupported message type, Unsupported event code, Unsupported Processing ID, Unable to process for reasons unrelated for format or content."]
[null,"TM","TM","Too many candidates found"]
[]
[]
[null,"Values",null,"User-defined Table 0215 - Publicity Code","Use in PD1-11"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"01","01","No reminder/recall"]
[null,"02","02","Reminder/recall - any method"]
[null,"03","03","Reminder/recall - no calls"]
[null,"04","04","Reminder only - any method"]
[null,"05","05","Reminder only - no calls"]
[null,"06","06","Recall only - any method"]
[null,"07","07","Recall only - no calls"]
[null,"08","08","Reminder/recall - to provider"]
[null,"09","09","Reminder to provider"]
[null,"10","10","Only reminder to provider, no recall"]
[null,"11","11","Recall to provider"]
[null,"12","12","Only recall to provider, no reminder"]
[]
[]
[null,"Values",null,"HL7-defined Table 0227 - Manufacturers of Vaccines (code=MVX)","Use in RXA-17"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"<external table>",null,"http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=mvx "]
[]
[]
[null,"Values",null,"User-defined Table 0289 - County/Parish","Use in PID-11"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"<external table>",null," https://phinvads.cdc.gov/vads/ViewValueSet.action?id=20D34BBC-617F-DD11-B38D-00188B398520 "]
[]
[]
[null,"Values",null,"HL7-defined Table 0292 - Codes for Vaccines administered (code=CVX)","Use in RXA-5"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"<external table>",null,"http://www2a.cdc.gov/vaccines/iis/iisstandards/vaccines.asp?rpt=cvx "]
[]
[]
[null,"Values",null,"User-defined Table 0296 - Language","Use in PID-15"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"<external table>",null,"http://phinvads.cdc.gov/vads/ViewValueSet.action?id=43D34BBC-617F-DD11-B38D-00188B398520 "]
[]
[]
[null,"Values",null,"HL7-defined Table 0322 - Completion Status","Use in RXA-20"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"CP","CP","Complete"]
[null,null,"RE","Refused","It must be populated with RE if RXA-18 is populated with NA"]
[null,null,"NA","Not Administered","It must be populated with NA if this RXA has a CVX of 998 (no vaccine administered)"]
[null,null,"PA","Partially Administered"]
[]
[]
[null,"Values",null,"HL7-defined Table 0323 - Action Code","Use in RXA-21"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"A","A","Add"]
[null,"D","D","Delete"]
[null,"U","U","Update"]
[]
[]
[null,"Values",null,"HL7-defined Table 0354 - Message Structure","Use in MSH-9, third component"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"ACK","ACK","ACK"]
[null,"QBP_Q11","QBP_Q11","QBP"]
[null,"RSP_K11","RSP_K11","RSP"]
[null,"VXU_V04","VXU_V04","VXU"]
[]
[]
[null,"Values",null,"HL7-defined Table 0357 - Message Error Status Codes","Use in ERR-3"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"0","0","Message accepted","Success. Optional, as the AA conveys this. Used for systems that must always return a status code."]
[null,null,null,"Error status codes"]
[null,"100","100","Segment sequence error","The message segments were not in the proper order or required segments are missing."]
[null,"101","101","Required field missing","A required field is missing from the segment."]
[null,"102","102","Data type error","The field contained data of the wrong data type, e.g., an NM field contained letters of the alphabet."]
[null,"103","103","Table value not found","A field of data type ID or IS was compared against the corresponding table, and no match was found."]
[null,null,null,"Rejection status codes"]
[null,"200","200","Unsupported message type","The Message type is not supported."]
[null,"201","201","Unsupported event code","The Event Code is not supported."]
[null,"202","202","Unsupported processing ID","The Processing ID is not supported."]
[null,"203","203","Unsupported version ID","The Version ID is not supported."]
[null,"204","204","Unknown key identifier","The ID of the patient, order, etc. was not found. Used for transactions other than additions, e.g., transfer of a non-existent patient."]
[null,"205","205","Duplicate key identifier","The ID of the patient, order, etc. already exists. Used in response to addition transactions (Admit, New Order, etc.)."]
[null,"206","206","Application record locked","The transaction could not be performed at the application storage level, e.g., database locked."]
[null,"207","207","Application internal error","A catchall for internal errors not explicitly covered by other codes."]
[]
[]
[null,"Values",null,"User-defined Table 0360 - Degree","Use in all XPN data types, including PID-5, 6, 9"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"PN","PN","Advanced Practice Nurse"]
[null,"AA","AA","Associate of Arts"]
[null,"AS","AS","Associate of Science"]
[null,"BA","BA","Bachelor of Arts"]
[null,"BN","BN","Bachelor of Nursing"]
[null,"BS","BS","Bachelor of Science"]
[null,"BSN","BSN","Bachelor of Science in Nursing"]
[null,"CER","CER","Certificate"]
[null,"CANP","CANP","Certified Adult Nurse Practitioner"]
[null,"CMA","CMA","Certified Medical Assistant"]
[null,"CNP","CNP","Certified Nurse Practitioner"]
[null,"CNM","CNM","Certified Nurse Midwife"]
[null,"CNA","CNA","Certified Nurse’s Assistant"]
[null,"CRN","CRN","Certified Registered Nurse"]
[null,"CNS","CNS","Certified Nurse Specialist"]
[null,"CPNP","CPNP","Certified Pediatric Nurse Practitioner"]
[null,"DIP","DIP","Diploma"]
[null,"PHD","PHD","Doctor of Philosophy"]
[null,"MD","MD","Doctor of Medicine"]
[null,"DO","DO","Doctor of Osteopathy"]
[null,"EMT","EMT","Emergency Medical Technician"]
[null,"EMT-P","EMT-P","Emergency Medical Technician – Paramedic"]
[null,"FPNP","FPNP","Family Practice Nurse Practitioner"]
[null,"HS","HS","High School Graduate"]
[null,"JD","JD","Juris Doctor"]
[null,"LPN","LPN","Licensed Practical Nurse"]
[null,"MA","MA","Master of Arts"]
[null,"MBA","MBA","Master of Business Administration"]
[null,"MPH","MPH","Master of Public Health"]
[null,"MS","MS","Master of Science"]
[null,"MSN","MSN","Master of Science – Nursing"]
[null,"MDA","MDA","Medical Assistant"]
[null,"MT","MT","Medical Technician"]
[null,"NG","NG","Non-Graduate"]
[null,"NP","NP","Nurse Practitioner"]
[null,"PharmD","PharmD","Doctor of Pharmacy"]
[null,"PA","PA","Physician Assistant"]
[null,"PHN","PHN","Public Health Nurse"]
[null,"RMA","RMA","Registered Medical Assistant"]
[null,"RN","RN","Registered Nurse"]
[null,"RPH","RPH","Registered Pharmacist"]
[null,"SEC","SEC","Secretarial Certificate"]
[null,"TS","TS","Trade School Graduate"]
[]
[]
[null,"Values",null,"User-defined Table 0361 - Application","The Receiving Application "]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"<locally determined>","<locally determined>","Name assigned to the local IIS","Examples: WAIIS, CHIRP, WVSIIS"]
[]
[]
[null,"Values",null,"User-defined Table 0362 - Facility","Use in ORC-17.1 and RXA-11.4"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,">locally determined>",">locally determined>","Facility ID assigned by the IIS","Example: SIISCLIENT9900"]
[]
[]
[null,"Values",null,"User-defined Table 0363 - Assigning Authority"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"AK","AKA","ALASKA"]
[null,"AL","ALA","ALABAMA"]
[null,"AS","ASA","AMERICAN SAMOA"]
[null,"AZ","AZA","ARIZONA"]
[null,"AR","ARA","ARKANSAS"]
[null,null,"BAA","NEW YORK CITY","Not supported"]
[null,"CA","CAA","CALIFORNIA"]
[null,null,"CHA","CHICAGO","Not supported"]
[null,"CO","COA","COLORADO"]
[null,"CT","CTA","CONNECTICUT"]
[null,"DE","DEA","DELAWARE"]
[null,"DC","DCA","DISTRICT OF COLUMBIA"]
[null,"FL","FLA","FLORIDA"]
[null,"FM","FMA","FED STATES MICRO"]
[null,"GA","GAA","GEORGIA"]
[null,"GU","GUA","GUAM"]
[null,"HI","HIA","HAWAII"]
[null,"ID","IDA","IDAHO"]
[null,"IL","ILA","ILLINOIS"]
[null,"IN","INA","INDIANA"]
[null,"IA","IAA","IOWA"]
[null,"KS","KSA","KANSAS"]
[null,"KY","KYA","KENTUCKY"]
[null,"LA","LAA","LOUISIANA"]
[null,"ME","MEA","MAINE"]
[null,"MH","MHA","REP MARS ISLANDS"]
[null,"MD","MDA","MARYLAND"]
[null,"MA","MAA","MASSACHUSETTS"]
[null,"MI","MIA","MICHIGAN"]
[null,"MN","MNA","MINNESOTA"]
[null,"MS","MSA","MISSISSIPPI"]
[null,"MO","MOA","MISSOURI"]
[null,"MP","MPA","NO. MARIANA ISLAND"]
[null,"MT","MTA","MONTANA"]
[null,"NE","NEA","NEBRASKA"]
[null,"NV","NVA","NEVADA"]
[null,"NH","NHA","NEW HAMPSHIRE"]
[null,"NJ","NJA","NEW JERSEY"]
[null,"NM","NMA","NEW MEXICO"]
[null,"NY","NYA","NEW YORK STATE"]
[null,"NC","NCA","NORTH CAROLINA"]
[null,"ND","NDA","NORTH DAKOTA"]
[null,"OH","OHA","OHIO"]
[null,"OK","OKA","OKLAHOMA"]
[null,"OR","ORA","OREGON"]
[null,"PW","RPA","REPUBLIC PALAU"]
[null,"PA","PAA","PENNSYLVANIA"]
[null,"Not supported","PHA","PHILADELPHIA","Not supported"]
[null,"PR","PRA","PUERTO RICO"]
[null,"RI","RIA","RHODE ISLAND"]
[null,"SC","SCA","SOUTH CAROLINA"]
[null,"SD","SDA","SOUTH DAKOTA"]
[null,"Not supported","TBA","SAN ANTONIO","Not supported"]
[null,"Not supported","THA","HOUSTON","Not supported"]
[null,"TN","TNA","TENNESSEE"]
[null,"TX","TXA","TEXAS"]
[null,"UT","UTA","UTAH"]
[null,"VT","VTA","VERMONT"]
[null,"VA ","VAA","VIRGINIA"]
[null,"VI","VIA","VIRGIN ISLANDS"]
[null,"WA","WAA","WASHINGTON"]
[null,"WV","WVA","WEST VIRGINIA"]
[null,"WI","WIA","WISCONSIN"]
[null,"WY","WYA","WYOMING"]
[]
[]
[null,"Values",null,"User-defined Table 0396 - Coding System"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"CDCPHINVS","CDCPHINVS","PHIN VS (CDC Local Coding System)"]
[null,"CVX","CVX","CDC Vaccine Codes"]
[null,"MVX","MVX","CDC Vaccine Manufacturer Codes"]
[null,"NPI","NPI","National Provider Identifier"]
[]
[]
[null,"Values",null,"HL7 Table 0399 - Country Codes","This component specifies the country where the addressee is located. "]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"AFB","AFB","Afghanistan"]
[null,"ALA","ALA","Aland Islands"]
[null,"ALB","ALB","Albania"]
[null,"DZA","DZA","Algeria"]
[null,"ASM","ASM","American Samoa"]
[null,"AND","AND","Andorra"]
[null,"AGO","AGO","Angola"]
[null,"AIA","AIA","Anguilla"]
[null,"ATA","ATA","Antarctica"]
[null,"ATG","ATG","Antigua and Barbuda"]
[null,"ARG","ARG","Argentina"]
[null,"ARM","ARM","Armenia"]
[null,"ABW","ABW","Aruba"]
[null,"AUS","AUS","Australia"]
[null,"AUT","AUT","Austria"]
[null,"AZE","AZE","Azerbaijan"]
[null,"BHS","BHS","Bahamas"]
[null,"BHR","BHR","Bahrain"]
[null,"BGD","BGD","Bangladesh"]
[null,"BRG","BRB","Barbados"]
[null,"BLR","BLR","Belarus"]
[null,"BEL","BEL","Belgium"]
[null,"BLZ","BLZ","Belize"]
[null,"BEN","BEN","Benin"]
[null,"BMU","BMU","Bermuda"]
[null,"BTN","BTN","Bhutan"]
[null,"BOL","BOL","Bolivia"]
[null,"BIH","BIH","Bosnia and Herzegovina"]
[null,"BWA","BWA","Botswana"]
[null,"BVT","BVT","Bouvet Island"]
[null,"BRA","BRA","Brazil"]
[null,"VGB","VGB","British Virgin Islands"]
[null,"IOT","IOT","Bristish Indian Ocean Territory"]
[null,"BRN","BRN","Brunei Darussalam"]
[null,"BGR","BGR","Bulgaria"]
[null,"BFA","BFA","Burkina Faso"]
[null,"BDI","BDI","Burundi"]
[null,"KHM","KHM","Cambodia"]
[null,"CMR","CMR","Cameroon"]
[null,"DAN","CAN","Canada"]
[null,"CPV","CPV","Cape Verde"]
[null,"CYM","CYM","Cayman Islands"]
[null,"CAF","CAF","Central African Republic"]
[null,"TCD","TCD","Chad"]
[null,"CHL","CHL","Chile"]
[null,"CHN","CHN","China"]
[null,"HKG","HKG","Hong Kong, SAR China"]
[null,"MAC","MAC","Macao, SAR China"]
[null,"CXR","CXR","Christmas Island"]
[null,"CCK","CCK","Cocos (Keeling) Islands"]
[null,"COL","COL","Colombia"]
[null,"COM","COM","Comoros"]
[null,"COG","COG","Congo (Brazzaville)"]
[null,"COD","COD","Congo (Kinshasa)"]
[null,"COK","COK","Cook Islands"]
[null,"CRI","CRI","Costa Rica"]
[null,"CIV","CIV","Cote d'Ivoire"]
[null,"HRV","HRV","Croatia"]
[null,"CUB","CUB","Cuba"]
[null,"CYP","CYP","Cyprus"]
[null,"CZE","CZE","Czech Republic"]
[null,"DNK","DNK","Denmark"]
[null,"DJI","DJI","Djibouti"]
[null,"DMA","DMA","Dominica"]
[null,"DOM","DOM","Dominican Republic"]
[null,"ECU","ECU","Ecuador"]
[null,"EGY","EGY","Egypt"]
[null,"SLV","SLV","El Salvador"]
[null,"GNQ","GNQ","Equatorial Guinea"]
[null,"ERI","ERI","Eritrea"]
[null,"EST","EST","Estonia"]
[null,"ETH","ETH","Ethiopia"]
[null,"FLK","FLK","Falkland Island (Malvinas)"]
[null,"FRO","FRO","Faroe Islands"]
[null,"FJI","FJI","Fiji"]
[null,"FIN","FIN","Finland"]
[null,"FRA","FRA","France"]
[null,"GUF","GUF","French Guiana"]
[null,"PYF","PYF","French Polynesia"]
[null,"ATF","ATF","French Southern Territories"]
[null,"GAB","GAB","Gabon"]
[null,"GMB","GMB","Gambia"]
[null,"GEO","GEO","Georgia"]
[null,"DEU","DEU","Germany"]
[null,"GHA","GHA","Ghana"]
[null,"GIB","GIB","Gibraltar"]
[null,"GRC","GRC","Greece"]
[null,"GRL","GRL","Greenland"]
[null,"GRD","GRD","Grenada"]
[null,"GLP","GLP","Guadeloupe"]
[null,"GUM","GUM","Guam"]
[null,"GTM","GTM","Guatemala"]
[null,"GGY","GGY","Guernsey"]
[null,"GIN","GIN","Guinea"]
[null,"GNB","GNB","Guina-Bissau"]
[null,"GUY","GUY","Guyana"]
[null,"HTI","HTI","Haiti"]
[null,"HMD","HMD","Heard and Mcdonald Islands"]
[null,"VAT","VAT","Holy See (Vatican City State)"]
[null,"HND","HND","Honduras"]
[null,"HUN","HUN","Hungary"]
[null,"ISL","ISL","Iceland"]
[null,"IND","IND","India"]
[null,"IDN","IDN","Indonesia"]
[null,"IRN","IRN","Iran, Islamic Republic of"]
[null,"IRQ","IRQ","Iraq"]
[null,"IRL","IRL","Ireland"]
[null,"IMN","IMN","Isle of Man"]
[null,"ISR","ISR","Israel"]
[null,"ITA","ITA","Italy"]
[null,"JAM","JAM","Jamaica"]
[null,"JPN","JPN","Japan"]
[null,"JEY","JEY","Jersey"]
[null,"JOR","JOR","Jordan"]
[null,"KAZ","KAZ","Kazakhstan"]
[null,"KEN","KEN","Kenya"]
[null,"KIR","KIR","Kiribati"]
[null,"PRK","PRK","Korea (North)"]
[null,"KOR","KOR","Korea (South)"]
[null,"KWT","KWT","Kuwait"]
[null,"KGZ","KGZ","Kyrgyzstan"]
[null,"LAP","LAP","Lao DR"]
[null,"LVA","LVA","Latvia"]
[null,"LBN","LBN","Lebanon"]
[null,"LSO","LSO","Lesotho"]
[null,"LBR","LBR","Liberia"]
[null,"LBY","LBY","Libya"]
[null,"LIE","LIE","Liechtenstein"]
[null,"LTU","LTU","Lithuania"]
[null,"LUX","LUX","Luxembourg"]
[null,"MKD","MKD","Macedonia, Republic of"]
[null,"MDG","MDG","Madagascar"]
[null,"MWI","MWI","Malawi"]
[null,"MYS","MYS","Malysia"]
[null,"MDV","MDV","Maldives"]
[null,"MLI","MLI","Mali"]
[null,"MLT","MLT","Malta"]
[null,"MHL","MHL","Marshall Islands"]
[null,"MTQ","MTQ","Martinique"]
[null,"MRT","MRT","Mauritania"]
[null,"MUS","MUS","Mauritius"]
[null,"MYT","MYT","Mayotte"]
[null,"MEX","MEX","Mexico"]
[null,"FSM","FSM","Micronesia, Federated States of"]
[null,"MDA","MDA","Moldova"]
[null,"MCO","MCO","Monaco"]
[null,"MNG","MNG","Mongolia"]
[null,"MNE","MNE","Montenegro"]
[null,"MSR","MSR","Monteserrat"]
[null,"MAR","MAR","Morocco"]
[null,"MOZ","MOZ","Mozambique"]
[null,"MMR","MMR","Myanmar"]
[null,"NAM","NAM","Namibia"]
[null,"NRU","NRU","Nauru"]
[null,"NPL","NPL","Nepal"]
[null,"NLD","NLD","Netherlands"]
[null,"ANT","ANT","Netherlands Antilles"]
[null,"NCL","NCL","New Caledonia"]
[null,"NZL","NZL","New Zealand"]
[null,"NIC","NIC","Nicaragua"]
[null,"NER","NER","Niger"]
[null,"NGA","NGA","Nigeria"]
[null,"NIU","NIU","Niue"]
[null,"NFK","NFK","Norfolk Island"]
[null,"MNP","MNP","Northern Mariana Islands"]
[null,"NOR","NOR","Norway"]
[null,"OMN","OMN","Oman"]
[null,"PAK","PAK","Pakistan"]
[null,"PLW","PLW","Palau"]
[null,"PSE","PSE","Palestinian Territory"]
[null,"PAN","PAN","Panama"]
[null,"PNG","PNG","Papua New Guinea"]
[null,"PRY","PRY","Paraguay"]
[null,"PER","PER","Peru"]
[null,"PHL","PHL","Philippines"]
[null,"PCN","PCN","Pitcairn"]
[null,"POL","POL","Poland"]
[null,"PRT","PRT","Portugal"]
[null,"PRI","PRI","Puerto Rico"]
[null,"QAT","QAT","Qatar"]
[null,"REU","REU","Reunion"]
[null,"ROU","ROU","Romania"]
[null,"RUS","RUS","Russian Federation"]
[null,"RWA","RWA","Rwanda"]
[null,"BLM","BLM","Saint-Barthelemy"]
[null,"SHN","SHN","Saint Helena"]
[null,"KNA","KNA","Saint Ketts and Nevis"]
[null,"LCA","LCA","Saint Lucia"]
[null,"MAF","MAF","Saint-Martin (French part)"]
[null,"SPM","SPM","Saint Pierre and Miquelon"]
[null,"VCT","VCT","Saint Vincent and Grenadines"]
[null,"WSM","WSM","Samoa"]
[null,"SMR","SMR","San Marino"]
[null,"STP","STP","Sao Tome and Principe"]
[null,"SAU","SAU","Saudi Arabia"]
[null,"SEN","SEN","Senegal"]
[null,"SRB","SRB","Serbia"]
[null,"SYC","SYC","Seychelles"]
[null,"SLE","SLE","Sierra Leone"]
[null,"SGP","SGP","Singapore"]
[null,"SVK","SVK","Slovakia"]
[null,"SVN","SVN","Slovenia"]
[null,"SLB","SLB","Solomon Islands"]
[null,"SOM","SOM","Somalia"]
[null,"ZAF","ZAF","South Africa"]
[null,"SGS","SGS","South Georgia and the South Sandwich Islands"]
[null,"SSD","SSD","South Sudan"]
[null,"ESP","ESP","Spain"]
[null,"LKA","LKA","Sir Lanka"]
[null,"SDN","SDN","Sudan"]
[null,"SUR","SUR","Suriname"]
[null,"SJM","SJM","Svalbard and Jan Mayen Islands"]
[null,"SWZ","SWZ","Swaziland"]
[null,"SWE","SWE","Sweden"]
[null,"CHE","CHE","Switzerland"]
[null,"SYR","SYR","Syrian Arab Republic (Syria)"]
[null,"TWN","TWN","Taiwan, Republic of China"]
[null,"TJK","TJK","Tajikisan"]
[null,"TZA","TZA","Tanzania, United Republic of"]
[null,"THA","THA","Thailand"]
[null,"TLS","TLS","Timor-Leste"]
[null,"TGO","TGO","Togo"]
[null,"TKL","TKL","Tokelau"]
[null,"TON","TON","Tonga"]
[null,"TTO","TTO","Trinidad and Tobago"]
[null,"TUN","TUN","Tunisia"]
[null,"TUR","TUR","Turkey"]
[null,"TKM","TKM","Turkmenistan"]
[null,"TCA","TCA","Turks and Caicos Islands"]
[null,"TUV","TUV","Tuvalu"]
[null,"UGA","UGA","Uganda"]
[null,"UKR","UKR","Ukraine"]
[null,"ARE","ARE","United Arab Emirates"]
[null,"GBR","GBR","United Kingdom"]
[null,"USA","USA","United States of America"]
[null,"UMI","UMI","US Minor Outlying Islands"]
[null,"URY","URY","Uruguay"]
[null,"UZB","UZB","Uzbekistan"]
[null,"VUT","VUT","Vanuatu"]
[null,"VEN","VEN","Venezuela (Bolivarian Republic)"]
[null,"VNM","VNM","Viet Nam"]
[null,"VIR","VIR","Virgin Islands, US"]
[null,"WLF","WLF","Wallis and Futuna Islands"]
[null,"ESH","ESH","Western Sahara"]
[null,"YEM","YEM","Yemen"]
[null,"ZMB","ZMB","Zambia"]
[null,"ZWE","ZWE","Zimbabwe"]
[]
[]
[null,"Values",null,"User-defined Table 0441 - Immunization Registry Status","Use in PD1-16"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"A","A","Active"]
[null,"I","I","Inactive--Unspecified"]
[null,"L","L","Inactive-Lost to follow-up (cannot contact)"]
[null,"M","M","Inactive-Moved or gone elsewhere (transferred)"]
[null,"P","P","Inactive-Permanently inactive (do not re-activate or add new entries to this record)"]
[null,"U","U","Unknown"]
[]
[]
[null,"Values",null,"User-defined Table 0471 - Query Name"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,null,"Z34","Request Immunization History"]
[null,null,"Z44","Request Evaluated History and Forecast"]
[]
[]
[null,"Values",null,"HL7-defined Table 0516 - Error Severity","Use in ERR-4"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"I","I","Information","Transaction successful, but includes returned information."]
[null,"W","W","Warning","Transaction successful, but there may be issues. These may include non-fatal errors with potential for loss of data."]
[null,"E","E","Error","Transaction was not successful. The application rejected data that is views as important. This could include required fields or the entire message. The sender should be alerted to review and correct the message."]
[]
[]
[null,"Values",null,"User-defined Table 0533 - Application Error Code"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,1,1,"Illogical Date error","Date conflicts with another date in the message."]
[null,2,2,"Invalid Date","Date is not valid or lacks required precision."]
[null,3,3,"Illogical Value error","The value conflicts with other data in the message."]
[null,4,4,"Invalid value","The value is not valid. This applies for fields that are not associated with a table of values."]
[null,5,5,"Table value not found","The value is not found in the associated table."]
[null,6,6,"Required observation missing","A required observation, such as VFC eligibility status, is missing."]

{"sheet":"NIP001","index":51,"n_rows":16,"n_cols":5,"rows_kept":16,"cut":false,"hidden":false,"merged":[[1,1,1,4],[15,2,15,4],[13,2,13,4]]}
[]
[null,"CDC-defined NIP001 Immunization Information Source"]
[null,"IWeb ","CDC","Description","Definitions"]
[null,"00","00","New immunization record","The record of a newly administered dose of vaccine. The dose was administered by the organization that is reporting this dose."]
[null,"01","01","Historical information - source unspecified","The record of a vaccine dose from a reliable historical source, such as an immunization card."]
[null,"02","02","Historical information - from another provider","The record of a vaccine dose from another health care provider’s historical records."]
[null,"03","03","Historical information - from parent’s written record","The record of a vaccine dose from parentally maintained written records."]
[null,"04","04","Historical information - from parent’s recall","The record of a vaccine dose from a parent's recall. The reliability of this record is considered low."]
[null,"05","05","Historical information - from another registry","The record of a vaccine dose from another Immunization Information System (IIS)."]
[null,"06","06","Historical information - from birth certificate","The record of a vaccine dose from a birth record."]
[null,"07","07","Historical information - from school record","The record of a vaccine dose from a written school record."]
[null,"08","08","Historical information - from public agency","The record of a vaccine dose from a written public health agency record."]
[]
[null,"Sample:","RXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|"]
[]
[null,"Sample:","RXA|0|1|201609080000||20^DTaP^CVX|999|||01^Historical information - source unspecified^NIP001||^^^SIISCLIENT1724|||||||||CP|A|"]

{"sheet":"NIP002","index":52,"n_rows":12,"n_cols":4,"rows_kept":12,"cut":false,"hidden":false,"merged":[[1,1,1,3],[2,1,2,3],[9,2,9,6],[10,1,10,3]]}
[]
[null,"CDC-defined NIP002 - Substance refusal reason (Use in RXA-18)"]
[null,"Definition: This field contains the reason the patient refused the medical substance/treatment. Any entry in the field indicates that the patient did not take the substance. If this field is populated, RXA-20 (Completion Status) shall be populated with RE."]
[null,"Description","Value","Note"]
[null,"Parental decision ",0]
[null,"Religious exemption",1]
[null,"Other ",2,"Must add text component of the CE field with description"]
[null,"Patient decision",3]
[]
[null,"Sample:"]
[null,"ORC|RE|365412^^^|56789^^^|||||||SIISCLIENT3363^SMITH^MAGGIE|"]
[null,"RXA|0|1|201609080000||20^DTaP^CVX|999||||||||||||00^PARENTAL DECISION^NIP002||RE|"]

{"sheet":"NIP003","index":53,"n_rows":39,"n_cols":7,"rows_kept":39,"cut":false,"hidden":false,"merged":[[35,1,35,4],[38,1,38,4],[7,1,7,4],[11,5,12,5],[15,6,15,16],[10,1,10,4],[18,1,18,4],[22,1,22,4],[13,6,13,15],[14,6,14,15],[16,6,16,17],[11,6,12,15],[8,6,8,23],[9,6,9,23],[20,6,20,23],[21,6,21,23],[1,1,1,4],[3,1,3,4],[5,1,5,4],[4,6,4,23],[6,6,6,23]]}
[]
[null,"CDC-defined NIP003 - Observation identifiers\n(Use in OBX-3)"]
[null,"LOINC® Code","Description","Corresponding data type (indicate in OBX-2)","Corresponding observation value EXAMPLE OR code table to use (value in OBX-5)"]
[null,"Vaccine Funding Program Eligibility Category - Use in OBX-3 to indicate that OBX-5 will contain the funding program eligibility category for a given immunization."]
[null,"64994-7","Vaccine funding program eligibility category","(CE)","HL70064","Sample:","ORC|RE||9999^DCS|||||||^Don^Smith|\nRXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|\nOBX|1|ST|64994-7^VACCINE FUNDING PROGRAM ELIGIBILITY CATEGORY^NIP003|1|V02^VFC eligible - Medicaid^HL70064||||||F|||20141117|||VXC40^Eligibility captured at the immunization level^CDCPHINVS"]
[null,"Vaccine Funding Source – Use in OBX-3 to indicate that OBX-5 will contain the funding source for a given immunization."]
[null,"30963-3","Vaccine funding source","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3287\n Value Set Code:: PHVS_ImmunizationFundingSource_IIS","Sample:","ORC|RE||9999^DCS|||||||^Don^Smith|\nRXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|\nOBX|2|CE|30963-3^VACCINE FUNDING SOURCE^NIP003|1|VXC51^Federal Funds^CDCPHINVS||||||F|"]
[null,"Vaccine Type Identifier"]
[null,"30956-7","Vaccine Type (Vaccine group or family)","(CE)","HL70292 (CVX codes - use the codes described as \"unspecified formulation\" as needed.)","Sample:","ORC|RE||9999^DCS|||||||^Don^Smith|\nRXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|\nOBX|3|CE|30956-7^VACCINE TYPE^NIP003|1|20^DTaP||||||F|"]
[null,"38890-0","Component Vaccine Type","(CE)","HL70292 (CVX codes - use the codes described as \"unspecified formulation\" as needed.)","Note:","30956-7 (vaccine type) is preferred over the alternative 38890-0 (Component Vaccine Type) even when the vaccine administered is a combination vaccine."]
[null,"Contraindications, Precautions, Indications and Immunities"]
[null,"30946-8","Vaccination contraindication/precaution effective date","(DT)",19970522]
[null,"30944-3","Vaccination temporary contraindication/precaution expiration date","(DT)",19990523]
[null,"30945-0","Vaccination contraindication/precaution","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3288\nValue Set Code:: PHVS_VaccinationContraindication_IIS"]
[null,"31044-1","Reaction","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3289\nValue Set Code:: PHVS_VaccinationReaction_IIS"]
[null,"59784-9","Disease with presumed immunity","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3293\nValue Set Code:: PHVS_EvidenceOfImmunity_IIS"]
[null,"75505-8","Diseases with serological evidence of immunity","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3293 Value Set Code:: PHVS_EvidenceOfImmunity_IIS"]
[null,"59785-6","Indications to immunize","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3290\nValue Set Code:: PHVS_VaccinationSpecialIndications_IIS"]
[null,"Vaccine Information Statement (VIS) Dates"]
[null,"69764-9","Document type","(CE)","Value Set OID: 2.16.840.1.114222.4.11.6041\nValue Set Code: PHVS_VISBarcodes_IIS"]
[null,"29768-9","Date Vaccine Information Statement Published","(TS)","19900605","Sample:","RXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|\nOBX|4|TS|29769-7^DATE VIS PRESENTED^NIP003|1|201411211||||||F|"]
[null,"29769-7","Date Vaccine Information Statement Presented","(TS)","199307311615","Sample:","RXA|0|1|201609080000||20^DTaP^CVX|0.5|mL^milliliters^UCUM||00^New immunization record^NIP001||^^^SIISCLIENT1724||||3923K|20171115|SKB^GlaxoSmithKline^HL70227|||CP|A|\nOBX|5|TS|29768-9^DATE VIS PUBLISHED^NIP003|1|20080918||||||F|"]
[null,"Forecasting and Evaluating Immunizations"]
[null,"30973-2","30973-2 -- Dose number in series","(NM)","2"]
[null,"30979-9","Vaccines due next","(CE)","HL70292 (CVX)"]
[null,"30980-7","30980-7 – Date vaccine due","(TS_NZ)","19980526"]
[null,"30981-5","30981-5 – Earliest date to give","(TS_NZ)","19980522"]
[null,"30982-3","30982-3 – Reason applied by forecast logic to project this vaccine","(CE) or (ST)","Codes for forecast logic reason locally defined."]
[null,"59779-9","Immunization Schedule used","(CE)","Value Set OID - 2.16.840.1.114222.4.11.3291\nValue Set Code:: PHVS_ImmunizationScheduleIdentifier_IIS"]
[null,"59777-3","Latest date next dose may be given","TS_NZ",19980522]
[null,"59778-1","Reason Code","(CE)","Locally Defined"]
[null,"59780-7","Immunization Series name","(CE)","Locally Defined"]
[null,"59782-3","Number of doses in primary series","(NM)","2"]
[null,"59781-5","Dose validity","(ID)","Y, N or empty"]
[null,"59783-1","Status in immunization series","(CE)","Locally defined value set"]
[null,"Smallpox Take Read: These codes allow information about evaluation of a smallpox vaccination, called the take response."]
[null,"46249-9","Vaccination Take - Response Type","(ST)","Major Take, Equivocal, Not Available"]
[null,"46250-7","Vaccination Take - Response Date","(TS)","20091221"]
[null,"LOINC® codes are copyright 1995-2009, Regenstrief Institute and the Logical Observation Identifier Names and Codes (LOINC®) Committee. All rights reserved."]

{"sheet":"NIP004","index":54,"n_rows":129,"n_cols":6,"rows_kept":129,"cut":false,"hidden":false,"merged":[[2,5,5,7],[15,5,20,7],[51,1,51,4],[64,1,64,4],[0,1,0,5],[1,1,1,4],[14,1,14,4],[24,1,24,4],[25,5,29,7],[52,5,56,7],[72,1,72,4],[82,1,82,4],[89,1,89,4],[115,1,115,4],[125,1,125,4],[116,5,121,7],[126,5,130,7],[65,5,69,7],[73,5,77,7],[83,5,86,7],[90,5,95,7]]}
[]
[null,"Value Set Name – Eligibility for Publicly Funded Vaccines"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0064 Code","Used in OBX- 5\nValue Set OID - 2.16.840.1.114222.4.11.3366\nValue Set Code: PHVS_FinancialClass_IIS\nValue set definition: Financial class references a client's eligibility status at a point in time. The values in this table relate to eligibility for the Vaccine for Children (VFC) program. "]
[null,"V01","Not VFC Eligible","Adult is 19 years or older and has insurance.","CDCPHINVS"]
[null,"V02","VFC Eligible - Medicaid/Medicaid Managed Care","Child is less than 19 years old, and is enrolled in Medicaid or Medicaid Managed Care."]
[null,"V03","VFC Eligible - Uninsured","Child is less than 19 years old and does not have health insurance.","CDCPHINVS"]
[null,"V04","VFC Eligible - American Indian/Alaskan Native","Child is less than 19 years old and is a member of a federally recognized tribe.","CDCPHINVS"]
[null,"V05","VFC Eligible - Federally Qualified Health Center Patient (under-insured)","Child is less than 19 years old, is receiving care at a Federally Qualified Health Center/Rural Health Center (FQHC/RHC) and has insurance but insurance does not cover vaccines.","CDCPHINVS"]
[null,"V22","CHIP",null,"CDCPHINVS"]
[null,"V23",317,"Adult is 19 years or older, is receiving care at a facility that has 317-funded, state supplied adult vaccine, and does not have insurance or has insurance but insurance does not cover vaccines.","CDCPHINVS"]
[null,"V24","Medicare","Adult is 19 years or older and is enrolled in in Medicare.","CDCPHINVS"]
[null,"V25","State Program Eligibility",null,"CDCPHINVS"]
[]
[]
[null,"Value Set Name – Immunization Funding Source"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX- 5\nValue Set OID - 2.16.840.1.114222.4.11.3287\nValue Set Code: PHVS_ImmunizationFundingSource_IIS\nValue set definition: Indicates funding source for an immunization. This is used to support vaccine inventory management.\nCode Set OID:\nNULLFL: 2.16.840.1.113883.5.1008\nCDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"PHC70","Private Funds","Immunization was funded by private funds, including insurance.","CDCPHINVS"]
[null,"VXC50","Public Funds","Immunization was funded with public funds from the federal government."]
[null,"VXC51","Federal Funds - Public VFC","Immunization was funded with public funds from the federal government.","CDCPHINVS"]
[null,"VXC52","State Funds - Public non-VFC","Immunization was funded with public funds from a state.","CDCPHINVS"]
[null,"PHC68","Military Funds","Immunization was paid for with military funds.","CDCPHINVS"]
[null,"VSC3","Tribal Funds","Immunization was paid for with tribal funds.","CDCPHINVS"]
[]
[]
[null,"Value Set Name – Vaccination Contraindications"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX- 5\nValue Set OID - 2.16.840.1.114222.4.11.3288\nValue Set Code: PHVS_VaccinationContraindication_IIS\nValue set definition: indicates a contraindication to vaccination.\nCode Set OID:\nSNOMED: 2.16.840.1.113883.6.96\nCDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"VX30","allergy (anaphylactic) to proteins of rodent or neural origin","allergy (anaphylactic) to proteins of rodent or neural origin","CDCPHINVS"]
[null,"VXC17","allergy (anaphylactic) to 2-phenoxyethanol","allergy (anaphylactic) to 2-phenoxyethanol","CDCPHINVS"]
[null,"VXC18","allergy to baker’s yeast (anaphylactic)","allergy to baker’s yeast (anaphylactic)","CDCPHINVS"]
[null,"91930004","Allergy to eggs (disorder)","allergy to egg ingestion (anaphylactic)","SCT"]
[null,"294847001","Gelatin allergy (disorder)","allergy to gelatin (anaphylactic)","SCT"]
[null,"294468006","Neomycin allergy (disorder)","allergy to neomycin (anaphylactic)","SCT"]
[null,"294466005","Streptomycin allergy (disorder)","allergy to streptomycin (anaphylactic)","SCT"]
[null,"VXC19","allergy to thimerosal (anaphylactic)","allergy to thimerosal (anaphylactic)","CDCPHINVS"]
[null,"VXC20","allergy to previous dose of this vaccine or to any of its unlisted vaccine components (anaphylactic)","allergy to previous dose of this vaccine or to any of its unlisted vaccine components (anaphylactic)","CDCPHINVS"]
[null,"402306009","Allergy to aluminum (disorder)","allergy (anaphylactic) to alum","SCT"]
[null,"300916003","Latex allergy (disorder)","allergy (anaphylactic) to latex","SCT"]
[null,"294530006","Polymyxin B allergy (disorder)","allergy (anaphylactic) to polymyxin B","SCT"]
[null,"VXC21","Previous history of intussusception","Previous history of intussusception","CDCPHINVS"]
[null,"VXC22","encephalopathy within 7 days of previous dose of DTP or DTaP","encephalopathy within 7 days of previous dose of DTP or DTaP","CDCPHINVS"]
[null,"VXC23","current fever with moderate-to-severe illness","current fever with moderate-to-severe illness","CDCPHINVS"]
[null,"VXC24","current acute illness, moderate to severe (with or without fever) (e.g., diarrhea, otitis media, vomiting)","current acute illness, moderate to severe (with or without fever) (e.g., diarrhea, otitis media, vomiting)","CDCPHINVS"]
[null,"27624003","Chronic disease (disorder)","chronic illness (e.g., chronic gastrointestinal disease)","SCT"]
[null,"VXC25","History of Arthus hypersensitivity reaction to a tetanus-containing vaccine administered < 10 years previously","History of Arthus hypersensitivity reaction to a tetanus-containing vaccine administered < 10 years previously","CDCPHINVS"]
[null,"VXC26","underlying unstable, evolving neurological disorders, (including seizure disorders, cerebral palsy, and developmental delay)","underlying unstable, evolving neurological disorders, (including seizure disorders, cerebral palsy, and developmental delay)","CDCPHINVS"]
[null,"VXC27","immunodeficiency due to any cause, including HIV (hematologic and solid tumors, congenital immunodeficiency, long-term immunosuppressive therapy, including steroids)","immunodeficiency due to any cause, including HIV (hematologic and solid tumors, congenital immunodeficiency, long-term immunosuppressive therapy, including steroids)","CDCPHINVS"]
[null,"77386006","Patient currently pregnant (finding)","pregnancy (in recipient)","SCT"]
[null,"302215000","Thrombocytopenic disorder (disorder)","thrombocytopenia","SCT"]
[null,"161461006","History of - purpura (situation)","thrombocytopenic purpura (history)","SCT"]
[]
[]
[null,"Value Set Name – Vaccination Reactions - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX- 5\nValue Set OID - 2.16.840.1.114222.4.11.3289\nValue Set Code: PHVS_VaccinationReaction_IIS\nValue set definition: indicates a reaction or adverse event associate in time with an immunization.\nCode Set OID:\nSNOMED: 2.16.840.1.113883.6.96\nCDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"39579001","Anaphylaxis (disorder)","Anaphylaxis","SCT"]
[null,"81308009","Disorder of brain (disorder)","Encephalopathy","SCT"]
[null,"VXC9","persistent, inconsolable crying lasting > 3 hours within 48 hours of dose","persistent, inconsolable crying lasting > 3 hours within 48 hours of dose","CDCPHINVS"]
[null,"VXC10","collapse or shock-like state within 48 hours of dose","collapse or shock-like state within 48 hours of dose","CDCPHINVS"]
[null,"VXC11","convulsions (fits, seizures) within 72 hours of dose","convulsions (fits, seizures) within 72 hours of dose","CDCPHINVS"]
[null,"VXC12","fever of >40.5C (105F) within 48 hours of dose","fever of >40.5C (105F) within 48 hours of dose","CDCPHINVS"]
[null,"VXC13","Guillain-Barre syndrome (GBS) within 6 weeks of dose","Guillain-Barre syndrome (GBS) within 6 weeks of dose","CDCPHINVS"]
[null,"VXC14","Rash within 14 days of dose","Rash within 14 days of dose","CDCPHINVS"]
[null,"VXC15","Intussusception within 30 days of dose","Intussusception within 30 days of dose","CDCPHINVS"]
[]
[]
[null,"Value Set Name – Vaccination Special Indications - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX- 5\nValue Set OID - 2.16.840.1.114222.4.11.3290\nValue Set Code: PHVS_VaccinationSpecialIndications_IIS\nValue set definition: Describes a factor about the client which may impact forecasting of next dose of vaccine needed.\nCode Set OID: CDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"VXC7","Rabies exposure within previous 10 days.","Rabies exposure within previous 10 days.","CDCPHINVS"]
[null,"VXC8","Member of special group","Member of special group","CDCPHINVS"]
[]
[]
[]
[]
[null,"Value Set Name – Immunization Profile Identifiers - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in MSH-21\nValue Set OID - 2.16.840.1.114222.4.11.3291\nValue Set Code: PHVS_ImmunizationProfileIdentifier_IIS\nValue set definition: Identifies the profile used by the message.\nCode Set OID:\nCDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"Z31","Return Candidate Clients","Return Candidate Clients","CDCPHINVS"]
[null,"Z32","Return Immunization History","Return Immunization History","CDCPHINVS"]
[null,"Z33","Return acknowledgement","Return acknowledgement (no match, too many match, error)","CDCPHINVS"]
[null,"Z34","Request Immunization History","Request Immunization History","CDCPHINVS"]
[null,"Z44","Request Evaluated History and Forecast","Request Evaluated History and Forecast","CDCPHINVS"]
[null,"Z42","Return Evaluated History and Forecast","Return Evaluated History and Forecast","CDCPHINVS"]
[]
[]
[null,"Value Set Name – Immunization Schedule Identifiers - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX-5\nValue Set OID - 2.16.840.1.114222.4.11.3292\nValue Set Code: PHVS_ImmunizationScheduleIdentifier_IIS\nValue set definition: Identifies the schedule used for immunization evaluation and forecast.\nCode Set OID: CDCPHINVS: 2.16.840.1.114222.4.5.274"]
[null,"VXC16","ACIP Schedule","This indicates that the current ACIP Schedule of recommendations were used to forecast next doses due.","CDCPHINVS"]
[]
[]
[]
[]
[null,"Value Set Name – History of Disease as Evidence of Immunity - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX-5\nValue Set OID - 2.16.840.1.114222.4.11.7244\nValue Set Code: PHVS_HistoryOfDiseaseAsEvidenceOfImmunity_IIS\nValue set definition: History of Disease as Evidence of Immunity indicates that a person has been diagnosed with a particular disease.\nCode Set OID:\nSNOMED: 2.16.840.1.113883.6.96"]
[null,409498004,"Anthrax (disorder)","History of anthrax infection.","SCT"]
[null,397428000,"Diphtheria (disorder)","History of diphtheria infection. ","SCT"]
[null,76902006,"Tetanus (disorder)","History of tetanus infection.","SCT"]
[null,27836007,"Pertussis (disorder)","History of pertussis infection.","SCT"]
[null,40468003,"Viral hepatitis, type A (disorder)","History of Hepatitis A infection.","SCT"]
[null,66071002,"Type B viral hepatitis (disorder)","History of Hepatitis B infection.","SCT"]
[null,91428005,"Haemophilus influenzae infection (disorder)","History of HIB infection.","SCT"]
[null,240532009,"Human Papilloma virus infection (disorder)","History of HPV infection.","SCT"]
[null,6142004,"Influenza (disorder)","History of influenza infection.","SCT"]
[null,52947006,"Japanese encephalitis virus disease (disorder)","History of Japanese encephalitis infection.","SCT"]
[null,14189004,"Measles (disorder)","History of measles infection.","SCT"]
[null,36989005,"Mumps (disorder)","History of mumps infection.","SCT"]
[null,36653000,"Rubella (disorder)","History of rubella infection.","SCT"]
[null,23511006,"Meningococcal infectious disease (disorder)","History of meningococcal infection.","SCT"]
[null,16814004,"Pneumococcal infectious disease (disorder)","History of pneumococcal infection.","SCT"]
[null,398102009,"Acute poliomyelitis (disorder)","History of polio infection.","SCT"]
[null,14168008,"Rabies (disorder)","History of rabies infection.","SCT"]
[null,18624000,"Disease due to Rotavirus (disorder)","History of rotavirus infection.","SCT"]
[null,4834000,"Typhoid fever (disorder)","History of typhoid infection.","SCT"]
[null,111852003,"Vaccinia (disorder)","History of vaccinia infection.","SCT"]
[null,38907003,"Varicella (disorder)","History of Varicella infection.","SCT"]
[null,16541001,"Yellow fever (disorder)","History of yellow fever infection.","SCT"]
[]
[]
[null,"Value Set Name – Serological Evidence of Immunity - IIS"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX-5\nValue Set OID - 2.16.840.1.114222.4.11.7245\nValue Set Code: PHVS_SerologicalEvidenceOfImmunity_IIS\nValue set definition: Serological Evidence of Immunity to a particular disease indicates that a person has immunity to that disease\nCode Set OID: SNOMED: 2.16.840.1.113883.6.96"]
[null,341112003,"Mumps (finding)","Serology confirmed Mumps","SCT"]
[null,278968001,"Rubella (finding)","Serology confirmed Rubella","SCT"]
[null,371111005,"Measles (finding)","Serology confirmed Measles","SCT"]
[null,371113008,"Varicella (finding)","Serology confirmed Varicella","SCT"]
[null,271511000,"Hepatitis B (finding)","Serology confirmed Hepatitis B","SCT"]
[null,278971009,"Hepatitis A (finding)","Serology confirmed Hepatitis A","SCT"]
[]
[]
[null,"Value Set Name – Funding Eligibility Observation Method (IIS)"]
[null,"Concept Code","Concept Name","Definition","HL7 Table 0396 Code","Used in OBX-17\nValue Set OID - 2.16.840.1.114222.4.11.6039\nValue Set Code: PHVS_FundingEligibilityObsMethod_IIS\nValue set definition: The Funding Observation Method identifies the method for capturing funding program eligibility. Not that it is always reported at the immunization level"]
[null,"VXC40","Eligibility captured at the immunization level",null,"CDCPHINVS"]
[null,"VXC41","Eligibility captured at the visit level",null,"CDCPHINVS"]

{"sheet":"CDC Information","index":55,"n_rows":6,"n_cols":3,"rows_kept":6,"cut":false,"hidden":false,"merged":[[1,1,1,5],[2,1,2,5],[3,2,3,5],[4,1,4,5],[5,1,5,3]]}
[]
[null,"IIS: HL7 Standard Code Sets"]
[]
[null,"Get Email Updates:  ","https://tools.cdc.gov/campaignproxyservice/subscriptions.aspx?topic_id=USCDC_11_30"]
[null,"For the latest code sets, please visit the CDC website.  This site includes CVX codes, MVX (manufacturer codes), CPT mapping, and product mapping.      "]
[null,"http://www.cdc.gov/vaccines/programs/iis/code-sets.html"]

{"sheet":"Document History","index":56,"n_rows":5,"n_cols":5,"rows_kept":5,"cut":false,"hidden":false,"merged":[]}
[]
[null,"Version ","Date ","Author ","Change Description "]
[null,"1.0 ","2021-10-01","Linda Pursley","Initial Draft"]
[null,"1.1 ","2022-05-05","IIS Team/Karen Meranda","Review updates/edits"]
[null,1.2,"2022-05-12","Kathyrn Riter","Published"]