Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 5.66 KB

concepts.md

File metadata and controls

90 lines (68 loc) · 5.66 KB
Raw

Domain 'concepts'

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

concepts/
  ├── diagnoses.csv
  ├── findings.csv
  ├── misc.csv
  └──  ...

The way those CSV files are processed is controlled by a reserved part of the CSV file header line that holds metadata about the CSV file itself. Here is an example of a header line:

Uuid Void/Retire Fully specified name:en Short name:en Description:en ... _version:1 _order:1000


Let's review some important headers.

Localized headers: Fully specified name, Short name and Description

Those are locale specific headers, they are never used as such because they always need to indicate the locale for the values of their column.
For example for a column to contain short names in English (locale 'en') simply name the header Short name:en. The same logic applies for the other locale specific headers.

Header Fully specified name (mandatory for at least one locale)

The fully specified name is a secondary identifier for the concepts domain, it will be used to attempt fetching the concept if no UUID is provided.

Header Short name (localized)
Header Description (localized)
Header Data class (mandatory)
Header Data type (mandatory)

Here is an example of valid CSV to define basic concepts:

Uuid Fully specified name:en Short name:en Description:en Data class Data type
Nationality Nat. The status of belonging to a particular nation. Question Text
db2f4fc4-.. Language Lang. The method of human communication. Question Text
Header Answers (optional)

To provide a semicolumn-separated list of answer concepts to the concept to be created or edited.

Header Members (optional)

To provide a semicolumn-separated list of concepts to be members of the concept set to be created or edited. Note that the concept will be marked a being a set as soon as set members are provided.

Here is an example of the 'nested' columns:

... Answers Members ...
... CONCEPT_NAME; source:134; db2f4fc4-.. ...
... CONCEPT_NAME; source:134; db2f4fc4-.. ...

As the example suggests, it is possible to provide lists of concepts identifiers to fill the values of the columns 'answers' or 'members' under the form of concept names (eg. "CONCEPT_NAME"), concept mappings (eg. "source:134") and concept UUIDs (eg. "db2f4fc4-.."). The concepts that could not be fetched through their provided identifier will fail the creation of the concept from the CSV line altogether, and the parser will continue to the next CSV line.

NOTE In the current implementation the listing order of the concepts in the CSV file does matter since unexisting concepts will fail the CSV line processing. It is recommended to take this into account and to insert CSV lines for concepts with nested lists low enough in the CSV file so that all nested concepts are found when the CSV line is being processed.

Header Same as mappings

To provide a semicolumn-separated list of concept mappings for the concept to be created or edited.

Here is an example of the 'mappings' columns:

... Same as mappings ...
... ICD-10-WHO:T45.9; CIEL:122226; Cambodia:115 ...
Attribute headers

Concepts support attributes. The values for those attributes can be set under ad-hoc headers starting with the special prefix Attribute|. The value indicated on a CSV line will be resolved to its final value based on the type of the attribute. Let us look at an example:

... Attribute|Last Audit Date ...
... 2017-05-15 ...

This attribute points to an attribute type identified by "Last Audit Date". The attribute type identifier (a name here) suggests that it might be an attribute of custom datatype Date. This means that its value, represented by the string 2017-05-15, will eventually be resolved as the Java date Mon May 15 00:00:00 2017 set as an attribute of the concept described by the CSV line.

Below are the headers specific to concepts numeric:

Header Absolute low
Header Critical low
Header Normal low
Header Normal high
Header Critical high
Header Absolute high
Header Units
Header Allow decimals
Header Display precision

NOTE The concept will be considered as a candidate to be a concept numeric if and only if its data type is set to Numeric.

Below are the headers specific to concepts complex:

Header Complex data handler (mandatory for concepts complex)

This should be the class name of a valid complex data handler class at runtime. Eg. ImageHandler, BinaryDataHandler, ... etc. See here for the list of handlers shipped with Core 2.x.

NOTE The concept will be considered as a candidate to be a concept complex if and only if its data type is set to Complex.

Further examples:

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