art-decor.org - User contributions [en]

ART Scenario Editor

2020-07-08T12:58:58Z

Mligtvoet: moved form parameters to the end of the page

{{:ART_Scenario_Introduction}}

== Creating a scenario ==
This documentation describes setting up scenarios from scratch, so there are no actors or scenarios present when starting.

===Add Actors===
Open the Actors tab. Add Actors by clicking on the plus sign (1).

[[File:ScenarioEditor-actor.jpg|750px]]

Enter a name for the Actor (2), choose the type of actor: Person, Organization or Device (3). Click on the small plus under "Description" to add a description for this Actor.

Finally save the Actors by clicking '''Save''' (4) or cancel the edit by clicking '''Cancel'''.

===Add Scenario and Transaction Group===
Next create a Scenario by opening the '''Scenarios''' tab and clicking on the plus sign (1).

[[File:ScenarioEditor-scenario.jpg|750px]]

Click on the Scenario in the navigation area (2) and edit the name of the Scenario (3).
Then click on the Transaction Group (4) and edit the name of the Transaction Group as well (5).

Finally hit the '''Save''' button (6) or cancel the edit by clicking '''Cancel'''.

===Add a Transaction of Type "stationary" (e.g. CDA documents)===
Click on the Transaction in the navigation area and edit the name (2). Select as type "Stationary" (3) because a CDA document is always a stationary transaction (the sending action´city is a different thing). In addition you need to label a transaction (4). This is a business name (only letters and digits are allowed).
{{NoteBox|The Transaction label is also used for the name of the resulting schematron file. For example, if the label is "vitsig2017" your schematron file would be named "''projectprefix-''vitsig2017.sch".}}

[[File:ScenarioEditor-transactionstationary.jpg|750px]]

As stationary transaction do not have a "back" flow of information (as the acknowledgement in messages) click on the "back" transaction (5, e.g. Response) and click on the red cross (6) to delete this unused transaction.

===Add a Transaction of Type "initial" and "back" (e.g. messages)===

[[File:ScenarioEditor-transactionback.jpg|750px]]

[[File:ScenarioEditor-transactioninitial.jpg|750px]]

===Assign a Representing Template===
To assign a Representing Template to a Transaction, click on the respective Transaction and edit it. Right to the bottom you will find the "Template" with a pen to assign (or change) the Representing Template. By clicking on the edit pen you will get a list of all templates of your project. Choose the appropriate Representing Template (e.g. a CDA document level template, a message template) and click on the '''Save''' button.

[[File:ScenarioEditor-representingtemplate.jpg |750px]]

===Editing the concepts of a transaction===
[[File:ScenarioEditor-transaction4.jpg|750px]]

=Locking=

ART uses item level locking to prevent multiple users form editing the same item. When an item is edited this item and all children and parents of this item are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|400px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Scenario-lock-message.png|750px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.
Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Scenario-project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.
The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Scenario-decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

=Form parameters=
The scenarios form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-scenarios--[prefix]?id=[scenario/transaction id]&effectiveDate=[scenario/transaction effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project scenario or transaction with this id. Format: OID
| ''always''
|-
| effectiveDate
| Switches to the project scenario or transaction with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| ''always''
|-
| datasetId
| Filters the list of scenarios/transaction to those that binds the project dataset with this id. Format: OID
| ''always''
|-
| datasetEffectiveDate
| Filters the list of scenarios/transaction to those that binds 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
| ''always''
|-
| actorId
| Selects the actor with this id in the list of actors. Format: OID. Setting this param assumes param section=actors
| ''always''
|-
| section
| Switches to the requested section. Options
* scenarios (default if actorId is not used) - switches to the tab Scenarios
* actors (default if param actorId is used) - switches to the tab Actors
| art v1.5.3
|}

ART Dataset Editor

2020-07-08T12:58:13Z

Mligtvoet: moved form parameters to the end of the page

