Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a new attribute - title to RESOURCE_DESCRIPTION #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add a new attribute - title to RESOURCE_DESCRIPTION #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1477613
Add a new attribute - title to RESOURCE_DESCRIPTION
bostjanl-better Nov 4, 2024
004a58e
Changes for
wolandscat Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified computable/UML/openEHR_UML-BASE.mdzip
View file
Open in desktop
Binary file not shown.
20 changes: 12 additions & 8 deletions docs/UML/classes/org.openehr.base.resource.resource_description.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ h|*Attributes*
^h|*Signature*
^h|*Meaning*

h|*0..1*
|*title*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
a|Long-form descriptive title of the resource, typically needed in templates and occasionally in specialised archetypes where the root archetype/template name is not descriptive enough to disambiguate from similar archetypes/templates.

h|*1..1*
|*original_author*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
a|Original author of this resource, with all relevant details, including organisation.
Expand All @@ -28,15 +32,15 @@ h|*0..1*
|*other_contributors*: `link:/releases/BASE/{base_release}/foundation_types.html#_list_class[List^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
a|Other contributors to the resource, each listed in "name <email>" form.

h|*1..1*
|*lifecycle_state*: `link:/releases/BASE/{base_release}/foundation_types.html#_terminology_code_class[Terminology_code^]`
a|Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.

h|*1..1*
|*parent_resource*: `<<_authored_resource_class,AUTHORED_RESOURCE>> +
{default{nbsp}={nbsp}}`
a|Reference to owning resource.

h|*1..1*
|*lifecycle_state*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
a|Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.

h|*0..1*
|*custodian_namespace*: `link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]`
a|Namespace in reverse internet id form, of current custodian organisation.
Expand Down Expand Up @@ -84,11 +88,11 @@ conversion_details = <
>
----

h|*0..1*
|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
a|Additional non-language-sensitive resource meta-data, as a list of name/value pairs.

