MediaWiki:Common.css

2021-07-28T11:50:11Z

Admin:

ART Value Set Editor

2021-07-28T10:23:45Z

Admin:

=Value set editor=
==Creating new value sets==
Editors of a project may create new value sets through the value set form.

Clicking on the [[File:TemplateEditor-plusbutton.png|30px]] button opens the value set creation dialog. You have four options to populate a new value set:
* Browse and use existing code systems like LOINC, etc.
* Entering codes on your own manually
* Use complete code systems (OID)
* Add codes as exceptions, e.g. nullFlavors

Adding a Value Set is simple. If you have the corresponding permissions, the [[File:TemplateEditor-plusbutton.png|30px]] button appears above the list of value sets (1).

[[File:ValuesetEditor-Plus.png|350px|Adding a Value Set]]

==Value Set Editor Dialog==
The Value Set Editor Dialog has three main parts:
* metadata for the Value Set (1)
* a selector to choose from Source Code System (2)
* the Value Set Content (3).

The Value Set Content area has four parts:
* Complete Code Systems (references with the Code System OID)
* Values, i.e. Coded Concepts from official/proprietary existing code systems
* Value Sets to be included in the Value Set
* Exceptional Coded Concepts

[[File:ValuesetEditor-Editor.png|650px|Value Set Editor Dialog]]

==Value Set Metadata==
Value Sets have a couple of metadata to be determined:
* a display name (1)
* a busines name (2)
* a full text description, optional (3)
* and an optional Canonical URI (4)
The Value Set id is automatically derived from the Value Set Ids of the project (5).

[[File:ValuesetEditor-Metadaten.png|650px|Value Set Metadaten]]

==Source Code System Selection==
To select codes from a browsable Code System choose the desired System from the Source Code System Selection menu. A browser opens if clicking on "Select"

[[File:ValuesetEditor-csselect.png|350px|Source Code System Selection]]

==Value Set Code System Browser==
The Code System Browsers are more or less all equally designed: you type in a search term and get the results displayed. Selecting a concept (1) and clicking on "Add to valueset" (2) adds the corresponding Coded Concept to the Value Set (in the background). You can select another concept and add it until done.

[[File:ValuesetEditor-SCTBrowser.png|650px|Value Set Code System Browser]]

==Value Set with Values==
Once the selection of Coded Concepts for a Value Set is finished and the Code System Browser dialog is closed, the Coded Concepts chosen so far appear in the "Values" section of the Value Set Content area.

If you want to enter codes manually press the * button next to the "Values" Heading. This adds a new first row in the Values area and you can edit Level, Type, Code, Display name, Codesystem and Description.

The items have the following meaning:
* Level of hierarchy
* Type of node, either a selectable leaf node (L), a specializable head of a hierarchy (S), an abstract value as a head of a hierarchy (cannot be selected but is displayed as a grouper) or deprecated (D)
* Code
* Display Name
* Code System OID
* A full text description
Clicking on the + or - next to a row adds a new row under the selected row or deletes the row.

[[File:ValuesetEditor-Values.png|650px|Value Set Values]]

==Including other defined Value Sets in a Value Set==
Another possibility to add Coded Concepts to the Value Set Content is to include other defined (and available) Value Sets. Clicking on the + next to the "Value Set Includes" heading opens a Value Set selection dialog and chosen Value Set content is added to the Content of the edited Value Set.
{{NoteBox|Please note that this is done by reference (transclusion), the included content is not copied to the new Value Set.}}

It is also possible to include the Coded Concepts from another Value Set as Exceptions (1) rather than normal Concepts.

[[File:ValuesetEditor-Includes.png|650px|Including another Value Set]]

==Intensional expressions==
Intensional expressions can be added:
* Include or
* Exclusion

[[File:ValuesetEditor-Intensional_01.png|450px|Intensional_expressions]]

