REST API for Clinical One Platform

Root Schema : schema

Type: array

Show Source

Array of: object ClinicalData

List of clinical data subjects/visits/logs.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ClinicalData"
    }
}

Nested Schema : ClinicalData

Type: object

List of clinical data subjects/visits/logs.

Show Source

Annotations: array Annotations
AuditRecords: array AuditRecords
MetaDataVersionOID: string
Signatures: array Signatures
StudyOID: string
SubjectData: array SubjectData

{
    "type":"object",
    "properties":{
        "SubjectData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectData"
            }
        },
        "AuditRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecords"
            }
        },
        "Signatures":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signatures"
            }
        },
        "Annotations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotations"
            }
        },
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    },
    "description":"List of clinical data subjects/visits/logs.",
    "example":[
        {
            "subjectOID":"SUBJ1"
        }
    ]
}

Example:

[
    {
        "subjectOID":"SUBJ1"
    }
]

Nested Schema : Annotations

Type: array

Show Source

Array of: object Annotations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotations"
    }
}

Nested Schema : AuditRecords

Type: array

Show Source

Array of: object AuditRecords

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditRecords"
    }
}

Nested Schema : Signatures

Type: array

Show Source

Array of: object Signatures

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Signatures"
    }
}

Nested Schema : SubjectData

Type: array

Show Source

Array of: object SubjectData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectData"
    }
}

Nested Schema : Annotations

Type: object

Show Source

Annotation: array Annotation

{
    "type":"object",
    "properties":{
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : Annotation

Type: object

Show Source

Comment: object Comment

Annotation comment object
Flag: object Flag

Flags associated with this annotation
ID: string

Annotation identifier

Example: AN1
SeqNum: integer (int32)

Sequence number for annotation

Example: 1
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

Transaction type for annotation

Example: INSERT

{
    "type":"object",
    "properties":{
        "Comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "Flag":{
            "type":"object",
            "properties":{
                "FlagValue":{
                    "$ref":"#/components/schemas/FlagValue"
                },
                "FlagType":{
                    "$ref":"#/components/schemas/FlagType"
                }
            },
            "description":"Flags associated with this annotation",
            "example":[
                {
                    "flagOID":"FLAG1"
                }
            ]
        },
        "SeqNum":{
            "type":"integer",
            "description":"Sequence number for annotation",
            "format":"int32",
            "example":1
        },
        "TransactionType":{
            "type":"string",
            "description":"Transaction type for annotation",
            "example":"INSERT",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ID":{
            "type":"string",
            "description":"Annotation identifier",
            "example":"AN1"
        }
    }
}

Nested Schema : Comment

Type: object

Annotation comment object

Show Source

SponsorOrSite: string

Allowed Values: [ "SPONSOR", "SITE" ]
Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "SponsorOrSite":{
            "type":"string",
            "enum":[
                "SPONSOR",
                "SITE"
            ]
        }
    },
    "description":"Annotation comment object",
    "example":{
        "value":"Requires follow-up"
    }
}

Example:

{
    "value":"Requires follow-up"
}

Nested Schema : Flag

Type: object

Flags associated with this annotation

Show Source

FlagType: object FlagType
FlagValue: object FlagValue

{
    "type":"object",
    "properties":{
        "FlagValue":{
            "$ref":"#/components/schemas/FlagValue"
        },
        "FlagType":{
            "$ref":"#/components/schemas/FlagType"
        }
    },
    "description":"Flags associated with this annotation",
    "example":[
        {
            "flagOID":"FLAG1"
        }
    ]
}

Example:

[
    {
        "flagOID":"FLAG1"
    }
]

Nested Schema : FlagType

Type: object

Show Source

CodeListOID: string
Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : FlagValue

Type: object

Show Source

CodeListOID: string
Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : AuditRecords

Type: object

Show Source

AuditRecord: array AuditRecord

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecord"
            }
        }
    }
}

Nested Schema : AuditRecord

Type: array

Show Source

Array of: object AuditRecord

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditRecord"
    }
}

Nested Schema : AuditRecord

Type: object

Show Source

DateTimeStamp: object DateTimeStamp

Timestamp of signing
ID: string

Audit record identifier

Example: AUD1
LocationRef: object LocationRef

Reference to a study/site location for an ODM User.
ReasonForChange: object ReasonForChange

Reason for data change
SourceID: object SourceID

Source identifier
UserRef: object UserRef

