1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. EHR Data
  5. Add EHR Data for a particular subject and a visit

V1.0

put

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata

This API would act as upsert it would insert if the data is not present else it would update.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request payload for saving EHR data elements for a subject in a study visit event, including context and a list of EHR form data submissions.
Show Source
Nested Schema : ContextEhr
Type: object
Submission context for an EHR data operation, identifying the study, subject, event, and site details.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 2E4567890ABCDEF1234567890ABCDEF0
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: 65DFE0E1F48C4097A0F6B1F7A1F9F8C8
  • Minimum Length: 0
    Maximum Length: 100
    The user-friendly name of the study.
    Example: Clinical Study ABC
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 1.0.0.0
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: AEBC7137B253422D8A23C8C12B8DF125
  • Pass true if submitted data should be OCC validated, otherwise false.
    Example: false
Nested Schema : CoreDataEHRFormElementRequestDto
Type: object
Represents a form definition and set of core data elements to be submitted as part of an EHR save operation.
Show Source
  • CoreDataElementEhr
    Represents a single EHR data element instance submitted as part of a form with supporting metadata and identifiers.
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 85B29A9062BD4C8B9584E0907A37A84A
Nested Schema : CoreDataElementEhr
Type: object
Represents a single EHR data element instance submitted as part of a form with supporting metadata and identifiers.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Any general comments for the data element instance.
    Example: Measured after fasting
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: D9876543D9876543D9876543D9876543
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: C1234567C1234567C1234567C1234567
  • Primary uuid identifier for the data element instance (HEX, upper case).
    Example: C1234567C1234567C1234567C1234567
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Unit of measurement for this value (if applicable).
    Example: mg/dL
  • occCodes
    List of OCC codes associated with this data element instance.
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: F4443333F4443333F4443333F4443333
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Minimum Length: 0
    Maximum Length: 255
    Reason for this data entry/edit.
    Example: Other
  • Calendar date/time the data was originally recorded.
    Example: 2023-01-01T07:00:00Z
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 2
  • Source units for this value.
    Example: 258677007
  • Source value for this element as provided in upstream system.
    Example: 2024-08-26T14:57:36.039373-07:00
  • Transaction end date/time for this observation.
    Example: 2024-01-01T13:00:00Z
  • Transaction start date/time for this observation.
    Example: 2024-01-01T12:00:00Z
  • Minimum Length: 0
    Maximum Length: 4000
    Measured value captured for this data element.
    Example: 42.0
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: E5554444E5554444E5554444E5554444
  • Minimum Length: 0
    Maximum Length: 100
    Code supplied by vendor.
    Example: VENDOR42
Nested Schema : occCodes
Type: array
List of OCC codes associated with this data element instance.
Show Source
  • List of OCC codes associated with this data element instance.
    Example: ["2.16.840.1.113883.5.50"]
Example:
[
    "2.16.840.1.113883.5.50"
]
Examples

Back to Top

Response

Supported Media Types

200 Response

Subjects success.
Body ()
Root Schema : DataElementDto15
Type: object
Represents a single data element involved in an EHR form association request/response, with identifying and status fields.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for the data element change
    Example: Captured by device
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Date-time value in UTC
    Example: 2025-10-16T14:30:31.892Z
  • Day part of date
    Example: 16
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ADF5A7800A954FA5B831E7B6B9CA39A9
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Numeric decimal value
    Example: 12.34
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
  • Freeze status of the data element,can have Values NOT_APPLICABLE, FROZEN
    Example: FROZEN
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: D2E9219A568740A78CC570066F56C2D6
  • Hour part of time
    Example: 14
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.
    Example: DETAIL
  • The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.
    Example: FLAG
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
  • The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.
    Example: REASON
  • Type of item represented by this data element
    Example: TEXT
  • Minimum Length: 0
    Maximum Length: 64
    Measurement unit
    Example: mg/dL
  • Minute part of time
    Example: 30
  • Month part of date
    Example: 10
  • Identifier of normalized unit
    Example: A78AD8C31CD843CD8B847C06C0420FF5
  • Minimum Length: 0
    Maximum Length: 100
    Normalized value if applicable
    Example: 120
  • Numeric integer value
    Example: 120
  • Object version number used for concurrency control.
    Example: 14
  • Indicates the type of operation performed on a data element like update, clear, insert
    Example: insert
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: FEDCBA9876543210FEDCBA9876543210
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the data element change
    Example: Initial entry
  • Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.
    Example: 2
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
  • Identifier of root data element in UUID, 32-character uppercase hexadecimal string.
    Example: 1234567890ABCDEF1234567890ABCDEF
  • Second part of time
    Example: 31
  • Signature status of the data element, can have Values NOT_APPLICABLE, SIGNED
    Example: SIGNED
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Software version number
    Example: 14
  • Source timestamp for this data element version.
    Example: 2024-03-15T10:22:11Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Study name
    Example: STUDY-ABC
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: 10F75668189F422F9A461A315D211111
  • The date and time at which the transaction processing completed.
    Example: 2025-10-16T14:30:31.892Z
  • The date and time at which the transaction processing began.
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 32767
    Validation failure details if any
    Example: Incorrect values not allowed
  • Minimum Length: 0
    Maximum Length: 25
    Validation status of the data element. The validation status can be null or SUCCESS.
    Example: SUCCESS
  • Minimum Length: 0
    Maximum Length: 4000
    Raw value captured for the item
    Example: 120
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: 0123456789ABCDEF0123456789ABCDEF
  • Minimum Length: 0
    Maximum Length: 100
    Vendor code if provided
    Example: VENDOR1
  • Verification status of the data element can have Values NOT_APPLICABLE, VERIFIED
    Example: VERIFIED
  • End timestamp of the data element version
    Example: 2025-10-16T14:30:31.892Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Year part of date
    Example: 2025
Examples

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top