openapi: 3.2.0 info: title: NCI EVS Rest Concept endpoints API description: Endpoints to support searching, metadata, and content retrieval for EVS terminologies. To learn more about how to interact with this api, see the Github evsrestapi-client-SDK project. termsOfService: https://evs.nci.nih.gov/ftp1/NCI_Thesaurus/ThesaurusTermsofUse.htm contact: name: NCI EVS email: NCIAppSupport@nih.gov version: 2.4.1.RELEASE servers: - url: / tags: - name: Concept endpoints paths: /api/v1/concept/{terminology}: get: tags: - Concept endpoints summary: Get concepts specified by list parameter operationId: getConcepts parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information.' required: false schema: type: string example: minimal - name: list in: query description: List (comma-separated) of codes to return concepts for, e.g. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestException' '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}: get: tags: - Concept endpoints summary: Get the concept for the specified terminology and code operationId: getConcept parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. required: true schema: type: string - name: limit in: query description: If set to an integer (between 1 and 100), elements of the concept should be limited to that specified number of entries. Thus a user interface can quickly retrieve initial data for a concept (even with include=full) and then call back for more data. An extra placeholder entry with just a ct field will be included to indicate the total count. required: false schema: type: integer format: int32 example: 100 - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information.' required: false schema: type: string example: summary - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestException' '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/subtree: get: tags: - Concept endpoints summary: Get the entire subtree from the root node to the specified code operationId: getSubtree parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: limit in: query description: If set to an integer (between 1 and 100), subtrees and siblings at each level will be limited to the specified number of entries. Thus a user interface can quickly retrieve initial data for a subtree and then call back for more data. An extra placeholder entry with just a ct field will be included to indicate the total count. required: false schema: type: integer format: int32 example: 100 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/HierarchyNode' /api/v1/concept/{terminology}/{code}/subtree/children: get: tags: - Concept endpoints summary: Get the entire subtree from the root node to the specified code operationId: getSubtreeChildren parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: limit in: query description: If set to an integer (between 1 and 100), children will be limited to the specified number of entries. Thus a user interface can quickly retrieve initial data for a subtree and then call back for more data. An extra placeholder entry with just a ct field will be included to indicate the total count. required: false schema: type: integer format: int32 example: 100 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/HierarchyNode' /api/v1/concept/{terminology}/{code}/roles: get: tags: - Concept endpoints summary: Get roles for the specified terminology and code operationId: getRoles_1 parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' /api/v1/concept/{terminology}/{code}/pathsToRoot: get: tags: - Concept endpoints summary: Get paths to the hierarchy root from the specified code operationId: getPathsToRoot parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case. Any value other than ''minimal'' may produce very large payload results. ' required: false schema: type: string example: minimal - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 100 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/pathsToAncestor/{ancestorCode}: get: tags: - Concept endpoints summary: Get paths from the specified code to the specified ancestor code operationId: getPathsToAncestor parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: ancestorCode in: path description: Ancestor code of the other specified code, e.g. 'C2991' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case. Any value other than ''minimal'' may produce very large payload results. ' required: false schema: type: string example: minimal - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 100 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/pathsFromRoot: get: tags: - Concept endpoints summary: Get paths from the hierarchy root to the specified concept operationId: getPathsFromRoot parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information. For this call, it is recommended to avoid using this parameter unless you need it for a specific use case. Any value other than ''minimal'' may produce very large payload results. ' required: false schema: type: string example: minimal - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 100 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/parents: get: tags: - Concept endpoints summary: Get parent concepts for the specified terminology and code operationId: getParents parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/maps: get: tags: - Concept endpoints summary: Get maps for the specified terminology and code operationId: getMaps parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Mapping' /api/v1/concept/{terminology}/{code}/inverseRoles: get: tags: - Concept endpoints summary: Get inverse roles for the specified terminology and code operationId: getInverseRoles parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' /api/v1/concept/{terminology}/{code}/inverseAssociations: get: tags: - Concept endpoints summary: Get inverse associations for the specified terminology and code operationId: getInverseAssociations parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Association' /api/v1/concept/{terminology}/{code}/history: get: tags: - Concept endpoints summary: Get history for the specified terminology and code operationId: getHistory parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit and ncim. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/disjointWith: get: tags: - Concept endpoints summary: Get "disjoint with" info for the specified terminology and code operationId: getDisjointWith parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3910' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/DisjointWith' /api/v1/concept/{terminology}/{code}/descendants: get: tags: - Concept endpoints summary: Get descendant concepts for the specified terminology and code operationId: getDescendants parameters: - name: terminology in: path description: Terminology, e.g. 'ncit'' required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. 'C3224' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 50000 - name: maxLevel in: query description: Max level of results to return required: false schema: type: integer format: int32 example: 10000 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/children: get: tags: - Concept endpoints summary: Get child concepts for the specified terminology and code operationId: getChildren parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/{code}/associations: get: tags: - Concept endpoints summary: Get the associations for the specified terminology and code operationId: getAssociations_1 parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' or 'ncim' (See here for complete list) required: true schema: type: string example: ncit - name: code in: path description: Code in the specified terminology, e.g. required: true schema: type: string - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Association' /api/v1/concept/{terminology}/subsetMembers/{code}: get: tags: - Concept endpoints summary: Get subset members for the specified terminology and code description: This endpoint will be deprecated in v2 in favor of a top level subset member endpoint. operationId: getSubsetMembers_1 parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 10000 - name: code in: path description: Code for a subset concept in the specified terminology, e.g. 'C157225' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information.' required: false schema: type: string example: minimal - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/roots: get: tags: - Concept endpoints summary: Get root concepts for the specified terminology operationId: getRoots parameters: - name: terminology in: path description: Terminology, e.g. 'ncit'. This call is only meaningful for ncit. required: true schema: type: string example: ncit - name: include in: query description: 'Indicator of how much data to return. Comma-separated list of any of the following values: minimal, summary, full, associations, children, definitions, disjointWith, history, inverseAssociations, inverseRoles, maps, parents, properties, roles, synonyms. See here for detailed information.' required: false schema: type: string example: minimal - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: $ref: '#/components/schemas/Concept' /api/v1/concept/{terminology}/codes: get: tags: - Concept endpoints summary: Get all codes for the specified terminology operationId: getAllCodesForTerminology parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '200': description: Successfully retrieved the requested information content: application/json: schema: type: array items: type: string '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' /api/v1/concept/{terminology}/associations/{codeOrLabel}: get: tags: - Concept endpoints summary: Get the association entries for the specified terminology and code. operationId: getAssociationEntries parameters: - name: terminology in: path description: Terminology, e.g. 'ncit' required: true schema: type: string example: ncit - name: codeOrLabel in: path description: Code/label in the specified terminology, e.g. 'A5' or 'Has_Salt_Form' for ncit. This call is only meaningful for ncit. required: true schema: type: string - name: fromRecord in: query description: Start index of the search results required: false schema: type: integer format: int32 example: 0 - name: pageSize in: query description: Max number of results to return required: false schema: type: integer format: int32 example: 10 - name: X-EVSRESTAPI-License-Key in: header description: Required license information for restricted terminologies. See here for detailed information. required: false schema: type: string responses: '417': description: Expectation failed content: application/json: schema: $ref: '#/components/schemas/RestException' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/RestException' '200': description: Successfully retrieved the requested information content: application/json: schema: $ref: '#/components/schemas/AssociationEntryResultList' components: schemas: DisjointWith: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Relationship code type: type: string description: Relationship type relatedCode: type: string description: Related code (the code on the other side of the relationship) relatedName: type: string description: Preferred name of the related code source: type: string description: Relationship source group: type: string description: Role group number for grouping related roles highlight: type: string description: Used by search calls to provide information for highlighting a view of results qualifiers: type: array description: Type/value qualifiers on the relationship items: $ref: '#/components/schemas/Qualifier' description: Represents an assertion of disjointness between two concepts Mapping: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 mapsetCode: type: string source: type: string description: Terminology of the source code, e.g. 'ncit' sourceName: type: string description: Preferred name of the source code sourceTermType: type: string description: Term type of the source code sourceCode: type: string description: Source code of the map (the thing being mapped 'from') sourceTerminology: type: string description: Human-readable label for the terminology of the source code, e.g. 'NCI Thesaurus' sourceTerminologyVersion: type: string description: Terminology version of the source code sourceLoaded: type: boolean description: Indicates whether the source code terminology/version is currently loaded type: type: string rank: type: string group: type: string rule: type: string target: type: string description: Terminology of the target code, e.g. 'ncit' targetName: type: string targetTermType: type: string targetCode: type: string description: Target code of the map (the thing being mapped 'to') targetTerminology: type: string description: Human-readable label for the terminology of the target code, e.g. 'NCI Thesaurus' targetTerminologyVersion: type: string description: Terminology version of the target code targetLoaded: type: boolean description: Indicates whether the target terminology/version is currently loaded sortKey: type: string targetTermGroup: type: string writeOnly: true description: Represents a map from a concept to concepts in other terminologies Role: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Relationship code type: type: string description: Relationship type relatedCode: type: string description: Related code (the code on the other side of the relationship) relatedName: type: string description: Preferred name of the related code source: type: string description: Relationship source group: type: string description: Role group number for grouping related roles highlight: type: string description: Used by search calls to provide information for highlighting a view of results qualifiers: type: array description: Type/value qualifiers on the relationship items: $ref: '#/components/schemas/Qualifier' description: Represents a (logically) defining relationship between two concepts Property: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string type: type: string description: Property type value: type: string description: Property value highlight: type: string description: Used by search calls to provide information for highlighting a view of results qualifiers: type: array description: Type/value qualifiers on the property items: $ref: '#/components/schemas/Qualifier' source: type: string description: Property source description: Represents a type/value property on a concept Extensions: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 isDisease: type: boolean isDiseaseGrade: type: boolean isDiseaseStage: type: boolean isMainType: type: boolean isSubtype: type: boolean isBiomarker: type: boolean isReferenceGene: type: boolean mainMenuAncestors: type: array items: $ref: '#/components/schemas/Paths' description: Generally unset, this is used for certain special cases HierarchyNode: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Code of the hierarchy node label: type: string description: Code label for the hierarchy node level: type: integer description: Indicates level of depth in the (respective) hierarchy format: int32 leaf: type: boolean description: Indicates whether the code has children expanded: type: boolean description: Indicates whether the node has been expanded children: type: array description: Child nodes items: $ref: '#/components/schemas/HierarchyNode' description: Represents a node in a subtree rendering of the hierarchy SearchCriteria: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 term: type: string description: Search term, e.g. 'heart', or 'C3224' type: type: string description: 'The match type, one of: contains, match, startsWith, phrase, AND, OR, fuzzy' include: type: string description: Include parameter value, e.g. 'minimal', 'summary', 'synonyms,properties,children' sort: type: string description: Sort field ascending: type: boolean description: Indicates whether sort is ascending (true), descending (false), or not specified (null) fromRecord: type: integer description: Start index of the search results format: int32 pageSize: type: integer description: Max number of results to return format: int32 conceptStatus: type: array description: Comma-separated list of concept status values to restrict search results by items: type: string description: Comma-separated list of concept status values to restrict search results by property: type: array description: Comma-separated list of properties to restrict search results by items: type: string description: Comma-separated list of properties to restrict search results by value: type: string description: A property value to restrict search results by synonymSource: type: array description: Comma-separated list of synonym sources to restrict search results by items: type: string description: Comma-separated list of synonym sources to restrict search results by synonymType: type: array description: Comma-separated list of synonym types to restrict search results by items: type: string description: Comma-separated list of synonym types to restrict search results by definitionSource: type: array description: Comma-separated list of definition sources to restrict search results by items: type: string description: Comma-separated list of definition sources to restrict search results by definitionType: type: array description: Comma-separated list of definition types to restrict search results by items: type: string description: Comma-separated list of definition types to restrict search results by synonymTermType: type: array description: Comma-separated list of synonym term types to restrict search results by items: type: string description: Comma-separated list of synonym term types to restrict search results by subset: type: array description: Comma-separated list of subsets to restrict search results by, e.g. 'C157225' items: type: string description: Comma-separated list of subsets to restrict search results by, e.g. 'C157225' codeList: type: array description: Comma-separated list of concept codes to restrict search results by, e.g. 'C157225' items: type: string description: Comma-separated list of concept codes to restrict search results by, e.g. 'C157225' terminology: type: array description: Comma-separated list of terminologies to search items: type: string description: Comma-separated list of terminologies to search sparql: type: string description: SPARQL query, only available as an output parameter description: Criteria for a search or find operation History: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Code for this history record name: type: string description: Last known preferred name for the code action: type: string description: Indicates the history action, e.g. 'merge', 'active', 'retire', 'SY', 'RB', etc. date: type: string description: Date of the history record replacementCode: type: string description: Code replacing this code replacementName: type: string description: Preferred name of the code replacing this code description: Represents a history record, generally for a retired concept Definition: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 definition: type: string description: Text definition value highlight: type: string description: Used by search calls to provide information for highlighting a view of results code: type: string description: Definition code type: type: string description: Definition type source: type: string description: Definition source qualifiers: type: array description: Type/value qualifiers on the definition items: $ref: '#/components/schemas/Qualifier' description: Represents a text definition for a concept Synonym: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 name: type: string description: Name for a concept highlight: type: string description: Used by search calls to provide information for highlighting a view of results termType: type: string description: Synonym term type type: type: string description: Synonym type typeCode: type: string description: Synonym Type code source: type: string description: Synonym source code: type: string description: Code of the synonym, used in particular for Metathesaurus data where the source of the synonym is not the terminology itself subSource: type: string description: Synonym sub-source qualifiers: type: array description: Type/value qualifiers on the synonym items: $ref: '#/components/schemas/Qualifier' active: type: boolean description: Indicates whether the synonym is active description: Represents one of the (potentially many) names for a concept ConceptMinimal: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Code (unique identifier) for this meaning name: type: string description: Preferred name for the code terminology: type: string description: Terminology abbreviation, e.g. 'nci' version: type: string description: Terminology version, e.g. '23.11d' level: type: integer description: Level of depth in a hierarchy (when this object is used to represent an element in a path) format: int32 description: Represents minimal information about a concept in a terminology Paths: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 paths: type: array description: List of paths items: $ref: '#/components/schemas/Path' description: Represents a list of paths AssociationEntryResultList: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 total: type: integer description: Total nubmer of results (if paging is not considered) format: int64 timeTaken: type: integer description: Total time taken to compute the result format: int64 parameters: $ref: '#/components/schemas/SearchCriteria' associationEntries: type: array items: $ref: '#/components/schemas/AssociationEntry' Qualifier: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Qualifier code type: type: string description: Qualifier type value: type: string description: Qualifier value description: Represents a type/value qualifier on a concept element Concept: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Code (unique identifier) for this meaning name: type: string description: Preferred name for the code terminology: type: string description: Terminology abbreviation, e.g. 'nci' version: type: string description: Terminology version, e.g. '23.11d' level: type: integer description: Level of depth in a hierarchy (when this object is used to represent an element in a path) format: int32 highlight: type: string description: Used by search calls to provide information for highlighting a view of results subsetLink: type: string description: Link to download data for a subset, used when the concept represents subset metadata mapsetLink: type: string description: Metadata for downloading a mapset conceptStatus: type: string description: Status value for the concept, e.g. Retired_Concept source: type: string description: Associations from this concept to other ones leaf: type: boolean description: Indicates whether concept is a leaf node active: type: boolean description: Indicates whether the concept is active defining: type: boolean description: Indicates whether the concept is defining synonyms: type: array description: Synonyms, or all of the names for this concept, including the preferred name items: $ref: '#/components/schemas/Synonym' definitions: type: array description: Text definitions items: $ref: '#/components/schemas/Definition' properties: type: array description: Key/value properties items: $ref: '#/components/schemas/Property' children: type: array description: Child concepts in the hierarchy items: $ref: '#/components/schemas/Concept' parents: type: array description: Parent concepts in the hierarchy items: $ref: '#/components/schemas/Concept' descendants: type: array description: Descendant concepts in the hierarchy items: $ref: '#/components/schemas/Concept' qualifiers: type: array description: Qualifiers for use when a concept is used as a parent/child - to indicate RELA for NCIm-derived content items: $ref: '#/components/schemas/Qualifier' associations: type: array description: Associations from this concept to other ones items: $ref: '#/components/schemas/Association' inverseAssociations: type: array description: Associations to this concept from other ones items: $ref: '#/components/schemas/Association' roles: type: array description: Roles from this concept to other ones items: $ref: '#/components/schemas/Role' disjointWith: type: array description: Assertions of disjointness with respect to other concepts items: $ref: '#/components/schemas/DisjointWith' inverseRoles: type: array description: Roles to this concept from other ones items: $ref: '#/components/schemas/Role' history: type: array description: History records items: $ref: '#/components/schemas/History' maps: type: array description: Maps from this concept to concepts in other terminologies items: $ref: '#/components/schemas/Mapping' paths: $ref: '#/components/schemas/Paths' extensions: $ref: '#/components/schemas/Extensions' description: Represents a concept in a terminology RestException: type: object properties: timestamp: type: string format: date-time status: type: integer format: int32 error: type: string message: type: string path: type: string description: Payload for JSON error responses Path: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 direction: type: integer description: Direction of the map (1 means node-to-root, -1 means root-to-node) format: int32 concepts: type: array description: Concepts on the path items: $ref: '#/components/schemas/ConceptMinimal' description: Represents a path (or partial path) in a hierarchy Association: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Relationship code type: type: string description: Relationship type relatedCode: type: string description: Related code (the code on the other side of the relationship) relatedName: type: string description: Preferred name of the related code source: type: string description: Relationship source group: type: string description: Role group number for grouping related roles highlight: type: string description: Used by search calls to provide information for highlighting a view of results qualifiers: type: array description: Type/value qualifiers on the relationship items: $ref: '#/components/schemas/Qualifier' description: Represents a non-defining (in a logical sense) relationship between two concepts AssociationEntry: type: object properties: uri: type: string description: URI for this element in an rdf-based source file ct: type: integer description: Used to indicate the total amount of data in cases where a limit is being applied format: int32 code: type: string description: Code on the 'from' side of the association type: type: string description: Relationship type relatedCode: type: string description: Code on the 'to' side of the association relatedName: type: string description: Preferred name of the related code source: type: string description: Relationship source group: type: string description: Role group number for grouping related roles highlight: type: string description: Used by search calls to provide information for highlighting a view of results qualifiers: type: array description: Type/value qualifiers on the relationship items: $ref: '#/components/schemas/Qualifier' terminology: type: string description: Terminology abbreviation, e.g. 'nci' version: type: string description: Terminology version, e.g. '23.11d' association: type: string description: Type of relationship between code and related code name: type: string description: Preferred name of the code description: Represents an entry in a table of associations between two concepts