QPP Technical Specifications. ARIA Oncology Information System for Radiation and Medical Oncology

Transcription

1 QPP Technical Specifications ARIA Oncology Information System for Radiation and Medical Oncology P A NOVEMBER 2017

2 Document ID Document Title Abstract Manufacturer European Authorized Representative Notice FDA 21 CFR 820 Quality System Regulations (cgmps) P A QPP Technical Specifications This document provides API information about the web services that allow thirdparty systems to Request and Response data from the ARIA system. This publication is the English-language original. Varian Medical Systems, Inc Hansen Way Palo Alto, CA United States of America Varian Medical Systems UK Ltd. Oncology House Gatwick Road, Crawley West Sussex RH10 9RG United Kingdom Information in this user guide is subject to change without notice and does not represent a commitment on the part of Varian. Varian is not liable for errors contained in this user guide or for incidental or consequential damages in connection with furnishing or use of this material. This document contains proprietary information protected by copyright. No part of this document may be reproduced, translated, or transmitted without the express written permission of Varian Medical Systems, Inc. Varian Medical Systems, Oncology Systems products are designed and manufactured in accordance with the requirements specified within this federal regulation. HIPAA Varian s products and services are specifically designed to include features that help our customers comply with the Health Insurance Portability and Accountability Act of 1996 (HIPAA). The software application uses a secure login process, requiring a user name and password, that supports role-based access. Users are assigned to groups, each with certain access rights, which may include the ability to edit and add data or may limit access to data. When a user adds or modifies data within the database, a record is made that includes which data were changed, the user ID, and the date and time the changes were made. This establishes an audit trail that can be examined by authorized system administrators. WHO ICD-O codes and terms used by permission of WHO, from: International Classification of Diseases for Oncology, (ICD-O) 3rd edition, Geneva, World Health Organization, ICD-10 codes and terms used by permission of WHO, from: International Statistical Classification of Diseases and Related Health Problems, Tenth Revision (ICD-10). Vols 1 3, Geneva, World Health Organization, QPP Technical Specifications

3 Electronic labeling This symbol on the label indicates that the Instructions for Use for the corresponding product are available at Access the Instructions for Use in electronic form by logging in with your assigned MyVarian user credentials. In compliance with EU Commission Directive No 207/2012, Varian will send EU customers a free printed copy of the Instructions for Use within 7 days. Use the Paper Document Request form provided on the Varian webpage to order your copy. CAUTION: US Federal law restricts this device to sale by or on the order of a physician. Trademarks Copyright ARIA Oncology Information Systems and Varian are trademarks of Varian Medical Systems, Inc. Microsoft is a registered trademark of Microsoft Corporation. All other trademarks or registered trademarks are the property of their respective owners Varian Medical Systems, Inc. All rights reserved. Produced in India 3

4 Contents CHAPTER 1 INTRODUCTION...5 Overview...5 Visual Cues... 6 Contact Varian Customer Support... 6 Terms of Use... 7 CHAPTER 2 WEB APIS... 8 Calling Web APIs... 8 Importing Certificate... 8 AuthenticationTypes...9 Basic Authentication...10 Post URL Testing a Web Service...11 Examples...12 CHAPTER 3 QPP APIS Patient Selection...14 Error Handling...16 Patient Data Category Error Handling Patient All Data...24 Error Handling...26 APPENDIX A EXAMPLES FOR SUPPORTED API PatientSelectionRequest-Examples PatientSelectionResponse-Examples...30 PatientDataCategoryRequest-Examples PatientDataCategoryResponse-Examples PatientAllDataRequest-Examples PatientAllDataResponse-Examples QPP Technical Specifications

5 Chapter 1 Introduction Overview This guide provides information about the following three Web APIs (Application Program Interfaces) required for QPP Measure Provide Patient Access. PatientSelection PatientDataCategory PatientAllData A third-party application can use these three APIs to retrieve a unique patient identifier based on patient identification. Patient identification can be First Name, Last Name, Gender, and Date of Birth. This identifier can be further used to get CCDS (Common Clinical Data Set) for a specific patient. You can filter the CCDS content by Date and/or Data Category. This set of APIs can be used for both, Medical or Radiation Oncology. Quality Payment Program (QPP) APIs are web APIs for ARIA Oncology Information System (OIS). These APIs can be used to retrieve ARIA OIS data from third-party software using web service calls. The QPP API package includes the ONC Certified 2015 Edition Health IT Certification Criterion as shown in the table below. Regulation Text Citation Certification Criterion (g)(7) Application access patient selection (g)(8) Application access data category request (g)(9) Application access all data request Intended Audience This reference guide provides detailed information on how to use QPP APIs. It is also assumed that QPP APIs are installed and running. This guide is intended for users who want to integrate third-party software with ARIA in a programmatic manner. These users may be hospital programmers, IT personnel, and others. Note: The Web APIs described in this document are subject to change at Varian's discretion and therefore, changes applied might require changes to any application that uses them. Chapter 1 Introduction 5

