URIs
Identification of DECOR objects with URI's.
Contents
URI logic
Item | Description |
---|---|
server | http://art-decor.org/decor/services |
separator | / |
action | RetrieveDataset, RetrieveTransaction, RetrieveValueset, RetrieveCode, RetrieveOID, RetrieveTemplate , RetrieveConcept, DatasetIndex, TransactionIndex, ValuesetIndex, CodeSystemIndex, OIDIndex, ConceptIndex, GetImage, RetrieveProject, ProjectIndex The services RetrieveProject and ProjectIndex are not public services because these are 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 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 value set or template, in 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 instance language=en-US. When no language is entered, the server's default language is returned and if this is not available, English is returned. By default English should be available. Please note that by passing the language parameter, the HTML-display may return texts in that language. |
format | The desired return format, for instance format=xml (or: html, csv, pdf). When no format parameter is entered, the default return format is XML. For the XML formats an XML schema and description is also returned. 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 projectprefix (/decor/project/@prefix) must be an exact match. |
mode | The returntype. 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. |
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. |
Examples
URI
Description |
---|
http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65&effectiveDate=2013-01-10T00:00:00
Will return a valueset 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&format=csv
Will return a valueset with a specific date in the return format CSV |
http://art-decor.org/decor/services/RetrieveValueSet?id=1.2.40.0.34.10.65
Will return all versions of a valueset in the default return format (XML) |
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 (XML) in American English |
http://art-decor.org/decor/services/RetrieveCode?code=1&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 |
Implementation status of the query parameters
Each query parameter marked with is implemented at this moment. Each query parameter marked with N/A is not applicable, not implemented at this moment.
id | code | codeSystem | name | assigningAuthority | effectiveDate | language | format | prefix | mode | hidecolumns | |
---|---|---|---|---|---|---|---|---|---|---|---|
RetrieveDataset | required | N/A | N/A | N/A | N/A | optional | required | optional | N/A | N/A | optional |
RetrieveValueset (at least id, name, or prefix) |
optional | N/A | N/A | optional | N/A | optional | optional | optional | optional | N/A | N/A |
RetrieveTransaction | required | N/A | N/A | N/A | N/A | N/A | required | optional | N/A | N/A | optional |
RetrieveTemplate | optional | N/A | N/A | N/A | N/A | optional | optional | optional | N/A | N/A | N/A |
RetrieveCode | N/A | required | required | N/A | N/A | N/A | optional | optional | N/A | N/A | N/A |
RetrieveOID | required | N/A | N/A | N/A | N/A | N/A | optional | optional | N/A | N/A | N/A |
RetrieveConcept | required | N/A | N/A | N/A | N/A | N/A | N/A | optional | N/A | N/A | N/A |
DECOR Index | N/A | N/A | N/A | N/A | N/A | N/A | required | N/A | required | N/A | N/A |
DataSetIndex | optional | N/A | N/A | N/A | N/A | optional | optional | N/A | optional | N/A | N/A |
ValueSetIndex | optional | N/A | N/A | optional | N/A | optional | optional | N/A | optional | N/A | N/A |
TransactionIndex | optional | N/A | N/A | optional | N/A | N/A | optional | N/A | optional | N/A | N/A |
CodeSystemIndex | N/A | N/A | optional | N/A | N/A | optional | optional | N/A | N/A | N/A | N/A |
OIDIndex | optional | N/A | N/A | optional | optional | optional | optional | N/A | N/A | N/A | N/A |
ConceptIndex | optional | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A | N/A |
GetImage | optional | N/A | N/A | N/A | N/A | N/A | N/A | N/A | required | N/A | N/A |
RetrieveProject | required | N/A | N/A | optional | N/A | N/A | optional | N/A | optional | optional | N/A |
ProjectIndex | optional | N/A | N/A | optional | N/A | N/A | optional | N/A | optional | N/A | N/A |
Implementation status of the return formats
Each format marked with is implemented at this moment.
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:
Column to hide | hidecolumn contains |
---|---|
Name | N/A |
ID | 2 |
Mandatory | 3 |
Conformance | 4 |
Cardinality | 5 |
Max | 6 |
Datatype | 7 |
Unit | 8 |
Example | 9 |
Codes | a |
Description | b |
Source | c |
Rationale | d |
Operationalization | e |
Comment | f |
Condition | g |
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.