openapi: 3.0.
1
info:
title: MIPS Data Submission API Service
description: >-
<p>This interactive documentation describes the API for submitting exam data
to the MIPS portal.</p><p>This API allows you to submit QM data complying
with the Quality Payment Program(QPP). A list of measures that can be
submitted for a given performance year can be found in the <a
href='[Link]
target='blank'>QPP Measures Data Repository.
</a></p><table><tr><th>Code</th><th>Type</th><th>Notes</th></tr><tr><td>2xx</td><td>Ok</
td><td>Everything
is Ok</td></tr><tr><td>400</td><td>Data Parsing Error</td><td>Upload data is
incorrect format (or) Either uploaded data is empty or
null.</td></tr><tr><td>401</td><td>Authentication
Error</td><td>Missing/Invalid authentication token (or) Authentication token
may have expired.</td></tr><tr><td>403</td><td>Forbidden Error</td><td>
Invalid json parameters for token
validaton.</td></tr><tr><td>500</td><td>Internal Server Error</td><td>Error
in creating file or saving data to database.</td></tr></table>
paths:
/api/ExamAPI/PostMIPSdata:
post:
tags:
- ExamAPI
summary: Submits MIPS Exam Data
description: >-
Validates the provided data, save it to a JSON file stored in the app
server directory, and store the file properties in a database
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ImportExams'
example:
transaction_Id: Example01
transaction_DateTime: 2/2/2023
num_Of_Exam_Included: '1'
partner_Id: '12345'
app_Id: '1234'
facility_Id: '4567'
rawData_Id: '0'
exam:
- physician_Group_TIN: '000000001'
exam_Unique_Id: UniqueExam01
exam_DateTime: 02/02/2023
physician_NPI: '1234567890'
patient_Id: PatientExample01
patient_Age: '40'
patient_Gender: M
patient_Medicare_Beneficiary: 'N'
patient_Medicare_Advantage: 'N'
num_Of_Measures_Included: '1'
measure_Data:
- measure_Num: '012'
cpT_Code: Code
diagnosis_Code: I6.11
numerator_Code: G9456
text/json:
schema:
$ref: '#/components/schemas/ImportExams'
example:
transaction_Id: Example01
transaction_DateTime: 2/2/2023
num_Of_Exam_Included: '1'
partner_Id: '12345'
app_Id: '1234'
facility_Id: '4567'
rawData_Id: '0'
exam:
- physician_Group_TIN: '000000001'
exam_Unique_Id: UniqueExam01
exam_DateTime: 02/02/2023
physician_NPI: '1234567890'
patient_Id: PatientExample01
patient_Age: '40'
patient_Gender: M
patient_Medicare_Beneficiary: 'N'
patient_Medicare_Advantage: 'N'
num_Of_Measures_Included: '1'
measure_Data:
- measure_Num: '012'
cpT_Code: Code
diagnosis_Code: I6.11
numerator_Code: G9456
application/*+json:
schema:
$ref: '#/components/schemas/ImportExams'
example:
transaction_Id: Example01
transaction_DateTime: 2/2/2023
num_Of_Exam_Included: '1'
partner_Id: '12345'
app_Id: '1234'
facility_Id: '4567'
rawData_Id: '0'
exam:
- physician_Group_TIN: '000000001'
exam_Unique_Id: UniqueExam01
exam_DateTime: 02/02/2023
physician_NPI: '1234567890'
patient_Id: PatientExample01
patient_Age: '40'
patient_Gender: M
patient_Medicare_Beneficiary: 'N'
patient_Medicare_Advantage: 'N'
num_Of_Measures_Included: '1'
measure_Data:
- measure_Num: '012'
cpT_Code: Code
diagnosis_Code: I6.11
numerator_Code: G9456
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
/api/ExamAPI/GetMIPSTransactionStatus:
post:
tags:
- ExamAPI
summary: Provides MIPS Transaction Data Status.
description: >-
Validates the params data and provide processed data status for
Transaction.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetTransactionStatusRequest'
example:
transaction_Id: Test5_112616-0742
facility_Id: '100210'
app_Id: '12340'
partner_Id: '100024'
text/json:
schema:
$ref: '#/components/schemas/GetTransactionStatusRequest'
example:
transaction_Id: Test5_112616-0742
facility_Id: '100210'
app_Id: '12340'
partner_Id: '100024'
application/*+json:
schema:
$ref: '#/components/schemas/GetTransactionStatusRequest'
example:
transaction_Id: Test5_112616-0742
facility_Id: '100210'
app_Id: '12340'
partner_Id: '100024'
responses:
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
/api/UploaderAPI/PostFiledata:
post:
tags:
- UploaderAPI
summary: Submits MIPS Exam Data
description: >-
Validates the provided data, save it to the app server directory, and
store the file properties in a database
responses:
'200':
description: OK
content:
application/json:
schema:
type: string
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorDetails'
components:
schemas:
ErrorDetails:
type: object
properties:
error:
type: string
nullable: true
statusCode:
type: integer
format: int32
type:
type: string
nullable: true
timestamp:
type: string
format: date-time
details:
type: string
nullable: true
additionalProperties: false
GetTransactionStatusRequest:
type: object
properties:
transaction_Id:
type: string
nullable: true
facility_Id:
type: string
nullable: true
app_Id:
type: string
nullable: true
partner_Id:
type: string
nullable: true
additionalProperties: false
ImportExam:
type: object
properties:
physician_Group_TIN:
type: string
nullable: true
exam_Unique_Id:
type: string
nullable: true
exam_DateTime:
type: string
nullable: true
physician_NPI:
type: string
nullable: true
patient_Id:
type: string
nullable: true
patient_Age:
type: string
nullable: true
patient_Gender:
type: string
nullable: true
patient_Medicare_Beneficiary:
type: string
nullable: true
patient_Medicare_Advantage:
type: string
nullable: true
num_Of_Measures_Included:
type: string
nullable: true
measure_Data:
type: array
items:
$ref: '#/components/schemas/ImportMeasureData'
nullable: true
additionalProperties: false
ImportExams:
type: object
properties:
transaction_Id:
type: string
nullable: true
transaction_DateTime:
type: string
nullable: true
num_Of_Exam_Included:
type: string
nullable: true
partner_Id:
type: string
nullable: true
app_Id:
type: string
nullable: true
facility_Id:
type: string
nullable: true
rawData_Id:
type: string
nullable: true
exam:
type: array
items:
$ref: '#/components/schemas/ImportExam'
nullable: true
additionalProperties: false
ImportMeasureData:
type: object
properties:
measure_Num:
type: string
nullable: true
cpT_Code:
type: string
nullable: true
diagnosis_Code:
type: string
nullable: true
numerator_Code:
type: string
nullable: true
additionalProperties: false
securitySchemes:
Bearer:
type: http
description: User Supplied JWT Authorization
scheme: Bearer
security:
- Bearer: []