openapi: 3.2.0 info: title: Optum CMS Transmittal APIs API version: v1.0 contact: name: Ken Kracker email: ken.kracker@optum.com description: 'Operations tagged CMS Transmittal APIs across 2 of this provider''s published API definitions: optum-cms-common-facility-openapi.yml, optum-cms-common-physician-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: /v1/cmscommonms tags: - name: CMS Transmittal APIs paths: /api/cms/common/transmittal/: post: tags: - CMS Transmittal APIs summary: Fetches the data for CMS Transmittal operationId: getCMSTransmittal parameters: - name: sort in: query description: Any of these values(publicationType,-publicationType,publicationSubject,-publicationSubject,transmittalNumber,-transmittalNumber,changeRequest,-changeRequest,postDate,-postDate,effectiveDate,-effectiveDate,docImpDate,-docImpDate,rescinded,-rescinded,replacedBy,-replacedBy,relatedDocName,-relatedDocName,retroactiveFlag,-retroactiveFlag,healthCareTypes,-healthCareTypes,specialities,-specialities ) are allowed.The default is -effectiveDate required: false schema: type: array items: type: string default: [] - name: limit in: query required: false schema: type: integer format: int32 default: 50 example: 150 - name: page in: query required: false schema: type: integer format: int32 default: 1 - name: yyyy-MM-dd in: header description: Date for which historical data is required required: false schema: type: string format: yyyy-MM-dd requestBody: content: application/json: schema: $ref: '#/components/schemas/CMSTransmittal' responses: '200': description: 'POST-for-GET: Fetch CMS Transmittal ' content: application/json: example: content: - docId: 615315 documentSourceId: 4 publicationType: Pub 100-04 Medicare Claims Processing publicationSubject: Annual Updates to the Prior Authorization/Pre-Claim Review Federal Holiday Schedule Tables for Generating Reports transmittalNumber: R12026CP changeRequest: '13151' postDate: '2023-05-11 00:00:00' effectiveDate: '2024-01-01 00:00:00' docImpDate: '2023-10-02 00:00:00' healthCareTypes: ALL TYPES specialities: ALL PROVIDERS '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Notification' example: timestamp: '2023-07-14T06:37:03.741+00:00' status: 404 error: Not Found message: Not Found path: /cmscommonms/api/cms/common/transmittalssss '500': description: Interal server error content: application/json: example: timestamp: '2023-07-28T06:36:22.518+00:00' path: /cmscommonms/api/cms/common/transmittal status: 500 error: Internal Server Error requestId: e36d239e-324 security: - bearerAuth: [] servers: - url: /v1/cmscommonms /api/cms/common/transmittal/{doc-id}/{doc-source-id}/transmittal-download: get: tags: - CMS Transmittal APIs summary: Fetches the file content for CMS Transmittal operationId: getCMSTransmittalDocument parameters: - name: doc-id in: path description: Transmittal Document ID required: true schema: type: integer format: int32 example: 619114 - name: doc-source-id in: path description: 'Transmittal Document Source Id ' required: true schema: type: integer format: int32 example: 4 - name: yyyy-MM-dd in: header description: Date for which historical data is required required: false schema: type: string format: yyyy-MM-dd responses: '200': description: Fetches The file content in the form of byte array, response headers and media type as FileType content: application/pdf: schema: $ref: '#/components/schemas/Notification' example: " access-control-expose-headers: Content-Disposition \n cache-control: no-cache,no-store,max-age=0,must-revalidate \n connection: keep-alive \n content-disposition: attachment; filename=R12138OTN.pdf \n content-length: 178521 \n content-type: application/pdf \n date: Fri,28 Jul 2023 12:03:02 GMT \n expires: 0 \n pragma: no-cache \n vary: Origin,Access-Control-Request-Method,Access-Control-Request-Headers \n x-content-type-options: nosniff \n x-frame-options: DENY \n x-xss-protection: 0 \n" '404': description: 'Not found: Sub terms not found' content: application/json: schema: $ref: '#/components/schemas/Notification' example: timestamp: '2023-07-28T06:19:48.666+00:00' status: 404 error: Not Found message: Not Found path: /cmscommonms/api/cms/common/transmittal/{docId}/{docSourceId}transmittal-download '500': description: Internal server error content: application/json: example: timestamp: '2023-07-28T06:19:48.666+00:00' path: /cmscommonms/api/cms/common/transmittal/{docId}/{docSourceId}transmittal-download status: 500 error: Internal Server Error requestId: a4796cc7-1 security: - bearerAuth: [] servers: - url: /v1/cmscommonms /api/cms/common/transmittal/{code}: get: tags: - CMS Transmittal APIs summary: Fetches the data for the CMS Transmittal for given CPT ,HCPCS code operationId: getCodeDetailCMSTransmittals parameters: - name: code in: path required: true schema: type: string example: 13152 - name: yyyy-MM-dd in: header description: Date for which historical data is required required: false schema: type: string format: yyyy-MM-dd responses: '200': description: Fetches transmittals for the given CPT or HCPCS code content: application/json: example: - docId: 615607 documentSourceId: 4 transmittalNumber: R12052CP postDate: '2023-05-18 00:00:00' effectiveDate: '2023-07-01 00:00:00' rescinded: Y replacedBy: R12062CP fileName: R12052CP '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/Notification' example: timestamp: '2023-10-18T06:37:03.741+00:00' status: 404 error: Not Found message: Not Found path: /cmscommonms/api/cms/common/transmittal/{code}/ '500': description: Internal server error content: application/json: example: timestamp: '2023-10-18T07:22:01.017+00:00' path: /cmscommonms/api/cms/common/transmittal/{code}/ status: 500 error: Internal Server Error requestId: a4796cc7-1 security: - bearerAuth: [] servers: - url: /v1/cmscommonms components: schemas: Notification: type: object properties: error: type: array items: type: string warning: type: array items: type: string info: type: array items: type: string CMSTransmittal: type: object properties: docId: type: integer format: int32 documentSourceId: type: integer format: int32 publicationType: type: string publicationSubject: type: string transmittalNumber: type: string changeRequest: type: string postDate: type: string effectiveDate: type: string docImpDate: type: string rescinded: type: string replacedBy: type: string relatedDocName: type: string retroactiveFlag: type: string healthCareTypes: type: string specialities: type: string ascFlag: type: string fileName: type: string code: type: string securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT x-refined-from: - optum-cms-common-facility-openapi.yml - optum-cms-common-physician-openapi.yml x-readme: explorer-enabled: true proxy-enabled: true