Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 5.46 KB

mdm.md

File metadata and controls

90 lines (65 loc) · 5.46 KB
Raw

Domain 'metadatasets'

The metadatasets subfolder contains CSV import files for saving metadata terms mappings in bulk. This is a possible example of its content:

metadatasets/
  ├──metadatasets.csv
  └── ...

There is currently only one format for the CSV line, here are the possible headers with a sample data set:

Uuid Void/Retire Name Description _order:1000
f0ebcb99-7618-41b7-b0bf-8ff93de67b9e Extra Identifiers Set Set of extra patient identifiers

Headers that start with an underscore such as _order:1000 are metadata headers. The values in the columns under those headers are never read by the CSV parser.

Metadata sets expose the usual OpenMRS metadata headers:

Header Name

Metadata sets names are optional and are not used as unique identifiers for metadata sets.

Header Description

Domain 'metadatasetmembers'

The metadatasetmembers subfolder contains CSV import files for saving metadata terms mappings in bulk. This is a possible example of its content:

metadatasetmembers/
  metadatasetmembers.csv
  └── ...

There is currently only one format for the CSV line, here are the possible headers with a sample data set:

Uuid Void/Retire Name Description Metadata set uuid Metadata class Metadata uuid Sort weight _order:1000
ee00777d-0cbe-41b7-4c67-8ff93de67b9e Legacy Id f0ebcb99-7618-41b7-b0bf-8ff93de67b9e org.openmrs.PatientIdentifierType n0ebcb90-m618-n1b1-b0bf-kff93de97b9j
f0ebcb99-272d-41b7-4c67-078de9342492 TRUE Old OpenMRS Id f0ebcb99-7618-41b7-b0bf-8ff93de67b9e org.openmrs.PatientIdentifierType 8f6ed8bb-0cbe-4c67-bc45-c5c0320e1324
dbfd899d-e9e1-4059-8992-73737c924f88 Outpatient Id IdentifierType for OPD f0ebcb99-7618-41b7-b0bf-8ff93de67b9e org.openmrs.PatientIdentifierType 7b0f5697-27e3-40c4-8bae-f4049abfb4ed 34

Each line describes how a metata set member belongs to a metata set. Let's review the key headers:

Header Name

Metadata set members names are optional and are not used as unique identifiers.

Header Description
Header Metadata set uuid (mandatory)

The UUID of the set to which the member belongs.

Header Metadata class (mandatory)

The Java class of the metadata entity that the member represents.

Header Metadata uuid (mandatory)

The UUID of the metadata entity that the member represents.

Header Sort weight

See here.

Domain 'metadatatermmappings'

The metadatatermmappings subfolder contains CSV import files for saving metadata terms mappings in bulk. This is a possible example of its content:

metadatatermmappings/
  ├──metadataterms.csv
  └── ...

There is currently only one format for the CSV line, here are the possible headers with a sample data set:

Uuid Void/Retire Mapping source Mapping code Metadata class name Metadata uuid _order:1000
21e24b36-f9e3-4b0e-986d-9899665597f7 org.openmrs.module.emrapi emr.primaryIdentifierType org.openmrs.PatientIdentifierType 264c9e75-77da-486a-8361-31558e051930

Headers that start with an underscore such as _order:1000 are metadata headers. The values in the columns under those headers are never read by the CSV parser.

Let's review some important headers.

Header Mapping source (mandatory)

A logical grouping of metadata terms mappings.

Header Mapping code (mandatory)

The code part of the metadata term mapping. That is a unique code, in the scope of the source, that points to and represents the metadata. Together the mapping source and the mapping code form the metadata term mapping that identify univocally a piece of metadata.

Header Metadata class name (mandatory)

The complete Java class name of the metadata object, eg. org.openmrs.PatientIdentifierType, org.openmrs.Location, ... etc.

Header Metadata uuid (mandatory)

The UUID of the metadata object represented by the metadata term mapping.

Further examples:

Please look at the test configuration folder for sample import files for all domains, see here.