This text documents how datasets can be edited.
=Log in and navigate to the dataset page=
Perform the following steps:
* Prerequisite: you need an account with the proper [[ART_maintenance_manual#ART_user_roles|permissions]] to edit the project. Contact the project maintainer.
* go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
* Log into ART-DECOR by clicking '''Login''' at the top-right
* select a project from the dropdown box '''DECOR'''
* navigate to the '''Datasets''' tab
=Building a dataset=
A dataset is a list of (hierarchical) concepts, see also: [[DECOR-dataset]].

Typically the first concepts created are concept groups which contain child concepts. Building a dataset is done by:
* Setting dataset attributes
* Adding concepts to the dataset, see: [[ART_Dataset_Editor#Add a concept group|add a concept group]] and [[ART_Dataset_Editor#Add a concept item|add a concept item]].

=Setting dataset attributes=
==Set the dataset status==
Datasets can have the following status:
* draft: (yellow) the dataset is under development (nascent), not ready for production use. This is the initial status for new datasets.
* final: (green) the dataset is finalized, and deemed fit for use.
* rejected: (purple) the dataset is rejected. During the development proces it was decided that further development on this dataset will not happen.
* cancelled: (blue) the dataset was never published and is withdrawn.

Below is a screenshot that displays the buttons to change the dataset status:
[[File:En_dataset_02.jpg|400px]]

==Set the dataset version label==
The dataset version ia a human readable version number or version label for convenient human rendition; not used by an application.
The version label can be altered by:
* adding text in the textbox
[[File:En_dataset_03.jpg|400px]]
* saving the version label by clicking on the button '''save'''
* cancelling the edit by clicking on the button '''cancel'''

==Set the dataset description==
The dataset can optionally contain a human readable text that describes the dataset.
Adding a dataset description is done by:
* Clicking on '''description''' folds out a text editor
[[File:En_dataset_04.jpg|750px]]
* Add text, and optionally use the text formatting tools.
* You may optionally link to images or other web addresses.
* Click on another textbox, for instance the '''name''' textbox
* The form will now display the '''save''' and '''cancel''' buttons to save the description, or cancel the edit.

=Concept attributes=
Concepts have the following attributes:
* Version: ART-DECOR enters a date when the concept is created
* Id: ART-DECOR will assign an identifier for new concepts based on the dataset identifier
* type: group or item. Groups can contain other concepts
* Status, see [[Concept status machine]]
* Name: A name for the artifact that will be meaningful to business or domain experts. One artifact may have different business name translations for each realm and/or language
* Description: One to many descriptions per language
* Source: human readable hint where this data element originally comes from
* Rationale: human readable justification or explanation why this concept is present
* Operationalization: how to measure, obtain, specify the value of an observation
* Comment: One to many comments on the concept
Only for concept items (not for groups):
* Value:
** Type: the datatype, see [[DECOR-dataset]]
** Properties, see [[DECOR-dataset|datatype facets]]
** Example, one or many example values for this concept

=Add a concept group=
A concept group is a concept that groups one or more child-concepts.
To create a dataset group perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px|Add dataset concept button]]
* Set the concept '''Type''' to '''Group'''
[[File:en_dataset_add_concept_type_group.png|750px|Set concept type to group]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept group, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''', see also [[ART_Dataset_Editor#Moving_concepts|Moving concepts]].
* Save the concept group by clicking '''Save'''
[[File:En_dataset_add_concept_save.png|750px|Save concept]]

=Add a concept item=
To create a dataset concept item perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px]]
* Set the concept '''Type''' to '''Item'''
[[File:en_dataset_add_concept_type_item.png|750px|Set concept type to item]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description_item.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''', see also [[ART_Dataset_Editor#Moving_concepts|Moving concepts]].
* Save the concept by clicking '''Save'''
[[File:en_dataset_add_concept_save_item.png|750px|Save concept]]

=Add a concept from a repository=
When you add a concept group or concept item, ART-DECOR automatically searches all known repositories for similar concepts.
Note that this is unrelated to which repository projects are configured in '''Projects''' / '''General''' / '''Repository reference'''.

Please note that:
* When you want to add a concept from the repository, your own concept should either be a group, or item. And that should be the same as the original concept in the repository.
* When adding concepts you can either add them:
** As reference: Select this option if you want a singular reference to the concept. This will allow you to go to the referenced concept, without pulling physically pulling it into your current structure. This option is suited for circular references. You may convert a reference to an inherited structure at any time.
** As inherit: Select this option if you want to copy the referenced structure into your current structure. Each concept will then point to its original for its properties (name, description, value domain etc.). This option is not suited for circular references. Your inherited structure will not automatically get new concepts if they are added in the original. You cannot convert an inherited structure into an reference.

=Add concept translations=
To add translations to your project, first make sure that:
* the project name itself is translated, see: [[ART_Project_Editor#Add_a_language_to_a_project|ART Project Editor Documentation]]
Now we can add translations to dataset concepts with the '''Translate''' button on the dataset concept editor form:

[[File:Dataset_concept_translate.png|450px]]

This will open a display for adding translations to the dataset concept.
You can add translations for the various dataset concept fields: Name, Synonym, Description, Source, Rationale, Comment, Operationalization.

After adding translations, click '''Close''' to close the form.
[[File:Dataset_concept_translate_close.png|450px]]

Next you need to click '''Save''' to save the translations:

[[File:Dataset_concept_translate_save.png|250px]]

=Example dataset=
* Example dataset demo1-: Patient measurements, see [https://art-decor.org/art-decor/decor-datasets--demo1-]
* Example dataset demo5-: Vital Signs Report Summary, with CDA Document, see [https://art-decor.org/art-decor/decor-datasets--demo5-]

=Moving concepts=
* Select a concept you want to move
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''':
[[File:Dataset_move_concept_01.png|750px]]

* The concept can be inserted above/after, or inserted into a group:
[[File:Dataset_move_concept_02.png|550px]]

=Locking=

ART uses concept level locking to prevent multiple users form editing the same item. When a concept is edited this concept and all children of this concept are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|300px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Concept-locked-message.png|400px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.

Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

=Form parameters=
The dataset form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-datasets--[prefix]?id=[dataset id]&effectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project dataset with this id. Format: OID
| art v1.5
|-
| effectiveDate
| Switches to the project dataset with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| art v1.5
|- style="font-style:italic;"
| datasetId
| Switches to the project dataset with this id. Format: OID
| ''always'' (deprecated in art >= 1.5)
|-
| conceptId
| Switches to the project dataset concept with this id. Format: OID. If you do not specify params id/effectiveDate, then this param only works if the concept happens to be in the default/newest dataset
| ''always''
|-
| conceptEffectiveDate
| Switches to the project dataset concept with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId
| ''always''
|}

ART Scenario Viewer

2020-07-08T12:53:42Z

Mligtvoet:

{{:ART_Scenario_Introduction}}

=Form parameters=
The scenarios form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-scenarios--[prefix]?id=[scenario/transaction id]&effectiveDate=[scenario/transaction effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]&language=[ll-CC]&scenariotree=[true|false]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project scenario or transaction with this id. Format: OID
| ''always''
|-
| effectiveDate
| Switches to the project scenario or transaction with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| ''always''
|-
| datasetId
| Filters the list of scenarios/transaction to those that binds the project dataset with this id. Format: OID
| ''always''
|-
| datasetEffectiveDate
| Filters the list of scenarios/transaction to those that binds 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
| ''always''
|-
| actorId
| Selects the actor with this id in the list of actors. Format: OID. Setting this param assumes param section=actors
| ''always''
|-
| section
| Switches to the requested section. Options
* scenarios (default if actorId is not used) - switches to the tab Scenarios
* actors (default if param actorId is used) - switches to the tab Actors
| art v1.5.3
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| ''1.8.51''
|-
| scenariotree
| Collapses the scenario tree is 'false', or leaves it in view otherwise
| art v1.8.51
|}

ART Scenario Editor

2020-07-08T12:53:10Z

Mligtvoet:

{{:ART_Scenario_Introduction}}

== Creating a scenario ==
This documentation describes setting up scenarios from scratch, so there are no actors or scenarios present when starting.

===Add Actors===
Open the Actors tab. Add Actors by clicking on the plus sign (1).

[[File:ScenarioEditor-actor.jpg|750px]]

Enter a name for the Actor (2), choose the type of actor: Person, Organization or Device (3). Click on the small plus under "Description" to add a description for this Actor.

Finally save the Actors by clicking '''Save''' (4) or cancel the edit by clicking '''Cancel'''.

===Add Scenario and Transaction Group===
Next create a Scenario by opening the '''Scenarios''' tab and clicking on the plus sign (1).

[[File:ScenarioEditor-scenario.jpg|750px]]

Click on the Scenario in the navigation area (2) and edit the name of the Scenario (3).
Then click on the Transaction Group (4) and edit the name of the Transaction Group as well (5).

Finally hit the '''Save''' button (6) or cancel the edit by clicking '''Cancel'''.

===Add a Transaction of Type "stationary" (e.g. CDA documents)===
Click on the Transaction in the navigation area and edit the name (2). Select as type "Stationary" (3) because a CDA document is always a stationary transaction (the sending action´city is a different thing). In addition you need to label a transaction (4). This is a business name (only letters and digits are allowed).
{{NoteBox|The Transaction label is also used for the name of the resulting schematron file. For example, if the label is "vitsig2017" your schematron file would be named "''projectprefix-''vitsig2017.sch".}}

[[File:ScenarioEditor-transactionstationary.jpg|750px]]

As stationary transaction do not have a "back" flow of information (as the acknowledgement in messages) click on the "back" transaction (5, e.g. Response) and click on the red cross (6) to delete this unused transaction.

===Add a Transaction of Type "initial" and "back" (e.g. messages)===

[[File:ScenarioEditor-transactionback.jpg|750px]]

[[File:ScenarioEditor-transactioninitial.jpg|750px]]

===Assign a Representing Template===
To assign a Representing Template to a Transaction, click on the respective Transaction and edit it. Right to the bottom you will find the "Template" with a pen to assign (or change) the Representing Template. By clicking on the edit pen you will get a list of all templates of your project. Choose the appropriate Representing Template (e.g. a CDA document level template, a message template) and click on the '''Save''' button.

[[File:ScenarioEditor-representingtemplate.jpg |750px]]

===Editing the concepts of a transaction===
[[File:ScenarioEditor-transaction4.jpg|750px]]

=Form parameters=
The scenarios form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-scenarios--[prefix]?id=[scenario/transaction id]&effectiveDate=[scenario/transaction effective date]&datasetId=[dataset id]&datasetEffectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project scenario or transaction with this id. Format: OID
| ''always''
|-
| effectiveDate
| Switches to the project scenario or transaction with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| ''always''
|-
| datasetId
| Filters the list of scenarios/transaction to those that binds the project dataset with this id. Format: OID
| ''always''
|-
| datasetEffectiveDate
| Filters the list of scenarios/transaction to those that binds 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
| ''always''
|-
| actorId
| Selects the actor with this id in the list of actors. Format: OID. Setting this param assumes param section=actors
| ''always''
|-
| section
| Switches to the requested section. Options
* scenarios (default if actorId is not used) - switches to the tab Scenarios
* actors (default if param actorId is used) - switches to the tab Actors
| art v1.5.3
|}

=Locking=

ART uses item level locking to prevent multiple users form editing the same item. When an item is edited this item and all children and parents of this item are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|400px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Scenario-lock-message.png|750px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.
Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Scenario-project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.
The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Scenario-decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

ART Scenario Introduction

2020-07-08T12:51:03Z

Mligtvoet: Moved from ART_Scenario_Editor to here, to also include in ART_Scenario_Viewer

== Introduction ==
Scenarios are a container for transaction groups and transactions and will typically represent a health care use case, e.g. a Medication Prescription or a Radiology Examination. With that, scenarios/transaction provide the usage context as starting communicating without knowing why is not suitable.

Transaction groups contain Transactions. There are two categories of transactions.

Category 1: The pair of "initial" and "back" used in the messaging paradigm where an initial information transfer evokes a response message in terms of an acknowledgement or in a query/response environment. This transaction typically has a sender and a receiver interacting.

[[File:ScenarioEditor-transaction1.jpg|750px]]

Category 2: The "stationary" transaction that is a self-referencing transaction for example to create a document. This interaction typically has a "sender" only, that is more a creator of the document. Sending and receiving aspects are not part of this category of transaction and handled separately.

[[File:ScenarioEditor-transaction2.jpg|750px]]

Transactions represent a (sub)set of concepts from a dataset and add cardinality, conformance and possible conditions to them so they reflect the use case demands appropriately. A transaction typically has a reference to a representing template, that is the technical representation of the transaction and its underlying concepts.

[[File:ScenarioEditor-transaction3.jpg|750px]]

ART Dataset Editor

2020-07-08T12:48:34Z

Mligtvoet: added moving, deleted removing concepts, deleted {{underconstruction}}

This text documents how datasets can be edited.
=Log in and navigate to the dataset page=
Perform the following steps:
* Prerequisite: you need an account with the proper [[ART_maintenance_manual#ART_user_roles|permissions]] to edit the project. Contact the project maintainer.
* go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
* Log into ART-DECOR by clicking '''Login''' at the top-right
* select a project from the dropdown box '''DECOR'''
* navigate to the '''Datasets''' tab
=Building a dataset=
A dataset is a list of (hierarchical) concepts, see also: [[DECOR-dataset]].

Typically the first concepts created are concept groups which contain child concepts. Building a dataset is done by:
* Setting dataset attributes
* Adding concepts to the dataset, see: [[ART_Dataset_Editor#Add a concept group|add a concept group]] and [[ART_Dataset_Editor#Add a concept item|add a concept item]].

=Setting dataset attributes=
==Set the dataset status==
Datasets can have the following status:
* draft: (yellow) the dataset is under development (nascent), not ready for production use. This is the initial status for new datasets.
* final: (green) the dataset is finalized, and deemed fit for use.
* rejected: (purple) the dataset is rejected. During the development proces it was decided that further development on this dataset will not happen.
* cancelled: (blue) the dataset was never published and is withdrawn.

Below is a screenshot that displays the buttons to change the dataset status:
[[File:En_dataset_02.jpg|400px]]

==Set the dataset version label==
The dataset version ia a human readable version number or version label for convenient human rendition; not used by an application.
The version label can be altered by:
* adding text in the textbox
[[File:En_dataset_03.jpg|400px]]
* saving the version label by clicking on the button '''save'''
* cancelling the edit by clicking on the button '''cancel'''

==Set the dataset description==
The dataset can optionally contain a human readable text that describes the dataset.
Adding a dataset description is done by:
* Clicking on '''description''' folds out a text editor
[[File:En_dataset_04.jpg|750px]]
* Add text, and optionally use the text formatting tools.
* You may optionally link to images or other web addresses.
* Click on another textbox, for instance the '''name''' textbox
* The form will now display the '''save''' and '''cancel''' buttons to save the description, or cancel the edit.

=Concept attributes=
Concepts have the following attributes:
* Version: ART-DECOR enters a date when the concept is created
* Id: ART-DECOR will assign an identifier for new concepts based on the dataset identifier
* type: group or item. Groups can contain other concepts
* Status, see [[Concept status machine]]
* Name: A name for the artifact that will be meaningful to business or domain experts. One artifact may have different business name translations for each realm and/or language
* Description: One to many descriptions per language
* Source: human readable hint where this data element originally comes from
* Rationale: human readable justification or explanation why this concept is present
* Operationalization: how to measure, obtain, specify the value of an observation
* Comment: One to many comments on the concept
Only for concept items (not for groups):
* Value:
** Type: the datatype, see [[DECOR-dataset]]
** Properties, see [[DECOR-dataset|datatype facets]]
** Example, one or many example values for this concept

=Add a concept group=
A concept group is a concept that groups one or more child-concepts.
To create a dataset group perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px|Add dataset concept button]]
* Set the concept '''Type''' to '''Group'''
[[File:en_dataset_add_concept_type_group.png|750px|Set concept type to group]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept group, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''', see also [[ART_Dataset_Editor#Moving_concepts|Moving concepts]].
* Save the concept group by clicking '''Save'''
[[File:En_dataset_add_concept_save.png|750px|Save concept]]

=Add a concept item=
To create a dataset concept item perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px]]
* Set the concept '''Type''' to '''Item'''
[[File:en_dataset_add_concept_type_item.png|750px|Set concept type to item]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description_item.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''', see also [[ART_Dataset_Editor#Moving_concepts|Moving concepts]].
* Save the concept by clicking '''Save'''
[[File:en_dataset_add_concept_save_item.png|750px|Save concept]]

=Add a concept from a repository=
When you add a concept group or concept item, ART-DECOR automatically searches all known repositories for similar concepts.
Note that this is unrelated to which repository projects are configured in '''Projects''' / '''General''' / '''Repository reference'''.

Please note that:
* When you want to add a concept from the repository, your own concept should either be a group, or item. And that should be the same as the original concept in the repository.
* When adding concepts you can either add them:
** As reference: Select this option if you want a singular reference to the concept. This will allow you to go to the referenced concept, without pulling physically pulling it into your current structure. This option is suited for circular references. You may convert a reference to an inherited structure at any time.
** As inherit: Select this option if you want to copy the referenced structure into your current structure. Each concept will then point to its original for its properties (name, description, value domain etc.). This option is not suited for circular references. Your inherited structure will not automatically get new concepts if they are added in the original. You cannot convert an inherited structure into an reference.

=Add concept translations=
To add translations to your project, first make sure that:
* the project name itself is translated, see: [[ART_Project_Editor#Add_a_language_to_a_project|ART Project Editor Documentation]]
Now we can add translations to dataset concepts with the '''Translate''' button on the dataset concept editor form:

[[File:Dataset_concept_translate.png|450px]]

This will open a display for adding translations to the dataset concept.
You can add translations for the various dataset concept fields: Name, Synonym, Description, Source, Rationale, Comment, Operationalization.

After adding translations, click '''Close''' to close the form.
[[File:Dataset_concept_translate_close.png|450px]]

Next you need to click '''Save''' to save the translations:

[[File:Dataset_concept_translate_save.png|250px]]

=Example dataset=
* Example dataset demo1-: Patient measurements, see [https://art-decor.org/art-decor/decor-datasets--demo1-]
* Example dataset demo5-: Vital Signs Report Summary, with CDA Document, see [https://art-decor.org/art-decor/decor-datasets--demo5-]

=Moving concepts=
* Select a concept you want to move
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset''':
[[File:Dataset_move_concept_01.png|750px]]

* The concept can be inserted above/after, or inserted into a group:
[[File:Dataset_move_concept_02.png|550px]]

=Form parameters=
The dataset form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-datasets--[prefix]?id=[dataset id]&effectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project dataset with this id. Format: OID
| art v1.5
|-
| effectiveDate
| Switches to the project dataset with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| art v1.5
|- style="font-style:italic;"
| datasetId
| Switches to the project dataset with this id. Format: OID
| ''always'' (deprecated in art >= 1.5)
|-
| conceptId
| Switches to the project dataset concept with this id. Format: OID. If you do not specify params id/effectiveDate, then this param only works if the concept happens to be in the default/newest dataset
| ''always''
|-
| conceptEffectiveDate
| Switches to the project dataset concept with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId
| ''always''
|}

=Locking=

ART uses concept level locking to prevent multiple users form editing the same item. When a concept is edited this concept and all children of this concept are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|300px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Concept-locked-message.png|400px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.

Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

File:Dataset move concept 01.png

2020-07-08T12:45:09Z

Mligtvoet:

File:Dataset move concept 02.png

2020-07-08T12:44:43Z

Mligtvoet:

ART Dataset Editor

2020-07-08T12:30:29Z

Mligtvoet: /* Example dataset */

{{underconstruction}}
This text documents how datasets can be edited.
=Log in and navigate to the dataset page=
Perform the following steps:
* Prerequisite: you need an account with the proper [[ART_maintenance_manual#ART_user_roles|permissions]] to edit the project. Contact the project maintainer.
* go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
* Log into ART-DECOR by clicking '''Login''' at the top-right
* select a project from the dropdown box '''DECOR'''
* navigate to the '''Datasets''' tab
=Building a dataset=
A dataset is a list of (hierarchical) concepts, see also: [[DECOR-dataset]].

Typically the first concepts created are concept groups which contain child concepts. Building a dataset is done by:
* Setting dataset attributes
* Adding concepts to the dataset, see: [[ART_Dataset_Editor#Add a concept group|add a concept group]] and [[ART_Dataset_Editor#Add a concept item|add a concept item]].

=Setting dataset attributes=
==Set the dataset status==
Datasets can have the following status:
* draft: (yellow) the dataset is under development (nascent), not ready for production use. This is the initial status for new datasets.
* final: (green) the dataset is finalized, and deemed fit for use.
* rejected: (purple) the dataset is rejected. During the development proces it was decided that further development on this dataset will not happen.
* cancelled: (blue) the dataset was never published and is withdrawn.

Below is a screenshot that displays the buttons to change the dataset status:
[[File:En_dataset_02.jpg|400px]]

==Set the dataset version label==
The dataset version ia a human readable version number or version label for convenient human rendition; not used by an application.
The version label can be altered by:
* adding text in the textbox
[[File:En_dataset_03.jpg|400px]]
* saving the version label by clicking on the button '''save'''
* cancelling the edit by clicking on the button '''cancel'''

==Set the dataset description==
The dataset can optionally contain a human readable text that describes the dataset.
Adding a dataset description is done by:
* Clicking on '''description''' folds out a text editor
[[File:En_dataset_04.jpg|750px]]
* Add text, and optionally use the text formatting tools.
* You may optionally link to images or other web addresses.
* Click on another textbox, for instance the '''name''' textbox
* The form will now display the '''save''' and '''cancel''' buttons to save the description, or cancel the edit.

=Concept attributes=
Concepts have the following attributes:
* Version: ART-DECOR enters a date when the concept is created
* Id: ART-DECOR will assign an identifier for new concepts based on the dataset identifier
* type: group or item. Groups can contain other concepts
* Status, see [[Concept status machine]]
* Name: A name for the artifact that will be meaningful to business or domain experts. One artifact may have different business name translations for each realm and/or language
* Description: One to many descriptions per language
* Source: human readable hint where this data element originally comes from
* Rationale: human readable justification or explanation why this concept is present
* Operationalization: how to measure, obtain, specify the value of an observation
* Comment: One to many comments on the concept
Only for concept items (not for groups):
* Value:
** Type: the datatype, see [[DECOR-dataset]]
** Properties, see [[DECOR-dataset|datatype facets]]
** Example, one or many example values for this concept

=Add a concept group=
A concept group is a concept that groups one or more child-concepts.
To create a dataset group perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px|Add dataset concept button]]
* Set the concept '''Type''' to '''Group'''
[[File:en_dataset_add_concept_type_group.png|750px|Set concept type to group]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept group, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset'''
* Save the concept group by clicking '''Save'''
[[File:En_dataset_add_concept_save.png|750px|Save concept]]

=Add a concept item=
To create a dataset concept item perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px]]
* Set the concept '''Type''' to '''Item'''
[[File:en_dataset_add_concept_type_item.png|750px|Set concept type to item]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description_item.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset'''
* Save the concept by clicking '''Save'''
[[File:en_dataset_add_concept_save_item.png|750px|Save concept]]

=Add a concept from a repository=
When you add a concept group or concept item, ART-DECOR automatically searches all known repositories for similar concepts.
Note that this is unrelated to which repository projects are configured in '''Projects''' / '''General''' / '''Repository reference'''.

Please note that:
* When you want to add a concept from the repository, your own concept should either be a group, or item. And that should be the same as the original concept in the repository.
* When adding concepts you can either add them:
** As reference: Select this option if you want a singular reference to the concept. This will allow you to go to the referenced concept, without pulling physically pulling it into your current structure. This option is suited for circular references. You may convert a reference to an inherited structure at any time.
** As inherit: Select this option if you want to copy the referenced structure into your current structure. Each concept will then point to its original for its properties (name, description, value domain etc.). This option is not suited for circular references. Your inherited structure will not automatically get new concepts if they are added in the original. You cannot convert an inherited structure into an reference.

=Add concept translations=
To add translations to your project, first make sure that:
* the project name itself is translated, see: [[ART_Project_Editor#Add_a_language_to_a_project|ART Project Editor Documentation]]
Now we can add translations to dataset concepts with the '''Translate''' button on the dataset concept editor form:

[[File:Dataset_concept_translate.png|450px]]

This will open a display for adding translations to the dataset concept.
You can add translations for the various dataset concept fields: Name, Synonym, Description, Source, Rationale, Comment, Operationalization.

After adding translations, click '''Close''' to close the form.
[[File:Dataset_concept_translate_close.png|450px]]

Next you need to click '''Save''' to save the translations:

[[File:Dataset_concept_translate_save.png|250px]]

=Example dataset=
* Example dataset demo1-: Patient measurements, see [https://art-decor.org/art-decor/decor-datasets--demo1-]
* Example dataset demo5-: Vital Signs Report Summary, with CDA Document, see [https://art-decor.org/art-decor/decor-datasets--demo5-]

=Removing concepts=
=Moving concepts=

=Form parameters=
The dataset form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-datasets--[prefix]?id=[dataset id]&effectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project dataset with this id. Format: OID
| art v1.5
|-
| effectiveDate
| Switches to the project dataset with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| art v1.5
|- style="font-style:italic;"
| datasetId
| Switches to the project dataset with this id. Format: OID
| ''always'' (deprecated in art >= 1.5)
|-
| conceptId
| Switches to the project dataset concept with this id. Format: OID. If you do not specify params id/effectiveDate, then this param only works if the concept happens to be in the default/newest dataset
| ''always''
|-
| conceptEffectiveDate
| Switches to the project dataset concept with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId
| ''always''
|}

=Locking=

ART uses concept level locking to prevent multiple users form editing the same item. When a concept is edited this concept and all children of this concept are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|300px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Concept-locked-message.png|400px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.

Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

Testscenario test author dutch

2020-07-08T12:26:12Z

Mligtvoet: /* Add concepts */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Note that the 'soort/type' for Person should be '''group''', so that it can contain child dataset concepts (of type 'item')
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Project Index==
Now that we have created some content, it will also be available in our Project Index.
For documentation, see [[ART_Project_Editor#Project_Index|Project index]].

===Open Project Index===
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here

===Transaction===
* Under transactions
* Open the 'Alles/All' view for the transaction you created
* 'Alles uitklappen/Expand all' to show al dataset concepts in this transaction
* It should list the Person dataset concept group you have created

===FHIR Questionnaire===
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
For documentation, see the [[ART_Terminology_Association_Editor|Terminology Editor manual]]

Exercise valuesets 6:
We will add a '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add a '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''':
* To see the newly created value set in the Value Sets screen you have to refresh it!
* Also, if you browse to Project Index/transaction this will show the terminology association, and the valueset association.

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T10:23:06Z

Mligtvoet: /* Terminologiekoppelingen / Terminology associations */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Project Index==
Now that we have created some content, it will also be available in our Project Index.
For documentation, see [[ART_Project_Editor#Project_Index|Project index]].

===Open Project Index===
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here

===Transaction===
* Under transactions
* Open the 'Alles/All' view for the transaction you created
* 'Alles uitklappen/Expand all' to show al dataset concepts in this transaction
* It should list the Person dataset concept group you have created

===FHIR Questionnaire===
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
For documentation, see the [[ART_Terminology_Association_Editor|Terminology Editor manual]]

Exercise valuesets 6:
We will add a '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add a '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''':
* To see the newly created value set in the Value Sets screen you have to refresh it!
* Also, if you browse to Project Index/transaction this will show the terminology association, and the valueset association.

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T10:20:54Z

Mligtvoet: /* FHIR Questionnaire */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Project Index==
Now that we have created some content, it will also be available in our Project Index.
For documentation, see [[ART_Project_Editor#Project_Index|Project index]].

===Open Project Index===
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here

===Transaction===
* Under transactions
* Open the 'Alles/All' view for the transaction you created
* 'Alles uitklappen/Expand all' to show al dataset concepts in this transaction
* It should list the Person dataset concept group you have created

===FHIR Questionnaire===
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
For documentation, see the [[ART_Terminology_Association_Editor|Terminology Editor manual]]

Exercise valuesets 6:
We will add a '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add a '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T10:10:19Z

Mligtvoet: /* Terminologiekoppelingen / Terminology associations */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
For documentation, see the [[ART_Terminology_Association_Editor|Terminology Editor manual]]

Exercise valuesets 6:
We will add a '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add a '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T10:09:53Z

Mligtvoet: /* Terminology */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
For documentation, see the [[ART_Terminology_Association_Editor|Terminology Editor manual]]

Exercise valuesets 6:
We will add an '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add an '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T10:08:10Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Terminology ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

===Value Sets===
For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an '''terminology association''' between the 'person/gender' dataset concept, and the SNOMED Gender code.
This works for any dataset concept.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a Terminologiekoppeling/terminology association by clicking on the plus at the right of Terminologiekoppelingen. By default 'SNOMED' is selected, but other terminology systems are available.
# Search for the SNOMED code you want to associate the dataset concept with, in this example 'gender'.
# 'Koppeling maken' to create the terminology association.

Exercise valuesets 7:
We will add an '''valueset association''' between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:59:55Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In your own project: Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an valueset association between the 'person/gender' dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select the dataset concept 'person/gender' from the dataset tree.
# Add a waardelijstkoppeling/valueset association by clicking on the plus at the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:52:49Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first. They are accessible from 'Repository reference' and open up in a seperate browser window.
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:31:39Z

Mligtvoet: /* FHIR Questionnaire */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.
For documentation, see [[FHIR_Questionnaire_support|manual]].

The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:31:18Z

Mligtvoet: /* FHIR Questionnaire */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON. For documentation, see [[FHIR_Questionnaire_support|manual]].
The FHIR Questionnaire can be shown from the [[ART_Project_Editor#Project_Index|Project index]].
* Open the Project Index, by selecting the tab 'Project', 'Project Index'
* All items in our project are listed here
* Under 'Transactions', open the Questionnaire/html to render our transaction as a FHIR Questionnaire

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:25:35Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==FHIR Questionnaire==
Note that the scenario/transaction we have just created is now available as a FHIR Questionnaire, in XML and JSON.

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T09:12:30Z

Mligtvoet: /* Scenarios tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Add all the 'Person' concepts you added in the dataset to a transaction

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:56:47Z

Mligtvoet: /* Scenarios tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions called Initial and Response
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:55:53Z

Mligtvoet: /* Scenarios tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new transaction group.
## Fill in a name and description for the new transaction group
## Save
## Open the transaction group by clicking on the + left of its name in the treeview on the left.
# Select (in turn) in the treeview the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:30:49Z

Mligtvoet: /* Inherit a ZIB group */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving/Inherit'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

ART Dataset Viewer

2020-07-08T08:29:06Z

Mligtvoet:

=General info on datasets=
A dataset is a list of (hierarchical) concepts, see also: [[DECOR-dataset]].
=Viewing dataset=
Datasets can be accessed as follows:
* as a HTML-representation:
** go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
** select a project from the dropdown box '''DECOR'''
** by default the tab '''Project/General''' is opened
** the link to the static HTML-representation can be found under '''Reference'''. An example of a HTML-representation: [http://art-decor.org/demos/demo3/ DECOR Demo 3: EKG Report CDA Document]
* interactive representation:
** go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
** select a project from the dropdown box '''DECOR'''
** navigate to the '''Datasets''' tab
=Navigating dataset=
On the dataset page the following keyboard shortcuts can be used to navigate the concepts:
* CTRL + Y: up
* CTRL + G: left
* CTRL + H: right
* CTRL + B: down
Please note that these keys may already be in use in your browser. If so you have to reassign these keys in your browser configuration.

=Form parameters=
The dataset form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-datasets--[prefix]?id=[dataset id]&effectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]&language=[ll-CC]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project dataset with this id. Format: OID
| art v1.5
|-
| effectiveDate
| Switches to the project dataset with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| art v1.5
|- style="font-style:italic;"
| datasetId
| Switches to the project dataset with this id. Format: OID
| ''always'' (deprecated in art >= 1.5)
|-
| conceptId
| Switches to the project dataset concept with this id. Format: OID. If you do not specify params id/effectiveDate, then this param only works if the concept happens to be in the default/newest dataset
| ''always''
|-
| conceptEffectiveDate
| Switches to the project dataset concept with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId
| ''always''
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| art v1.8.51
|}

ART Dataset Editor

2020-07-08T08:27:07Z

Mligtvoet: /* Add a concept from a repository */

{{underconstruction}}
This text documents how datasets can be edited.
=Log in and navigate to the dataset page=
Perform the following steps:
* Prerequisite: you need an account with the proper [[ART_maintenance_manual#ART_user_roles|permissions]] to edit the project. Contact the project maintainer.
* go to the ART-DECOR [http://art-decor.org/art-decor/home main page]
* Log into ART-DECOR by clicking '''Login''' at the top-right
* select a project from the dropdown box '''DECOR'''
* navigate to the '''Datasets''' tab
=Building a dataset=
A dataset is a list of (hierarchical) concepts, see also: [[DECOR-dataset]].

Typically the first concepts created are concept groups which contain child concepts. Building a dataset is done by:
* Setting dataset attributes
* Adding concepts to the dataset, see: [[ART_Dataset_Editor#Add a concept group|add a concept group]] and [[ART_Dataset_Editor#Add a concept item|add a concept item]].

=Setting dataset attributes=
==Set the dataset status==
Datasets can have the following status:
* draft: (yellow) the dataset is under development (nascent), not ready for production use. This is the initial status for new datasets.
* final: (green) the dataset is finalized, and deemed fit for use.
* rejected: (purple) the dataset is rejected. During the development proces it was decided that further development on this dataset will not happen.
* cancelled: (blue) the dataset was never published and is withdrawn.

Below is a screenshot that displays the buttons to change the dataset status:
[[File:En_dataset_02.jpg|400px]]

==Set the dataset version label==
The dataset version ia a human readable version number or version label for convenient human rendition; not used by an application.
The version label can be altered by:
* adding text in the textbox
[[File:En_dataset_03.jpg|400px]]
* saving the version label by clicking on the button '''save'''
* cancelling the edit by clicking on the button '''cancel'''

==Set the dataset description==
The dataset can optionally contain a human readable text that describes the dataset.
Adding a dataset description is done by:
* Clicking on '''description''' folds out a text editor
[[File:En_dataset_04.jpg|750px]]
* Add text, and optionally use the text formatting tools.
* You may optionally link to images or other web addresses.
* Click on another textbox, for instance the '''name''' textbox
* The form will now display the '''save''' and '''cancel''' buttons to save the description, or cancel the edit.

=Concept attributes=
Concepts have the following attributes:
* Version: ART-DECOR enters a date when the concept is created
* Id: ART-DECOR will assign an identifier for new concepts based on the dataset identifier
* type: group or item. Groups can contain other concepts
* Status, see [[Concept status machine]]
* Name: A name for the artifact that will be meaningful to business or domain experts. One artifact may have different business name translations for each realm and/or language
* Description: One to many descriptions per language
* Source: human readable hint where this data element originally comes from
* Rationale: human readable justification or explanation why this concept is present
* Operationalization: how to measure, obtain, specify the value of an observation
* Comment: One to many comments on the concept
Only for concept items (not for groups):
* Value:
** Type: the datatype, see [[DECOR-dataset]]
** Properties, see [[DECOR-dataset|datatype facets]]
** Example, one or many example values for this concept

=Add a concept group=
A concept group is a concept that groups one or more child-concepts.
To create a dataset group perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px|Add dataset concept button]]
* Set the concept '''Type''' to '''Group'''
[[File:en_dataset_add_concept_type_group.png|750px|Set concept type to group]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept group, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset'''
* Save the concept group by clicking '''Save'''
[[File:En_dataset_add_concept_save.png|750px|Save concept]]

=Add a concept item=
To create a dataset concept item perform the following steps:
* Click '''add''', this will create a stub concept.
[[File:en_dataset_add_concept.png|750px]]
* Set the concept '''Type''' to '''Item'''
[[File:en_dataset_add_concept_type_item.png|750px|Set concept type to item]]
* Type a name for the concept group in '''Name'''
When you have entered a name for the concept, that name is now shown in the dataset tree on the left-hand side.
* Multiple textfields can now be added to the concept group: '''Description''', '''Relations''', '''Source''', '''Rationale''', '''Properties''', '''Operationalization''', '''Comment'''.
Single-click on one of those field names to open or close a textbox editor where you can enter text.
[[File:en_dataset_add_concept_description_item.png|750px|Add concept description]]
* It is possible to move the concept in the dataset tree by selecting '''Move concept within dataset'''
* Save the concept by clicking '''Save'''
[[File:en_dataset_add_concept_save_item.png|750px|Save concept]]

=Add a concept from a repository=
When you add a concept group or concept item, ART-DECOR automatically searches all known repositories for similar concepts.
Note that this is unrelated to which repository projects are configured in '''Projects''' / '''General''' / '''Repository reference'''.

Please note that:
* When you want to add a concept from the repository, your own concept should either be a group, or item. And that should be the same as the original concept in the repository.
* When adding concepts you can either add them:
** As reference: Select this option if you want a singular reference to the concept. This will allow you to go to the referenced concept, without pulling physically pulling it into your current structure. This option is suited for circular references. You may convert a reference to an inherited structure at any time.
** As inherit: Select this option if you want to copy the referenced structure into your current structure. Each concept will then point to its original for its properties (name, description, value domain etc.). This option is not suited for circular references. Your inherited structure will not automatically get new concepts if they are added in the original. You cannot convert an inherited structure into an reference.

=Add concept translations=
To add translations to your project, first make sure that:
* the project name itself is translated, see: [[ART_Project_Editor#Add_a_language_to_a_project|ART Project Editor Documentation]]
Now we can add translations to dataset concepts with the '''Translate''' button on the dataset concept editor form:

[[File:Dataset_concept_translate.png|450px]]

This will open a display for adding translations to the dataset concept.
You can add translations for the various dataset concept fields: Name, Synonym, Description, Source, Rationale, Comment, Operationalization.

After adding translations, click '''Close''' to close the form.
[[File:Dataset_concept_translate_close.png|450px]]

Next you need to click '''Save''' to save the translations:

[[File:Dataset_concept_translate_save.png|250px]]

=Example dataset=
=Removing concepts=
=Moving concepts=

=Form parameters=
The dataset form, as most other forms, supports parametrization.

<syntaxhighlight lang="text" enclose="div">
/decor-datasets--[prefix]?id=[dataset id]&effectiveDate=[dataset effective date]&conceptId=[concept id]&conceptEffectiveDate=[concept effective date]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| id
| Switches to the project dataset with this id. Format: OID
| art v1.5
|-
| effectiveDate
| Switches to the project dataset with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id
| art v1.5
|- style="font-style:italic;"
| datasetId
| Switches to the project dataset with this id. Format: OID
| ''always'' (deprecated in art >= 1.5)
|-
| conceptId
| Switches to the project dataset concept with this id. Format: OID. If you do not specify params id/effectiveDate, then this param only works if the concept happens to be in the default/newest dataset
| ''always''
|-
| conceptEffectiveDate
| Switches to the project dataset concept with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param conceptId
| ''always''
|}

=Locking=

ART uses concept level locking to prevent multiple users form editing the same item. When a concept is edited this concept and all children of this concept are locked. Locks are released when the changes are saved or the action is cancelled, when navigating away from the page a warning is displayed:

[[File:Page-leave-message.png|300px]]

Navigating away from the page without saving the changes or cancelling the edit will leave the lock in place. If the same user attempts to edit the item at a later time the lock will be cleared automatically, if another user attempts to edit the item a message is displayed that the item is locked:

[[File:Concept-locked-message.png|400px]]

It is possible to break the lock at this time, be sure that no other user is actually working on this item before breaking a lock.

Project administrators can access an overview of all locks for the project on the Status tab of the Project Information page:

[[File:Project-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

The Status tab on the DECOR administration page shows the locks for all projects:

[[File:Decor-locks.png|750px]]

Individual locks can be cleared here and all locks for a particular user can also be cleared here.

Testscenario test author dutch

2020-07-08T08:17:55Z

Mligtvoet: /* Issues */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==
For documentation, see the [[ART_Issues|Issue manual]].

For this section, click on the Issues menu (in the top menu bar).

Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:17:33Z

Mligtvoet: /* Templates */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==
For documentation, see the [[ART_Template_Editor|Template editor manual]]

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:16:56Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==
For documentation, see the [[ART_Value_Set_Editor|Value Set Editor manual]]

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:16:19Z

Mligtvoet: /* Project tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For documentation, see the Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:15:46Z

Mligtvoet: /* Datasets */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
For documentation, see the [[ART_Dataset_Editor|Dataset editor manual]].

Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T08:04:11Z

Mligtvoet: /* Add concepts */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First look at all the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add your own Person concept by clicking on the +
# Give the Person concept a unique name, for instance: PersonYourFirstName
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Person/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T07:58:55Z

Mligtvoet: /* General tab / Algemeen */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author, who is also a project admin
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First check al the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add the Person concept by clicking on the +
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Persoon/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T07:56:44Z

Mligtvoet: /* Governance Groups tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# This step will only be demonstrated, since we usually do not want to change governance configuration.
Demo: Make the project member of a governance group (e.g. your own organization)

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First check al the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add the Person concept by clicking on the +
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Persoon/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T07:43:08Z

Mligtvoet: /* Scenarios */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# Make the project member of a governance group (e.g. Nictiz) by clicking on the + to the left of the governance group name.

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First check al the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add the Person concept by clicking on the +
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Persoon/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==
For documentation, see [[ART_Scenario_Editor|manual]]

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-08T07:39:53Z

Mligtvoet: /* Project tab */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
For more information: Project Editor [[ART_Project_Editor|manual]]
===General tab / Algemeen===
Exercise project 1:
# Login as project author
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# Make the project member of a governance group (e.g. Nictiz) by clicking on the + to the left of the governance group name.

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First check al the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add the Person concept by clicking on the +
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Persoon/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

Testscenario test author dutch

2020-07-03T06:24:50Z

Mligtvoet: /* Value Sets (in Terminology) */

=Introduction=

This is a testscenario for ART-DECOR information standards. During the test an ART-DECOR project is recreated, based on the demo5 project from ART-DECOR examples (see see [[https://art-decor.org/art-decor/decor-project--demo5-]] or [[https://sourceforge.net/p/artdecor/code-0/HEAD/tree/branches/stable/decor/data/examples/demo5/demo5-decor.xml]]).
Note that some content such as ZIBs/HCIM are only used in a Dutch context.

To execute the scenario, you need the following user accounts:
# A general author account
# Access to the project as an author: https://decor.nictiz.nl/art-decor/decor-project--snictiz-

Note that a lot of steps described below require saving after edit.

=Steps to perform for this scenario=
==Start with clean setup==
Delete the contents (only datasets/scenarios/terminology/issues/templates) of the project if it already exists.

This can be done ''only'' by having low level access with admin rights to the underlying eXist database: Delete the collection the project's data resides in. For this test project: /db/apps/decor/data/projects/test

==Project tab==
===General tab / Algemeen===
Exercise project 1:
# Login as project author
# Add or change the description of the project
Exercise project 2:
# Add building block repositories with prefixes 'ad1bbr-' & 'ad2bbr-' by clicking on the + next to 'Repository references'. Note that this action can only be performed by a 'decor-admin'
# Check that building block repository 'zib2017bbr-' is added, or add it yourself

===Copyright tab===
Exercise project 3:
# Add a Contributer by clicking the +.
# Enter name and contact information.
# Add a logo from your computer by clicking on add and then browse.
# Enter the correct Copyright years. Examples are: 2012-2016, 2012-

===Authors tab===
Exercise project 4:
# Add an author by clicking on the +.

===Governance Groups tab===

For more information: [[Dealing_with_Governance_Groups|Dealing with governance groups]].
Exercise project 5:
# Make the project member of a governance group (e.g. Nictiz) by clicking on the + to the left of the governance group name.

==Datasets==
Login as project author.
For this section, click on the Datasets menu (in the top menu bar).

===Basic dataset changes===

Use the "Datasets/Datasets" tab.
On this page the metadata for all datasets in the project can be managed.
Documentation: [[ART_Dataset_Editor#Setting_dataset_attributes]]

Make some basic changes to the test dataset:
Exercise dataset 1:
# Select a dataset
# Add a version label
# Fill in a dataset description
# Save

===Add concepts===

For more information check the [[ART_Dataset_Editor|Dataset editor manual]].

Exercise dataset 2:
Use the "Concepts Test dataset" tab. Recreate the concept "Person" (and underlying concepts) from the demo5 project dataset, see [[https://art-decor.org/art-decor/decor-datasets--demo5-?id=2.16.840.1.113883.3.1937.99.60.5.1.1&effectiveDate=2014-07-08T00%3A00%3A00&conceptId=2.16.840.1.113883.3.1937.99.60.5.2.10&conceptEffectiveDate=2014-07-08T00%3A00%3A00&language=en-US]]

# First check al the child concepts of 'Person'. For each concept, have a look at the Value/type, Waarde/Soort.

# Add the Person concept by clicking on the +
# Enter Description, Source, Rationale, Operationalization, Comment.
# For each concept:
## Select the right kind of type (group or item)
## Add a name for the concept.
## At 'Value' select the type
## Note that we shall use Persoon/Gender at a later stage in this session. Check the value/type for this concept.

=== Inherit a ZIB group ===

Exercise dataset 3:
# Add a concept group, name 'Patient', filter below on Zorginformatiebouwstenen (ZIB) 2017
# Select the concept below
# Select the wheel icon on the right, Concept selecteren
# Select 'Als overerving'
# Save the concept group

==Scenarios==

For this section, click on the Scenario's menu (in the top menu bar).

===Add actors===

Use the Actors tab.
Exercise scenarios 1:

# Add two actors by clicking on the +

===Scenarios tab===

Use the Scenarios tab.
Exercise scenarios 2:
# Add a scenario by clicking the + next to Scenarios.
## Fill in a name and description for the new scenario
## Save
# Open the scenario by clicking on the + left of its name in the tree view on the left.
# Click on the default group "Group"
# Click on the + at the top of the tree view. This will create a new group.
## Fill in a name and description for the new group
## Save
# Select (in turn) in the tree view the transactions of the group (called Initial and Response)
## Edit them (by clicking the pencil in top right)
## Fill in some data (label, description, change name)
Exercise scenarios 3:
## You can add Concepts to the added transaction by clicking on the pencil next to the word 'Concepts'. This pencil is only visible when the Transaction is not in edit mode, so make sure you save the transaction before trying to add concepts.
To add concepts in the transaction you start by selecting a parent group, while that concept group is selected, click next to Card/Conf on an option that applies: All 1..1 R, All 0..1 R, ..
Click save and then close the window to go back to the transaction.
## Create a transaction for all the 'Person' concepts you added in the dataset.

You can always edit a transaction or transaction group by clicking on it in Scenarios. Then click on the pencil next to the word 'Transaction' to edit.
For more information check the [[ART_Scenario_Editor|Scenario Editor manual]]

==Value Sets (in Terminology) ==

For this section, click on the Terminology menu (in the top menu bar) and choose Value Sets.

For more information: [[ART_Value_Set_Editor|Value Set Editor manual]]

Exercise valuesets 1:
# Create a new valueset.
## Click on the + above the tree view on the left-hand side. A new window opens.
## Fill in Version label, Display Name (mandatory) and Name (mandatory). The display name may hold spaces but the Name has to be one word.

Exercise valuesets 2:
# Add first value
## Check that the source/bron is SNOMED, click Select to activate it, this will show a popup which the search window for the codesystem.
## Enter search term: bloedgroep
## SNOMED codes may be added one by one to the valueset. Select one from the search results and 'toevoegen aan waardelijst'/'Add to valueset'
## Click button: Close
## Store the new valueset by clicking 'save'

Exercise valuesets 3:
# We will manually edit the valueset we just created and add a code manually
## Add manual data by clicking on the + to the left of Values to create a new code line. Fill in a Level en select a Type L. Also fill in a code (required) and a Display name (required).
## Save the value set (When the save button is not clickable you probably did not fill in one of the mandatory fields. Also check if the 'Name' really is only one word and if the Code only contains numbers and dots.)

Exercise valuesets 4:
# Create a reference
## Precondition: repository reference to a bbr project is already present
## Usually it will help to open the repository project in a separate browser window and search the valueset first
## In the project where you want to add the reference: Click on the "chain" icon above the tree view on the left-hand side
## Search for a valueset, and select it to save it to this project
For instance for the zib2017bbr repository, search for 'Allergie'

Exercise valuesets 5:
# Check if the valueset 'GeslachtCodelijst'/Gender, is present as a referenced valueset. If not, add it as a referenced valueset to the project.

=== Terminologiekoppelingen / Terminology associations ===
Exercise valuesets 6:
We will add an association between the person/gender dataset concept, and the GeslachtCodelijst/Gender valueset.
This works because the person/gender dataset concept has waarde/value type 'Code'.

# Go to Terminology / Terminologiekoppelingen.
# Select from the dataset tree the concept person/gender.
# Add a waardelijstkoppeling/valueset association by clicking on the right of Waardelijstkoppelingen.
# Select the valueset you want to associate the dataset concept with, in this example GeslachtCodelijst.
# 'Statische koppeling aanmaken' to create the association with this fixed version of the valueset.
# Go back to the dataset to view the dataset concept and associated valueset.

'''REMARK''': To see the newly created value set in the Value Sets screen you have to refresh it!

==Templates==

For this section, click on the Templates menu (in the top menu bar) and choose the Templates menu entry.

For more information: [[ART_Template_Editor|Template editor manual]]
Exercise templates 1:
# Create a template by inheritance. Click on the + above the tree view on the left-hand side. A new window opens.
## Filter on zorginformatiebouwstenen repository and select a template from that project.
## Confirm by 'Selecteren/select'
## This will inherit the template into our own project

Exercise templates 2:
# Edit a template by selecting it and clicking on the pencil on the right of the name of the template to edit it.
# Make a change and save the template

==Issues==

For this section, click on the Issues menu (in the top menu bar).

For more information: [[ART_Issues|Issue manual]].
Exercise issues 1:
# Add an issue by clicking on the flag to the right
## Select the correct type (incident, change request, for future consideration, request for information/education)
## Fill in a title.
## Select the desired priority (Lowest, Low, Normal, High, Highest).
## Fill in description
## Assign issue to an author
## Save

FHIR Questionnaire support

2020-06-12T12:35:26Z

Mligtvoet: /* Intro */

=Intro=
FHIR Questionnaires are the format to define the various questionnaires used in healthcare to capture data from patients or professionals. Questionnaires are more free-format than FHIR resources, but still constrained. A Questionnaire is basically a nested tree of typed questions, i.e. a question can be a boolean, or a choice of answer options, or free text etc.

ART-DECOR datasets are, basically, a nested tree of typed items. Datasets cover a healthcare domain, ART-DECOR transactions a particular use case. The data types supported by ART-DECOR are similar to those in Questionnaires.

ART-DECOR now supports serializing any transaction as a Questionnaire, in JSON and XML format, and HTML rendering using the open source [http://lhncbc.github.io/lforms/ LHCForms] library (other options are planned). Of course this does not make sense for all transactions, but it can serve as an instant prototyping tool, and allows using ART-DECOR as a fine FHIR Questionnaire Management Tool.

The FHIR Questionnaires can be accessed from the [[ART_Project_Editor#Project_Index|ProjectIndex]].

=DECOR to Questionnaire translation=
==Serialization==
Both XML:
<syntaxhighlight lang="xml" heading="measurement_message.xml">
<item>
<extension url="http://hl7.org/fhir/StructureDefinition/questionnaire-unit">
<valueCoding>
<display value="kg"/>
</valueCoding>
</extension>
<linkId value="2.16.840.1.113883.3.1937.99.62.3.2.3--2011-01-28T00:00:00"/>
<code>
<system value="http://loinc.org"/>
<code value="29463-7"/>
<display value="Body weight"/>
</code>
<text value="Gewicht"/>
<type value="quantity"/>
<required value="true"/>
<repeats value="false"/>
</item>
</syntaxhighlight>
and JSON are supported:
<syntaxhighlight lang="javascript" heading="measurement_message.xml">
"item": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/questionnaire-unit",
"valueCoding": {"display": "kg"}
}
],
"linkId": "2.16.840.1.113883.3.1937.99.62.3.2.3--2011-01-28T00:00:00",
"code": [
{
"system": "http://loinc.org",
"code": "29463-7",
"display": "Body weight"
}
],
"text": "Weight",
"type": "quantity",
"required": true,
"repeats": false
},
</syntaxhighlight>

Notes:
* units are added when present in the dataset
* required is derived from transaction minimumMultiplicity
* repeats is derived from transaction maximumMultiplicity
* unique linkId's are made from concept id and effectiveDate

==Type conversion==
{| class="wikitable"
|-
! DECOR type !! FHIR Questionnaire type
|-
|group || group
|-
|boolean || boolean
|-
|date || date
|-
|decimal || decimal
|-
|quantity || quantity
|-
|string || string
|-
|text || string
|-
|code (referring to valueSet) || choice
|-
|code (referring to complete codeSystem) || string
|-
|count || integer
|-
|datetime || dateTime
|-
|quantity || quantity
|-
|duration || decimal
|-
|identifier || string
|-
|ordinal || choice
|}

Notes:
* DECOR datatype facets translate to Questionnaire properties:
** default to initial.value[x]
** fixed to readonly
** maxLength to maxLength
* but: facet default on code does not work yet, Questionnaires expects a Coding, and DECOR default is just a string
* enableWhen support is planned as a future enhancement

ART Project Editor

2020-06-12T12:32:40Z

Mligtvoet: /* Project Index */

__TOC__
=Changing the name of a project=
Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

=Add a language to a project=
If you want to add a language to a project, you can perform the following steps:
Open '''Project'''-tab, section: '''general'''

Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Click on the plus to add a language:

[[File:En_language_add_02.jpg|500px]]

Enter a new language in the first field, for instance: en-US

Add an English name for the project.

To save, click on the button: '''Change'''
[[File:En_language_add_03.jpg|500px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

Select the added language in the top-right:
[[File:En_language_add_05.jpg|750px]]
The project name should now be shown in English.
[[File:En_language_add_06.jpg|500px]]

After adding a translation for the project name, this will enable you to add translations to dataset concepts, see [[ART_Dataset_Editor#Add_concept_translations|Dataset Editor documentation]].

=Description=
The description of a project can be added or changed. The description and editor supports html-layout. The description can contain, for instance:
* General information about the project
* Links to external websites with more information on the project.
* Terms of use of the content in the project
* Disclaimer of the content in the project
* License information of the content in the project

=Properties=
==Project prefix==
This area shows the project prefix. This is a read-only field, the prefix can not be changed.

==Default language==
When the project supports multiple languages, a default language for display can be selected here.

[[File:default_language_en.png|750px]]

Select the language new default language from the dropdown list of available languages, and afterwards '''save''' to store this setting.

For adding languages, see [[ART_Project_Editor#Add_a_language_to_a_project|Add a language to a project]]

==Marking a project as building block repository==
In the project-tab, projects can be marked as building block repository (BBR). In that way they are marked as containing reusable content. Content from BBR's can be reused in other projects.
The contents of this 'project' are considered suitable for re-use by other projects when this setting is active.

Follow these steps to mark a project as BBR:
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Contains reusable content?'''
[[File:mark_repository.png|750px]]

* Click '''Save''' to update the project information

==Privacy settings==
A project can be marked as private with: 'Is private'?
The project is not listed in the menus and ignored in searches when this setting is active. This useful for projects in incubation fase. You may still work in the project based on direct URLs

==Marking a project as Experimental==
Project is experimental or meant to test things rather than aimed at production use.
The project should not contain content that is meant for production use.

==Issue Notifier==
The external services that can be configured on the project-tab:
* The ART-DECOR Automatic Notifier System ([[ADANS]]): email about changes in issues in the project.

=Project Index=
The ART-DECOR Projext Index offers a read-only view on datasets, transactions, value sets, templates and code systems per project:
* Project oriented/as a service: see [[URIs#ProjectIndex|URIs Projectindex]] services '''ProjectIndex''' or '''ValueSetIndex'''. These services support multiple machine-processable formats such as (for example): xml or csv.

The Project Index can be accessed by clicking on the link:
[[File:Projectindex.png|450px]]

Screenshot of the Project index of an example project:
[[File:Projectindex_en_demo1.png|750px]]

=Reference a building block repository=
In order to use concepts, value sets, and templates from a BBR (building block repository), it is necessary to first add a reference to a repository. Follow these steps to add a reference to a BBR from a project:
* If not done yet: First mark the project containing reusable content as BBR, see [[ART_Project_Editor#Marking_a_project_as_building_block_repository]]
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Add building block repository'''. This will show a list of BBR's (depending on the server settings, these can include BBR's that reside on this server and/or BBR's that reside on external servers. See also the [[ART_maintenance_manual#External_repository_server|ART maintenance manual]]).
* Select a BBR
* Click '''add''' to add a BBR-reference in the current project
Screenshot that shows the user-interface for adding a BBR-reference from a project:
[[File:En_project_bbr_reference.png|750px]]
* Click '''Save''' to update the project information
* After saving the project information, the BBR-reference is shown like:
[[File:En_project_bbr_reference_added.png|750px]]
* After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project

=Adding authors to a project=
Before a user can edit a project, the following steps must be performed:
* the user must have a personal ART-DECOR user account, please [[Contact]] us to obtain one
* the user must have the proper group permissions (See also the [[ART_maintenance_manual#ART_user_roles|ART maintenance manual]])
* Now the user can be added to the project by a decor-admin from the project:
** Log in as '''decor-admin'''
** Go to tab '''Project/Authors'''
** Add a user to the current project by clicking '''Add author'''
** Select the user
** Click '''Add'''
** Click '''Save''' to update the project information

=Project specific author settings=
Any ART-DECOR user may be active in multiple projects. He may be acting from different organizations depending on the project, and he may be more or (temporarily) less involved. For these reasons ART-DECOR supports switching on/off notification settings for [[ADANS]] on a project specific level.
Any user with 'decor-admin' rights in the project can adjust the settings for any project author. In addition to that, the decor-admin project user may switch the ADANS notifier on/off for the entire project. All other project (issue) authors can adjust their own settings.

The notifiers work as follows:
* project notifier is on when it is '---' or 'on'. project notifier is off when it is 'off' (project opt-out)
* user notifier is on when it is 'on'. project notifier is off when it is '---' or 'off' (user opt-in)

[[File:project-author-decor-view.png|750px|normal user view]]

[[File:project-author-decor-admin-view.png|750px|decor-admin user view]]

=Preflighting publication and quality checks=
A number of checks can be done to check the quality of your project before you create a publication.

1) Is the project schema and schematron valid?
In order to check this:
* Log in as '''decor-admin'''
* Go to the page 'Project/Development'
[[File:en_development_check_01.png|350px|Click Development page]]
* Make sure the correct dataset is selected
[[File:en_development_check_02.png|350px|Select dataset]]
* Click the button to Check DECOR
[[File:en_development_check_03.png|350px|Click Check DECOR]]

2) Consider making dynamic template and value set links static.
In a final release you would not expect any dynamic template links.
In a final release you may expect dynamic value set links, although they are likely the exception.

3) Run a [[TerminologyReport]] to check the quality of terminology content contained in the project.

4) Compile a development version (temporary build) to test compilation and schematron validation against samples until you are satisfied that no valid things are marked invalid and vice versa.

Possible parameters for compilation are:
* '''Schematron closed'''
* '''Explicit includes''': When active the schematron process should make sure that the main schematron only includes templates that are explicitly associated directly or indirectly to the current template. When inactive, the schematron process should contain schematron includes for any defined template in the scope of this DECOR project, regardless whether they are associated directly or indirectly to the current template.
* '''Abort on recursive definition'''
* '''Force recompile''': By default, if a compilation exists that is newer than the last modified date of the project, this compilation will be used. If you want to include changes from other projects (BBRs) that occurred after the compilation, you will need to force recompile

[[File:Development_version_01.png|650px|Compile a development version: setting parameters]]

Start the compilation process:
[[File:Development_version_02.png|550px|Compile a development version: compiling]]

After compiling you can validate XML instances from your desktop against the compiled schematron:
[[File:Development_version_03.png|950px|Validate XML instance]]

=Creating a new version / release / publication request=
ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project.
The creation of a version/release works as follows:
* Log in as '''decor-admin'''
* Check that ADRAM is configured for this project. On the tab 'Project/General', Publication location should contain a URL where the publication is going to be published. Behind the 'Publication location' it should show 'Release and Archive Manager configured' (this checks that ADRAM is configured for this project at the publication location).
[[File:En project publication 01.jpg|750px|normal user view]]

On the tab 'Project/Version information', one can create a new version/release/publication request by clicking on the plus button (see 1 at figure below). In addition the publication parameters and filter can be set by clicking on the wheel button (2). Finally you may compare two releases of your project by clicking on the delta button (3).
[[File:Projectpublication02.png|750px|normal user view]]

When clicking on the plus button, a dialog is presented where information detailing the version/release/publication request can be entered:
* Description: enter a text describing the version or release.
* Type: Intermediate version, or Release. For a release a release label can be entered.
* Save compilations in the following languages: languages can be de-selected to exclude them from the publication.
* Publication request: selecting this checkbox will trigger ADRAM to create a publication at the publication location shown.
* Select 'Add' to confirm.
[[File:En project publication 03.jpg|750px|normal user view]]

==Publication parameters==
The wheel button presents a small dialog to change and maintain the publication parameters. It is organised in a few tabs (see 1 at figure below) ''General'', ''ISO schematron generation'', ''Human readable publication'' and Publication ''Filter'' and a cancel and save button below (2).
The parameters can be switched on or off, a description is shown to explain what the parameter is for.

===General tab===
[[File:Projectpublication10.png|550px|normal user view]]

===ISO schematron generation tab===
[[File:Publication_parameters_01.png|550px|normal user view]]

===Human readable publication tab===
In the ''Human readable publication'' tab there is also a small lists of artefact categories to be chosen from to determine whether they are included in a resulting PDF or not (1).
[[File:Projectpublication11.png|550px|normal user view]]

===Filter tab===
The Publication ''Filter'' tab allows to set filters on and off, i.e. whether a publication contains all scenarios/transactions of the project (filter "off", see 1) or only selected ones. You can select either one or multiple scenarios/transactions from your project's scenarios/transactions in the list (2). You must give a label to your filter in order to describe the nature of the partial publication (3). The "Select all" and "Clear selection" button allows you to select all or none of the scenarios/transactions (4).
[[File:Projectpublication12.png|550px|normal user view]]

==Publication status==
The following different kinds of publication status are supported:
*When a publication request is first released by ADRAM and appears on the HTML landing page, its status is '''Under pre-publication review'''. The publication may be moved from that status to any of the following statuses.
*'''Draft''': The publication is in draft, not yet finalized (nascent) and may be overridden at any time by a new and final release.
*'''Active''': The publication is final (active) and can be considered for production use.
*'''Retired''' The publication is considered to be no longer used.
*'''Cancelled''': A publication has withdrawn, has never been used.
*'''Build failed''': This special status represents that during the build and compile phase of the publication, ADRAM detected a processing error.

ADRAM will check periodically for new publication requests and will create the publication at the publication location. Typically a review should be done after which the publication status can be upgraded to 'Draft/Active/Retired/Cancelled' via the tab 'Project/ Versions/Releases'. The status for a publication can now be updated in the column 'Edit':
[[File:En project publication 05.jpg|750px|normal user view]]

ADRAM will re-check and update the publication status at the publication location. Visit the publication location URL to see the various releases:
[[File:En project publication 04.jpg|750px|normal user view]]

=Maintaining a local OID Registry=
ART-DECOR has a central place for registration of OIDs but you can certainly have your own local registrations. This is useful for example when your project contain references to code systems not maintained in ART-DECOR, nor administered in one of the hosted central OID Registries. Please note that centralized registration is usually to be preferred.

To view the local ids, you don't need to login. To update them you need to have decor-admin privileges and be author in the project. In both cases, go to the Ids tab on the Project form.

The Ids tab is divided in two sections "External Ids" and "Base Ids". The ''External Ids'' is meant for OID, defined and potentially registered outside the project, and used in the project. The External Ids may be of any type like Identifiers, Identification systems, Code systems etc. The ''Base Ids'' are used as an Identification system for the identification of various DECOR project artifacts and are normally derived from the project id.

Add a new id in either section using the appropriate <nowiki>[</nowiki>+<nowiki>]</nowiki> button. Update a description by updating the appropriate fields. Don't forget to Save.

The base ids also sport the option "Default". When you have multiple base ids for a specific type, you may switch the default base id. Switching the default means that new artifacts of that type will be created using this new default unless you override.

[[File:En_project_ids_01.png|750px|project ids]]

=Form parameters=
The project form, as most other forms, supports parametrization.

<syntaxhighlight lang="text">
/decor-project--[prefix]?section=[section name]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| section
| Switches to the requested section. Options
* general (default) - switches to the tab General
* copyright - switches to the tab Copyright/Contributors
* authors - switches to the tab Authors
* versions - switches to the tab Versions
* ids - switches to the tab Ids (admin only)
* status - switches to the tab Status (admin only)
* maintenance - switches to the tab Maintenance (admin only)
* governancegroups - switches to the tab Governance groups
| art v1.5.3
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| art v1.8.51
|}

File:Projectindex en demo1.png

2020-06-12T12:32:07Z

Mligtvoet:

File:Projectindex example.png

2020-06-12T12:27:23Z

Mligtvoet: Mligtvoet uploaded a new version of "File:Projectindex example.png"

File:Projectindex example.png

2020-06-12T12:24:54Z

Mligtvoet: Mligtvoet uploaded a new version of "File:Projectindex example.png"

ART Project Editor

2020-06-08T07:12:58Z

Mligtvoet: /* Preflighting publication and quality checks */

__TOC__
=Changing the name of a project=
Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

=Add a language to a project=
If you want to add a language to a project, you can perform the following steps:
Open '''Project'''-tab, section: '''general'''

Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Click on the plus to add a language:

[[File:En_language_add_02.jpg|500px]]

Enter a new language in the first field, for instance: en-US

Add an English name for the project.

To save, click on the button: '''Change'''
[[File:En_language_add_03.jpg|500px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

Select the added language in the top-right:
[[File:En_language_add_05.jpg|750px]]
The project name should now be shown in English.
[[File:En_language_add_06.jpg|500px]]

After adding a translation for the project name, this will enable you to add translations to dataset concepts, see [[ART_Dataset_Editor#Add_concept_translations|Dataset Editor documentation]].

=Description=
The description of a project can be added or changed. The description and editor supports html-layout. The description can contain, for instance:
* General information about the project
* Links to external websites with more information on the project.
* Terms of use of the content in the project
* Disclaimer of the content in the project
* License information of the content in the project

=Properties=
==Project prefix==
This area shows the project prefix. This is a read-only field, the prefix can not be changed.

==Default language==
When the project supports multiple languages, a default language for display can be selected here.

[[File:default_language_en.png|750px]]

Select the language new default language from the dropdown list of available languages, and afterwards '''save''' to store this setting.

For adding languages, see [[ART_Project_Editor#Add_a_language_to_a_project|Add a language to a project]]

==Marking a project as building block repository==
In the project-tab, projects can be marked as building block repository (BBR). In that way they are marked as containing reusable content. Content from BBR's can be reused in other projects.
The contents of this 'project' are considered suitable for re-use by other projects when this setting is active.

Follow these steps to mark a project as BBR:
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Contains reusable content?'''
[[File:mark_repository.png|750px]]

* Click '''Save''' to update the project information

==Privacy settings==
A project can be marked as private with: 'Is private'?
The project is not listed in the menus and ignored in searches when this setting is active. This useful for projects in incubation fase. You may still work in the project based on direct URLs

==Marking a project as Experimental==
Project is experimental or meant to test things rather than aimed at production use.
The project should not contain content that is meant for production use.

==Issue Notifier==
The external services that can be configured on the project-tab:
* The ART-DECOR Automatic Notifier System ([[ADANS]]): email about changes in issues in the project.

=Project Index=
The ART-DECOR Projext Index offers a read-only view on datasets, transactions, value sets, templates and code systems per project:
* Project oriented/as a service: see [[URIs#ProjectIndex|URIs Projectindex]] services '''ProjectIndex''' or '''ValueSetIndex'''. These services support multiple machine-processable formats such as (for example): xml or csv.

The Project Index can be accessed by clicking on the link:
[[File:Projectindex.png|450px]]

Screenshot of the Project index of an example project:
[[File:Projectindex_example.png|650px]]

=Reference a building block repository=
In order to use concepts, value sets, and templates from a BBR (building block repository), it is necessary to first add a reference to a repository. Follow these steps to add a reference to a BBR from a project:
* If not done yet: First mark the project containing reusable content as BBR, see [[ART_Project_Editor#Marking_a_project_as_building_block_repository]]
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Add building block repository'''. This will show a list of BBR's (depending on the server settings, these can include BBR's that reside on this server and/or BBR's that reside on external servers. See also the [[ART_maintenance_manual#External_repository_server|ART maintenance manual]]).
* Select a BBR
* Click '''add''' to add a BBR-reference in the current project
Screenshot that shows the user-interface for adding a BBR-reference from a project:
[[File:En_project_bbr_reference.png|750px]]
* Click '''Save''' to update the project information
* After saving the project information, the BBR-reference is shown like:
[[File:En_project_bbr_reference_added.png|750px]]
* After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project

=Adding authors to a project=
Before a user can edit a project, the following steps must be performed:
* the user must have a personal ART-DECOR user account, please [[Contact]] us to obtain one
* the user must have the proper group permissions (See also the [[ART_maintenance_manual#ART_user_roles|ART maintenance manual]])
* Now the user can be added to the project by a decor-admin from the project:
** Log in as '''decor-admin'''
** Go to tab '''Project/Authors'''
** Add a user to the current project by clicking '''Add author'''
** Select the user
** Click '''Add'''
** Click '''Save''' to update the project information

=Project specific author settings=
Any ART-DECOR user may be active in multiple projects. He may be acting from different organizations depending on the project, and he may be more or (temporarily) less involved. For these reasons ART-DECOR supports switching on/off notification settings for [[ADANS]] on a project specific level.
Any user with 'decor-admin' rights in the project can adjust the settings for any project author. In addition to that, the decor-admin project user may switch the ADANS notifier on/off for the entire project. All other project (issue) authors can adjust their own settings.

The notifiers work as follows:
* project notifier is on when it is '---' or 'on'. project notifier is off when it is 'off' (project opt-out)
* user notifier is on when it is 'on'. project notifier is off when it is '---' or 'off' (user opt-in)

[[File:project-author-decor-view.png|750px|normal user view]]

[[File:project-author-decor-admin-view.png|750px|decor-admin user view]]

=Preflighting publication and quality checks=
A number of checks can be done to check the quality of your project before you create a publication.

1) Is the project schema and schematron valid?
In order to check this:
* Log in as '''decor-admin'''
* Go to the page 'Project/Development'
[[File:en_development_check_01.png|350px|Click Development page]]
* Make sure the correct dataset is selected
[[File:en_development_check_02.png|350px|Select dataset]]
* Click the button to Check DECOR
[[File:en_development_check_03.png|350px|Click Check DECOR]]

2) Consider making dynamic template and value set links static.
In a final release you would not expect any dynamic template links.
In a final release you may expect dynamic value set links, although they are likely the exception.

3) Run a [[TerminologyReport]] to check the quality of terminology content contained in the project.

4) Compile a development version (temporary build) to test compilation and schematron validation against samples until you are satisfied that no valid things are marked invalid and vice versa.

Possible parameters for compilation are:
* '''Schematron closed'''
* '''Explicit includes''': When active the schematron process should make sure that the main schematron only includes templates that are explicitly associated directly or indirectly to the current template. When inactive, the schematron process should contain schematron includes for any defined template in the scope of this DECOR project, regardless whether they are associated directly or indirectly to the current template.
* '''Abort on recursive definition'''
* '''Force recompile''': By default, if a compilation exists that is newer than the last modified date of the project, this compilation will be used. If you want to include changes from other projects (BBRs) that occurred after the compilation, you will need to force recompile

[[File:Development_version_01.png|650px|Compile a development version: setting parameters]]

Start the compilation process:
[[File:Development_version_02.png|550px|Compile a development version: compiling]]

After compiling you can validate XML instances from your desktop against the compiled schematron:
[[File:Development_version_03.png|950px|Validate XML instance]]

=Creating a new version / release / publication request=
ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project.
The creation of a version/release works as follows:
* Log in as '''decor-admin'''
* Check that ADRAM is configured for this project. On the tab 'Project/General', Publication location should contain a URL where the publication is going to be published. Behind the 'Publication location' it should show 'Release and Archive Manager configured' (this checks that ADRAM is configured for this project at the publication location).
[[File:En project publication 01.jpg|750px|normal user view]]

On the tab 'Project/Version information', one can create a new version/release/publication request by clicking on the plus button (see 1 at figure below). In addition the publication parameters and filter can be set by clicking on the wheel button (2). Finally you may compare two releases of your project by clicking on the delta button (3).
[[File:Projectpublication02.png|750px|normal user view]]

When clicking on the plus button, a dialog is presented where information detailing the version/release/publication request can be entered:
* Description: enter a text describing the version or release.
* Type: Intermediate version, or Release. For a release a release label can be entered.
* Save compilations in the following languages: languages can be de-selected to exclude them from the publication.
* Publication request: selecting this checkbox will trigger ADRAM to create a publication at the publication location shown.
* Select 'Add' to confirm.
[[File:En project publication 03.jpg|750px|normal user view]]

==Publication parameters==
The wheel button presents a small dialog to change and maintain the publication parameters. It is organised in a few tabs (see 1 at figure below) ''General'', ''ISO schematron generation'', ''Human readable publication'' and Publication ''Filter'' and a cancel and save button below (2).
The parameters can be switched on or off, a description is shown to explain what the parameter is for.

===General tab===
[[File:Projectpublication10.png|550px|normal user view]]

===ISO schematron generation tab===
[[File:Publication_parameters_01.png|550px|normal user view]]

===Human readable publication tab===
In the ''Human readable publication'' tab there is also a small lists of artefact categories to be chosen from to determine whether they are included in a resulting PDF or not (1).
[[File:Projectpublication11.png|550px|normal user view]]

===Filter tab===
The Publication ''Filter'' tab allows to set filters on and off, i.e. whether a publication contains all scenarios/transactions of the project (filter "off", see 1) or only selected ones. You can select either one or multiple scenarios/transactions from your project's scenarios/transactions in the list (2). You must give a label to your filter in order to describe the nature of the partial publication (3). The "Select all" and "Clear selection" button allows you to select all or none of the scenarios/transactions (4).
[[File:Projectpublication12.png|550px|normal user view]]

==Publication status==
The following different kinds of publication status are supported:
*When a publication request is first released by ADRAM and appears on the HTML landing page, its status is '''Under pre-publication review'''. The publication may be moved from that status to any of the following statuses.
*'''Draft''': The publication is in draft, not yet finalized (nascent) and may be overridden at any time by a new and final release.
*'''Active''': The publication is final (active) and can be considered for production use.
*'''Retired''' The publication is considered to be no longer used.
*'''Cancelled''': A publication has withdrawn, has never been used.
*'''Build failed''': This special status represents that during the build and compile phase of the publication, ADRAM detected a processing error.

ADRAM will check periodically for new publication requests and will create the publication at the publication location. Typically a review should be done after which the publication status can be upgraded to 'Draft/Active/Retired/Cancelled' via the tab 'Project/ Versions/Releases'. The status for a publication can now be updated in the column 'Edit':
[[File:En project publication 05.jpg|750px|normal user view]]

ADRAM will re-check and update the publication status at the publication location. Visit the publication location URL to see the various releases:
[[File:En project publication 04.jpg|750px|normal user view]]

=Maintaining a local OID Registry=
ART-DECOR has a central place for registration of OIDs but you can certainly have your own local registrations. This is useful for example when your project contain references to code systems not maintained in ART-DECOR, nor administered in one of the hosted central OID Registries. Please note that centralized registration is usually to be preferred.

To view the local ids, you don't need to login. To update them you need to have decor-admin privileges and be author in the project. In both cases, go to the Ids tab on the Project form.

The Ids tab is divided in two sections "External Ids" and "Base Ids". The ''External Ids'' is meant for OID, defined and potentially registered outside the project, and used in the project. The External Ids may be of any type like Identifiers, Identification systems, Code systems etc. The ''Base Ids'' are used as an Identification system for the identification of various DECOR project artifacts and are normally derived from the project id.

Add a new id in either section using the appropriate <nowiki>[</nowiki>+<nowiki>]</nowiki> button. Update a description by updating the appropriate fields. Don't forget to Save.

The base ids also sport the option "Default". When you have multiple base ids for a specific type, you may switch the default base id. Switching the default means that new artifacts of that type will be created using this new default unless you override.

[[File:En_project_ids_01.png|750px|project ids]]

=Form parameters=
The project form, as most other forms, supports parametrization.

<syntaxhighlight lang="text">
/decor-project--[prefix]?section=[section name]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| section
| Switches to the requested section. Options
* general (default) - switches to the tab General
* copyright - switches to the tab Copyright/Contributors
* authors - switches to the tab Authors
* versions - switches to the tab Versions
* ids - switches to the tab Ids (admin only)
* status - switches to the tab Status (admin only)
* maintenance - switches to the tab Maintenance (admin only)
* governancegroups - switches to the tab Governance groups
| art v1.5.3
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| art v1.8.51
|}

File:Development version 03.png

2020-06-08T07:05:58Z

Mligtvoet:

File:Development version 02.png

2020-06-08T07:05:49Z

Mligtvoet:

File:Development version 01.png

2020-06-08T07:05:38Z

Mligtvoet:

ART Project Editor

2020-06-08T07:00:22Z

Mligtvoet: /* Filter tab */

__TOC__
=Changing the name of a project=
Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

=Add a language to a project=
If you want to add a language to a project, you can perform the following steps:
Open '''Project'''-tab, section: '''general'''

Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Click on the plus to add a language:

[[File:En_language_add_02.jpg|500px]]

Enter a new language in the first field, for instance: en-US

Add an English name for the project.

To save, click on the button: '''Change'''
[[File:En_language_add_03.jpg|500px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

Select the added language in the top-right:
[[File:En_language_add_05.jpg|750px]]
The project name should now be shown in English.
[[File:En_language_add_06.jpg|500px]]

After adding a translation for the project name, this will enable you to add translations to dataset concepts, see [[ART_Dataset_Editor#Add_concept_translations|Dataset Editor documentation]].

=Description=
The description of a project can be added or changed. The description and editor supports html-layout. The description can contain, for instance:
* General information about the project
* Links to external websites with more information on the project.
* Terms of use of the content in the project
* Disclaimer of the content in the project
* License information of the content in the project

=Properties=
==Project prefix==
This area shows the project prefix. This is a read-only field, the prefix can not be changed.

==Default language==
When the project supports multiple languages, a default language for display can be selected here.

[[File:default_language_en.png|750px]]

Select the language new default language from the dropdown list of available languages, and afterwards '''save''' to store this setting.

For adding languages, see [[ART_Project_Editor#Add_a_language_to_a_project|Add a language to a project]]

==Marking a project as building block repository==
In the project-tab, projects can be marked as building block repository (BBR). In that way they are marked as containing reusable content. Content from BBR's can be reused in other projects.
The contents of this 'project' are considered suitable for re-use by other projects when this setting is active.

Follow these steps to mark a project as BBR:
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Contains reusable content?'''
[[File:mark_repository.png|750px]]

* Click '''Save''' to update the project information

==Privacy settings==
A project can be marked as private with: 'Is private'?
The project is not listed in the menus and ignored in searches when this setting is active. This useful for projects in incubation fase. You may still work in the project based on direct URLs

==Marking a project as Experimental==
Project is experimental or meant to test things rather than aimed at production use.
The project should not contain content that is meant for production use.

==Issue Notifier==
The external services that can be configured on the project-tab:
* The ART-DECOR Automatic Notifier System ([[ADANS]]): email about changes in issues in the project.

=Project Index=
The ART-DECOR Projext Index offers a read-only view on datasets, transactions, value sets, templates and code systems per project:
* Project oriented/as a service: see [[URIs#ProjectIndex|URIs Projectindex]] services '''ProjectIndex''' or '''ValueSetIndex'''. These services support multiple machine-processable formats such as (for example): xml or csv.

The Project Index can be accessed by clicking on the link:
[[File:Projectindex.png|450px]]

Screenshot of the Project index of an example project:
[[File:Projectindex_example.png|650px]]

=Reference a building block repository=
In order to use concepts, value sets, and templates from a BBR (building block repository), it is necessary to first add a reference to a repository. Follow these steps to add a reference to a BBR from a project:
* If not done yet: First mark the project containing reusable content as BBR, see [[ART_Project_Editor#Marking_a_project_as_building_block_repository]]
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Add building block repository'''. This will show a list of BBR's (depending on the server settings, these can include BBR's that reside on this server and/or BBR's that reside on external servers. See also the [[ART_maintenance_manual#External_repository_server|ART maintenance manual]]).
* Select a BBR
* Click '''add''' to add a BBR-reference in the current project
Screenshot that shows the user-interface for adding a BBR-reference from a project:
[[File:En_project_bbr_reference.png|750px]]
* Click '''Save''' to update the project information
* After saving the project information, the BBR-reference is shown like:
[[File:En_project_bbr_reference_added.png|750px]]
* After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project

=Adding authors to a project=
Before a user can edit a project, the following steps must be performed:
* the user must have a personal ART-DECOR user account, please [[Contact]] us to obtain one
* the user must have the proper group permissions (See also the [[ART_maintenance_manual#ART_user_roles|ART maintenance manual]])
* Now the user can be added to the project by a decor-admin from the project:
** Log in as '''decor-admin'''
** Go to tab '''Project/Authors'''
** Add a user to the current project by clicking '''Add author'''
** Select the user
** Click '''Add'''
** Click '''Save''' to update the project information

=Project specific author settings=
Any ART-DECOR user may be active in multiple projects. He may be acting from different organizations depending on the project, and he may be more or (temporarily) less involved. For these reasons ART-DECOR supports switching on/off notification settings for [[ADANS]] on a project specific level.
Any user with 'decor-admin' rights in the project can adjust the settings for any project author. In addition to that, the decor-admin project user may switch the ADANS notifier on/off for the entire project. All other project (issue) authors can adjust their own settings.

The notifiers work as follows:
* project notifier is on when it is '---' or 'on'. project notifier is off when it is 'off' (project opt-out)
* user notifier is on when it is 'on'. project notifier is off when it is '---' or 'off' (user opt-in)

[[File:project-author-decor-view.png|750px|normal user view]]

[[File:project-author-decor-admin-view.png|750px|decor-admin user view]]

=Preflighting publication and quality checks=
A number of checks can be done to check the quality of your project before you create a publication.

1) Is the project schema and schematron valid?
In order to check this:
* Log in as '''decor-admin'''
* Go to the page 'Project/Development'
[[File:en_development_check_01.png|350px|Click Development page]]
* Make sure the correct dataset is selected
[[File:en_development_check_02.png|350px|Select dataset]]
* Click the button to Check DECOR
[[File:en_development_check_03.png|350px|Click Check DECOR]]

2) Consider making dynamic template and value set links static.
In a final release you would not expect any dynamic template links.
In a final release you may expect dynamic value set links, although they are likely the exception.

3) Run a [[TerminologyReport]] to check the quality of terminology content contained in the project.

4) Run development builds to test compilation and schematron validation against samples until you are satisfied that no valid things are marked invalid and vice versa.
Possible parameters are:
* Compile with '''Schematron closed'''
[[File:en_development_check_04.png|650px|Compile a development version]]

After compiling you can validate XML instances from your desktop against the compiled schematron:
[[File:en_development_check_05.png|650px|Validate XML instance]]

=Creating a new version / release / publication request=
ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project.
The creation of a version/release works as follows:
* Log in as '''decor-admin'''
* Check that ADRAM is configured for this project. On the tab 'Project/General', Publication location should contain a URL where the publication is going to be published. Behind the 'Publication location' it should show 'Release and Archive Manager configured' (this checks that ADRAM is configured for this project at the publication location).
[[File:En project publication 01.jpg|750px|normal user view]]

On the tab 'Project/Version information', one can create a new version/release/publication request by clicking on the plus button (see 1 at figure below). In addition the publication parameters and filter can be set by clicking on the wheel button (2). Finally you may compare two releases of your project by clicking on the delta button (3).
[[File:Projectpublication02.png|750px|normal user view]]

When clicking on the plus button, a dialog is presented where information detailing the version/release/publication request can be entered:
* Description: enter a text describing the version or release.
* Type: Intermediate version, or Release. For a release a release label can be entered.
* Save compilations in the following languages: languages can be de-selected to exclude them from the publication.
* Publication request: selecting this checkbox will trigger ADRAM to create a publication at the publication location shown.
* Select 'Add' to confirm.
[[File:En project publication 03.jpg|750px|normal user view]]

==Publication parameters==
The wheel button presents a small dialog to change and maintain the publication parameters. It is organised in a few tabs (see 1 at figure below) ''General'', ''ISO schematron generation'', ''Human readable publication'' and Publication ''Filter'' and a cancel and save button below (2).
The parameters can be switched on or off, a description is shown to explain what the parameter is for.

===General tab===
[[File:Projectpublication10.png|550px|normal user view]]

===ISO schematron generation tab===
[[File:Publication_parameters_01.png|550px|normal user view]]

===Human readable publication tab===
In the ''Human readable publication'' tab there is also a small lists of artefact categories to be chosen from to determine whether they are included in a resulting PDF or not (1).
[[File:Projectpublication11.png|550px|normal user view]]

===Filter tab===
The Publication ''Filter'' tab allows to set filters on and off, i.e. whether a publication contains all scenarios/transactions of the project (filter "off", see 1) or only selected ones. You can select either one or multiple scenarios/transactions from your project's scenarios/transactions in the list (2). You must give a label to your filter in order to describe the nature of the partial publication (3). The "Select all" and "Clear selection" button allows you to select all or none of the scenarios/transactions (4).
[[File:Projectpublication12.png|550px|normal user view]]

==Publication status==
The following different kinds of publication status are supported:
*When a publication request is first released by ADRAM and appears on the HTML landing page, its status is '''Under pre-publication review'''. The publication may be moved from that status to any of the following statuses.
*'''Draft''': The publication is in draft, not yet finalized (nascent) and may be overridden at any time by a new and final release.
*'''Active''': The publication is final (active) and can be considered for production use.
*'''Retired''' The publication is considered to be no longer used.
*'''Cancelled''': A publication has withdrawn, has never been used.
*'''Build failed''': This special status represents that during the build and compile phase of the publication, ADRAM detected a processing error.

ADRAM will check periodically for new publication requests and will create the publication at the publication location. Typically a review should be done after which the publication status can be upgraded to 'Draft/Active/Retired/Cancelled' via the tab 'Project/ Versions/Releases'. The status for a publication can now be updated in the column 'Edit':
[[File:En project publication 05.jpg|750px|normal user view]]

ADRAM will re-check and update the publication status at the publication location. Visit the publication location URL to see the various releases:
[[File:En project publication 04.jpg|750px|normal user view]]

=Maintaining a local OID Registry=
ART-DECOR has a central place for registration of OIDs but you can certainly have your own local registrations. This is useful for example when your project contain references to code systems not maintained in ART-DECOR, nor administered in one of the hosted central OID Registries. Please note that centralized registration is usually to be preferred.

To view the local ids, you don't need to login. To update them you need to have decor-admin privileges and be author in the project. In both cases, go to the Ids tab on the Project form.

The Ids tab is divided in two sections "External Ids" and "Base Ids". The ''External Ids'' is meant for OID, defined and potentially registered outside the project, and used in the project. The External Ids may be of any type like Identifiers, Identification systems, Code systems etc. The ''Base Ids'' are used as an Identification system for the identification of various DECOR project artifacts and are normally derived from the project id.

Add a new id in either section using the appropriate <nowiki>[</nowiki>+<nowiki>]</nowiki> button. Update a description by updating the appropriate fields. Don't forget to Save.

The base ids also sport the option "Default". When you have multiple base ids for a specific type, you may switch the default base id. Switching the default means that new artifacts of that type will be created using this new default unless you override.

[[File:En_project_ids_01.png|750px|project ids]]

=Form parameters=
The project form, as most other forms, supports parametrization.

<syntaxhighlight lang="text">
/decor-project--[prefix]?section=[section name]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| section
| Switches to the requested section. Options
* general (default) - switches to the tab General
* copyright - switches to the tab Copyright/Contributors
* authors - switches to the tab Authors
* versions - switches to the tab Versions
* ids - switches to the tab Ids (admin only)
* status - switches to the tab Status (admin only)
* maintenance - switches to the tab Maintenance (admin only)
* governancegroups - switches to the tab Governance groups
| art v1.5.3
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| art v1.8.51
|}

ART Project Editor

2020-06-08T06:59:22Z

Mligtvoet: /* Creating a new version / release / publication request */

__TOC__
=Changing the name of a project=
Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

=Add a language to a project=
If you want to add a language to a project, you can perform the following steps:
Open '''Project'''-tab, section: '''general'''

Edit the name for the project.
[[File:En_language_add_01.jpg|750px]]

Click on the plus to add a language:

[[File:En_language_add_02.jpg|500px]]

Enter a new language in the first field, for instance: en-US

Add an English name for the project.

To save, click on the button: '''Change'''
[[File:En_language_add_03.jpg|500px]]

Save the updated project settings by clicking '''Save''':

[[File:Save_form.png|150px]]

Select the added language in the top-right:
[[File:En_language_add_05.jpg|750px]]
The project name should now be shown in English.
[[File:En_language_add_06.jpg|500px]]

After adding a translation for the project name, this will enable you to add translations to dataset concepts, see [[ART_Dataset_Editor#Add_concept_translations|Dataset Editor documentation]].

=Description=
The description of a project can be added or changed. The description and editor supports html-layout. The description can contain, for instance:
* General information about the project
* Links to external websites with more information on the project.
* Terms of use of the content in the project
* Disclaimer of the content in the project
* License information of the content in the project

=Properties=
==Project prefix==
This area shows the project prefix. This is a read-only field, the prefix can not be changed.

==Default language==
When the project supports multiple languages, a default language for display can be selected here.

[[File:default_language_en.png|750px]]

Select the language new default language from the dropdown list of available languages, and afterwards '''save''' to store this setting.

For adding languages, see [[ART_Project_Editor#Add_a_language_to_a_project|Add a language to a project]]

==Marking a project as building block repository==
In the project-tab, projects can be marked as building block repository (BBR). In that way they are marked as containing reusable content. Content from BBR's can be reused in other projects.
The contents of this 'project' are considered suitable for re-use by other projects when this setting is active.

Follow these steps to mark a project as BBR:
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Contains reusable content?'''
[[File:mark_repository.png|750px]]

* Click '''Save''' to update the project information

==Privacy settings==
A project can be marked as private with: 'Is private'?
The project is not listed in the menus and ignored in searches when this setting is active. This useful for projects in incubation fase. You may still work in the project based on direct URLs

==Marking a project as Experimental==
Project is experimental or meant to test things rather than aimed at production use.
The project should not contain content that is meant for production use.

==Issue Notifier==
The external services that can be configured on the project-tab:
* The ART-DECOR Automatic Notifier System ([[ADANS]]): email about changes in issues in the project.

=Project Index=
The ART-DECOR Projext Index offers a read-only view on datasets, transactions, value sets, templates and code systems per project:
* Project oriented/as a service: see [[URIs#ProjectIndex|URIs Projectindex]] services '''ProjectIndex''' or '''ValueSetIndex'''. These services support multiple machine-processable formats such as (for example): xml or csv.

The Project Index can be accessed by clicking on the link:
[[File:Projectindex.png|450px]]

Screenshot of the Project index of an example project:
[[File:Projectindex_example.png|650px]]

=Reference a building block repository=
In order to use concepts, value sets, and templates from a BBR (building block repository), it is necessary to first add a reference to a repository. Follow these steps to add a reference to a BBR from a project:
* If not done yet: First mark the project containing reusable content as BBR, see [[ART_Project_Editor#Marking_a_project_as_building_block_repository]]
* Log in as '''decor-admin'''
* Go to tab '''Project/General'''
* Click on '''Add building block repository'''. This will show a list of BBR's (depending on the server settings, these can include BBR's that reside on this server and/or BBR's that reside on external servers. See also the [[ART_maintenance_manual#External_repository_server|ART maintenance manual]]).
* Select a BBR
* Click '''add''' to add a BBR-reference in the current project
Screenshot that shows the user-interface for adding a BBR-reference from a project:
[[File:En_project_bbr_reference.png|750px]]
* Click '''Save''' to update the project information
* After saving the project information, the BBR-reference is shown like:
[[File:En_project_bbr_reference_added.png|750px]]
* After adding the BBR-reference: when adding dataset concepts, value sets or templates, content from the BBR is also presented in the current project

=Adding authors to a project=
Before a user can edit a project, the following steps must be performed:
* the user must have a personal ART-DECOR user account, please [[Contact]] us to obtain one
* the user must have the proper group permissions (See also the [[ART_maintenance_manual#ART_user_roles|ART maintenance manual]])
* Now the user can be added to the project by a decor-admin from the project:
** Log in as '''decor-admin'''
** Go to tab '''Project/Authors'''
** Add a user to the current project by clicking '''Add author'''
** Select the user
** Click '''Add'''
** Click '''Save''' to update the project information

=Project specific author settings=
Any ART-DECOR user may be active in multiple projects. He may be acting from different organizations depending on the project, and he may be more or (temporarily) less involved. For these reasons ART-DECOR supports switching on/off notification settings for [[ADANS]] on a project specific level.
Any user with 'decor-admin' rights in the project can adjust the settings for any project author. In addition to that, the decor-admin project user may switch the ADANS notifier on/off for the entire project. All other project (issue) authors can adjust their own settings.

The notifiers work as follows:
* project notifier is on when it is '---' or 'on'. project notifier is off when it is 'off' (project opt-out)
* user notifier is on when it is 'on'. project notifier is off when it is '---' or 'off' (user opt-in)

[[File:project-author-decor-view.png|750px|normal user view]]

[[File:project-author-decor-admin-view.png|750px|decor-admin user view]]

=Preflighting publication and quality checks=
A number of checks can be done to check the quality of your project before you create a publication.

1) Is the project schema and schematron valid?
In order to check this:
* Log in as '''decor-admin'''
* Go to the page 'Project/Development'
[[File:en_development_check_01.png|350px|Click Development page]]
* Make sure the correct dataset is selected
[[File:en_development_check_02.png|350px|Select dataset]]
* Click the button to Check DECOR
[[File:en_development_check_03.png|350px|Click Check DECOR]]

2) Consider making dynamic template and value set links static.
In a final release you would not expect any dynamic template links.
In a final release you may expect dynamic value set links, although they are likely the exception.

3) Run a [[TerminologyReport]] to check the quality of terminology content contained in the project.

4) Run development builds to test compilation and schematron validation against samples until you are satisfied that no valid things are marked invalid and vice versa.
Possible parameters are:
* Compile with '''Schematron closed'''
[[File:en_development_check_04.png|650px|Compile a development version]]

After compiling you can validate XML instances from your desktop against the compiled schematron:
[[File:en_development_check_05.png|650px|Validate XML instance]]

=Creating a new version / release / publication request=
ART supports the creation of a project publication. For the publication feature to work, [[ADRAM|ADRAM]] needs to be installed and configured for this project.
The creation of a version/release works as follows:
* Log in as '''decor-admin'''
* Check that ADRAM is configured for this project. On the tab 'Project/General', Publication location should contain a URL where the publication is going to be published. Behind the 'Publication location' it should show 'Release and Archive Manager configured' (this checks that ADRAM is configured for this project at the publication location).
[[File:En project publication 01.jpg|750px|normal user view]]

On the tab 'Project/Version information', one can create a new version/release/publication request by clicking on the plus button (see 1 at figure below). In addition the publication parameters and filter can be set by clicking on the wheel button (2). Finally you may compare two releases of your project by clicking on the delta button (3).
[[File:Projectpublication02.png|750px|normal user view]]

When clicking on the plus button, a dialog is presented where information detailing the version/release/publication request can be entered:
* Description: enter a text describing the version or release.
* Type: Intermediate version, or Release. For a release a release label can be entered.
* Save compilations in the following languages: languages can be de-selected to exclude them from the publication.
* Publication request: selecting this checkbox will trigger ADRAM to create a publication at the publication location shown.
* Select 'Add' to confirm.
[[File:En project publication 03.jpg|750px|normal user view]]

==Publication parameters==
The wheel button presents a small dialog to change and maintain the publication parameters. It is organised in a few tabs (see 1 at figure below) ''General'', ''ISO schematron generation'', ''Human readable publication'' and Publication ''Filter'' and a cancel and save button below (2).
The parameters can be switched on or off, a description is shown to explain what the parameter is for.

===General tab===
[[File:Projectpublication10.png|550px|normal user view]]

===ISO schematron generation tab===
[[File:Publication_parameters_01.png|550px|normal user view]]

===Human readable publication tab===
In the ''Human readable publication'' tab there is also a small lists of artefact categories to be chosen from to determine whether they are included in a resulting PDF or not (1).
[[File:Projectpublication11.png|550px|normal user view]]

===Filter tab===
The Publication ''Filter'' tab allows to set filters on and off, i.e. whether a publication contains all scenarios/transactions of the project (filter "off", see 1) or only selected ones. You can select either one or multiple scenarios/transactions from your project's scenarios/transactions in the list (2). You must give a label to your filter in order to describe the nature of the partial publication (3). The "Select all" and "Clear selection" button allows you to select all or none of the scenarios/transactions (4).
[[File:Projectpublication12.png|550px|normal user view]]

The following different kinds of a publication status are supported:
*When a publication request is first released by ADRAM and appears on the HTML landing page, its status is '''Under pre-publication review'''. The publication may be moved from that status to any of the following statuses.
*'''Draft''': The publication is in draft, not yet finalized (nascent) and may be overridden at any time by a new and final release.
*'''Active''': The publication is final (active) and can be considered for production use.
*'''Retired''' The publication is considered to be no longer used.
*'''Cancelled''': A publication has withdrawn, has never been used.
*'''Build failed''': This special status represents that during the build and compile phase of the publication, ADRAM detected a processing error.

ADRAM will check periodically for new publication requests and will create the publication at the publication location. Typically a review should be done after which the publication status can be upgraded to 'Draft/Active/Retired/Cancelled' via the tab 'Project/ Versions/Releases'. The status for a publication can now be updated in the column 'Edit':
[[File:En project publication 05.jpg|750px|normal user view]]

ADRAM will re-check and update the publication status at the publication location. Visit the publication location URL to see the various releases:
[[File:En project publication 04.jpg|750px|normal user view]]

=Maintaining a local OID Registry=
ART-DECOR has a central place for registration of OIDs but you can certainly have your own local registrations. This is useful for example when your project contain references to code systems not maintained in ART-DECOR, nor administered in one of the hosted central OID Registries. Please note that centralized registration is usually to be preferred.

To view the local ids, you don't need to login. To update them you need to have decor-admin privileges and be author in the project. In both cases, go to the Ids tab on the Project form.

The Ids tab is divided in two sections "External Ids" and "Base Ids". The ''External Ids'' is meant for OID, defined and potentially registered outside the project, and used in the project. The External Ids may be of any type like Identifiers, Identification systems, Code systems etc. The ''Base Ids'' are used as an Identification system for the identification of various DECOR project artifacts and are normally derived from the project id.

Add a new id in either section using the appropriate <nowiki>[</nowiki>+<nowiki>]</nowiki> button. Update a description by updating the appropriate fields. Don't forget to Save.

The base ids also sport the option "Default". When you have multiple base ids for a specific type, you may switch the default base id. Switching the default means that new artifacts of that type will be created using this new default unless you override.

[[File:En_project_ids_01.png|750px|project ids]]

=Form parameters=
The project form, as most other forms, supports parametrization.

<syntaxhighlight lang="text">
/decor-project--[prefix]?section=[section name]
</syntaxhighlight>

{| style="text-align: left;" class="artdecorwiki"
! Parameter !! Description !! Since
|-
| prefix || Project prefix || ''always''
|-
| section
| Switches to the requested section. Options
* general (default) - switches to the tab General
* copyright - switches to the tab Copyright/Contributors
* authors - switches to the tab Authors
* versions - switches to the tab Versions
* ids - switches to the tab Ids (admin only)
* status - switches to the tab Status (admin only)
* maintenance - switches to the tab Maintenance (admin only)
* governancegroups - switches to the tab Governance groups
| art v1.5.3
|-
| language
| Displays contents in the requested language. When contents are not available in the requested language, there will be nothing to display. Example en-US, or nl-NL.
| art v1.8.51
|}

File:Publication parameters 01.png

2020-06-08T06:57:48Z

Mligtvoet: Mligtvoet uploaded a new version of "File:Publication parameters 01.png"

File:Publication parameters 01.png

2020-06-08T06:49:32Z

Mligtvoet: