Programs synchronization

Introduction

Note that information about OpenMRS programs is placed here.

FHIR Mapping

On this page are placed suggestion on how to map OpenMRS classes:

OpenMRS class	FHIR class

This is a suggestion on how to map OpenMRS Form object into FHIR Questionnaire.

Fields which didn't match into FHIR representation are marked on red. Keyword extension means that FHIR Extension has to be used to synchronize this field.
Fields which partially match into FHIR representation are marked on orange.

OpenMRS class Form. FHIR class Questionnaire.

OpenMRS class	OpenMRS field	DB field	FHIR field	Details
Form	formId : Integer	form_id : INT	identifier : Identifier	Can be put as one of the identifiers
BaseOpenmrsMetadata	name : String	name : TEXT	name : string	Matches well
Form	version : String	version : TEXT	version : string	Matches well
Form	build : Integer	build : INT	extension
Form	published : Boolean	published : INT	approvalDate : date	Assume that published = (approvalDate != null)
		xslt : ?		Absent in OpenMRS core object
		template : ?		Absent in OpenMRS core object
BaseOpenmrsMetadata	description : String	description : TEXT	description : markdown	Matches well
Form	encounterType : EncounterType	encounter_type : INT	extension	To be put into extension. Only encounterTypeId will be synchronized
Form	formFields : Set<FormField>	Many to one relation	item : BackboneElement	See FormField object mapping for details
BaseOpenmrsMetadata	creator : User	creator : INT	publisher : string	FHIR expects text representation of the user's name in this field. OpenMRS uses id of the user
BaseOpenmrsMetadata	dateCreated : Date	date_created : DATETIME	extension
BaseOpenmrsMetadata	changedBy : User	changed_by : INT	extension
BaseOpenmrsMetadata	dateChanged : Date	date_changed : DATETIME	date : dateTime	Matches well
BaseOpenmrsMetadata	retired : Boolean	retired : INT	status : code (draft \| active \| retired \| unknown)	FHIR status field can be set to "retired"
BaseOpenmrsMetadata	retiredBy : User	retired_by : INT	extension
BaseOpenmrsMetadata	dateRetired : User	date_retired : DATETIME	extension
BaseOpenmrsMetadata	retireReason : String	retired_reason : TEXT	extension
BaseOpenmrsObject	uuid : String	uuid : TEXT	identifier : Identifier	Can be put as one of the identifiers

OpenMRS class Field extends FormField. FHIR class BackboneElement.

OpenMRS class	OpenMRS field	DB field	FHIR field	Details
Field	fieldId : Integer	field_id : INT	extension
BaseOpenmrsMetadata	name : String	name : TEXT	text : string	Matches well
BaseOpenmrsMetadata	description : String	description : TEXT	extension
Field	fieldType : FieldType	field_type : INT	type : code (group \| display \| boolean \| decimal \| integer \| date \| dateTime + QuestionnaireItemType)	FHIR code is required. FHIR type is not designed to hold Id of field_type.
Field	concept : Concept	concept_id : INT	extension	Only Id of the concept will be synchronized. Whole Concepts will be synchronized separately.
Field	tableName: String	table_name : TEXT	extension
Field	attributeName : String	attribute_name : TEXT	extension
Field	defaultValue : String	default_value : INT	initialString : string
Field	selectMultiple : Boolean	select_multiple : INT	extension
Field	answers : Set<FieldAnswer>	Many to one relation.	enableWhen : BackboneElement	See FieldAnswer object mapping.
FormField	formFieldId : Integer	form_field_id : INT	linkId : string	Required by FHIR.
FormField	form : Form	form_id : INT		Can be deduced from JSON structure.
FormField	field : Field	field_id : INT	extension
FormField	fieldNumber : Integer	field_number : INT	extension
FormField	fieldPart : String	field_part : INT	extension
FormField	pageNumber : Integer	page_number : INT	extension
FormField	parent : FormField	parent_form_field : INT	extension	Field Id will be synced.
FormField	minOccurs : Integer	min_occurs : INT	extension
FormField	maxOccurs : Integer	max_occurs : INT	extension
FormField	required : Boolean	required : INT	required : boolean
FormField	sortWeight : Float	sort_weight : INT	extension
FormField	field : Field	field_id : INT	extension	Field Id will be synced.
BaseOpenmrsMetadata	creator : User	creator : INT	extension	User Id will be synced.
BaseOpenmrsMetadata	dateCreated : Date	date_created : DATETIME	extension
BaseOpenmrsMetadata	changedBy : User	changed_by : INT	extension	User Id will be synced.
BaseOpenmrsMetadata	dateChanged : Date	date_changed : DATETIME	extension
BaseOpenmrsMetadata	retired : Boolean	retired : INT	extension
BaseOpenmrsMetadata	retiredBy : User	retired_by : TEXT	extension	User Id will be synced.
BaseOpenmrsMetadata	dateRetired : User	date_retired : DATETIME	extension	User Id will be synced.
BaseOpenmrsMetadata	retireReason : String	retire_reason : TEXT	extension
BaseOpenmrsObject	uuid : String	uuid : TEXT	extension

OpenMRS class FieldAnswer.

OpenMRS class	OpenMRS field	DB field	FHIR field	Details
FieldAnswer	dateCreated : Date	date_created : DATETIME	extension
FieldAnswer	concept : Concept	answer_id : INT	answerCoding : Coding
FieldAnswer	creator : User	creator : INT	extension
FieldAnswer	field : Field	field_id : INT		Can be deduced from JSON structure.
FieldAnswer	dirty : boolean			Not saved to db.
BaseOpenmrsObject	uuid : String	uuid : TEXT	extension