Reference to user

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "ReasonForChange":{
            "$ref":"#/components/schemas/ReasonForChange"
        },
        "SourceID":{
            "$ref":"#/components/schemas/SourceID"
        },
        "ID":{
            "type":"string",
            "description":"Audit record identifier",
            "example":"AUD1"
        }
    }
}

Nested Schema : DateTimeStamp

Type: object

Timestamp of signing

Show Source

FormattedValue: string
Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "FormattedValue":{
            "type":"string"
        }
    },
    "description":"Timestamp of signing",
    "example":{
        "value":"2025-10-27T10:00:00Z"
    }
}

Example:

{
    "value":"2025-10-27T10:00:00Z"
}

Nested Schema : LocationRef

Type: object

Reference to a study/site location for an ODM User.

Show Source

LocationOID: string

OID/ID for the associated location.

Example: LOC101

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string",
            "description":"OID/ID for the associated location.",
            "example":"LOC101"
        }
    },
    "description":"Reference to a study/site location for an ODM User.",
    "example":{
        "locationOID":"LOC101"
    }
}

Example:

{
    "locationOID":"LOC101"
}

Nested Schema : ReasonForChange

Type: object

Reason for data change

Show Source

Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    },
    "description":"Reason for data change",
    "example":{
        "value":"Correction"
    }
}

Example:

{
    "value":"Correction"
}

Nested Schema : SourceID

Type: object

Source identifier

Show Source

Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    },
    "description":"Source identifier",
    "example":{
        "value":"SYS"
    }
}

Example:

{
    "value":"SYS"
}

Nested Schema : UserRef

Type: object

Reference to user

Show Source

UserOID: string

OID of the referenced user

Example: USER123

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string",
            "description":"OID of the referenced user",
            "example":"USER123"
        }
    },
    "description":"Reference to user",
    "example":{
        "userOID":"USER123"
    }
}

Example:

{
    "userOID":"USER123"
}

Nested Schema : Signatures

Type: object

Show Source

Signature: array Signature

{
    "type":"object",
    "properties":{
        "Signature":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signature"
            }
        }
    }
}

Nested Schema : Signature

Type: array

Show Source

Array of: object Signature

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Signature"
    }
}

Nested Schema : Signature

Type: object

Show Source

CryptoBindingManifest: object CryptoBindingManifest

Crypto binding manifest details
DateTimeStamp: object DateTimeStamp

Timestamp of signing
ID: string

Signature identifier

Example: SIG123
LocationRef: object LocationRef

Reference to a study/site location for an ODM User.
SignatureRef: object SignatureRef

Reference to signature
UserRef: object UserRef

Reference to user

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "SignatureRef":{
            "$ref":"#/components/schemas/SignatureRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "CryptoBindingManifest":{
            "$ref":"#/components/schemas/CryptoBindingManifest"
        },
        "ID":{
            "type":"string",
            "description":"Signature identifier",
            "example":"SIG123"
        }
    }
}

Nested Schema : CryptoBindingManifest

Type: object

Crypto binding manifest details

Show Source

Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    },
    "description":"Crypto binding manifest details",
    "example":{
        "manifestID":"CBM1"
    }
}

Example:

{
    "manifestID":"CBM1"
}

Nested Schema : SignatureRef

Type: object

Reference to signature

Show Source

SignatureOID: string

{
    "type":"object",
    "properties":{
        "SignatureOID":{
            "type":"string"
        }
    },
    "description":"Reference to signature",
    "example":{
        "refID":"SIGREF1"
    }
}

Example:

{
    "refID":"SIGREF1"
}

Nested Schema : SubjectData

Type: object

Show Source

Annotation: array Annotation
AuditRecord: object AuditRecord
Initials: string
InvestigatorRef: object InvestigatorRef
Signature: object Signature
SiteRef: object SiteRef
StudyEventData: array StudyEventData
SubjectHistory: array SubjectHistory
SubjectKey: string
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
TransferData: array TransferData

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "InvestigatorRef":{
            "$ref":"#/components/schemas/InvestigatorRef"
        },
        "SiteRef":{
            "$ref":"#/components/schemas/SiteRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "StudyEventData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventData"
            }
        },
        "SubjectKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Initials":{
            "type":"string"
        },
        "TransferData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferData"
            }
        },
        "SubjectHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : InvestigatorRef

Type: object

Show Source

UserOID: string

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string"
        }
    }
}

Nested Schema : SiteRef

Type: object

Show Source

LocationOID: string
Name: string

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        }
    }
}

