Difference between revisions of "ART Scenario Viewer"
(added template Underconstruction so page can be found as todo) |
|||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Underconstruction}} | + | <!--{{Underconstruction}}--> |
| + | {{: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 | ||
| + | |} | ||
Latest revision as of 12:53, 8 July 2020
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.
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.
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.
Form parameters
The scenarios form, as most other forms, supports parametrization.
/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]
| 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
|
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 |