Two ways of finding the OpenClinica-ID's (OID's) for a rule
When you want to construct a rule for a CRF, you're going to need four ingredients:
- the OID of an event
- the OID of a CRF(-version) in that event
- the OID of an item-group in that CRF
- the OID of an item in that group
You can access this information via two completely different routes:
1: using the OpenClinica-application
2: using the StudyMetaData-file
If this is one of the first times you are using the OID's, choose the first option.
If you are familiar with XML-files and you can find your way around in your study, choose the second option.
Using the OpenClinica-application
This is the easy way to find OID's. It uses the OpenClinica-interface.
Login to OpenClinica and click on the Study-name which is in the top of your screen.
fig. 1: Click on the Study Name
In the screen that opens you see all the information about your Study. Scroll down to the bit with the Study-Events For this example we'll use EndOfStudy. Click on the magnifier-icon of this event. (fig. 2)
fig. 2: List Event Definitions
Now a screen opens, displaying information about the event and about the CRF's in that event. Here you can find your first ingredient: the OpenClinica ID (OID) of the StudyEvent, in this case SE_EOS (fig. 3). Write this down for later use. Then click on the magnifier-icon on the right of the CRF you want to use for your rule.
fig. 3: OID of an Event Definitions
In the screen that opens you see the CRF-details, including the OID of the CRF: F_TDSASIMPLERU (fig. 4). Again: write this down, because this is your second ingredient. Now click on the strange icon on the right to view the meta-data of the CRF.
fig. 4: OID of CRF version
This next screen gives you both the OID of the item and of the group this item belongs to: ingredients 3 and 4 (fig. 5)
fig. 5: OID's of both item and group
As described above you can now define the target for your rule:
<Target Context="OC_RULES_V1">SE_EOS.F_TDSASIMPLERU.IG_TDSAS_UNGROUPED.I_TDSAS_ABNORMALFINDINGSXTHORAX1</Target>
Using the StudyMetaData-file
Here's an alternative way to get the OID's. Login to OpenClinica as Study Director or Data Manager and click on "Tasks". Choose from the list that appears "Study setup", "View study".
fig. 6: Task menu: View Study
In the first line screen that appears (Download all of the OIDs needed for Data Import and Rules in the ODM XML File format by clicking here.) you find the link to the StudyMetaData-file
fig. 7: View Study, StudyMetaData-file
Clicking on this link will start the download of an XML file. You can open it, preferably in an XML-editor (fig. 8).
fig. 8: StudyMetaData-file: OID's
If you have looked at a StudyMetaData-file before, you will notice that this is just a simple version of it. For this example I threw out a few hundreds of lines and left only the relevant ones.
We are looking for four OID's and they come in pairs:
- in the StudyEventDef is a reference to the form
- in the ItemGroupDef is a reference to the items
In the red circles you'll find all the information you need to build your rule:
| Study event OID | : SE_EOS |
| CRF OID | : F_TDSASIMPLERU |
| Group OID | : IG_TDSAS_UNGROUPED |
| Item OID | : I_TDSAS_ABNORMALFINDINGSXTHORAX |
| I_TDSAS_ABNORMALFINDINGSXTHORAXSPEC |
Thus the target for your rule
would be :
<Target Context="OC_RULES_V1">SE_EOS.F_TDSASIMPLERU.IG_TDSAS_UNGROUPED.I_TDSAS_ABNORMALFINDINGSXTHORAX</Target>
You can now start writing your rules.
Other how-to-pages can be found here.
this page was last reviewed November 2014