Jump to

• Request
• Response

V1.0

get

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/ehrdata/subjects/{subjectId}/visit/{eventId}/studyversion/{studyVersion}/{category}

Retrieves EHR Data for a particular subject and a visit. Fetches for the category provided, which can be any of the following:

• LABS
• MEDICAL
• MEDICATIONHISTORY
• VITALS
• DEMOGRAPHICS
• PROCEDURES

Request

Path Parameters

• category(required): string
  EHR category name can be any of these LABS, MEDICAL, MEDICATIONHISTORY, VITALS, DEMOGRAPHICS, PROCEDURES.

  Example:

  LABS

• eventId(required): string(uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example:

  2E4567890ABCDEF1234567890ABCDEF0

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  ABCDEF1234567890ABCDEF1234567890

• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example:

  1.0.0.0

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  AEBC7137B253422D8A23C8C12B8DF125

Query Parameters

• dictionaryIds: array[string]
  Values from codelist of specific choice

  Example:

  [
      "DCT1",
      "DCT2"
  ]

• endDateTime: string
  The end date until which you want to retrieve the data values.

  Example:

  2023-01-31

• eventInstanceNum: integer
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example:

  1

• limit: integer(int32)
  limit

  Example:

  100

• offset: integer(int32)
  offset

  Example:

  0

• siteId: string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

  Example:

  65DFE0E1F48C4097A0F6B1F7A1F9F8C8

• sortOrder: string
  Order of sorting for records. DESC by default

  Example:

  ASC

• startDateTime: string
  Date for which you want to retrieve the data values.

  Example:

  2023-01-01

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

EHR category data successfully retrieved with paginated result.

Body ()

Root Schema : OCCCategoryDataDto

Type: object

Represents a category of EHR data associated with a subject for a specific visit event in OCC. Contains the name of the EHR category and the list of category data records retrieved for the subject.

Show Source

• category: string
  The OCC EHR category type can be of LABS, MEDICAL, MEDICATIONHISTORY, VITALS, DEMOGRAPHICS, PROCEDURES.

  Example: LABS
• categoryData: object EHRCategoryDTO
  Represents a single record within an OCC EHR category, corresponding to measured or recorded clinical data at a point in time. Includes a list of the individual data points.

{
    "type":"object",
    "properties":{
        "category":{
            "type":"string",
            "description":"The OCC EHR category type can be of LABS, MEDICAL, MEDICATIONHISTORY, VITALS, DEMOGRAPHICS, PROCEDURES.",
            "example":"LABS"
        },
        "categoryData":{
            "$ref":"#/components/schemas/EHRCategoryDTO"
        }
    },
    "description":"Represents a category of EHR data associated with a subject for a specific visit event in OCC. Contains the name of the EHR category and the list of category data records retrieved for the subject."
}

Nested Schema : EHRCategoryDTO

Type: object

Represents a single record within an OCC EHR category, corresponding to measured or recorded clinical data at a point in time. Includes a list of the individual data points.

Show Source

• recordedData: object EHRRecordedDataDTO
  Stores the individual recorded EHR data values for a given measurement, with HDI identifier and clinical data attributes.
• recordedDate: string (date-time)
  The date/time clinical data was recorded for this EHR category record.

  Example: 2023-10-01T08:15:00Z

{
    "type":"object",
    "properties":{
        "recordedDate":{
            "type":"string",
            "description":"The date/time clinical data was recorded for this EHR category record.",
            "format":"date-time",
            "example":"2023-10-01T08:15:00Z"
        },
        "recordedData":{
            "$ref":"#/components/schemas/EHRRecordedDataDTO"
        }
    },
    "description":"Represents a single record within an OCC EHR category, corresponding to measured or recorded clinical data at a point in time. Includes a list of the individual data points."
}

Nested Schema : EHRRecordedDataDTO

Type: object

Stores the individual recorded EHR data values for a given measurement, with HDI identifier and clinical data attributes.

Show Source

• attributes: object EHRDataAttributesDTO
  Detailed attribute or measured value associated with an OCC EHR clinical record. Includes property name, value, units, codes and HDI identifier.
• hdiId: string
  Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.

  Example: D2E9219A568740A78CC570066F56C2D6

{
    "type":"object",
    "properties":{
        "hdiId":{
            "type":"string",
            "description":"Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.",
            "example":"D2E9219A568740A78CC570066F56C2D6"
        },
        "attributes":{
            "$ref":"#/components/schemas/EHRDataAttributesDTO"
        }
    },
    "description":"Stores the individual recorded EHR data values for a given measurement, with HDI identifier and clinical data attributes."
}

Nested Schema : EHRDataAttributesDTO

Type: object

Detailed attribute or measured value associated with an OCC EHR clinical record. Includes property name, value, units, codes and HDI identifier.

Show Source

• hdiId: string
  Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.

  Example: C091C9D975C44E87B8D417C3AC867A43
• name: string
  Canonical name of the measured property or attribute.

  Example: Hemoglobin
• occCodes: array occCodes
  OCC codes referencing controlled vocabulary/clinical mapping.
• parentName: string
  Parent name or grouping for this clinical property or attribute.

  Example: Lab Panel
• sourceUnit: string
  Original source unit for the measurement.

  Example: g/dL
• sourceValue: string
  Original source value for the measurement.

  Example: 13.7
• units: string
  Units for the measured property value.

  Example: g/dL
• values: array values
  Recorded values for this property.

{
    "type":"object",
    "properties":{
        "parentName":{
            "type":"string",
            "description":"Parent name or grouping for this clinical property or attribute.",
            "example":"Lab Panel"
        },
        "name":{
            "type":"string",
            "description":"Canonical name of the measured property or attribute.",
            "example":"Hemoglobin"
        },
        "values":{
            "type":"array",
            "description":"Recorded values for this property.",
            "example":[
                "13.7"
            ],
            "items":{
                "type":"string",
                "description":"Recorded values for this property.",
                "example":"[\"13.7\"]"
            }
        },
        "units":{
            "type":"string",
            "description":"Units for the measured property value.",
            "example":"g/dL"
        },
        "hdiId":{
            "type":"string",
            "description":"Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.",
            "example":"C091C9D975C44E87B8D417C3AC867A43"
        },
        "occCodes":{
            "type":"array",
            "description":"OCC codes referencing controlled vocabulary/clinical mapping.",
            "example":[
                "2.16.840.1.113883.5.50"
            ],
            "items":{
                "type":"string",
                "description":"OCC codes referencing controlled vocabulary/clinical mapping.",
                "example":"[\"2.16.840.1.113883.5.50\"]"
            }
        },
        "sourceUnit":{
            "type":"string",
            "description":"Original source unit for the measurement.",
            "example":"g/dL"
        },
        "sourceValue":{
            "type":"string",
            "description":"Original source value for the measurement.",
            "example":"13.7"
        }
    },
    "description":"Detailed attribute or measured value associated with an OCC EHR clinical record. Includes property name, value, units, codes and HDI identifier."
}

Nested Schema : occCodes

Type: array

OCC codes referencing controlled vocabulary/clinical mapping.

Show Source

• Array of: string
  OCC codes referencing controlled vocabulary/clinical mapping.

  Example: ["2.16.840.1.113883.5.50"]

{
    "type":"array",
    "description":"OCC codes referencing controlled vocabulary/clinical mapping.",
    "example":[
        "2.16.840.1.113883.5.50"
    ],
    "items":{
        "type":"string",
        "description":"OCC codes referencing controlled vocabulary/clinical mapping.",
        "example":"[\"2.16.840.1.113883.5.50\"]"
    }
}

Example:

[
    "2.16.840.1.113883.5.50"
]

Nested Schema : values

Type: array

Recorded values for this property.

Show Source

• Array of: string
  Recorded values for this property.

  Example: ["13.7"]

{
    "type":"array",
    "description":"Recorded values for this property.",
    "example":[
        "13.7"
    ],
    "items":{
        "type":"string",
        "description":"Recorded values for this property.",
        "example":"[\"13.7\"]"
    }
}

Example:

[
    "13.7"
]

Examples

Select an example Get EHR Data Example

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

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: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

  Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"object",
            "description":"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"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

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