h|*0..1*
|*details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^],<<_resource_description_item_class,RESOURCE_DESCRIPTION_ITEM>>>`
a|Details of all parts of resource description that are natural language-dependent, keyed by language code.

h|*0..1*
|*other_details*: `link:/releases/BASE/{base_release}/foundation_types.html#_hash_class[Hash^]<link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^], link:/releases/BASE/{base_release}/foundation_types.html#_string_class[String^]>`
a|Additional non-language-sensitive resource meta-data, as a list of name/value pairs.
|===
65 changes: 34 additions & 31 deletions docs/UML/diagrams/BASE-resource.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 33 additions & 12 deletions docs/resource.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
<meta name="keywords" content="openehr, resources">
<title>Resource Model</title>
<link rel="stylesheet" href="https://specifications.openehr.org/styles/openehr.css">
<link rel="stylesheet" href="https://specifications.openehr.org/styles/asciidoctor-tabs.css">
</head>
<body class="book toc2 toc-left">
<div id="header">
Expand Down Expand Up @@ -108,7 +109,7 @@ <h1 id="_resource_model" class="sect0"><a class="anchor" href="#_resource_model"
</colgroup>
<thead>
<tr>
<th class="tableblock halign-center valign-top" colspan="2">&#169; 2003 - 2022 The openEHR Foundation</th>
<th class="tableblock halign-center valign-top" colspan="2">&#169; 2003 - 2024 The openEHR Foundation</th>
</tr>
</thead>
<tbody>
Expand Down Expand Up @@ -148,13 +149,25 @@ <h2 id="_amendment_record"><a class="anchor" href="#_amendment_record"></a>Amend
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a id="latest_issue"></a>1.9.0</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://specifications.openehr.org/tickets/SPECBASE-39" target="_blank" rel="noopener">SPECBASE-39</a>: Change <code>RESOURCE_DESCRIPTION.<em>lifecycle_state</em></code> type to <code>String</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">I McNicoll</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a id="latest_issue_date"></a>05 Nov 2024</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://specifications.openehr.org/tickets/SPECBASE-40" target="_blank" rel="noopener">SPECBASE-40</a>: Add <code><em>title</em></code> attribute to <code>RESOURCE_DESCRIPTION</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">I McNicoll</p></td>
<td class="tableblock halign-left valign-top"></td>
</tr>
<tr>
<th class="tableblock halign-center valign-top" colspan="4"><p class="tableblock"><strong>BASE Release 1.2.0</strong></p></th>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a id="latest_issue"></a>1.8.3</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">1.8.3</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="https://specifications.openehr.org/tickets/SPECBASE-23" target="_blank" rel="noopener">SPECBASE-23</a>: Add <code><em>other_contributors</em></code> to <code>TRANSLATION_DETAILS</code>.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">S Garde</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><a id="latest_issue_date"></a>22 Feb 2021</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">[22 Feb 2021</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"></td>
Expand Down Expand Up @@ -663,6 +676,13 @@ <h4 id="_resource_description_class"><a class="anchor" href="#_resource_descript
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>Meaning</strong></p></th>
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>0..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>title</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_string_class" target="_blank" rel="noopener">String</a></code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Long-form descriptive title of the resource, typically needed in templates and occasionally in specialised archetypes where the root archetype/template name is not descriptive enough to disambiguate from similar archetypes/templates.</p>
</div></div></td>
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>1..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>original_author</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_hash_class">Hash<sup></a>&lt;<a href="/releases/BASE/latest/foundation_types.html#_string_class">String</sup></a>, <a href="/releases/BASE/latest/foundation_types.html#_string_class" target="_blank" rel="noopener">String</a>&gt;</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
Expand Down Expand Up @@ -692,17 +712,17 @@ <h4 id="_resource_description_class"><a class="anchor" href="#_resource_descript
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>1..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>lifecycle_state</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_terminology_code_class" target="_blank" rel="noopener">Terminology_code</a></code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>parent_resource</strong>: <code><a href="#_authored_resource_class">AUTHORED_RESOURCE</a><br>
{default&#160;=&#160;}</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.</p>
<p>Reference to owning resource.</p>
</div></div></td>
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>1..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>parent_resource</strong>: <code><a href="#_authored_resource_class">AUTHORED_RESOURCE</a><br>
{default&#160;=&#160;}</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>lifecycle_state</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_string_class" target="_blank" rel="noopener">String</a></code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Reference to owning resource.</p>
<p>Lifecycle state of the resource, typically including states such as: initial, in_development, in_review, published, superseded, obsolete.</p>
</div></div></td>
</tr>
<tr>
Expand Down Expand Up @@ -780,16 +800,16 @@ <h4 id="_resource_description_class"><a class="anchor" href="#_resource_descript
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>0..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>other_details</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_hash_class">Hash<sup></a>&lt;<a href="/releases/BASE/latest/foundation_types.html#_string_class">String</sup></a>, <a href="/releases/BASE/latest/foundation_types.html#_string_class" target="_blank" rel="noopener">String</a>&gt;</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>details</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_hash_class">Hash<sup></a>&lt;<a href="/releases/BASE/latest/foundation_types.html#_string_class">String</sup></a>,<a href="#_resource_description_item_class">RESOURCE_DESCRIPTION_ITEM</a>&gt;</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Additional non-language-sensitive resource meta-data, as a list of name/value pairs.</p>
<p>Details of all parts of resource description that are natural language-dependent, keyed by language code.</p>
</div></div></td>
</tr>
<tr>
<th class="tableblock halign-center valign-top"><p class="tableblock"><strong>0..1</strong></p></th>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>details</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_hash_class">Hash<sup></a>&lt;<a href="/releases/BASE/latest/foundation_types.html#_string_class">String</sup></a>,<a href="#_resource_description_item_class">RESOURCE_DESCRIPTION_ITEM</a>&gt;</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>other_details</strong>: <code><a href="/releases/BASE/latest/foundation_types.html#_hash_class">Hash<sup></a>&lt;<a href="/releases/BASE/latest/foundation_types.html#_string_class">String</sup></a>, <a href="/releases/BASE/latest/foundation_types.html#_string_class" target="_blank" rel="noopener">String</a>&gt;</code></p></td>
<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
<p>Details of all parts of resource description that are natural language-dependent, keyed by language code.</p>
<p>Additional non-language-sensitive resource meta-data, as a list of name/value pairs.</p>
</div></div></td>
</tr>
</tbody>
Expand Down Expand Up @@ -933,5 +953,6 @@ <h4 id="_resource_annotations_class"><a class="anchor" href="#_resource_annotati
Last updated 2022-11-29 11:16:12 UTC
</div>
</div>
<script src="https://specifications.openehr.org/js/asciidoctor-tabs.js"></script>
</body>
</html>
14 changes: 12 additions & 2 deletions docs/resource/master00-amendment_record.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,22 @@
|===
|Issue|Details|Raiser|Completed

|[[latest_issue]]1.9.0
|{spec_tickets}/SPECBASE-39[SPECBASE-39^]: Change `RESOURCE_DESCRIPTION._lifecycle_state_` type to `String`.
|I McNicoll
|[[latest_issue_date]]05 Nov 2024

|
|{spec_tickets}/SPECBASE-40[SPECBASE-40^]: Add `_title_` attribute to `RESOURCE_DESCRIPTION`.
|I McNicoll
|

4+^h|*BASE Release 1.2.0*

|[[latest_issue]]1.8.3
|1.8.3
|{spec_tickets}/SPECBASE-23[SPECBASE-23^]: Add `_other_contributors_` to `TRANSLATION_DETAILS`.
|S Garde
|[[latest_issue_date]]22 Feb 2021
|[22 Feb 2021

|
|{spec_tickets}/SPECPUB-6[SPECPUB-6^]: Correct spelling error in `TRANSLATION_DETAILS._accreditation_`.
Expand Down