Nested Schema : StudyEventData

Type: array

Show Source

Array of: object StudyEventData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StudyEventData"
    }
}

Nested Schema : SubjectHistory

Type: array

Show Source

Array of: object History

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/History"
    }
}

Nested Schema : TransferData

Type: array

Show Source

Array of: object TransferData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TransferData"
    }
}

Nested Schema : StudyEventData

Type: object

Show Source

Annotation: array Annotation
AuditRecord: object AuditRecord
EventHistory: array EventHistory
FormData: array FormData
RepeatingFormSummary: object RepeatingFormSummary
Signature: object Signature
StudyEventOID: string
StudyEventRepeatKey: string

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "FormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormData"
            }
        },
        "StudyEventOID":{
            "type":"string"
        },
        "StudyEventRepeatKey":{
            "type":"string"
        },
        "RepeatingFormSummary":{
            "$ref":"#/components/schemas/RepeatingFormSummary"
        },
        "EventHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : EventHistory

Type: array

Show Source

Array of: object History

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/History"
    }
}

Nested Schema : FormData

Type: array

Show Source

Array of: object FormData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormData"
    }
}

Nested Schema : RepeatingFormSummary

Type: object

Show Source

RepeatingFormData: array RepeatingFormData

{
    "type":"object",
    "properties":{
        "RepeatingFormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepeatingFormData"
            }
        }
    }
}

Nested Schema : History

Type: object

Show Source

action: string
actionDate: string (date-time)
details: array details

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string"
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "actionDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : details

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormData

Type: object

Show Source

