1. REST API for Oracle Clinical One PlatformREST API for Clinical One Platform
  2. Use cases
  3. Integrate data into Clinical One via Digital Gateway
  4. Construct ODM
  5. IRTData payload reference

IRTData payload reference

The request body is expected to be data wrapped in an <IRTData> element, in the ODM XML format. Each external IWR system can choose to fit a specific payload type to map IRTData into Oracle Clinical One Platform.

There are two different payload types used to map data into Clinical One via Digital Gateway: REFNAME mapping and GUID mapping.

Note:

According to the payload type used, additional mappings may be required in the integration configuration in Digital Gateway.
  • If the IRTData payload uses reference codes (REFNAME mapping), the integration configuration file in Digital Gateway must have GUID mappings for these.
  • If the IRTData payload uses GUID mapping, those mappings don't need to be redefined in the integration configuration file.
XML Tag Purpose REFNAME mapping example GUID mapping example
EventType Type of event. This element defines what type of data is being sent and how the corresponding data is to be processed according to the integration configuration Screening Screening
StudyOID Unique Identifier for the study StudyABC StudyABC
LocationOID Site ID Site1000 Site GUID, i.e. 84EE8610B5E6466D9B7B64FE99F6606A
SubjectKey SubjectNumber (as expected to display on Clinical One UI) 1000-01 1000-01
StudyEventOID VisitName Scr Screening Visit GUID, i.e. 4D9ABE7BA9184AD99B799C90F196A77A
StudyEventRepeatKey Visit repeat key - This determines each instance of repeating visit uniquely
  • Null (or) visit repeat key as date in yyyy-MM-dd
  • If this value is sent as null for a repeating visit, the payload is expected to send an item that can be configured as Visit Start Date
  • Null for non-repeating visit.
  • Date in yyyy-MM-dd format for repeating visit
FormOID Form Name Demog Demography Form GUID, i.e. 808387D999134836B7B2C3CA6B007BAE
FormRepeatKey Form repeat key - This determines each instance of repeating form uniquely
  • Null or form repeat key from source
  • If this value is sent as null for a repeating form, the payload is expected to send an item that can be configured as primary key for the form.
  • Null for flat form
  • Repeat key for repeating form
ItemGroupOID Sectional Form Name Null (or) Name of sectional repeating form
  • Sectional flat form: ItemGroupOID must match FormOID
  • Sectional repeating form: Form Section GUID
ItemGroupRepeatKey Sectional repeating Form key - This determines each instance of sectional repeating form uniquely

Sectional flat form: Null

Sectional repeating form: Null or sectional form repeat key from source

If this value is sent as null for a sectional repeating form, the payload is expected to send an item that can be configured as primary key for the form.
  • Repeat key for sectional repeating form
  • Null otherwise
ItemOID Item Name itmDOB Date of Birth GUID, i.e. 2F6E5C889639439EBBC8A80D240E23F1
Value Item Value 01-Jan-1990 Values will be used as-is
  • Text: ABC
  • Date: send in target date format
  • Radio button
    • [{\"value\":\"1\"}]
  • Checkboxes
    • [{\"value\":\"1\"}]

      or

    • [{\"value\":\"1\"},{\"value\":\"2\"}]
<AuditRecord><ReasonForChange>Value Reason (Audit reason for data update) Null (or) update reason Null (or) update reason