Construct ODM

The external IWR system will make Rest API POST calls to ib-ext-svc with a request body. The request body is expected to be data wrapped in an <IRTData> element, in the ODM XML format.

An <IRTData> element is sent as the input data in the integration request. Each consists of a <ClinincalData> element, including the information to be mapped, and an <EventType> element that defines what kind of data is being sent.

• The event type allows integration to know how the corresponding data is to be processed according to the integration configuration.
• The <ClinicalData> element includes the ODM XML subject data and can consist of multiple <SubjectData> nodes.

You must construct your ODM according to your integration configuration, the event type and the clinical data you want to map. Additionally, each external IWR system can choose to fit one of two different patterns to map IRTData into Oracle Clinical One Platform:

REFNAME mapping	GUID mapping
The external IWR system sends OIDs from the source system. OIDs are sent as reference codes. Integration must be configured to map source to target as REFNAME mappings. Acceptable data transformations can be configured as well. Keys for repeating visits and forms can be used from the source or can be configured.	The external IWR system configures source-target static mappings on their end. OIDs are sent as Clinical One GUIDs. Ownership of mappings and data transformations remain with the external IWR system. Repeat keys and item values will be sent in target format. OIDs, repeat keys and items values will be used as-is.

For more information on IRTData payload types and mappings see IRTData payload reference.

See examples below for GUID and REFNAME mappings:

Tip:

You may use these examples as a base to construct your ODM. Make sure to replace each of these values with those relevant to your integration. You can include more or less items, forms, visits and <SubjectData> nodes, according to the data you want to integrate.

Example - IRTData sample using GUID mapping

<IRTData>
    <EventType>UnSchedVisit_RF</EventType>
    <ClinicalData>
        <SubjectData>
            <AuditRecord/>
            <Signature/>
            <InvestigatorRef/>
            <SiteRef>
                <LocationOID>84EE8610B5E6466D9B7B64FE99F6606A</LocationOID>
                <Name/>
            </SiteRef>
            <StudyEventData>
                <AuditRecord/>
                <Signature/>
                <FormData>
                    <AuditRecord/>
                    <Signature/>
                    <ArchiveLayoutRef/>
                    <ItemGroupData>
                        <AuditRecord/>
                        <Signature/>
                        <Items>
                            <ItemOID>2F6E5C889639439EBBC8A80D240E23F1</ItemOID>
                            <Value>2</Value>
                        </Items>
                        <Items>
                            <ItemOID>3F5F1602BF674D32AE4D9B18DA175CD2</ItemOID>
                            <Value>23</Value>
                        </Items>
                        <ItemGroupOID/>
                        <ItemGroupRepeatKey/>
                        <TransactionType/>
                    </ItemGroupData>
                    <FormOID>808387D999134836B7B2C3CA6B007BAE</FormOID>
                    <FormRepeatKey/>
                </FormData>
                <StudyEventOID>4D9ABE7BA9184AD99B799C90F196A77A</StudyEventOID>
                <StudyEventRepeatKey/>
            </StudyEventData>
            <SubjectKey>1238</SubjectKey>
            <TransactionType>INSERT</TransactionType>
            <Initials>ABC</Initials>
        </SubjectData>
        <StudyOID>6516CC36A0E949989021A22633177C90</StudyOID>
        <MetaDataVersionOID/>
    </ClinicalData>
</IRTData>

Example - IRTData sample using reference codes

<IRTData>
	<EventType>SubjectScreening</EventType>
	<ClinicalData>
		<SubjectData>
			<SiteRef>
				<LocationOID>Site1</LocationOID>
			</SiteRef>
			<StudyEventData>
				<FormData>
					<ItemGroupData>
						<Items>
							<AuditRecord>
								<ReasonForChange>
									<Value>Data update</Value>
								</ReasonForChange>
							</AuditRecord>
							<ItemOID>itmInitials</ItemOID>
							<Value>TST1</Value>
						</Items>
						<Items>
							<AuditRecord>
								<ReasonForChange>
									<Value>Data update</Value>
								</ReasonForChange>
							</AuditRecord>
							<ItemOID>itmDate</ItemOID>
							<Value>03-AUG-1988</Value>
						</Items>
						<ItemGroupOID>IG1</ItemGroupOID>
						<ItemGroupRepeatKey>1</ItemGroupRepeatKey>
					</ItemGroupData>
					<FormOID>ScrForm</FormOID>
					<FormRepeatKey>1</FormRepeatKey>
				</FormData>
				<StudyEventOID>ScrVisit</StudyEventOID>
				<StudyEventRepeatKey>1</StudyEventRepeatKey>
			</StudyEventData>
			<SubjectKey>1238</SubjectKey>
			<Initials>ABC</Initials>
		</SubjectData>
		<StudyOID>StudyABC</StudyOID>
	</ClinicalData>
</IRTData>