6 Visual Cues This publication uses the following visual cues to help you find information: WARNING: A warning describes actions or conditions that can result in serious injury or death. CAUTION: A caution describes hazardous actions or conditions that can result in minor or moderate injury. NOTICE: A notice describes actions or conditions that can result in damage to equipment or loss of data. Note: A note describes information that may pertain to only some conditions, readers, or sites. Tip: A tip describes useful but optional information such as a shortcut, reminder, or suggestion, to help get optimal performance from the equipment or software. Contact Varian Customer Support Varian Customer Support is available on the internet, by , and by telephone. Support services are available without charge during the initial warranty period. The MyVarian website provides contact information, product documentation, and other resources for all Varian products. 1. Go to 2. Choose an option: If you have an account, enter your User login information ( and password). If you do not have an account, click Create New Account and follow the instructions. Establishing an account may take up to two working days. 3. Click Contact Us at the top of the window to display customer support and training options, and international addresses and telephone numbers. 6 QPP Technical Specifications

7 4. From the Contact Us page, choose an option: Call Varian Medical Systems support using a phone support number for your geographic area. Complete the form corresponding to your request for use on a call with a live Varian representative; then follow the instructions to complete the remote connection. You can order documents by phone, request product or applications support, and report product-related issues. Links on the MyVarian website navigate to other support resources for products, services, and education. 5. To find documents, click Product Documentation. Online documents in PDF format include customer technical bulletins (CTBs), manuals, and customer release notes (CRNs). Terms of Use APIs described in this Reference Guide expose patient clinical data of the institution where they will be installed. Varian does not own this patient data and therefore, defers to these institutions the right to define the Terms of Use that should not go beyond Varian generic rules that are described in the following web pages: Chapter 1 Introduction 7

8 Chapter 2 Web APIs Calling Web APIs This section describes how the QPP APIs web services can be used for responding to or requesting for patient data specified in the Common Clinical Data Set stored in ARIA database. The following are the requirements to call QPP web APIs. QPP APIs use HTTPS protocol to encrypt the communication between server and client. QPP APIs uses the REST based HTTP POST method. API Key - An API Key needs to be passed in HTTPS header. Note: An application programming interface key (API key) is a code passed in by computer programs by calling an application programming interface (API) to identify the calling program and its scope. API keys are used to track and control the API usage, for example to prevent malicious use or abuse of API. Credentials - Valid user credentials are required. Note: Request for authentication must have valid user credentials. Ensure that the user has: Appropriate privileges to use the API and registered on Varian Service Portal. Full Access to Patient Registration privilege to call QPP APIs. QPP APIs support two types of authentications. Refer AuthenticationTypes on page 9for details about supported authentication. Valid user credentials are passed as per selected authentication scheme. Import Certificate - The certificate can be imported manually. Note: QPP APIs work on HTTPS protocol for secure data exchange. Therefore, the QPP API server publishes the certificate, that can be imported in the client to encrypt and decrypt data. Importing Certificate It is mandatory to import the certificate before using the QPP APIs. 1. Browse to the Gateway URL: service.svc to route to the hosted Rest URL for web APIs.. 2. Choose Certificate error > Next. 3. Click the Place all certificates in the following store radio button. 8 QPP Technical Specifications

9 4. Choose Browse > Trusted Root Certification > Authorities and then click OK. 5. Click Next on Certificate Import Wizard. 6. Click Finish. The certificate import is successful. AuthenticationTypes ARIA Access supports the following authentication types: Integrated Windows Authentication (IWA) Basic Authentication Integrated Windows Authentication REST A REST request contains Header and Content elements. The Header element contains an API Key. Chapter 2 Web APIs 9

