CDISC-published OpenAPI for the USDM (Unified Study Definitions Model) study-definitions interface from the Digital Data Flow programme — create, update, read and version a study definition and search study designs. The repository describes it as a DDF emulation: a reference contract and implementation for the community rather than a CDISC-operated production service, so no baseURL is recorded.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/cdisc-usdm-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.1.0
info:
title: DDF USDM API
description: A simple TransCelerate Digital Data Flow (DDF) Study Definitions Repository
API.
version: 3.13.0
paths:
/v3/studyDefinitions:
post:
tags:
- Production
summary: Create a study
description: Create an entire study including all child element with a single
post
operationId: create_study_v3_studyDefinitions_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Wrapper-Input'
required: true
responses:
'201':
description: Successful Response
content:
application/json:
schema:
type: string
format: uuid
title: Response Create Study V3 Studydefinitions Post
'400':
description: Bad Request
status_code: string
detail: string
message: string
'401':
description: Unauthorized
status_code: string
detail: string
message: string
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/studyDefinitions/{studyId}:
put:
tags:
- Production
summary: Update a study
description: Update an entire study including all child element with a single
put
operationId: update_study_v3_studyDefinitions__studyId__put
parameters:
- name: studyId
in: path
required: true
schema:
type: string
title: Studyid
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Wrapper-Input'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: string
format: uuid
title: Response Update Study V3 Studydefinitions Studyid Put
'400':
status_code: string
detail: string
message: string
description: Bad Request
'401':
status_code: string
detail: string
message: string
description: Unauthorized
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Production
summary: Return a study
description: Return an entire study including all child elements
operationId: read_full_study_v3_studyDefinitions__studyId__get
parameters:
- name: studyId
in: path
required: true
schema:
type: string
title: Studyid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Wrapper-Output'
'400':
status_code: string
detail: string
message: string
description: Bad Request
'401':
status_code: string
detail: string
message: string
description: Unauthorized
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/studyDefinitions/{studyId}/history:
get:
tags:
- Production
summary: Returns the study history
description: Returns the history for the specified study
operationId: read_study_history_v3_studyDefinitions__studyId__history_get
parameters:
- name: studyId
in: path
required: true
schema:
type: string
title: Studyid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Wrapper-Output'
title: Response Read Study History V3 Studydefinitions Studyid History
Get
'400':
status_code: string
detail: string
message: string
description: Bad Request
'401':
status_code: string
detail: string
message: string
description: Unauthorized
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/v3/studyDesigns:
get:
tags:
- Production
summary: Study designs for a study
description: Returns all the study designs for a specified study.
operationId: search_study_design_v3_studyDesigns_get
parameters:
- name: studyId
in: query
required: true
schema:
type: string
format: uuid
title: Studyid
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
anyOf:
- $ref: '#/components/schemas/InterventionalStudyDesign-Output'
- $ref: '#/components/schemas/ObservationalStudyDesign-Output'
title: Response Search Study Design V3 Studydesigns Get
'400':
status_code: string
detail: string
message: string
description: Bad Request
'401':
status_code: string
detail: string
message: string
description: Unauthorized
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
Abbreviation-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
abbreviatedText:
type: string
minLength: 1
title: Abbreviatedtext
expandedText:
type: string
minLength: 1
title: Expandedtext
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Input'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Abbreviation
const: Abbreviation
title: Instancetype
type: object
required:
- id
- abbreviatedText
- expandedText
- instanceType
title: Abbreviation
Abbreviation-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
abbreviatedText:
type: string
minLength: 1
title: Abbreviatedtext
expandedText:
type: string
minLength: 1
title: Expandedtext
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Output'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Abbreviation
const: Abbreviation
title: Instancetype
type: object
required:
- id
- abbreviatedText
- expandedText
- instanceType
title: Abbreviation
Activity-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
previousId:
anyOf:
- type: string
- type: 'null'
title: Previousid
nextId:
anyOf:
- type: string
- type: 'null'
title: Nextid
childIds:
items:
type: string
type: array
title: Childids
default: []
definedProcedures:
items:
$ref: '#/components/schemas/Procedure-Input'
type: array
title: Definedprocedures
default: []
biomedicalConceptIds:
items:
type: string
type: array
title: Biomedicalconceptids
default: []
bcCategoryIds:
items:
type: string
type: array
title: Bccategoryids
default: []
bcSurrogateIds:
items:
type: string
type: array
title: Bcsurrogateids
default: []
timelineId:
anyOf:
- type: string
- type: 'null'
title: Timelineid
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Input'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Activity
const: Activity
title: Instancetype
type: object
required:
- id
- name
- instanceType
title: Activity
Activity-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
previousId:
anyOf:
- type: string
- type: 'null'
title: Previousid
nextId:
anyOf:
- type: string
- type: 'null'
title: Nextid
childIds:
items:
type: string
type: array
title: Childids
default: []
definedProcedures:
items:
$ref: '#/components/schemas/Procedure-Output'
type: array
title: Definedprocedures
default: []
biomedicalConceptIds:
items:
type: string
type: array
title: Biomedicalconceptids
default: []
bcCategoryIds:
items:
type: string
type: array
title: Bccategoryids
default: []
bcSurrogateIds:
items:
type: string
type: array
title: Bcsurrogateids
default: []
timelineId:
anyOf:
- type: string
- type: 'null'
title: Timelineid
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Output'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Activity
const: Activity
title: Instancetype
type: object
required:
- id
- name
- instanceType
title: Activity
Address-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
text:
anyOf:
- type: string
- type: 'null'
title: Text
lines:
items:
type: string
type: array
title: Lines
default: []
city:
anyOf:
- type: string
- type: 'null'
title: City
district:
anyOf:
- type: string
- type: 'null'
title: District
state:
anyOf:
- type: string
- type: 'null'
title: State
postalCode:
anyOf:
- type: string
- type: 'null'
title: Postalcode
country:
anyOf:
- $ref: '#/components/schemas/Code-Input'
- type: 'null'
instanceType:
type: string
enum:
- Address
const: Address
title: Instancetype
type: object
required:
- id
- instanceType
title: Address
Address-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
text:
anyOf:
- type: string
- type: 'null'
title: Text
lines:
items:
type: string
type: array
title: Lines
default: []
city:
anyOf:
- type: string
- type: 'null'
title: City
district:
anyOf:
- type: string
- type: 'null'
title: District
state:
anyOf:
- type: string
- type: 'null'
title: State
postalCode:
anyOf:
- type: string
- type: 'null'
title: Postalcode
country:
anyOf:
- $ref: '#/components/schemas/Code-Output'
- type: 'null'
instanceType:
type: string
enum:
- Address
const: Address
title: Instancetype
type: object
required:
- id
- instanceType
title: Address
AdministrableProduct-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
pharmacologicClass:
anyOf:
- $ref: '#/components/schemas/Code-Input'
- type: 'null'
administrableDoseForm:
$ref: '#/components/schemas/AliasCode-Input'
productDesignation:
$ref: '#/components/schemas/Code-Input'
sourcing:
anyOf:
- $ref: '#/components/schemas/Code-Input'
- type: 'null'
properties:
items:
$ref: '#/components/schemas/AdministrableProductProperty-Input'
type: array
title: Properties
default: []
identifiers:
items:
$ref: '#/components/schemas/AdministrableProductIdentifier-Input'
type: array
title: Identifiers
default: []
ingredients:
items:
$ref: '#/components/schemas/Ingredient-Input'
type: array
title: Ingredients
default: []
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Input'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- AdministrableProduct
const: AdministrableProduct
title: Instancetype
type: object
required:
- id
- name
- administrableDoseForm
- productDesignation
- instanceType
title: AdministrableProduct
AdministrableProduct-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
pharmacologicClass:
anyOf:
- $ref: '#/components/schemas/Code-Output'
- type: 'null'
administrableDoseForm:
$ref: '#/components/schemas/AliasCode-Output'
productDesignation:
$ref: '#/components/schemas/Code-Output'
sourcing:
anyOf:
- $ref: '#/components/schemas/Code-Output'
- type: 'null'
properties:
items:
$ref: '#/components/schemas/AdministrableProductProperty-Output'
type: array
title: Properties
default: []
identifiers:
items:
$ref: '#/components/schemas/AdministrableProductIdentifier-Output'
type: array
title: Identifiers
default: []
ingredients:
items:
$ref: '#/components/schemas/Ingredient-Output'
type: array
title: Ingredients
default: []
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Output'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- AdministrableProduct
const: AdministrableProduct
title: Instancetype
type: object
required:
- id
- name
- administrableDoseForm
- productDesignation
- instanceType
title: AdministrableProduct
AdministrableProductIdentifier-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
text:
type: string
title: Text
scopeId:
type: string
title: Scopeid
instanceType:
type: string
enum:
- AdministrableProductIdentifier
const: AdministrableProductIdentifier
title: Instancetype
type: object
required:
- id
- text
- scopeId
- instanceType
title: AdministrableProductIdentifier
AdministrableProductIdentifier-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
text:
type: string
title: Text
scopeId:
type: string
title: Scopeid
instanceType:
type: string
enum:
- AdministrableProductIdentifier
const: AdministrableProductIdentifier
title: Instancetype
type: object
required:
- id
- text
- scopeId
- instanceType
title: AdministrableProductIdentifier
AdministrableProductProperty-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
text:
type: string
title: Text
type:
$ref: '#/components/schemas/Code-Input'
quantity:
anyOf:
- $ref: '#/components/schemas/Quantity-Input'
- type: 'null'
instanceType:
type: string
enum:
- AdministrableProductProperty
const: AdministrableProductProperty
title: Instancetype
type: object
required:
- id
- name
- text
- type
- instanceType
title: AdministrableProductProperty
AdministrableProductProperty-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
text:
type: string
title: Text
type:
$ref: '#/components/schemas/Code-Output'
quantity:
anyOf:
- $ref: '#/components/schemas/Quantity-Output'
- type: 'null'
instanceType:
type: string
enum:
- AdministrableProductProperty
const: AdministrableProductProperty
title: Instancetype
type: object
required:
- id
- name
- text
- type
- instanceType
title: AdministrableProductProperty
Administration-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
duration:
$ref: '#/components/schemas/Duration-Input'
dose:
anyOf:
- $ref: '#/components/schemas/Quantity-Input'
- type: 'null'
route:
anyOf:
- $ref: '#/components/schemas/AliasCode-Input'
- type: 'null'
frequency:
anyOf:
- $ref: '#/components/schemas/AliasCode-Input'
- type: 'null'
administrableProductId:
anyOf:
- type: string
- type: 'null'
title: Administrableproductid
medicalDeviceId:
anyOf:
- type: string
- type: 'null'
title: Medicaldeviceid
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Input'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Administration
const: Administration
title: Instancetype
type: object
required:
- id
- name
- duration
- instanceType
title: Administration
Administration-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
duration:
$ref: '#/components/schemas/Duration-Output'
dose:
anyOf:
- $ref: '#/components/schemas/Quantity-Output'
- type: 'null'
route:
anyOf:
- $ref: '#/components/schemas/AliasCode-Output'
- type: 'null'
frequency:
anyOf:
- $ref: '#/components/schemas/AliasCode-Output'
- type: 'null'
administrableProductId:
anyOf:
- type: string
- type: 'null'
title: Administrableproductid
medicalDeviceId:
anyOf:
- type: string
- type: 'null'
title: Medicaldeviceid
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Output'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- Administration
const: Administration
title: Instancetype
type: object
required:
- id
- name
- duration
- instanceType
title: Administration
AliasCode-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
standardCode:
$ref: '#/components/schemas/Code-Input'
standardCodeAliases:
items:
$ref: '#/components/schemas/Code-Input'
type: array
title: Standardcodealiases
default: []
instanceType:
type: string
enum:
- AliasCode
const: AliasCode
title: Instancetype
type: object
required:
- id
- standardCode
- instanceType
title: AliasCode
AliasCode-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
standardCode:
$ref: '#/components/schemas/Code-Output'
standardCodeAliases:
items:
$ref: '#/components/schemas/Code-Output'
type: array
title: Standardcodealiases
default: []
instanceType:
type: string
enum:
- AliasCode
const: AliasCode
title: Instancetype
type: object
required:
- id
- standardCode
- instanceType
title: AliasCode
AnalysisPopulation-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
text:
type: string
title: Text
subsetOfIds:
items:
type: string
type: array
title: Subsetofids
default: []
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Input'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- AnalysisPopulation
const: AnalysisPopulation
title: Instancetype
type: object
required:
- id
- name
- text
- instanceType
title: AnalysisPopulation
AnalysisPopulation-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
text:
type: string
title: Text
subsetOfIds:
items:
type: string
type: array
title: Subsetofids
default: []
notes:
items:
$ref: '#/components/schemas/CommentAnnotation-Output'
type: array
title: Notes
default: []
instanceType:
type: string
enum:
- AnalysisPopulation
const: AnalysisPopulation
title: Instancetype
type: object
required:
- id
- name
- text
- instanceType
title: AnalysisPopulation
AssignedPerson-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Input'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
personName:
$ref: '#/components/schemas/PersonName-Input'
jobTitle:
type: string
title: Jobtitle
organizationId:
anyOf:
- type: string
- type: 'null'
title: Organizationid
instanceType:
type: string
enum:
- AssignedPerson
const: AssignedPerson
title: Instancetype
type: object
required:
- id
- name
- personName
- jobTitle
- instanceType
title: AssignedPerson
AssignedPerson-Output:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items:
$ref: '#/components/schemas/ExtensionAttribute-Output'
type: array
title: Extensionattributes
default: []
name:
type: string
minLength: 1
title: Name
label:
anyOf:
- type: string
- type: 'null'
title: Label
description:
anyOf:
- type: string
- type: 'null'
title: Description
personName:
$ref: '#/components/schemas/PersonName-Output'
jobTitle:
type: string
title: Jobtitle
organizationId:
anyOf:
- type: string
- type: 'null'
title: Organizationid
instanceType:
type: string
enum:
- AssignedPerson
const: AssignedPerson
title: Instancetype
type: object
required:
- id
- name
- personName
- jobTitle
- instanceType
title: AssignedPerson
BiomedicalConcept-Input:
properties:
id:
type: string
minLength: 1
title: Id
extensionAttributes:
items
# --- truncated at 32 KB (226 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cdisc/refs/heads/main/openapi/cdisc-usdm-api-openapi.yml