Annotation: array Annotation
ArchiveLayoutRef: object ArchiveLayoutRef
AuditRecord: object AuditRecord
FormOID: string
FormRepeatKey: string
FormStatus: string
ItemGroupData: array ItemGroupData
NotDoneValue: string
Signature: object Signature
Signatures: object Signatures
Status: string
TitleAddendum: string
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "ArchiveLayoutRef":{
            "$ref":"#/components/schemas/ArchiveLayoutRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "ItemGroupData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupData"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormRepeatKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Status":{
            "type":"string"
        },
        "TitleAddendum":{
            "type":"string"
        },
        "FormStatus":{
            "type":"string"
        },
        "NotDoneValue":{
            "type":"string"
        },
        "Signatures":{
            "$ref":"#/components/schemas/Signatures"
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : ArchiveLayoutRef

Type: object

Show Source

ArchiveLayoutOID: string

{
    "type":"object",
    "properties":{
        "ArchiveLayoutOID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupData

Type: array

Show Source

Array of: object ItemGroupData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ItemGroupData"
    }
}

Nested Schema : ItemGroupData

Type: object

Show Source

Annotation: object Annotation

Annotations for the item group
AuditRecord: object AuditRecord
ItemGroupOID: string

OID for this item group

Example: IG1
ItemGroupRepeatKey: string

Repeat key for this group

Example: RPT1
Items: object Items

Contained item data list
Signature: object Signature
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

Transaction type for the group

Example: INSERT

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"object",
            "properties":{
                "Comment":{
                    "$ref":"#/components/schemas/Comment"
                },
                "Flag":{
                    "type":"object",
                    "properties":{
                        "FlagValue":{
                            "$ref":"#/components/schemas/FlagValue"
                        },
                        "FlagType":{
                            "$ref":"#/components/schemas/FlagType"
                        }
                    },
                    "description":"Flags associated with this annotation",
                    "example":[
                        {
                            "flagOID":"FLAG1"
                        }
                    ]
                },
                "SeqNum":{
                    "type":"integer",
                    "description":"Sequence number for annotation",
                    "format":"int32",
                    "example":1
                },
                "TransactionType":{
                    "type":"string",
                    "description":"Transaction type for annotation",
                    "example":"INSERT",
                    "enum":[
                        "INSERT",
                        "UPDATE",
                        "REMOVE",
                        "UPSERT",
                        "CONTEXT"
                    ]
                },
                "ID":{
                    "type":"string",
                    "description":"Annotation identifier",
                    "example":"AN1"
                }
            },
            "description":"Annotations for the item group",
            "example":[
                {
                    "annotationOID":"AN1"
                }
            ]
        },
        "Items":{
            "type":"object",
            "properties":{
                "AuditRecord":{
                    "$ref":"#/components/schemas/AuditRecord"
                },
                "Signature":{
                    "$ref":"#/components/schemas/Signature"
                },
                "MeasurementUnitRef":{
                    "$ref":"#/components/schemas/MeasurementUnitRef"
                },
                "Annotation":{
                    "type":"object",
                    "properties":{
                        "Comment":{
                            "$ref":"#/components/schemas/Comment"
                        },
                        "Flag":{
                            "type":"object",
                            "properties":{
                                "FlagValue":{
                                    "$ref":"#/components/schemas/FlagValue"
                                },
                                "FlagType":{
                                    "$ref":"#/components/schemas/FlagType"
                                }
                            },
                            "description":"Flags associated with this annotation",
                            "example":[
                                {
                                    "flagOID":"FLAG1"
                                }
                            ]
                        },
                        "SeqNum":{
                            "type":"integer",
                            "description":"Sequence number for annotation",
                            "format":"int32",
                            "example":1
                        },
                        "TransactionType":{
                            "type":"string",
                            "description":"Transaction type for annotation",
                            "example":"INSERT",
                            "enum":[
                                "INSERT",
                                "UPDATE",
                                "REMOVE",
                                "UPSERT",
                                "CONTEXT"
                            ]
                        },
                        "ID":{
                            "type":"string",
                            "description":"Annotation identifier",
                            "example":"AN1"
                        }
                    },
                    "description":"Annotations for this item",
                    "example":[
                        {
                            "id":"AN1"
                        }
                    ]
                },
                "ItemOID":{
                    "type":"string",
                    "description":"OID of the item",
                    "example":"ITM1"
                },
                "TransactionType":{
                    "type":"string",
                    "description":"Transaction type",
                    "example":"UPDATE",
                    "enum":[
                        "INSERT",
                        "UPDATE",
                        "REMOVE",
                        "UPSERT",
                        "CONTEXT"
                    ]
                },
                "ParentItemOID":{
                    "type":"string",
                    "description":"OID of parent item",
                    "example":"ITM_PARENT"
                },
                "NotDone":{
                    "type":"string",
                    "description":"Whether item is not done (0 or 1)",
                    "example":"0"
                },
                "SelectedCodeListItemsType":{
                    "type":"string",
                    "description":"Selected code list items type",
                    "example":"CODE_A"
                },
                "Value":{
                    "type":"string",
                    "description":"Value for this item",
                    "example":"130"
                },
                "DocumentId":{
                    "type":"string",
                    "description":"Document ID reference",
                    "example":"DOC1"
                },
                "DocumentVersion":{
                    "type":"number",
                    "description":"Document version",
                    "example":1
                }
            },
            "description":"Contained item data list",
            "example":[
                {
                    "itemOID":"ITM1"
                }
            ]
        },
        "ItemGroupOID":{
            "type":"string",
            "description":"OID for this item group",
            "example":"IG1"
        },
        "ItemGroupRepeatKey":{
            "type":"string",
            "description":"Repeat key for this group",
            "example":"RPT1"
        },
        "TransactionType":{
            "type":"string",
            "description":"Transaction type for the group",
            "example":"INSERT",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    }
}

Nested Schema : Annotation

Type: object

Annotations for the item group

Show Source

Comment: object Comment

Annotation comment object
Flag: object Flag

Flags associated with this annotation
ID: string

Annotation identifier

Example: AN1
SeqNum: integer (int32)

Sequence number for annotation

Example: 1
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

Transaction type for annotation

Example: INSERT

{
    "type":"object",
    "properties":{
        "Comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "Flag":{
            "type":"object",
            "properties":{
                "FlagValue":{
                    "$ref":"#/components/schemas/FlagValue"
                },
                "FlagType":{
                    "$ref":"#/components/schemas/FlagType"
                }
            },
            "description":"Flags associated with this annotation",
            "example":[
                {
                    "flagOID":"FLAG1"
                }
            ]
        },
        "SeqNum":{
            "type":"integer",
            "description":"Sequence number for annotation",
            "format":"int32",
            "example":1
        },
        "TransactionType":{
            "type":"string",
            "description":"Transaction type for annotation",
            "example":"INSERT",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ID":{
            "type":"string",
            "description":"Annotation identifier",
            "example":"AN1"
        }
    },
    "description":"Annotations for the item group",
    "example":[
        {
            "annotationOID":"AN1"
        }
    ]
}

Example:

[
    {
        "annotationOID":"AN1"
    }
]

Nested Schema : Items

Type: object

Contained item data list

Show Source

Annotation: object Annotation

Annotations for this item
AuditRecord: object AuditRecord
DocumentId: string

