Difference between revisions of "ART Value Set Viewer"
(first setup of page) |
(→Form parameters) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | =Views= | |
ART-DECOR offers multiple views on value sets: | ART-DECOR offers multiple views on value sets: | ||
* Project oriented: go to http://art-decor.org/art-decor/, select a project from the dropdown '''DECOR'''. In that project select the tab '''Terminology/Valuesets''' | * Project oriented: go to http://art-decor.org/art-decor/, select a project from the dropdown '''DECOR'''. In that project select the tab '''Terminology/Valuesets''' | ||
| Line 5: | Line 5: | ||
* Valueset oriented/as a service: see [[URIs]] service '''RetrieveValueSet'''. This service will return one valueset when queried with an id. | * Valueset oriented/as a service: see [[URIs]] service '''RetrieveValueSet'''. This service will return one valueset when queried with an id. | ||
| − | + | =Example= | |
Screenshot of an example valueset from one of the Continuity of Care Document (CCD) value sets: MedicationStatusCode | Screenshot of an example valueset from one of the Continuity of Care Document (CCD) value sets: MedicationStatusCode | ||
[[File:En_valueset_ccd_MedicationStatusCode.png|750px]] | [[File:En_valueset_ccd_MedicationStatusCode.png|750px]] | ||
| + | |||
| + | =Form parameters= | ||
| + | The value set form, as most other forms, supports parametrization. | ||
| + | |||
| + | <syntaxhighlight lang="text"> | ||
| + | /decor-valuesets--[prefix]?id=[value set id]&effectiveDate=[value set effective date]&language=[ll-CC] | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | {| style="text-align: left;" class="artdecorwiki" | ||
| + | ! Parameter !! Description !! Since | ||
| + | |- | ||
| + | | prefix || Project prefix || ''always'' | ||
| + | |- | ||
| + | | id | ||
| + | | Switches to the project value set with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | ||
| + | | art v1.5 | ||
| + | |- | ||
| + | | effectiveDate | ||
| + | | Switches to the project value set with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | ||
| + | | art v1.5 | ||
| + | |- style="font-style:italic;" | ||
| + | | valueSetRef | ||
| + | | Switches to the project value set with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | ||
| + | | ''always'' (deprecated in art >= 1.5) | ||
| + | |- style="font-style:italic;" | ||
| + | | valueSetEffectiveDate | ||
| + | | Switches to the project value set with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param valueSetRef | ||
| + | | ''always'' (deprecated in art >= 1.5) | ||
| + | |- | ||
| + | | 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 | ||
| + | |} | ||
Latest revision as of 11:02, 4 October 2017
Views
ART-DECOR offers multiple views on value sets:
- Project oriented: go to http://art-decor.org/art-decor/, select a project from the dropdown DECOR. In that project select the tab Terminology/Valuesets
- Project oriented/as a service: see URIs services ProjectIndex or ValueSetIndex. These services support multiple machine-processable formats such as (for example): xml or csv
- Valueset oriented/as a service: see URIs service RetrieveValueSet. This service will return one valueset when queried with an id.
Example
Screenshot of an example valueset from one of the Continuity of Care Document (CCD) value sets: MedicationStatusCode
Form parameters
The value set form, as most other forms, supports parametrization.
/decor-valuesets--[prefix]?id=[value set id]&effectiveDate=[value set effective date]&language=[ll-CC]
| Parameter | Description | Since |
|---|---|---|
| prefix | Project prefix | always |
| id | Switches to the project value set with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | art v1.5 |
| effectiveDate | Switches to the project value set with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param id | art v1.5 |
| valueSetRef | Switches to the project value set with this id/name. Format: OID/name. Note: while references by name remain supported on best effort basis for historic reasons they are notoriously ambiguous and hence strongly discouraged. | always (deprecated in art >= 1.5) |
| valueSetEffectiveDate | Switches to the project value set with this effective date. Format: yyyy-mm-ddThh:mm:ss. Works only in combination with param valueSetRef | always (deprecated in art >= 1.5) |
| 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 |
