openapi: 3.2.0 info: title: MedDRA API EUS SBX Details 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: Details paths: /api/detail: post: tags: - Details summary: Returns Details object for Term Code requestBody: content: application/json-patch+json: schema: $ref: '#/components/schemas/MedTypeDTO' application/json: schema: $ref: '#/components/schemas/MedTypeDTO' text/json: schema: $ref: '#/components/schemas/MedTypeDTO' application/*+json: schema: $ref: '#/components/schemas/MedTypeDTO' responses: '200': description: Ok content: application/json: schema: $ref: '#/components/schemas/detailsDTO' 400 v1: description: Failed Model Validation 400 v2: description: Failed Validation 400 v3: description: Language/Version Does Not exist 400 v4: description: Insufficient Authorization 400 v5: description: Internal Server Exception 400 v6: description: Invalid Input '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: postApiDetail x-operation-id-source: derived components: schemas: lltDTO: type: object properties: code: type: integer description: Term Code format: int32 ptcode: type: integer description: Parent PT Code format: int32 name: type: - string - 'null' description: Term Name current: type: - string - 'null' description: Term Currency jcurrency: type: - string - 'null' description: Term Currency for Japanese Language. scope: type: - string - 'null' description: Narrow or Broad scat: type: - string - 'null' description: SMQ category status: type: - string - 'null' description: SMQ Status Active inactive syns: type: - array - 'null' items: $ref: '#/components/schemas/synDTO' description: List of synonyms if the exist. Japanese additionalProperties: false description: Response Type for LLT mdhierDTO: type: object properties: lltcode: type: integer description: LLT Code format: int32 ptcode: type: integer description: PT Code format: int32 hltcode: type: integer description: HLT Code format: int32 hlgtcode: type: integer description: HLGT Code format: int32 soccode: type: integer description: SOC Code format: int32 lltname: type: - string - 'null' description: LLT Name ptname: type: - string - 'null' description: PT Name hltname: type: - string - 'null' description: HLT Name hlgtname: type: - string - 'null' description: HLGT Name socname: type: - string - 'null' description: SOC Name socabbrev: type: - string - 'null' description: SOC Abbreviation ptsoccode: type: integer description: Primary SOC code for this PT. format: int32 primarysocfg: type: - string - 'null' description: Y/N if this SOC Code is primary currency: type: - string - 'null' description: PT/LLT Currency jcurrency: type: - string - 'null' description: Japanese PT/LLT Currency syncode: type: - string - 'null' description: SYN(Synonym) Code. Japanese synname: type: - string - 'null' description: SYN(Synonym) Name. Japanese additionalProperties: false description: MedDRA Hiearchy Model synDTO: type: object properties: lltcode: type: integer description: Parent LLT Code. format: int32 code: type: integer description: Synonym Code. format: int32 name: type: - string - 'null' description: Synonym Name. additionalProperties: false description: Response Type for Synonym lltvDTO: type: object properties: code: type: integer description: Term Code format: int32 ptcode: type: integer description: Parent PT Code format: int32 name: type: - string - 'null' description: Term Name currency: type: - string - 'null' description: Term Currency jcurrency: type: - string - 'null' description: Term Currency for Japanese Language. scope: type: - string - 'null' description: Narrow or Broad scat: type: - string - 'null' description: SMQ category status: type: - string - 'null' description: SMQ Status Active inactive lsyn: type: - array - 'null' items: $ref: '#/components/schemas/synlDTO' description: List of synonyms if the exist. Japanese additionalProperties: false MedTypeDTO: required: - addlangs - bview - code - hlgtcode - hltcode - kana - lang - lltcode - pcode - ptcode - rsview - rtype - separator - smqcode - soccode - syncode - type - ver type: object properties: bview: type: string description: '[Required] Acceptible Browser Views SOC/SMQ' rsview: type: string description: '[Required] Acceptible Release views release' code: type: integer description: '[Required] for MedDRA Term or SMQ Code' format: int32 pcode: type: integer description: Parent Term Code format: int32 syncode: type: integer description: 'Used in Type API where return type = M. Synonym Code. Japanese only.' format: int32 lltcode: type: integer description: 'Used in Type API where return type = M. LLT Code.' format: int32 ptcode: type: integer description: 'Used in Type API where return type = M. PT Code.' format: int32 hltcode: type: integer description: 'Used in Type API where return type = M. HLT Code.' format: int32 hlgtcode: type: integer description: 'Used in Type API where return type = M. HLGT Code.' format: int32 soccode: type: integer description: 'Used in Type API where return type = M. SOC Code.' format: int32 smqcode: type: integer description: 'Used in Type API where return type = M or SE. SMQ Code.' format: int32 type: type: string description: '[Required] MedDRA type. See programmers guide for acceptible values. SOC/SMQ/HLGT/HLT/PT/LLT/SYN/MDHEIR' addlangs: type: array items: type: string description: 'Array for Additional translations to return. Refer to the Language API for valid inputs' rtype: type: string description: '[Required] MedDRA type. See programmers guide for acceptible values.' lang: type: string description: '[Required] Primary Language to Return.' ver: type: number description: '[Required] Release Version to use. Refer to Release API for valid Language/Version Combinations.' format: double kana: type: boolean description: Return of Japanese Kana Translation. separator: type: integer description: "Separator to use if selecting Additional Languages.\n0 = \" \" \n1 = \"\\n\"\n2 = \" | \"" format: int32 additionalProperties: false description: Model for Requesting Parents/Children/mdheir for Terms. synlDTO: type: object properties: lltcode: type: integer description: Parent LLT Code. format: int32 code: type: integer description: Synonym Code. format: int32 name: type: - string - 'null' description: Synonym Name. type: type: - string - 'null' description: Term Type. icon: type: - string - 'null' description: Term Icon. leaf: type: boolean description: is Leaf(has children). expanded: type: boolean description: Default expansion. additionalProperties: false description: Response Type for Synonym. smqtDTO: type: object properties: pcode: type: integer description: Parent Code if Available. format: int32 code: type: integer description: SMQ Code format: int32 name: type: - string - 'null' description: SMQ Name. type: type: - string - 'null' description: Type of Term SMQ/PT/LLT level: type: - string - 'null' description: SMQ Level. smqdescription: type: - string - 'null' description: SMQ Description. smqsource: type: - string - 'null' description: SMQ Source. smqnote: type: - string - 'null' description: SMQ Note. algorithm: type: - string - 'null' description: SMQ Algorithm. scope: type: - string - 'null' description: SMQ Scope status: type: - string - 'null' description: SMQ Status Active/Inactive. tstatus: type: - string - 'null' description: SMQ Status A/I. category: type: - string - 'null' description: SMQ Category. weight: type: - string - 'null' description: SMQ Weight. aversion: type: - string - 'null' description: Term Addition Version. lmversion: type: - string - 'null' description: Last Modified Version. child: $ref: '#/components/schemas/smqtDTO' additionalProperties: false description: Model for building SMQ Trees smqDTO: type: object properties: psmqcode: type: - integer - 'null' description: Parent SMQ code if Available. format: int32 code: type: integer description: SMQ Code. format: int32 smqname: type: - string - 'null' description: SMQ Name. smqlevel: type: integer description: SMQ Level. format: int32 smqdescription: type: - string - 'null' description: SMQ Description. smqsource: type: - string - 'null' description: SMQ Source. smqnote: type: - string - 'null' description: SMQ Note. meddraversion: type: - string - 'null' description: MedDRA Version. status: type: - string - 'null' description: SMQ Status A/I. smqalgorithm: type: - string - 'null' description: SMQ Algorithm. termcode: type: integer description: Term Code. format: int32 termlevel: type: integer description: Term Level. format: int32 termscope: type: - string - 'null' description: Term Scope. termcategory: type: - string - 'null' description: Term Category. termweight: type: - string - 'null' description: Term Weight. termstatus: type: - string - 'null' description: Term Status. termadditionversion: type: - string - 'null' description: Term Addition Version. termlastmodifiedversion: type: - string - 'null' description: Last Modified Version. pts: type: - array - 'null' items: $ref: '#/components/schemas/ptDTO' description: PT Children. llts: type: - array - 'null' items: $ref: '#/components/schemas/lltvDTO' description: LLT Children. smqs: type: - array - 'null' items: $ref: '#/components/schemas/smqDTO' description: SMQ Children. additionalProperties: false description: Response Type for SMQ treeuDTO: type: object properties: code: type: integer description: SMQ/PT/LLT Code. format: int32 name: type: - string - 'null' description: Term Translations type: type: - string - 'null' description: Term Type. active: type: - string - 'null' icon: type: - string - 'null' smqlevel: type: integer description: SMQ Level. format: int32 currency: type: - string - 'null' description: PT/LLT Currency jcurrency: type: - string - 'null' description: PT/LLT Currency leaf: type: boolean expanded: type: boolean child: $ref: '#/components/schemas/treeuDTO' additionalProperties: false ptDTO: type: object properties: code: type: integer description: PT Code format: int32 pcode: type: integer description: Parent Code HLT format: int32 ptsoccode: type: integer description: Primary SOC code for this PT. format: int32 name: type: - string - 'null' description: PT Name scope: type: - string - 'null' description: SMQ Scope Narrow or Broad current: type: - string - 'null' description: PT/LLT Currency status: type: - string - 'null' description: SMQ Status Active/Inactive scat: type: - string - 'null' description: SMQ category llts: type: - array - 'null' items: $ref: '#/components/schemas/lltDTO' description: Children LLTs. additionalProperties: false description: Response for PT type. detailsDTO: type: object properties: lang: type: - string - 'null' description: Details lang pcode: type: integer description: Parent Code for Term if Exists format: int32 code: type: integer description: Term Code format: int32 name: type: - string - 'null' description: Term Name syncode: type: - string - 'null' description: Synonymn Code if one Exists Japanese synname: type: - string - 'null' description: Synonymn Name if one Exists Japanese k1: type: - string - 'null' description: Kana translation 1 for Japanese k2: type: - string - 'null' description: Kana translation 2 for Japanese k3: type: - string - 'null' description: Kana translation 3 for Japanese type: type: - string - 'null' description: Term Type SOC/SMQ/HLGT/HLT/PT/LLT/SYN level: type: - string - 'null' description: SMQ Level smqdescription: type: - string - 'null' description: SMQ Description smqsource: type: - string - 'null' description: SMQ source smqnote: type: - string - 'null' description: SMQ Note algorithm: type: - string - 'null' description: SMQ Algorithm scope: type: - string - 'null' description: SMQ Scope Narrow/Broad status: type: - string - 'null' description: SMQ Status Active/Inactive tstatus: type: - string - 'null' description: Term Status for SMQ Details category: type: - string - 'null' description: SMQ Category weight: type: - string - 'null' description: SMQ Weight aversion: type: - string - 'null' description: SMQ Term Added Version lmversion: type: - string - 'null' description: SMQ Term Last Modified Version. currency: type: - string - 'null' description: MedDRA Currency jcurrency: type: - string - 'null' description: Japanese LLT Currency mds: type: - array - 'null' items: $ref: '#/components/schemas/mdhierDTO' description: mdhier Views are returned for Term Type SOC/HLGT/HLT/PT/LLT/SYN tsocs: type: - array - 'null' items: $ref: '#/components/schemas/treeuDTO' description: Trees for SOC view smq: type: - array - 'null' items: $ref: '#/components/schemas/smqDTO' description: SMQ List. tsmqs: type: - array - 'null' items: $ref: '#/components/schemas/smqtDTO' description: SMQ TreeViews. additionalProperties: false description: Model for Retrieving Details for a Term securitySchemes: oauth2: type: oauth2 flows: implicit: authorizationUrl: https://mid.meddra.org/connect/authorize scopes: meddraapi: Meddra API - full access