The following operators are available:
* is-a or << :: includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, including the provided concept itself (i.e. include child codes)
* descendant-of or < :: includes all concept ids that have a transitive is-a relationship with the concept Id provided as the value, excluding the provided concept itself (i.e. include child codes)
* is-not-a :: the specified property of the code does not have an is-a relationship with the provided value
* regex :: the specified property of the code matches the regex specified in the provided value
* in :: the select a set of concepts based on their membership of a (SNOMED CT) reference set

[[File:ValuesetEditor-Intensional_02.png|650px|Intensional_expressions]]

==Value Set with Exceptions ==
The same mechanism is used to allow adding Exceptional Concepts (like nullFlavors in HL7 v3/FHIR) to the Value Set Content. For that purpose simply click on "Add as exception" in the Code System Browser.

The corresponding value set contains Values and Exceptions.

[[File:ValuesetEditor-ValuesExceptions.png|650px|Value Set Exceptions]]

==Results==
After finalization of all editing work click on "Save". This is an example what a resulting Value Set with Coded Concepts (1) and Exceptions (2) looks like.

[[File:ValuesetEditor-Ready.png|650px|Value Set with exceptions, ready for use]]

==Creating a new version of a value set, based on a previous version==
Typically value sets go through a production process where they are reviewed and publicated and before they are production-ready.
The following overall flow usually applies:
* Set the status of a value set to '''pre-publication review''' or '''final'''
* During a review or from testing/production deployment change requests may create the need to perform edits on the value set. For instance: adding or deleting concepts from a value set.
* Afterwards, if the value sset needs to be updated, a new version can be created where the older version is left unchanged and editing can be done in the newest version.
To create a new version of a value set, based on a previous version, the following steps can be performed:
* Go to the Value Set form: terminology -> Value Sets
* Select a value set from the value set list in the tree
[[File:en_valueset_new_version_01.jpg|350px|Value Set selection]]

* Set the status of a valueset to '''pre-publication review''' or '''final'''
[[File:en_valueset_new_version_02.jpg|650px|Value Set setting status]]

* A dialog is presented where you can add an optional Version Label:
[[File:en_valueset_new_version_03.jpg|350px|Value Set setting status confirmation]]

* Click: Set status to ‘pre-publication review’. After that the new status for the value set is shown in the value set detail view:
[[File:en_valueset_new_version_08.jpg|450px|Value Set setting status shown]]

* During (for example) the review change requests may lead to the need to edit the value set.
* Create a new version of the value set (keeping the old one intact) by clicking '''Edit valueset'''
[[File:en_valueset_new_version_04.jpg|650px|Value Set edit button]]

* When editing, the following options are possible:
[[File:en_valueset_new_version_05.jpg|750px|Value Set edit choice]]

In the example scenario where a change request leads to an update of an existing value set, we would choose '''Create new version''' to create a new version of the value set with a new datetime stamp.
* Make your changes to the value set, for instance add or delete concepts and save the value set.
* '''Refresh''' the value set viewer:
[[File:en_valueset_new_version_06.jpg|350px|Value Set refresh]]
* Now the value set is shown with multiple versions, in the dropdown behind the value set name:
[[File:en_valueset_new_version_07.jpg|550px|Value Set with multiple versions]]

By selecting the datetime stamp, the different versions of the value set are shown.

=Value set associations=
With a valueset association it is possible to create a link between a dataset concept and a valueset.
The workflow for setting up a valueset associations:
* Go to datasets
* Create a concept in the dataset with the type 'Code' and save it
* Go to Terminology - tab Terminology associations
* Select in the left concept tree the just created concept
* Choose on the left of the 'valueset associations' the button: “Add”
* Select the valueset to associate with
* Make a choice:
** Creating a static associations: associate to this version valueset (whereby the version is determined by the date of the valueset). In this choice some changes/version are possibly not associated with the dataset concept.
** Creating dynamic associations: associate to this version valueset. If there is a new version valueset the dataset concept will still be associated with the latest version of the valueset.

* Go to datasets, select the concept. Now it will display that there is a valueset association created and also on which date and time it is created.
* When clicking on the link behind 'valueset associations' you'll be directed to the valueset itself.

=Value set datamodel=
[[File:Valueset_datamodel.jpg|550px]]

