openapi: 3.2.0 info: title: MedDRA API EUS SBX Data Impact API description: Web API to access MedDRA Data contact: name: Web Admin url: http://www.meddra.org/ email: wadmin@meddra.org version: '1' security: - oauth2: - meddraapi tags: - name: DataImpact paths: /api/di: post: tags: - DataImpact summary: Returns Data Impacted between Versions requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/diDTO' application/json: schema: $ref: '#/components/schemas/diDTO' text/json: schema: $ref: '#/components/schemas/diDTO' application/*+json: schema: $ref: '#/components/schemas/diDTO' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/dirDTO' 200 type=1 lang=Japanese: description: dirjDTO 200 type=10 lang=Japanese: description: dirjDTO 200 type=1: description: dirDTO 200 type=10: description: dirDTO 400 v1: description: Failed Model Validation 400 v2: description: Language/Version Does Not exist 400 v3: description: Insufficient Authorization 400 v4: description: Invalid Input 400 v5: description: Internal Server Exception '401': description: Unauthorized Access '415': description: Unsupported Media Type '429': description: The throttling limit on this API has been exceeded. Please review the MedDRA API documentation on throttling limits. '500': description: Internal Server Error operationId: postApiDi x-operation-id-source: derived components: schemas: dirDTO: type: object properties: lang: type: - string - 'null' description: Language sver: type: - string - 'null' description: 'Starting Version to use. Refer to Release API for valid Language/Version Combinations.' ever: type: - string - 'null' description: 'Ending Version to use. Refer to Release API for valid Language/Version Combinations.' ssoc: type: boolean description: 'Include Secondary SOC Information:' lrows: type: integer description: 'The total number of rows uploaded:' format: int32 vrows: type: integer description: 'The number of valid rows processed:' format: int32 irows: type: integer description: 'The number of valid rows impacted:' format: int32 prows: type: number description: 'Percentage of valid records impacted by the version update:' format: double summary: type: - array - 'null' items: $ref: '#/components/schemas/dirrowDTO' description: Summary. promos: type: - array - 'null' items: $ref: '#/components/schemas/dipromoDTO' description: Promotions. demos: type: - array - 'null' items: $ref: '#/components/schemas/didemoDTO' description: Demotions. mllts: type: - array - 'null' items: $ref: '#/components/schemas/dimlltDTO' description: LLTs under different PTs. dicllts: type: - array - 'null' items: $ref: '#/components/schemas/diclltDTO' description: Comprehensive LLT Changes. discllts: type: - array - 'null' items: $ref: '#/components/schemas/disclltDTO' description: LLT (excl PT) Primary SOC Chg. dicpts: type: - array - 'null' items: $ref: '#/components/schemas/dicptDTO' description: PT Primary SOC Changes. dimtncs: type: - array - 'null' items: $ref: '#/components/schemas/dimtncDTO' description: MedDRA Term Name Changes. dimcss: type: - array - 'null' items: $ref: '#/components/schemas/dimcsDTO' description: MedDRA Code Switches. diccss: type: - array - 'null' items: $ref: '#/components/schemas/diccsDTO' description: Currency Changes. dihcs: type: - array - 'null' items: $ref: '#/components/schemas/dihcDTO' description: LLT and PT Hierarchy Changes. diies: type: - array - 'null' items: $ref: '#/components/schemas/diieDTO' description: Input Errors. additionalProperties: false description: 'Summary of the components of the Data Impact Report Response. Japanese Non-Japanese 0 - Term Name Changes for Japanese Translation 1 - Term Name Changes only for Japanese Kana 2 - Japanese Currency Changes 3 0 - Promotions(30) 4 1 - Demotions(40) 5 2 - LLT under different PTs(50) 6 3 - Comprehensive LLT Changes(55) 7 4 - LLT(excl PT) Prim SOC Changes(60) 8 5 - PT Primary SOC Changes(70) 9 6 - MedDRA LLT PT Text Changes(80) 10 7 - MedDRA Code Switches(85) 11 8 - Currency Changes(90) 12 9 - LLT and PT Hierarchy Changes Count(101) 13 10 - Count(101)' diccsDTO: type: object properties: lltc: type: - string - 'null' description: LLT Code. llt: type: - string - 'null' description: LLT Name English Translation. scurrent: type: - string - 'null' description: Start Version Currency. ecurrent: type: - string - 'null' description: End Version Currency. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'Currency Changes. Total Changes between selected versions.' dirowDTO: required: - c - r - t type: object properties: r: maxLength: 400 minLength: 0 type: string description: Row ID. t: maxLength: 400 minLength: 0 type: string description: LLT/PT Term. c: type: integer description: LLT/PT Code. format: int32 additionalProperties: false description: Row from import for Data Impact Report. diclltDTO: type: object properties: lltc: type: - string - 'null' description: LLT Code. llt: type: - string - 'null' description: LLT Name. sptc: type: - string - 'null' description: Start Version PT Code. spt: type: - string - 'null' description: Start Version PT Name. eptc: type: - string - 'null' description: End Version PT Code. ept: type: - string - 'null' description: End Version PT Name. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'Data Impact LLTs Changes. Total Changes between selected versions.' dihcDTO: type: object properties: ver: type: - string - 'null' description: Version. ct: type: - string - 'null' description: Change Type. level: type: - string - 'null' description: Level. code: type: - string - 'null' description: Term Code. name: type: - string - 'null' description: Term Name. phlt: type: - string - 'null' description: Primary HLT Name. phlgt: type: - string - 'null' description: Primary HLGT Name. psoc: type: - string - 'null' description: Primary SOC Name. ispsoc: type: - string - 'null' description: Is Primary SOC. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'LLT and PT Hierarchy Changes. Total Changes between selected versions.' dirrowDTO: type: object properties: title: type: - string - 'null' description: Report Title. tut: type: - string - 'null' description: Total Unique Terms between selected versions. impactc: type: - string - 'null' description: Impact on uploaded data count. rs: type: boolean description: Report Selected?. note: type: - string - 'null' description: Notes. rt: type: integer description: Report Type. format: int32 rts: type: - string - 'null' description: Report Type String. additionalProperties: false description: Rows for Data Impact Report. dimtncDTO: type: object properties: code: type: - string - 'null' description: Term Code. name: type: - string - 'null' description: Term Name. ename: type: - string - 'null' description: End Version Term Name. level: type: - string - 'null' description: Term Level. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'MedDRA Term Name Changes. Total Changes between selected versions.' dimlltDTO: type: object properties: lltc: type: - string - 'null' description: LLT Code. llt: type: - string - 'null' description: LLT Name English Translation. sptc: type: - string - 'null' description: Start Version PT Code. spt: type: - string - 'null' description: Start Version PT Name. eptc: type: - string - 'null' description: End Version PT Code. ept: type: - string - 'null' description: End Version PT Name. ecurrent: type: - string - 'null' description: Is End Version Curency. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'LLTs under different PTs. Total Changes between selected versions.' didemoDTO: type: object properties: code: type: - string - 'null' description: Demoted PT Code. pt: type: - string - 'null' description: Demoted PT Name Translation. eptc: type: - string - 'null' description: End Version PT Code. ept: type: - string - 'null' description: End Version PT Name. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'Data Impact Demotions. Total Changes between selected versions.' disclltDTO: type: object properties: ct: type: - string - 'null' description: Change Type. lltc: type: - string - 'null' description: LLT Code. llt: type: - string - 'null' description: LLT Name. sptc: type: - string - 'null' description: Start Version PT Code. spt: type: - string - 'null' description: Start Version PT Name. ssocc: type: - string - 'null' description: Start Version SOC Code. ssoc: type: - string - 'null' description: Start Version SOC Name. sisp: type: - string - 'null' description: Is Start Version Primary SOC Name . eptc: type: - string - 'null' description: End Version PT Code. ept: type: - string - 'null' description: End Version PT Name. esocc: type: - string - 'null' description: End Version SOC Code. esoc: type: - string - 'null' description: End Version SOC Name. eisp: type: - string - 'null' description: Is End Version Primary SOC Name. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'LLT (excl PT) SOC Changes. Total Changes between selected versions.' dipromoDTO: type: object properties: code: type: - string - 'null' description: Promoted LLT Code. llt: type: - string - 'null' description: Promoted LLT Name English Translation. sptc: type: - string - 'null' description: Start Version PT Code. spt: type: - string - 'null' description: Start Version PT Name. esocc: type: - string - 'null' description: End Version Primary SOC Code. esoc: type: - string - 'null' description: End Version Primary SOC Name. rowid: type: - string - 'null' description: Row ID from Import. ispsoc: type: - string - 'null' description: Is Primary SOC. additionalProperties: false description: 'Data Impact Promotions. Total Changes between selected versions.' dicptDTO: type: object properties: ct: type: - string - 'null' description: Change Type. sptc: type: - string - 'null' description: Start Version PT Code. spt: type: - string - 'null' description: Start Version PT Name. ssocc: type: - string - 'null' description: Start Version SOC Code. ssoc: type: - string - 'null' description: Start Version SOC Name. sisp: type: - string - 'null' description: Is Start Version Primary SOC Name . esocc: type: - string - 'null' description: End Version SOC Code. esoc: type: - string - 'null' description: End Version SOC Name. eisp: type: - string - 'null' description: Is End Version Primary SOC Name. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'PT Primary SOC Changes. Total Changes between selected versions.' diieDTO: type: object properties: rowid: type: - string - 'null' description: Row ID from Import. name: type: - string - 'null' description: Term Name. code: type: - string - 'null' description: Term Code. com: type: - string - 'null' description: Comment. additionalProperties: false description: 'Input Errors. Total Changes between selected versions.' diDTO: required: - dlang - dtype - ever - filters - force - lang - rows - ssoc - sver type: object properties: lang: type: string description: '[Required] Language.' dlang: type: string description: '[Required] Display Language.' sver: type: number description: '[Required] Starting Version to use. Refer to Release API for valid Language/Version Combinations.' format: double ever: type: number description: "[Required]\nEnding Version to use.\nRefer to Release API for valid Language/Version Combinations. \n888.8 supplemental view english only." format: double dtype: type: integer description: "Type of Data Impact to Return.\nOption 1 or 10 \n888.8 supplemental view english only.\n999.9 imo view english only." format: int32 ssoc: type: boolean description: '[Required] Include Secondary SOC Information True/False' force: type: boolean description: "[Required]\nfalse - the data validation will be run \n if no errors the data impact report will run\n if validation errors exist just the errors will return.\ntrue - the data impact will run wiether \n or not there is validation error." filters: type: array items: type: integer format: int32 description: Filter results to Specific SOC codes rows: type: array items: $ref: '#/components/schemas/dirowDTO' description: Imported Rows. additionalProperties: false description: Data Impact Report. dimcsDTO: type: object properties: sname: type: - string - 'null' description: Start Version Term Name. scode: type: - string - 'null' description: Start Version Term Code. slevel: type: - string - 'null' description: Start Version Term Level. ename: type: - string - 'null' description: End Version Term Name. ecode: type: - string - 'null' description: End Version Term Code. elevel: type: - string - 'null' description: End Version Term Level. rowid: type: - string - 'null' description: Row ID from Import. additionalProperties: false description: 'MedDRA Code Switches. Total Changes between selected versions.' securitySchemes: oauth2: type: oauth2 flows: implicit: authorizationUrl: https://mid.meddra.org/connect/authorize scopes: meddraapi: Meddra API - full access