OpenMRS to OCL Mapping

This page illustrates how all fields in the OpenMRS v1.9 Concept Data Model map to OCL fields. This model is used during the import of the CIEL dictionary into OCL. It can also be used as a guide for OpenMRS implementers that are connecting to the OCL API.

OpenMRS v1.9 Concept Data Model

OpenMRS Wiki on the Concept Data Model

OpenMRS to OCL Maps

NOTE:

• Bolded fields are directly copied from OpenMRS
• Italicized fields are derived from the corresponding field in OpenMRS and are not directly copied
• Bolded and italicized fields are linked to the specified OpenMRS field via foreign key relationship
• ALL CAPS CODE represent the planned behavior but not yet implemented

OpenMRS Table	OpenMRS Field	OCL Field	Notes
concept_reference_source	uuid	source.external_id
concept_reference_source	name	source.full_name source.id source.short_code source.name
concept_reference_source	description	source.description
concept_reference_source	hl7_code	SOURCE.EXTRAS.HL7_CODE	Will be added
concept_reference_map	uuid	MAPPING.EXTERNAL_ID	Will be fixed in next import
concept_reference_map	concept_id	from_concept_code from_source_owner from_source_owner_type from_source_name from_source_url from_concept_name from_concept_url
concept_reference_map	concept_reference_term_id	to_source_owner to_source_owner_type to_source_name to_source_url to_concept_code to_concept_name to_concept_url
concept_reference_map	concept_map_type_id	mapping.map_type
concept_reference_term	uuid	MAPPING.EXTERNAL_ID	This will be removed
concept_reference_term	name	mapping.to_concept_name
concept_reference_term	code	mapping.to_concept_code
concept_reference_term	retired	MAPPING.RETIRED	This is the current behavior, but look at discussion question below
concept	id	concept.id
concept	uuid	concept.external_id
concept	retired	concept.retired
concept	datatype_id	concept.datatype
concept	class_id	concept.concept_class
concept	is_set	concept.extras.is_set
concept_name	uuid	concept.name.external_id
concept_name	name	concept.concept_name.name
concept_name	locale	concept.name.locale
concept_name	concept_name_type	concept.name.name_type
concept_name	locale_preferred	concept.name.locale_preferred
concept_description	uuid	concept.description.external_id
concept_description	description	concept.description.description
concept_description	locale	concept.description.locale
concept_description	locale_preferred	concept.description.locale_preferred
concept_datatype	name	concept.datatype	NOTE: Full datatype metadata will be stored in its own OCL source entitled OCL:Datatypes that in the future will populate datatype dropdowns
concept_class	name	concept.concept_class	NOTE: Full concept class metadata will be stored in its own OCL source entitled OCL:Classes that in the future will populate concept class dropdowns

OCL to OpenMRS Maps

OCL Field	OpenMRS Field	Notes
user		No corresponding fields in OpenMRS
org		No corresponding fields in OpenMRS
source
source.id, source.name, source.short_code	~concept_reference_source.name	Derived from this field
source.description
source.external_id
source.full_name
mapping.external_id	concept_reference_term.uuid	Probably switching to concept_reference_map.uuid

Changes to OCL

For Discussion:

• OCL.mapping.retired points to OMRS.concept_reference_term.retired, but it should point to OMRS.concept_reference_map.retired even though that field doesn't exist. Retiring the term would be the equivalent of retiring the concept in the external source.
• OMRS.concept.short_name, description, and form_text are not used in OCL

Change:

• OCL.mapping.retired points to OMRS.concept_reference_term.retired, but it should point to OMRS.concept_reference_map.retired even though that field doesn't exist. Retiring the term would be the equivalent of retiring the concept in the external source.

Missing in OCL:

• OMRS.concept_reference_source.hl7_code --> OCL.source.extras.hl7_code
• OMRS.concept_reference_map.description --> ? OCL.mapping.extras.description ?
• OMRS.concept_reference_map.version --> ? OCL.mapping.extras.version ?