URIs

2021-07-28T10:23:15Z

Admin:

Identification of DECOR objects with URI's.

== URI logic ==
{|class="artdecorwiki"
! Item
! Description
|-
| server
| <nowiki>http://art-decor.org/decor/services</nowiki>
|-
| separator
| /
|-
| action
| [[#ProjectIndex|ProjectIndex]], [[#RetrieveDataSet|RetrieveDataSet]], [[#RetrieveTransaction|RetrieveTransaction]], [[#RetrieveConcept|RetrieveConcept]], [[#RetrieveValueSet|RetrieveValueSet]], [[#RetrieveOID|RetrieveOID]], [[#RetrieveTemplate|RetrieveTemplate]] , [[#DataSetIndex|DataSetIndex]], [[#TransactionIndex|TransactionIndex]], [[#ValuesetIndex|ValuesetIndex]], [[#OIDIndex|OIDIndex]], [[#TerminologyReport|TerminologyReport]], [[#GetImage|GetImage]], [[#RetrieveIssue|RetrieveIssue]], [[#IssueIndex|IssueIndex]], [[#ProjectLogo|ProjectLogo]], [[#ValidateCode|ValidateCode]], [[#Template2Example|Template2Example]], [[#RetrieveQuestionnaire|RetrieveQuestionnaire]] ''[[#RetrieveProject|RetrieveProject]]''<br/>The service ''RetrieveProject'' is not a public service because it is only relevant for users who access these services via the database directly in order to produce a publication.
|-
| query part and query parameters separator
| ?
|-
! Query parameter
! Description
|-
| id
| The id of the concept, value set, template or dataset. For instance an OID like: 123 or 123.123.123
|-
| code
| The code of the concept.
|-
| codeSystem
| The codesystem of the concept. For instance an OID like: 123 or 123.123.123
|-
| assigningAuthority
| The responsibleAuthority/code/@code of the OID's returned must match.
|-
| effectiveDate
| The date of the object that id points to as YYYY-MM-DDTHH:mm:ss (2011-12-31T00:00:00). If no date is entered, all versions will be returned. If you use the key word 'dynamic' the latest/current version is returned.
|-
| language
| Language qualifier for contents, for instance language=en-US. When no language is entered, the content default language is used. Use language=* for "all languages"
|-
| ui
| User Interface language. When no language is entered, the server default language is used. By default English should be available.
|-
| format
| The desired return format, for instance format=xml (or: html, csv, pdf). When no format parameter is entered, the default return format is HTML. The HTML and PDF formats have no further specification and are not meant to be automatically parsed.
|-
| name
| The name of value set or template. The value set name (valueSet/@name) or OID-name (id/@name) or template name (template/@name) must be an exact match.
|-
| prefix
| The project prefix (/decor/project/@prefix) must be an exact match.
|-
| mode
| The return type. For instance 'mode=verbatim' returns the project as-is. 'mode=compiled' will resolve external references so the result is self-contained. Please note that 'compiled' is meant to be used for HTML- and Schematrongeneration. The returntype 'compiled' is unsuitable for other uses.
|-
| download
| If download=true, will trigger a download instead of showing output in the browser.
|-
| hidecolumns
| Which columns should be hidden in the returned view. For instance 'hidecolumns=53' will hide columns 3 and 5. After 9, continue in hexadecimal (a, b, c, etc.). Is only applicable for HTML views. See [[#Hidecolumns mapping|Hidecolumns mapping]].
|-
|}

== Examples ==
{|class="artdecorwiki"
! URI
Description
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&effectiveDate=2015-09-01T00:00:00&prefix=elga-&format=xml&language=de-DE
Will return a value set with a specific date in the return format XML
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&effectiveDate=2013-01-10T00:00:00&prefix=elga-&format=csv
Will return a value set with a specific date in the return format CSV
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&prefix=elga-&format=csv
Will return the latest/current version of a value set in the return format CSV
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&prefix=elga-
Will return all versions of a value set in the default return format (HTML)
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&effectiveDate=2015-09-01T00:00:00&prefix=elga-&format=json&language=de-DE
Will return a value set with a specific date in the in the return format JSON
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&effectiveDate=2015-09-01T00:00:00&prefix=elga-&format=sql&language=de-DE
Will return a value set with a specific date in the in the return format SQL
|-
| http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&language=en-US
{for future use} will return all versions of a valueset in the default return format (HTML) in American English
|-
| http://art-decor.org/decor/services/RetrieveCode?code=M&codeSystem=2.16.840.1.113883.5.1
{for future use} will return the concept 'Male' of HL7 AdministrativeGender
|-
| http://art-decor.org/decor/services/ValueSetIndex
will return a HTML table with formats and versions for all valuesets in DECOR projects, with links to the valuesets.
|-
| http://art-decor.org/decor/services/DataSetIndex
will return a HTML table with formats and versions for all datasets in DECOR projects, with links to the datasets.
|-
| http://art-decor.org/decor/services/GetImage?prefix=demo-
will return two SVG diagrams for each transactiongroup in the demo DECOR project. One diagram shows the functional perspective and the other shows the technical perspective.
|-
| http://art-decor.org/decor/services/GetImage?prefix=demo-&id=2.16.840.1.113883.2.4.3.46.99.3.4.1
will return two SVG diagrams for a specific transactiongroup with id '2.16.840.1.113883.2.4.3.46.99.3.4.1' in the demo DECOR project. One diagram shows the functional perspective and the other shows the technical perspective.
|-
| http://art-decor.org/decor/services/OIDIndex
will return a HTML table with an overview for all OIDs from the OID-registry, with links to a detailed view for each OID.
|-
| http://art-decor.org/decor/services/OIDIndex?id=1.0.3166.1.2.2
will return a HTML table with an overview for the OID with id '1.0.3166.1.2.2' from the OID-registry, with a link to a detailed view for this OID.
|-
| http://art-decor.org/decor/services/OIDIndex?id=1.0.3166.1.2.2&language=de-DE
will return a HTML table with an overview for the OID with id '1.0.3166.1.2.2' from the OID-registry, with a link to a detailed view for this OID in German.
|-
| http://art-decor.org/decor/services/RetrieveOID?id=1.0.3166.1.2.2&format=html
will return a HTML table with a detailed view for the OID with id '1.0.3166.1.2.2' from the OID-registry, with links to a XML view for this OID.
|-
| http://art-decor.org/decor/services/RetrieveOID?id=1.0.3166.1.2.2&format=html&language=de-DE
will return a HTML table with a detailed view in German for the OID with id '1.0.3166.1.2.2' from the OID-registry, with links to a XML view for this OID.
|-
| http://art-decor.org/decor/services/TransactionIndex?format=html&language=en-US
will return a HTML table with all transactions in American English
|-
| http://art-decor.org/decor/services/TransactionIndex?prefix=demo3-&format=html&language=en-US
will return a HTML table with all transactions from the DECOR project demo3- in American English
|-
| http://art-decor.org/decor/services/RetrieveTransaction?id=2.16.840.1.113883.3.1937.99.60.3.4.2&format=html&language=en-US
will return a HTML table for the transaction with id 2.16.840.1.113883.3.1937.99.60.3.4.2 (Electrocardiogram Report) in American English
|-
| http://art-decor.org/decor/services/RetrieveTemplate?id=2.16.840.1.113883.3.1937.99.60.3.10.3001&prefix=demo3-&format=xml
will return a original template in raw format with id 2.16.840.1.113883.3.1937.99.60.3.10.3001 (Electrocardiogram Report) in project demo3
|-
| http://art-decor.org/decor/services/Template2XSL?id=2.16.840.1.113883.3.1937.99.60.3.10.3001&prefix=demo3-&format=html
will return a HTML overview of generated XSLTs based on template id
2.16.840.1.113883.3.1937.99.60.3.10.3001 in project demo3
|-
| http://art-decor.org/decor/services/Template2XSL?id=2.16.840.1.113883.3.1937.99.60.3.10.3001&prefix=demo3-&format=xsl
will return the generated XSLT for template 2.16.840.1.113883.3.1937.99.60.3.10.3001 in project demo3
|-
| http://art-decor.org/decor/services/RetrieveConcept?conceptId=2.16.840.1.113883.3.1937.99.62.3.2.3&conceptEffectiveDate=2011-01-28T00:00:00&language=en-US will return info for the concept Weight inside the dataset of the demo1- project
|-
| https://art-decor.org/decor/services/Template2Example?id=2.16.840.1.113883.3.1937.99.62.3.10.11&effectiveDate=2012-03-11T00:00:00&prefix=demo1- will build an example based on the template id and effectiveDate supplied stoppage at references to other templates (@contains and include)
|-
| https://art-decor.org/decor/services/Template2Example?id=2.16.840.1.113883.3.1937.99.62.3.10.11&effectiveDate=2012-03-11T00:00:00&prefix=demo1-&doRecursive=true will build an example based on the template id and effectiveDate supplied traversing all references to other templates (until recursion is found or no more references are left to follow)
|-
| https://art-decor.org/decor/services/RetrieveQuestionnaire?id=2.16.840.1.113883.3.1937.99.62.3.4.2&effectiveDate=2012-09-05T16:59:35&language=en-US&ui=nl-NL&format=html will render this transaction through [https://lhcforms.nlm.nih.gov LHCForms]
|}

== Implementation status of the query parameters ==
Each query parameter marked with [[Image:Conformance.svg|20px]] is implemented at this moment.
Each query parameter marked with N/A is not applicable, not implemented at this moment.

{|class="artdecorwiki" width="100%"
! Service Name !! Parameter !! Description !! Status
|-
! <span id="ProjectIndex">ProjectIndex</span>
| format
| Return format. Options: 'html' (default), 'xml'.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix - if empty and format is html does all repositories. If empty and format is xml does all project metadata
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Content language - format ll-CC. Recommended with param version. Any '*' without quotes for 'any language'
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| ui
| User Interface language - format ll-CC when format is HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| view
| Options: 'd' Limits index to datasets, 't' limits view to transactions, 'v' limits index to value sets, 'r' limits index to templates (rules).
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="DataSetIndex"> DataSetIndex </span>
|
| Shortcut to Projectindex?view=d
|
|-
! <span id="TransactionIndex">TransactionIndex</span>
|
| Shortcut to Projectindex?view=t
|
|-
! <span id="ValueSetIndex">ValueSetIndex</span>
|
| Shortcut to Projectindex?view=v
|
|-
! <span id="TemplateIndex"> TemplateIndex </span>
|
| Shortcut to Projectindex?view=r
|
|-
! <span id="OIDIndex"> OIDIndex </span>
| prefix
| Registry prefix - if empty does all registries. Note: was parameter ''registry'' (still exists but deprecated)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Content language - format ll-CC. Recommended with param version. Any '*' without quotes for 'any language'
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| ui
| User Interface language - format ll-CC when format is HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| OID to filter list on
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| name
| OID name to filter list on
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| assigningAuthority
| OID assigning authority to filter list on
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| OID effective date to filter list on
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveConcept">RetrieveConcept</span>
|
| Shortcut to RetrieveTransaction where param ''id'' is optional may be either a dataset or a transaction, and param ''conceptId'' shall have a value. If param ''id'' does not have a value, then the dataset that holds the concept is assumed. See RetrieveTransaction for other parameters
|
|-
! <span id="RetrieveDataSet">RetrieveDataset</span>
|
| Shortcut to RetrieveTransaction where param ''id'' shall be a dataset. See RetrieveTransaction for other parameters
|
|-
! <span id="RetrieveTransaction"> RetrieveTransaction </span>
| format
| Return format. Options: 'html' (default), 'xml', 'hlist' (hierarchical list)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix. A dataset/transaction/concept is assumed to be in exactly one project, so param ''prefix'' is not necessary
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Content language - format ll-CC. Recommended with param version. Any '*' without quotes for 'any language'
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| ui
| User Interface language - format ll-CC when format is HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Dataset/Transaction id - format is OID. Param ''id'' and/or ''conceptId'' is required.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Dataset/Transaction effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id''.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| conceptId
| Concept id - format is OID. Param ''id'' and/or ''conceptId'' is required.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| conceptEffectiveDate
| Concept effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''conceptId''.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| community
| Community prefix. This parameter may repeat. Can only include communities with guest access enabled
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| unfiltered
| Options 'true' or 'false' (default). If true, shows any deprecated/cancelled/rejected concepts that may be in the dataset. If absent or 'false', those are hidden. Is always 'true' i.e. irrelevant for transactions.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| collapsed
| Options 'true' (default) or 'false'. If true, groups start collapsed.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| draggable
| Options 'true' (default) or 'false'. If false, dragging of columns is disabled. Since draggable columns can't be selected with the mouse, useful if one wants to copy data.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| download
| Options 'true' (default) or 'false'. Triggers a download.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| hidecolumns
| Alphanumeric indicator of columns that should be hidden upon launch. Default set is ''. Options: see below
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveConceptDiagram"> RetrieveConceptDiagram </span>
| format
| Return format. Options: 'svg' (default)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Project release language - format ll-CC. Recommended with param version. Also UI language with format HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| datasetId
| Format is OID. Need param transactionId or datasetId
| conditional [[Image:Conformance.svg|right|20px]]
|-
|
| datasetEffectiveDate
| Format is yyyy-mm-ddThh:mm:ss. Only relevant with param ''datasetId''
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| transactionId
| Format is OID. Need param transactionId or datasetId
| conditional [[Image:Conformance.svg|right|20px]]
|-
|
| transactionEffectiveDate
| Format is yyyy-mm-ddThh:mm:ss. Only relevant with param ''transactionId''
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Concept id. Format is OID.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Concept effective date. Format is yyyy-mm-ddThh:mm:ss. Only relevant with param ''id''
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| interactive
| Options 'true' (default) or 'false'. Triggers the generation of javascript (onClick) that allows interactive graphics and that should be set to false if the crated sag is about to be uploaded into a CMS where interactive graphics are not allowed.
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveValueSet">RetrieveValueSet</span>
| format
| Return format. Options: 'html' (default), 'xml' (ART-DECOR), 'csv', 'svs' (IHE SVS 2)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| inline
| Relevant only with format=html. Options 'true' and 'false' (default). Omits HTML header info. Useful for inclusion of HTML in other pages.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix. Doesn't return anything without prefix.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Project release language - format ll-CC. Recommended with param version. Also UI language with format HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Value set id - format is OID. Only with param prefix. When omitted checks param name
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| name
| Value set name - format is string. Only with param prefix. Only checked when id is omitted. When both id and name are omitted checks param ref
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| ref
| Value set id or name - format is OID or string. Only with param prefix. Only checked when both id and name are omitted. When id, name and ref are omitted all project value sets are returned.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Value set effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id'', ''name'', or ''ref''.
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveTemplate">RetrieveTemplate</span>
| format
| Return format. Options: 'html' (default), 'xml' (pure raw template (versions) wrapped in <rules/> element , 'expandedxml' (expanded template (versions) wrapped in <rules/> element, expands includes, associations etc.), 'xmlnowrapper' (pure first matching raw template)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| inline
| Relevant only with format=html. Options 'true' and 'false' (default). Omits HTML header info. Useful for inclusion of HTML in other pages.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Project release language - format ll-CC. Recommended with param version. Also UI language with format HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Template id - format is OID. Only with param prefix
| required [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Template effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id''.
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveTemplateDiagram">RetrieveTemplateDiagram</span>
| format
| Return format. Options: 'svg' (default), 'xml' (mostly useful for debug), 'hgraph' (hierarchical graph)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| ''not implemented''
|-
|
| language
| Project release language - format ll-CC. Recommended with param version. Also UI language with format HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Template id - format is OID. Only with param prefix
| required [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Template effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id''.
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="Template2Example">Template2Example</span>
| prefix
| Project prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Template id - format is OID. Only with param prefix, and when no template is POSTed to the service
| conditional [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Template effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id''.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| elementId
| Template element @id - Will trigger the example to be generated from that element onwards
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| serialized
| boolean. Default true when template is POSTed. Default false otherwise. Returns content of <example/> as serialized XML if true, or as XML otherwise
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| selectedOnly
| boolean. Default true when template is POSTed. Default false otherwise. Process only particles marked @selected="" on the incoming template. Imported when POSTed from the visual template-editor where some particles may have been unselected
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| recursive
| boolean. Default false. Process only particles in current template is false and do not proces @contains/include, or recursively follow all references to other templates until that runs into a loop or no more references are left to follow
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveOID">RetrieveOID</span>
| format
| Return format. Options: 'html' (default), 'xml'
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Registry prefix - if empty does all registries. Note: was parameter ''registry'' (still exists but deprecated)
| required [[Image:Conformance.svg|right|20px]]
|-
|
| language
| UI language with param format=html - format ll-CC.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| OID
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| name
| OID name/description
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| statusCode
| OID status code
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveIssue">RetrieveIssue</span>
| colspan="3" | Currently returns XML only and does not have an interface
|-
|
| id
| OID of the issue
| required [[Image:Conformance.svg|right|20px]]
|-
! <span id="IssueIndex">IssueIndex</span>
| colspan="3" | Currently returns XML only and does not have an interface
|-
|
| prefix
| Project prefix. Note: prefix was added in 1.6.11 to align with the other services. Parameter project remains supported.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| searchString
| List of terms that results should match in issue/@displayName or any desc element. Results all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| type
| List of issue/@type values that results should have. Returns all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| priority
| List of issue/@priority values that results should have. Returns all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| statusCode
| List of issue most recent status code values that results should have. Returns all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| assignedTo
| List of project/author/@id values that the latest assigned person of the issue should match. Returns all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| labels
| List of issue most recent label code values that results should have. Returns all if empty
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| sort
| Singular value to sort on. Supported are 'issue' (display name),'priority','type','status','date','assigned-to','label'. There's no default.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| max
| Maximum number of results with minimum 1. Default is 75
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="ProjectLogo">ProjectLogo</span><br/>''(since DECOR services 1.6.6)''
| prefix
| Project prefix.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| logo
| Project logo. If not provided will return the project/reference/@logo or if even that is empty will return the server default logo. You may specify any logo name such as a copyright logo. Any logo is expected to come from the collection prefix-logos which is also the place where you upload logos through the ART project form.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| mode
| Options: '' (default - retrieves the requested logo), 'list' (lists available logos)
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveProject">''RetrieveProject''</span>
| format
| Return format. Options: 'html' (default when param ''prefix'' is omitted), 'xml' (default in all other cases)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| prefix
| Project prefix - if empty shows HTML form that guides you.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Project release language - format ll-CC. Recommended with param version. Also UI language with format HTML
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| mode
| Options: 'verbatim' (default - raw project file), 'compiled' (resolves references and inherits, adds id info, suitable for publication purposes), 'test' (undocumented), 'cachemeta' (undocumented, internal use only), 'ada-definition' (creates an [[ADA_Documentation|ADA Definition file]] suitable as starting point for creating ADA Releases.)
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| force
| Options: 'true', 'false' (default). Relevant only when mode is 'compiled' and on the live version. If true and working on the live version i.e. not on a release, forces recompile if one should already exist. If false or working on a release, compiles when needed or returns the compiled release
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| ignoreFilter
| Options: 'true' (default), 'false'. Relevant only when mode is 'compiled' and on the live version. Use current compile filter settings if any (false) or ignore any filter settings and do a full compile (true).
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| download
| Options: 'true', 'false' (default)
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="ValidateCode">ValidateCode</span><br/>''(since DECOR services 1.8.27)''
| prefix
| Project prefix.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| id
| ValueSet id - format is OID.
| required [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| ValueSet effectiveDate - yyyy-mm-ttThh:mm:ss. Only with param ''id''.
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| code
| code to check
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| codeSystem
| codeSystem to check
| optional [[Image:Conformance.svg|right|20px]]
|-
! <span id="RetrieveQuestionnaire">RetrieveQuestionnaire</span>
| format
| Return format. Options: 'json', 'html', 'xml' (default).
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| id
| Content transaction id to convert
| required [[Image:Conformance.svg|right|20px]]
|-
|
| effectiveDate
| Content transaction effectiveDate to convert.yyyy-mm-ttThh:mm:ss. Only with param ''id''
| required [[Image:Conformance.svg|right|20px]]
|-
|
| version
| Project release version - format yyyy-mm-ttThh:mm:ss. Only with param prefix
| optional [[Image:Conformance.svg|right|20px]]
|-
|
| language
| Content language - format ll-CC. Recommended with param version. Any '*' without quotes for 'any language'
| optional [[Image:Conformance.svg|right|20px]]

|-
|
| fhirLinkItemStyle
| If set to "id" linkItem value is the id, e.g. "2.16.840.1.113883.3.1937.99.62.3.2.2--2011-01-28T00:00:00", if set to "oid" the OID is shown only, e.g. "2.16.840.1.113883.3.1937.99.62.3.2.2", otherwise the id display name is shown if available, if not and the default is "id.
| optional [[Image:Conformance.svg|right|20px]]

|-
|}

== Implementation status of the return formats ==
Each format marked with [[Image:Conformance.svg|20px]] is implemented at this moment.

{|class="artdecorwiki"
!
! Retrieve
Dataset
! Retrieve
Transaction
! Retrieve
Valueset
! Retrieve
Code
! Retrieve
OID
! Retrieve
Concept
! Retrieve
Project
! Retrieve
Template
|-
! XML
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
|-
! CSV
| no
| no
| [[Image:Conformance.svg|20px]]
| no
| no
| no
| no
| no
|-
! HTML
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| [[Image:Conformance.svg|20px]]
| no
| [[Image:Conformance.svg|20px]]
|-
! SQL
| no
| no
| [[Image:Conformance.svg|20px]]
| no
| no
| no
| no
| no

|-
! PDF
| for future use
| possibly
| possibly
| no
| no
| no
| no
| no
|}

All *Index resources are only returned in HTML format.

== Hidecolumns mapping ==
The query parameter hidecolumns can contain numbers and letters (the order is not significant) which represent the columns in the returned view, with the following mapping:

{|class="artdecorwiki"
! Column to hide
! hidecolumn contains
|-
| Name
| N/A
|-
| ID
| 2
|-
| Mandatory
| 3
|-
| Conformance (transaction)
| 4
|-
| Cardinality (transaction)
| 5
|-
| Max (transaction)
| 6
|-
| Cardinality/conformance/datatype column (convenience single column) (transaction)
| 0
|-
| Datatype
| 7
|-
| Unit
| 8
|-
| Example
| 9
|-
| Codes
| a
|-
| Description
| b
|-
| Source
| c
|-
| Rationale
| d
|-
| Operationalization
| e
|-
| Comment
| f
|-
| Condition (transaction)
| g
|-
| Status column
| h
|-
| Community column
| i
|-
| Terminology column
| j
|-
| Value set column
| k
|-
| Type column (group / item)
| l
|-
| Parent column
| m
|-
| Inherit column
| n
|-
| Mapping
| o
|-
| Context
| p
|}

== Error handling ==
When a resource does not exist (either the queried format does not exist, or the resource does not exist in that language, etc) a HTTP 404 error is returned.

== Local value sets vs external value sets ==
In DECOR value sets can be defined locally (only applicable to that DECOR project).
Value sets that are defined locally in the DECOR project, do have an ''id'' (OID) and a (local) ''name''.
Local value sets can contain a ''statusCode''.

External value sets always contain an ''id'' (OID).

A value set must always contain an ''effectiveDate'', which contains the "creation" date of the value set.
== FHIR URI's ==
For FHIR URI's, see: [[FHIR_URIs | FHIR URI's]]