Statuses of a code list and codes and changing them with a mass change function
Statuses
Code lists have different statuses. Code lists with the status “Incomplete” are visible only to logged-in users of the organisation responsible for the code list. The other statuses are visible to all users.
Code list statuses:
- Incomplete
- Draft
- Valid
- Superseded
- Retired
- Invalid
The status of a code list can be changed from one status to another according to the following rules:
Current status | New status |
|---|---|
Incomplete | Draft |
Draft | Incomplete, Valid, Retired, Invalid |
Valid | Retired, Superseded, Invalid |
Retired | Valid, Superseded, Invalid |
Superseded | Valid, Retired, Invalid |
Invalid | Valid, Retired |
The codes have corresponding statuses. However, unlike an incomplete code list, an incomplete code can also be seen by a user who has not logged in. The rules for the status transitions of codes are the same as those for code lists.
Mass change function for changing the status of codes
Codes can also be changed en masse from one status to another. There are two functionalities for doing this:
- changing the status of the codes in conjunction with changing the status of the code list
- changing the status of the codes without changing the status of the code list.
When the status of the code list is changed (the “Information” tab of the Codelist) from the Status field, the option “Change code statuses at the same time” appears under the Status field.
This option makes it possible to change a new status to all codes that have the same initial status as the codelist. Examples are presented in the following table:
Initial status of codelist | Initial status of codes | Action to be carried out | Situation after mass change |
|---|---|---|---|
Valid | Valid | Change status from Valid to Invalid. | Codelist status: Invalid Status of codes: Invalid |
Incomplete | Draft, Valid | Change status from Incomplete to Draft | Codelist status: Draft Status of codes: All codes have the same status as before |
Draft | Draft, Incomplete | Change status from Draft to Valid | Codelist status: Valid Status of codes: The codes that were in Draft status are Valid, the codes that were in Incomplete status are still incomplete. |
An alternative for mass transition of code statuses is to select "Update code statuses" from the “Choose action” menu of the code list.
A view then opens in which you can select the initial and target status of the codes that will be changed.
The view allows you to set the statuses only in accordance with the status transition rules.
In the end, click the Save button to perform the status transitions. The following are some examples:
Starting status of codes | Action to be carried out | Situation after mass change |
|---|---|---|
Draft | Change status from Draft to Valid | All codes are in status Valid |
Draft, Valid, Retired | Change status from Valid to Retired. | Codes that were in Valid status are in Retired status, other codes have their original status. |