ART Terminology Association Editor
Contents
Terminology Association Editor
A terminology association defines the binding of dataset concepts to relevant terminology. Associations may be done at three levels:
- An association with the concept itself, e.g. to use in HL7 V3 observation/code. This is normally a single code.
- An association with a list of codeable concepts, e.g. to use in HL7 V3 observation/value. This is normally a value set.
- An association for individual concepts in a dataset concept list to bind the exact value set member. This is normally a single code.
Supported actions
ART allows editing/deleting on all levels when you are logged in as a project editor. To associate a concept with terminology, you need to select it from the dataset through clicking or searching. When you have found the concept you need there are three distinct situations:
- This is an original concept without inheritance
- This is an inherited concept from within the project
- This is an inherited concept from a repository
Not all actions (adding/deleting) are supported in all situations:
| Situation | Add on concept | Delete on concept | Add on concept list | Delete on concept list | Add on concept list concept | Delete on concept list concept |
|---|---|---|---|---|---|---|
| Original concept | X | X | X | X | X | X |
| Inherited concept project | X | X (concept/@id based only) | ||||
| Inherited concept repository | X | X | X | X | X | X |
Some background
 | Note that changing the binding on any concept changes the bindings for any concept that inherits from the concept too. Please refer to the bottom part of the terminology association editor to assess the impact of changes you make. |
Terminology associations are based on the concept id. Each concept has its own id hence any association based on that id pertains specifically to that concept. When a concept inherits it also inherits the associations to the original. ART will find these based on the reference to the original in the inherit information.
Terminology associations are technically bound to the scope of the project. When you inherit from a concept in a repository, its terminology associations are also in that repository. You can copy them to your own project and add new ones, e.g. add LOINC where only SNOMED CT existed, or you can decide to ignore them.
This is not possible when you inherit within your project. Only adding/removing at concept level is possible as the concept has its own id. You cannot however remove the association you inherited from the original concept in the project. You can only change the associations on original concept in this case.
Interface Elements For an Original Concept
- Dataset selector
- Searching the dataset for concepts
- Refresh button to get the latest info, e.g. from co-authors without a full page refresh
- Dataset tree with all concepts in the selected dataset
- Selector for the terminology/code system to select a new main concept association from when you click +
- Deletes the current association
- Read only view of the concept with new issue button exactly as other users will view the concept
Interface Elements For an Inherited Concept (Repo)
- Clicking takes you the original concept. If this concept inherits from within the project, it will just switch concept and if needed dataset on the page. Also this button will change into a button that takes you back where you came from. If this concept inherits from a repository, this will open a new window/tab in the appropriate repository.
- Only applicable to concepts that inherit from a repository and do not have all terminology associations that the original has. Clicking this button will add them all at once. Another option is to add missing associations one by one: they are marked in grey below and have the + button to add them separately.
- Clicking the X button will delete the association. If this is a repository association it will show up in grey after deleting, with the + button. If this is a project association then it is just removed and only be restored by selecting it again
- Note that when you add one or all associations from the repository the saving process checks whether or not value set associations are in fact accessible. If they are not, it will also created value set references and even a building block repository line and notifies to you of that fact.
- This line in grey means that the repository concept has this association but this concept does not yet. You are encouraged to add it clicking the + button.
- Add missing value set code associations with the + button.
Form parameters
The terminology association form, as most other forms, supports parametrization.
/decor-terminology--[prefix]?datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
| Parameter | Description | Since |
|---|---|---|
| prefix | Project prefix | always |
| datasetId | Selects the project dataset with this id. Format: OID | always |
| datasetEffectiveDate | Selects the project dataset with this effectiveDate. Format: yyyy-mm-ddThh:mm:ss. | art v1.5 |
| conceptId | Selects the dataset concept with this id in the selected transaction. Format: OID. Param only works if the param id points to a transaction that binds the dataset that contains this concept. | always |
| conceptEffectiveDate | Selects the dataset concept with this effective date in the selected transaction. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId | art v1.5 |
