Construct ODM using REFNAME mapping

You have two options when using Oracle Clinical One Platform study refnames in the payload. The first option requires the assistance of an Oracle Services Consultant; the second option does not.

Option #1: The integration looks into the integration template and uses the refnames to locate the question, then imports the data.

Note:
To use this approach, an Oracle Services Consultant must first map the source values to the target refnames in the integration template.

Reach out to your Oracle point of contact if you want to use this option for refname mapping in your integration.
Option #2: The integration looks directly into the Oracle Clinical One Platform design service, using the refnames to locate the question, then imports the data.
You don't need to configure an integration template to use this approach. As soon as you are ready to integrate data in your study, follow the workflow described below to get the necessary data and construct the ODM.

Workflow to retrieve refnames and construct the ODM

Retrieve the study ID and study version. See Get data to construct ODM and refer to Step 1 and Step 2.
Use the Study Design report to obtain the visit ID and the form and question refnames. For step-by-step instructions to generate a report in Oracle Clinical One Platform, see Run a report.

Note:
If you are testing the integration, be sure to use the report generated from the Testing environment. When you configure the production instance, use the report generated from production environment (Active mode).
1. Visit IDs can be located in the Visits & Events section under the Visit/Event ID column.
2. Form and question refnames can be located in the Forms section under the Reference Code column.
Construct the ODM with the obtained information.

Tip:
See the example below for REFNAME mappings. You may use this example 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.

Additional information

The refnames included in the incoming payload must match the refnames in the targeted study version. The integration job fails if refname matches are not found.
For visits within branches, the refname value must include the branch short name followed by the visit Short Name (visit ID) separated by a dot; for example, <BranchShortName>.<VisitShortName>.
- BranchShortName can be located in the Branches section of the report under the ID column.
When refname mapping is enabled, the C1UserCredentials are mandatory since the study design needs to be obtained for this functionality.

For more information on IRTData payload types and specific mapping examples see IRTData payload reference.

Example - IRTData sample using REFNAME mapping

<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>