Document ID reference

Example: DOC1
DocumentVersion: number

Document version

Example: 1
ItemOID: string

OID of the item

Example: ITM1
MeasurementUnitRef: object MeasurementUnitRef

Measurement unit reference
NotDone: string

Whether item is not done (0 or 1)

Example: 0
ParentItemOID: string

OID of parent item

Example: ITM_PARENT
SelectedCodeListItemsType: string

Selected code list items type

Example: CODE_A
Signature: object Signature
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

Transaction type

Example: UPDATE
Value: string

Value for this item

Example: 130

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "MeasurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "Annotation":{
            "type":"object",
            "properties":{
                "Comment":{
                    "$ref":"#/components/schemas/Comment"
                },
                "Flag":{
                    "type":"object",
                    "properties":{
                        "FlagValue":{
                            "$ref":"#/components/schemas/FlagValue"
                        },
                        "FlagType":{
                            "$ref":"#/components/schemas/FlagType"
                        }
                    },
                    "description":"Flags associated with this annotation",
                    "example":[
                        {
                            "flagOID":"FLAG1"
                        }
                    ]
                },
                "SeqNum":{
                    "type":"integer",
                    "description":"Sequence number for annotation",
                    "format":"int32",
                    "example":1
                },
                "TransactionType":{
                    "type":"string",
                    "description":"Transaction type for annotation",
                    "example":"INSERT",
                    "enum":[
                        "INSERT",
                        "UPDATE",
                        "REMOVE",
                        "UPSERT",
                        "CONTEXT"
                    ]
                },
                "ID":{
                    "type":"string",
                    "description":"Annotation identifier",
                    "example":"AN1"
                }
            },
            "description":"Annotations for this item",
            "example":[
                {
                    "id":"AN1"
                }
            ]
        },
        "ItemOID":{
            "type":"string",
            "description":"OID of the item",
            "example":"ITM1"
        },
        "TransactionType":{
            "type":"string",
            "description":"Transaction type",
            "example":"UPDATE",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ParentItemOID":{
            "type":"string",
            "description":"OID of parent item",
            "example":"ITM_PARENT"
        },
        "NotDone":{
            "type":"string",
            "description":"Whether item is not done (0 or 1)",
            "example":"0"
        },
        "SelectedCodeListItemsType":{
            "type":"string",
            "description":"Selected code list items type",
            "example":"CODE_A"
        },
        "Value":{
            "type":"string",
            "description":"Value for this item",
            "example":"130"
        },
        "DocumentId":{
            "type":"string",
            "description":"Document ID reference",
            "example":"DOC1"
        },
        "DocumentVersion":{
            "type":"number",
            "description":"Document version",
            "example":1
        }
    },
    "description":"Contained item data list",
    "example":[
        {
            "itemOID":"ITM1"
        }
    ]
}

Example:

[
    {
        "itemOID":"ITM1"
    }
]

Nested Schema : Flag

Type: object

Flags associated with this annotation

Show Source

FlagType: object FlagType
FlagValue: object FlagValue

{
    "type":"object",
    "properties":{
        "FlagValue":{
            "$ref":"#/components/schemas/FlagValue"
        },
        "FlagType":{
            "$ref":"#/components/schemas/FlagType"
        }
    },
    "description":"Flags associated with this annotation",
    "example":[
        {
            "flagOID":"FLAG1"
        }
    ]
}

Example:

[
    {
        "flagOID":"FLAG1"
    }
]

Nested Schema : Annotation

Type: object

Annotations for this item

Show Source

Comment: object Comment

Annotation comment object
Flag: object Flag

Flags associated with this annotation
ID: string

Annotation identifier

Example: AN1
SeqNum: integer (int32)

Sequence number for annotation

Example: 1
TransactionType: string

Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

Transaction type for annotation

Example: INSERT

{
    "type":"object",
    "properties":{
        "Comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "Flag":{
            "type":"object",
            "properties":{
                "FlagValue":{
                    "$ref":"#/components/schemas/FlagValue"
                },
                "FlagType":{
                    "$ref":"#/components/schemas/FlagType"
                }
            },
            "description":"Flags associated with this annotation",
            "example":[
                {
                    "flagOID":"FLAG1"
                }
            ]
        },
        "SeqNum":{
            "type":"integer",
            "description":"Sequence number for annotation",
            "format":"int32",
            "example":1
        },
        "TransactionType":{
            "type":"string",
            "description":"Transaction type for annotation",
            "example":"INSERT",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ID":{
            "type":"string",
            "description":"Annotation identifier",
            "example":"AN1"
        }
    },
    "description":"Annotations for this item",
    "example":[
        {
            "id":"AN1"
        }
    ]
}