10 Header Element Value Example API Key REST Example (C#) For example: TYBDH1IUDEJDKEOJ2LM HI ApiKey: TYBDH1IUDEJDKEOJ2LM HI public static string SendData(string request, bool bisjson, string apikey) { var smediatype = bisjson? "application/json" : "application/xml"; var sresponse = System.String.Empty; using (var c = new HttpClient(new HttpClientHandler() {UseDefaultCredentials = true})) { c.defaultrequestheaders.add("apikey", apikey); var task = c.postasync(configurationmanager.appsettings["gatewayresturl"], new StringContent(request, Encoding.UTF8, smediatype)); Task.WaitAll(task); var responsetask = task.result.content.readasstringasync(); Task.WaitAll(responseTask); sresponse = responsetask.result; } return sresponse; } Basic Authentication The Header element comprises: An API Key Authorization Header Element Value Example API Key For example: TYBDH1IUDEJDKEOJ2LM HI ApiKey: TYBDH1IUDEJDKEOJ2LM HI Authorization "Basic" + <space> + Base64([UserName] + ":" + [Password] UserName = DemoUser and Password = DemoPwd 10 QPP Technical Specifications

11 Then the value is, for example, 'Basic RGVtb1VzZXI6RGVtb1B3ZA=' here 'RGVtb1VzZXI6RGVtb1B3ZA=' is Base64(DemoUser:DemoPwd). Post URL Posting the Request to Gateway URL Post this request as: POST Process Testing a Web Service Do the following to test whether the web service is working as expected. Note: This section describes one method to test the Web Services using the SoapUI application. Other tools can also be used. 1. Go to SoapUI and choose File > New REST Project. 2. Enter rest/process in the URL field. A REST project is created. For example, REST Project1. 3. Expand REST Project1 and select Request1 under Process. 4. Select POST method on the Request1 screen. Note: Users can rename project and request as per their preference. 5. Select Media Type either application/json or application/xml as required. Refer the Examples section for JSON and XML example. 6. Click the Authorization tab and select Authentication.Type. The available authentication types are: Basic Authentication Windows Integrated Authentication 1. Basic Authentication a. Select Basic in Add New Authorization and click OK. b. Enter your valid Shared Framework registered Username and Password. 2. Windows Integrated Authentication Chapter 2 Web APIs 11

12 a. Select NTLM option in Add New Authorization and click OK. b. Enter your valid Shared Framework registered Username and Password. 7. Select the Header tab and add new header. 8. In the Add HTTP Header dialog box, type ApiKey and click OK. 9. In Value field, enter the API Key provided by Varian. Note: Varian customer can generate their own API keys from MyVarian.com. 10. Click the Submit request to specified endpoint url icon. This response is visible in the Response tab. Examples XML and JSON Examples The Content element can be either of the following: XML JSON XML Example <z:anytype i:type="a:patientselectionrequest" xmlns:z=" schemas.microsoft.com/2003/10/serialization/" xmlns:i=" xmlns:a=" services.varian.com/ariaaccess/qpp/ PatientSelection"><Attributes i:nil="true" xmlns=" services.varian.com/foundation/sf/gateway"/><a:birthdatefrom xmlns:b=" Common"><b:Value> </b:Value></ a:birthdatefrom><a:birthdateto xmlns:b=" services.varian.com/ariawebconnect/ Common"><b:Value> </b:Value></ a:birthdateto><a:exactsearch i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/><a:firstname xmlns:b=" Common"><b:Value>rog</b:Value></a:FirstName><a:LastName i:nil="true" xmlns:b=" AriaWebConnect/Common"/><a:Sex i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/></z:anytype> 12 QPP Technical Specifications

13 JSON Example {" type":"patientselectionrequest: services.varian.com\/ariaaccess\/qpp\/ PatientSelection","Attributes":null,"BirthDateFrom": {"Value":" "},"BirthDateTo": {"Value":" "},"ExactSearch":null,"FirstName": {"Value":"rog"},"LastName":null,"Sex":null} Chapter 2 Web APIs 13

14 Chapter 3 QPP APIs Patient Selection The PatientSelection API allows you to search a patient in ARIA. This returns patient information including the patient ID that lets you uniquely identify a patient from response information. This API is designed as per Application access patient selection ( (g)(7)) You can send the request in the following format. { " type": "PatientSelectionRequest: services.varian.com\/ariaaccess\/qpp\/patientselection", "Attributes": null, "BirthDateFrom": {"Value": "{Enter BirthDateFrom in yyyy- MM-dd}"}, "BirthDateTo": {"Value": "{Enter BirthDateTo in yyyy-mmdd}"}, "ExactSearch": {"Value": {Enter 1 for true and 0 for False}}, "FirstName": {"Value": "{Enter First Name}"}, "LastName": {"Value": "{Enter Last Name}"}, "Sex": {"Value": "{Enter Gender Code Here Like F --> Female, M --> Male and so on}"}, } Refer Calling a Web APIs for details on how to call a web service. The following attributes are available as Request and Response for each patient in ARIA. Table 1 Request Details Parameter Name Limits, Conditions and Format Is Mandatory Value Description FirstName String, Max Length 60 No Search on: Patient FirstName Previous Name Preferred Name LastName String, Max Length 60 No 14 QPP Technical Specifications

15 Parameter Name Limits, Conditions and Format Is Mandatory Value Description BirthDateFrom String, ISO 8601 format, yyyy-mm-dd BirthDateTo String, ISO 8601 format, yyyy-mm-dd No No Note: Whenever BirthDateFrom and BirthDateTo is used they must be specified. Sex String No Fixed set of the following search values: F Female M Male O Other T Transsexual ExactSearch Number No Default Value is 0 Possible values are: 0 Perform (Starts With) Search on FirstName and LastName 1 Perform exact search on FirstName and LastName Table 2 Response Details Parameter Name Return Data Type and Format Id String, Max Length 25 FirstName String, Max Length 60 LastName String, Max Length 60 MiddleName String, Max Length 60 Previous Name String, Max Length 60 Preferred Name String, Max Length 60 BirthDate Sex String, ISO 8601 format, yyy-mm-dd String Refer, PatientSelectionRequest- Examples for XML and JSON examples. Chapter 3 QPP APIs 15

16 Assumption and Conditions The following are the assumptions and conditions for Patient Selection API: The API returns an empty response, if the specified search criteria in Request does not match with any patient in ARIA. It is mandatory to pass atleast one of the following parameters: FirstName LastName BirthDateFrom BirthDateTo The API matches FirstName and LastName in a non case-sensitive manner. Error Handling The following HTTP responses indicate that an error occurred while processing a request. Error Type Status Code Description Authentication Failure HTTP 401 The probable scenarios are: Request does not contain authorization header or value. Request contains invalid credentials. For example, credentials of a non-existing user. User is not registered in Varian Service Portal. API Key is not passed in the Request header. Request contains invalid API key. For example, the API key is not registered in Varian Service Portal or some characters are missing/incorrect in the specified API key. Bad Request HTTP 400 The probable scenarios are: Posted content is in invalid XML or JSON format. Request name and attributes are incorrectly written. Request content does not match with the given content type in header. 16 QPP Technical Specifications

17 Error Type Status Code Description Application Error HTTP 200 OK API returns its own custom error response on validation/ processing failures. The probable scenarios that may throw an error response are: BirthDate format is invalid. For example, the specified BirthDate does not comply with the {yyyy-mm-dd} format. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>Specified Date Format is not valid for EndTime, expected format is "yyyy-mm-dd"</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> If the Request content does not contain any one of the specified LastName, FirstName, or BirthDate. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>One or more required parameter missing.</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> Chapter 3 QPP APIs 17

18 Error Type Status Code Description Application Error HTTP 200 OK Date range for the specified BirthDate is incorrect. For example, FromDate is greater than ToDate. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>StartTime can not be greater than EndTime.</Message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> If the server encounters an internal error while processing the request. Patient Data Category The Patient Data Category API allows you to get patient data based on PatientId retrieved from Patient Selection for each of the individual data categories specified in the Common Clinical Data Set. It returns the complete set of data for that data category in a computable format as per the specified standards. This API is designed as per the Application access data category request ( (g)(8)) certification criteria. The API returns a response data of the requested data categories, that contain a Patient Id and XML structured clinical document. This XML structured clinical document is based on CCDA guidelines. You can specify the list of the following data categories supported by ARIA that require patient data. Allergies and Intolerance Plan of Treatment Encounters 18 QPP Technical Specifications

19 Functional Status Immunizations Instructions Results Medications Problems Procedures Reason for Referral Social History Medications Administered Reason for Visit Vital Signs Assessments Health Concerns Medical Equipment Chapter 3 QPP APIs 19

20 You can send the request in the following format. { " type":"patientdatarequest: http: \/\/ services.varian.com\/ariaaccess\/qpp\/patientdata", "Attributes": { "@nil": "true" }, "DataCategories": [ {"Value":"ALLERGIES_AND_INTOLERANCES"}, {"Value":"PLAN_OF_TREATMENT"}, {"Value":"ENCOUNTERS"}, {"Value":"FUNCTIONAL_STATUS"}, {"Value":"IMMUNIZATIONS"}, {"Value":"INSTRUCTIONS"}, {"Value":"RESULTS"}, {"Value":"MEDICATIONS"}, {"Value":"PROBLEMS"}, {"Value":"PROCEDURES"}, {"Value":"REASON_FOR_REFERRAL"}, {"Value":"SOCIAL_HISTORY"}, {"Value":"MEDICATIONS_ADMINISTERED"}, {"Value":"REASON_FOR_VISIT"}, {"Value":"VITAL_SIGNS"}, {"Value":"ASSESSMENTS"}, {"Value":"HEALTH_CONCERNS"}, {"Value":"MEDICAL_EQUIPMENT"}], "EndTime": { "Value": "{Enter EndTime in yyyy-mm-dd format}" }, "Id": { "Value": "{Enter Patient Id}" }, "StartTime": {"Value": "{Enter StartTime in yyyy-mm-dd format}" } } Refer Calling a Web APIs to call the service. The following attributes are available as Request and Response for each ARIA patient. Refer, PatientDataCategoryRequest-Examples for XML and JSON examples. 20 QPP Technical Specifications

21 Table 3 Request Details Parameter Name Limits, Conditions and Format Is Mandatory Value Description Id String, Max Length 25 Yes Patient ID StartTime EndTime String, ISO 8601 format, yyy-mm-dd String, ISO 8601 format, yyy-mm-dd No No Note: Whenever StartTime and EndTime is used they must be specified. DataCategories Number No Fixed set of values for search are: ALLERGIES_AND_INTOL- ERANCES Allergies and Intolerance PLAN_OF_TREATMENT Plan of Treatment ENCOUNTERS Encounters FUNCTIONAL_STATUS Functional Status IMMUNIZATIONS Immunizations INSTRUCTIONS Instructions RESULTS Results MEDICATIONS Medications PROBLEMS Problems PROCEDURES Procedures REASON_FOR_REFERRAL Reason for Referral SOCIAL_HISTORY Social History MEDICATIONS_ADMINISTERED Medications Administered REASON_FOR_VISIT Reason for Visit VITAL_SIGNS Vital Signs ASSESSMENTS Assessments HEALTH_CONCERNS Health Concerns MEDICAL_EQUIPMENT Medical Equipment Chapter 3 QPP APIs 21

22 Table 4 Response Details Parameter Name Return Data Type and Format Details Id String Patient ID Document String An XML structured clinical document based on the CCDA guidelines containing data of the requested data categories.. Refer, PatientDataCategoryRequest-Examples for XML and JSON examples. Assumption and Conditions The following are the assumptions and conditions for PatientDataCategoryRequest. The API returns an error response: If the Patient ID specified in the Request does not exist in ARIA. If specified StartDate is greater than EndDate. If the specified SectionFlags include invalid flag values. If the specified DocumentTypecontains an invalid value. If an internal error occurs while generating document for the specified Patient. Error Handling The following HTTP responses indicate that an error occurred while processing a request. Error Type Status Code Description Authentication Failure HTTP 401 The probable scenarios are: Request does not contain authorization header or value. Request contains invalid credentials. For example, credentials of a user that does not exist. User is not registered in Varian Service Portal. API Key is not passed in Request header. Request contains invalid API key.for example, the API key is not registered in Varian Service Portal or some characters are missing/incorrect in the specified API key. 22 QPP Technical Specifications

23 Error Type Status Code Description Bad Request HTTP 400 The probable scenarios are: Posted content is in invalid XML or JSON format. Request name and attributes are incorrectly written. Request content does not match with given content type in header. Application Error HTTP 200 OK API may return its own custom error response on validation/processing failures. Some of the possible scenarios are: Date format is invalid. i.e. Date is expected in {yyyy- MM-dd} format non compliance to this will generate an ApplicationError response. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>Specified Date Format is not valid for EndTime, expected format is "yyyy-mm-dd"</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> Chapter 3 QPP APIs 23

24 Error Type Status Code Description Application Error HTTP 200 OK Date Range for BirthDate is not correct i.e. FromDate is greater than ToDate. It will generate an ApplicationError response. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>One or more required parameter missing.</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> If Server has encountered some internal error while processing the request. Patient All Data The PatientAllData API allows you to get patient data of all data categories specified in the Common Clinical Data set for a specific date range. This API is designed as per Application access all data request ( (g)(9)) certification criteria. This API returns a response containing a Patient Id and XML structured clinical document having data of all data categories, if specified in Common Clinical Data Set. The following are the data categories supported in response: Allergies and Intolerance Plan of Treatment Encounters Functional Status Immunizations 24 QPP Technical Specifications

25 Instructions Results Medications Problems Procedures Reason for Referral Social History Medications Administered Reason for Visit Vital Signs Assessments Health Concerns Medical Equipment You can send the request in the following format. { " type": "PatientDataRequest: \/ARIAAccess\/QPP\/PatientData", "Attributes": null, "EndTime": {"Value": "{Enter EndTime in yyyy-mm-dd format}"}, "Id": {"Value": "{Enter Patient Id}"}, "StartTime": {"Value": "{Enter StartTime in yyyy-mm-dd format}"} } Refer Calling a Web APIs to call the service. The following attributes are available as Request and Response for each patient in ARIA. Table 5 Request Details Parameter Name Limits, Conditions and Format Is Mandatory Value Description Id String, Max Length 25 Yes Patient ID StartTime String, ISO 8601 format, yyy-mm-dd EndTime String, ISO 8601 format, yyy-mm-dd No No Note: Whenever Start Time and EndTime is used they must be specified. Chapter 3 QPP APIs 25

26 Table 6 Response Details Parameter Name Return Data Type and Format Details Id String Patient ID Refer, PatientAllDataRequest-Examples for XML and JSON examples. Assumption and Conditions The following are the assumptions and conditions for PatientAllData category request. The API returns an error response: If the Patient ID specified in the Request does not exist in ARIA. If the specified StartDate is greater than EndDate. If the specified DocumentType contains invalid value. If an internal error occurs while generating document for the specified Patient. Error Handling The following HTTP responses indicate that an error occurred while processing a request. Error Type Status Code Description Document String An XML structured clinical document based on CCDA guidelines, that contains data of the requested data categories. Authentication Failure HTTP 401 The probable scenarios are: Request does not contain authorization header or value. Request contains invalid credentials. For example, credentials of a user that does not exist. User is not registered in Varian Service Portal. API Key is not passed in Request header. Request contains invalid API key.for example, the API key is not registered in Varian Service Portal or some characters are missing/incorrect in the specified API key. Bad Request HTTP 400 The probable scenarios are: Posted content is in invalid XML or JSON format. Request name and attributes are incorrectly written. Request content does not match with given content type in header. 26 QPP Technical Specifications

27 Error Type Status Code Description Application Error HTTP 200 OK API may return its own custom error response on validation/processing failures. Some of the possible scenarios are: Date format is invalid. i.e. Date is expected in {yyyy- MM-dd} format non compliance to this will generate an ApplicationError response. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>Specified Date Format is not valid for EndTime, expected format is "yyyy-mm-dd"</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> Chapter 3 QPP APIs 27

28 Error Type Status Code Description Application Error HTTP 200 OK Date Range for BirthDate is not correct i.e. FromDate is greater than ToDate. It will generate an ApplicationError response. <ApplicationError xmlns=" services.varian.com/foundation/sf/ Gateway" xmlns:i=" <Attributes> <MessageAttribute> <Name>username</Name> <Value>.\Administrator</ Value> </MessageAttribute> </Attributes> <Message>One or more required parameter missing.</message> <StackTrace i:nil="true"/> <Code>AWC/ApplicationError</ Code> <Details/> </ApplicationError> If Server has encountered some internal error while processing the request. 28 QPP Technical Specifications

29 Appendix A Examples for Supported API PatientSelectionRequest-Examples Example for XML <z:anytype i:type="a:patientselectionrequest" xmlns:z=" schemas.microsoft.com/2003/10/serialization/" xmlns:i=" xmlns:a=" services.varian.com/ariaaccess/qpp/patientselection"> <Attributes i:nil="true" xmlns=" services.varian.com/foundation/sf/gateway"/> <a:birthdatefrom xmlns:b=" AriaWebConnect/Common"> <b:value> </b:value> </a:birthdatefrom> <a:birthdateto> xmlns:b=" AriaWebConnect/Common"> <b:value </b:value></a:birthdateto> <a:exactsearch i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/> <a:firstname xmlns:b=" AriaWebConnect/Common"> <b:value>john</b:value></a:firstname> <a:lastname i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/> <a:sex i:nil="true" xmlns:b=" AriaWebConnect/Common"/> </z:anytype> Example for JSON { " type": "PatientSelectionRequest: services.varian.com\/ariaaccess\/qpp\/patientselection", "Attributes": null, "BirthDateFrom": {"Value": " "}, "BirthDateTo": {"Value": " "}, "ExactSearch": null, "FirstName": {"Value": "rog"}, "LastName": null, "Sex": null } Appendix A Examples for Supported API 29

30 PatientSelectionResponse-Examples Example for XML Response xmlns=" Process"> <Attributes> <e> <Name>username</Name> <Value>ARIAV15\Varian</Value> < type>messageattribute: Foundation/SF/Gateway</ type> </e> </Attributes> <Patients> <e><birthdate> <Value> </Value> < type>string: AriaWebConnect/Common</ type> </BirthDate> <FirstName> <Value>Michael</Value> < type>string: AriaWebConnect/Common</ type> </FirstName> <Id> <Value> a.5.a</Value> < type>string: AriaWebConnect/Common</ type> </Id> <LastName> <Value>Drummond</Value> < type>string: AriaWebConnect/Common</ type> </LastName> <MiddleName> <Value>A.</Value> < type>string: AriaWebConnect/Common</ type> </MiddleName> <PreviousName> <Value>Jim</Value> < type>string: AriaWebConnect/Common</ type> </PreviousName> <PreferredName> <Value>Mike</Value> < type>string: AriaWebConnect/Common</ type> </PreferredName> <Sex> <Value>Male</Value> < type>string: AriaWebConnect/Common</ type> </Sex> < type>patientinfo: ARIAAccess/QPP/PatientSelection</ type> </e> </Patients> 30 QPP Technical Specifications

31 < type>patientselectionresponse: services.varian.com/ariaaccess/qpp/patientselection</ type> </Response> Example for JSON { " type": "PatientSelectionResponse: services.varian.com/ariaaccess/qpp/patientselection", "Attributes": [{" type": "MessageAttribute: services.varian.com/foundation/sf/gateway", "Name": "username", "Value": "ARIAV15\\Varian"}], "Patients": [{" type": "PatientInfo: services.varian.com/ariaaccess/qpp/patientselection", "BirthDate": {" type": "String: services.varian.com/ariawebconnect/common", "Value": " "}, "FirstName": {" type": "String: services.varian.com/ariawebconnect/common", "Value": "John"}, Id": {" type": "String: AriaWebConnect/Common", "Value": " a.5.a"}, "LastName": {" type": "String: services.varian.com/ariawebconnect/common", "Value": "Drummond"}, "MiddleName": {" type": "String: services.varian.com/ariawebconnect/common", "Value": "" }, "PreviousName": {" type": "String: services.varian.com/ariawebconnect/common", "Value": "Jack"}, "PreferredName": {" type": "String: services.varian.com/ariawebconnect/common", "Value": "Mike"} "Sex": {" type": "String: AriaWebConnect/Common", "Value": "Male"} }] Appendix A Examples for Supported API 31

32 PatientDataCategoryRequest-Examples Example for XML <z:anytype i:type="a:patientdatarequest" xmlns:z=" schemas.microsoft.com/2003/10/serialization/" xmlns:i=" xmlns:a=" services.varian.com/ariaaccess/qpp/patientdata"> <Attributes i:nil="true" xmlns=" services.varian.com/foundation/sf/gateway"/> <a:datacategories xmlns:b=" AriaWebConnect/Common"> <b:value>allergies_and_intolerances</b:value></ b:string> <b:value>plan_of_treatment</b:value></b:string> <b:value>encounters</b:value></b:string> <b:value>functional_status</b:value></b:string> <b:value>immunizations</b:value></b:string> <b:value>instructions</b:value></b:string> <b:value>results</b:value></b:string> <b:value>medications</b:value></b:string> <b:value>problems</b:value></b:string> <b:value>procedures</b:value></b:string> <b:value>reason_for_referral</b:value></b:string> <b:value>social_history</b:value></b:string> <b:value>medications_administered</b:value></ b:string> <b:value>reason_for_visit</b:value></b:string> 32 QPP Technical Specifications

33 <b:value>vital_signs</b:value></b:string> <b:value>assessments</b:value></b:string> <b:value>health_concerns</b:value></b:string> <b:value>medical_equipment</b:value></b:string> </a:datacategories> <a:documenttype i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/> <a:endtime xmlns:b=" AriaWebConnect/Common"> <b:value> </b:value></a:endtime> <a:id xmlns:b=" Common"> <b:value>test10</b:value></a:id> <a:starttime xmlns:b=" AriaWebConnect/Common"> <b:value> </b:value></a:starttime> <a:usemedoncologydata xmlns:b=" AriaWebConnect/Common"> <b:value>false</b:value></a:usemedoncologydata> </z:anytype> Example for JSON { " type": "PatientDataRequest: \/ARIAAccess\/QPP\/PatientData", "Attributes": null, "DataCategories": [{ "Value": "ALLERGIES_AND_INTOLERANCES"}, {"Value": "PLAN_OF_TREATMENT"}, {"Value": "ENCOUNTERS"}, {"Value": "FUNCTIONAL_STATUS"}, {"Value": "IMMUNIZATIONS"}, {"Value": "INSTRUCTIONS"}, {"Value": "RESULTS"}, {"Value": "MEDICATIONS"}, {"Value": "PROBLEMS"}, {"Value": "PROCEDURES"}, {"Value": "REASON_FOR_REFERRAL"}, {"Value": "SOCIAL_HISTORY"}, {"Value": "MEDICATIONS_ADMINISTERED"}, {"Value": "REASON_FOR_VISIT"}, {"Value": "VITAL_SIGNS"}, {"Value": "ASSESSMENTS"}, {"Value": "HEALTH_CONCERNS"}, Appendix A Examples for Supported API 33

34 } {"Value": "MEDICAL_EQUIPMENT"}], "DocumentType": null, "EndTime": {"Value": " "}, "Id": {"Value": "Test10"}, "StartTime": {"Value": " "}, "UseMedOncologyData": {"Value": false} PatientDataCategoryResponse-Examples Example for XML { <Response xmlns=" rest/process"> <Attributes> <e> <Name>username</Name> <Value>ARIAV15\Varian</Value> < type>messageattribute: services.varian.com/foundation/sf/gateway</ type> </e> </ Attributes> <Document> <Value> <![CDATA[/******** Clinical Document in xml format will be here *******/]]> </Value> < type>string: AriaWebConnect/Common</ type> </Document> <Id> <Value> g.9.a</Value> < type>string: 34 QPP Technical Specifications

35 AriaWebConnect/Common</ type> </Id> < type>patientdataresponse: ARIAAccess/QPP/PatientData</ type> </Response> Example for JSON { " type": "PatientDataResponse: ARIAAccess/QPP/PatientData", "Attributes": [{" type": "MessageAttribute: services.varian.com/foundation/sf/gateway", "Name": "username", "Value": "ARIAV15\\Varian"}], "Document": {" type": "String: AriaWebConnect/Common", "Value": " /******** Clinical Document in xml format will be here *******/"}, "Id": {" type": "String: AriaWebConnect/Common", "Value": " g.9.a"} } PatientAllDataRequest-Examples Example for XML <z:anytype i:type="a:patientdatarequest" xmlns:z=" schemas.microsoft.com/2003/10/serialization/" xmlns:i=" xmlns:a=" services.varian.com/ariaaccess/qpp/patientdata"> <Attributes i:nil="true" xmlns=" services.varian.com/foundation/sf/gateway"/> <a:datacategories xmlns:b=" AriaWebConnect/Common"> <b:value>allergies_and_intolerances</b:value></ b:string> <b:value>plan_of_treatment</b:value></b:string> <b:value>encounters</b:value></b:string> <b:value>functional_status</b:value></b:string> <b:value>immunizations</b:value></b:string> Appendix A Examples for Supported API 35

36 <b:value>instructions</b:value></b:string> <b:value>results</b:value></b:string> <b:value>medications</b:value></b:string> <b:value>problems</b:value></b:string> <b:value>procedures</b:value></b:string> <b:value>reason_for_referral</b:value></b:string> <b:value>social_history</b:value></b:string> <b:value>medications_administered</b:value></ b:string> <b:value>reason_for_visit</b:value></b:string> <b:value>vital_signs</b:value></b:string> <b:value>assessments</b:value></b:string> <b:value>health_concerns</b:value></b:string> <b:value>medical_equipment</b:value></b:string> </a:datacategories> <a:documenttype i:nil="true" xmlns:b=" services.varian.com/ariawebconnect/common"/> <a:endtime xmlns:b=" AriaWebConnect/Common"> <b:value> </b:value></a:endtime> <a:id xmlns:b=" Common"> <b:value>test10</b:value></a:id> <a:starttime xmlns:b=" AriaWebConnect/Common"> <b:value> </b:value></a:starttime> <a:usemedoncologydata xmlns:b=" AriaWebConnect/Common"> <b:value>false</b:value></a:usemedoncologydata> </z:anytype> Example for JSON { " type": "PatientDataRequest: \/ARIAAccess\/QPP\/PatientData", 36 QPP Technical Specifications

37 } "Attributes": null, "DataCategories": [{ "Value": "ALLERGIES_AND_INTOLERANCES"}, { "Value": "PLAN_OF_TREATMENT"}, { "Value": "ENCOUNTERS"}, { "Value": "FUNCTIONAL_STATUS"}, { "Value": "IMMUNIZATIONS"}, { "Value": "INSTRUCTIONS"}, { "Value": "RESULTS"}, { "Value": "MEDICATIONS"}, { "Value": "PROBLEMS"}, { "Value": "PROCEDURES"}, { "Value": "REASON_FOR_REFERRAL"}, { "Value": "SOCIAL_HISTORY"}, { "Value": "MEDICATIONS_ADMINISTERED"}, { "Value": "REASON_FOR_VISIT"}, { "Value": "VITAL_SIGNS"}, { "Value": "ASSESSMENTS"}, { "Value": "HEALTH_CONCERNS"}, { "Value": "MEDICAL_EQUIPMENT"}], "DocumentType": null, "EndTime": {"Value": " "}, "Id": {"Value": "Test10"}, "StartTime": {"Value": " "}, "UseMedOncologyData": {"Value": false} PatientAllDataResponse-Examples Example for XML { <Response xmlns=" rest/process"> <Attributes> <e> <Name>username</Name> <Value>ARIAV15\Varian</Value> < type>messageattribute: services.varian.com/foundation/sf/gateway</ type> </e> </ Attributes> <Document> <Value> <![CDATA[/******** Clinical Document in xml format will be here *******/]]> </Value> < type>string: AriaWebConnect/Common</ type> </Document> <Id> Appendix A Examples for Supported API 37

38 <Value> g.9.a</Value> < type>string: AriaWebConnect/Common</ type> </Id> < type>patientdataresponse: ARIAAccess/QPP/PatientData</ type> </Response> Example for JSON { " type": "PatientDataResponse: ARIAAccess/QPP/PatientData", "Attributes": [{" type": "MessageAttribute: services.varian.com/foundation/sf/gateway", "Name": "username", "Value": "ARIAV15\\Varian"}], "Document": {" type": "String: AriaWebConnect/Common", "Value": " /******** Clinical Document in xml format will be here *******/"}, "Id": {" type": "String: AriaWebConnect/Common", "Value": " g.9.a"} } 38 QPP Technical Specifications