...
- Only use alphanumeric characters (letters and numbers) and simple punctuation sparingly – e.g., comma (","), parentheses ("(" and ")"), and forward slash ("/").
- Descriptions may contain non-alphanumeric characters
- Sentence-case is recommended. This is either all lowercase or uppercase first letter (ie. 'Blue suede shoes').
- Avoid using all uppercase.
- Make exceptions for well known names (ie. EKG, HIV, pH)
- For drug names, some people use Tall Man Lettering to uppercase certain parts of drug names that are confused by providers, since this has been proven to reduce medication errors.
- Be consistent. Having a consistent naming convention for concepts is a must.
- Add standard SNOMED, ICD10, or RxNORM maps to concepts. Do this as part of creating the concept.
- Consistency in naming helps users predict concept names and makes the dictionary much easier to manage.
- Always work with your end users to ensure the your concept names make sense to them and match their workflows.
- Avoid changing names of concepts that have been used to store clinical data. After the point of data collection, concepts shouldn't be changed as you're then altering retrospective data. It is fine to continue to add synonyms to concepts, where applicable.
Describing Concepts
Every concept should have a description (at least within the system locale) that unambiguously describes the concept and, ideally, explains how it is intended to be used. For example, for a concept like "NUMBER OF CHILDREN", the description could clarify the concept with a statement like "A question asked of the patient and representing the number of their biological children, whether or not the children are alive, living at home, or living elsewhere."
Classes and datatypes
- Don't create boolean concepts for things like "Cough for last 3 weeks" = Yes/No. Instead have Symptom Present (coded), Symptom Absent (coded), and "Cough for last 3 weeks" (as an answer)
Consider importing concepts (e.g. from CIEL/MVP) when suitable <https://wiki.openmrs.org/x/ww4JAg>
...