Example:

[
    {
        "id":"AN1"
    }
]

Nested Schema : MeasurementUnitRef

Type: object

Measurement unit reference

Show Source

MeasurementUnitOID: string

OID of the referenced measurement unit

Example: U1

{
    "type":"object",
    "properties":{
        "MeasurementUnitOID":{
            "type":"string",
            "description":"OID of the referenced measurement unit",
            "example":"U1"
        }
    },
    "description":"Measurement unit reference",
    "example":{
        "measurementUnitOID":"U1"
    }
}

Example:

{
    "measurementUnitOID":"U1"
}

Nested Schema : Flag

Type: object

Flags associated with this annotation

Show Source

FlagType: object FlagType
FlagValue: object FlagValue

{
    "type":"object",
    "properties":{
        "FlagValue":{
            "$ref":"#/components/schemas/FlagValue"
        },
        "FlagType":{
            "$ref":"#/components/schemas/FlagType"
        }
    },
    "description":"Flags associated with this annotation",
    "example":[
        {
            "flagOID":"FLAG1"
        }
    ]
}

Example:

[
    {
        "flagOID":"FLAG1"
    }
]

Nested Schema : RepeatingFormData

Type: array

Show Source

Array of: object RepeatingFormData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RepeatingFormData"
    }
}

Nested Schema : RepeatingFormData

Type: object

Show Source

FormHeader: array FormHeader
FormID: string
FormOID: string
Row: array Row
SummaryNote: string

{
    "type":"object",
    "properties":{
        "FormOID":{
            "type":"string"
        },
        "FormID":{
            "type":"string"
        },
        "FormHeader":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormHeader"
            }
        },
        "Row":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Row"
            }
        },
        "SummaryNote":{
            "type":"string"
        }
    }
}

Nested Schema : FormHeader

Type: array

Show Source

Array of: object FormHeader

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormHeader"
    }
}

Nested Schema : Row

Type: array

Show Source

Array of: object Row

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Row"
    }
}

Nested Schema : FormHeader

Type: object

Show Source

Itemset: boolean
ItemsetHeader: string
Name: string
OID: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetHeader":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Row

Type: object

Show Source

Associated: boolean
AssociatedFormList: array AssociatedFormList
Deleted: boolean
FormIndex: number
Item: array Item
RowNo: string

{
    "type":"object",
    "properties":{
        "AssociatedFormList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedFormList"
            }
        },
        "RowNo":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "Associated":{
            "type":"boolean"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Item":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Item"
            }
        }
    }
}

Nested Schema : AssociatedFormList

Type: array

Show Source

Array of: object AssociatedFormList

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedFormList"
    }
}

Nested Schema : Item

Type: array

Show Source

Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Item"
    }
}

Nested Schema : AssociatedFormList

Type: object

Show Source

AuditTrail: array AuditTrail
Deleted: boolean
FormIndex: number
FormName: string
FormOID: string
InstanceNumber: integer
VisitIndex: number
VisitName: string
VisitOID: string

{
    "type":"object",
    "properties":{
        "AuditTrail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTrail"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "FormName":{
            "type":"string"
        },
        "VisitOID":{
            "type":"string"
        },
        "VisitIndex":{
            "type":"number"
        },
        "VisitName":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "InstanceNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : AuditTrail

Type: array

Show Source

Array of: object AuditTrail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditTrail"
    }
}

Nested Schema : AuditTrail

Type: object

Show Source

DateTimeStamp: string
Deleted: boolean
Note: string
User: string

{
    "type":"object",
    "properties":{
        "DateTimeStamp":{
            "type":"string"
        },
        "User":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Note":{
            "type":"string"
        }
    }
}

Nested Schema : Item

Type: object

Show Source

Itemset: boolean
ItemsetRows: string
OID: string
Value: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetRows":{
            "type":"string"
        },
        "Value":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : TransferData

Type: object

Show Source

FromSiteName: string
ToSiteName: string
TransferDate: string

{
    "type":"object",
    "properties":{
        "FromSiteName":{
            "type":"string"
        },
        "ToSiteName":{
            "type":"string"
        },
        "TransferDate":{
            "type":"string"
        }
    }
}

Get Clinical Data which is part of ODMSubmit

Request

Response

200 Response