#284 Add variables for SDPi version string (short version number) (#290)

* #284 Add variables for SDPi version string (short version number). Replace version in text with variable.

* #284 Remove mentioning of specific subsequent SDPi version to avoid inconsistencies after a release cycle.

* #284 Add CHANGELOG.md item

CHANGELOG.md

@@ -18,6 +18,7 @@ Each section shall contain a list of action items of the following format: `<bri
 ### Editorial Fixes
 
 - Correct SES section titles ([#272](https://github.com/IHE/DEV.SDPi/issues/272))
+- Implement semi-automatic version referencing by adding Asciidoc variables ( ([#284](https://github.com/IHE/DEV.SDPi/issues/284)))
 
 ## [1.3.1] - 2024-04-05
 

asciidoc/document-declarations.adoc

@@ -16,7 +16,7 @@ NOTES:
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:
+a| *{supplement_note}*:
 
 The following table is included in this version of the supplement to capture *_"forward" declarations of acronyms and labels_* that are used in the text but are not intended to be part of the General Introduction Appendix D Glossary.
 "Forward" means that they are used BEFORE the document section in which they are formally defined.

asciidoc/sdpi-supplement-intro.adoc

@@ -1,3 +1,4 @@
+:supplement_note: SDPi {ihe_supplement_sdpi_revision_short} Supplement Note
 
 [#supplement_clause_introduction_to_supplement,sdpi_offset=clear]
 = Introduction to this Supplement
@@ -23,7 +24,7 @@ These known limitations include:
 . *Requirements boxes* (e.g., "R1234") have been added especially in TF-2, with some also part of TF-1 and TF-3; this is an initial approach that *_will be significantly expanded in future versions of the supplement_*; an initial approach is provided in <<vol1_clause_sdpi_requirements_modeling_integration>>, with discussion related to how it will be expanded in future versions of the supplement;
 . *_<<term_safe_effective_secure>> Sections_* (see <<vol1_clause_appendix_a_ses_considerations_section_template>>) are included in the specification; however, their use and content will be significantly extended in future versions;
 . This supplement is currently rendered as a *"long form"* document -- one single HTML file; however, in subsequent versions the intent is to consider a multi-page / file HTML rendering + addition of a tabbed menu for navigating the sections of the supplement;
-. *"SDPi 1.3 Supplement Note"* boxes are provided throughout the document to help guide reviewers and implementers.
+. *{supplement_note}* boxes are provided throughout the document to help guide reviewers and implementers.
 
 |===
 

asciidoc/sdpi-supplement.adoc

@@ -21,6 +21,7 @@
 :sdpi_milestone_review: SDPi 1.3 Review
 
 :ihe_supplement_sdpi_revision: 1.3.1
+:ihe_supplement_sdpi_revision_short: 1.3
 :ihe_supplement_sdpi_revision_date: {localdatetime}
 :ihe_supplement_sdpi_revision_label: Standard for Trial Use / Implementation
 :ihe_supplement_sdpi_publication_month: March 29, 2024

asciidoc/volume0/tf0-ch-9-copyrights.adoc

@@ -17,7 +17,7 @@ IHE technical documents refer to, and make use of, a number of standards develop
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  The content below is verbatim from the IEEE permission letter.
+a| *{supplement_note}*:  The content below is verbatim from the IEEE permission letter.
 An abbreviated version may be provided in subsequent supplement versions with a reference to the complete letter.
 The copyright language will need to be updated to support the PKP standards (e.g., <<ref_ieee_11073_10700_2022>>.
 It may also need to be updated for <<ref_ieee_11073_10101_2020>>, which is needing to be renewed.

asciidoc/volume0/tf0-ch-d-glossary.adoc

@@ -5,7 +5,7 @@
 [%autowidth]
 [cols="1"]
 |===
-| *SDPi Supplement Version Note*: The General Introduction Appendix D Glossary in this initial version of the supplement includes all terms and acronyms that are utilized throughout the other volumes.  Subsequent versions of the supplement may re-locate items to other tables and sections within the technical framework.  To help differentiate between various classes or categories of terms, a *_new "Type" column_* has been added.  This could enable future dynamic resorting of the table by those users who are interested in, for example, only organizational definitions.  Finally, a *_References column_* has been added to pull this information out of the Definition column.
+| *{supplement_note}*: The General Introduction Appendix D Glossary in this initial version of the supplement includes all terms and acronyms that are utilized throughout the other volumes.  Subsequent versions of the supplement may re-locate items to other tables and sections within the technical framework.  To help differentiate between various classes or categories of terms, a *_new "Type" column_* has been added.  This could enable future dynamic resorting of the table by those users who are interested in, for example, only organizational definitions.  Finally, a *_References column_* has been added to pull this information out of the Definition column.
 |===
 
 [%noheader]

asciidoc/volume1/conformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc

@@ -6,7 +6,7 @@
 [%autowidth]
 [cols="1"]
 |===
-| *SDPi Supplement Version Note*: This section is provided as a placeholder for the <<acronym_ics>> table specification that will be added in the subsequent SDPi 1.4 supplement version.
+| *{supplement_note}*: This section is provided as a placeholder for the <<acronym_ics>> table specification that will be added in a subsequent SDPi supplement version.
 The tables will have an additional SDPi column added to the right side that indicates *if* and TBD *where* the requirement is satisfied.
 Requirement Definition (this table's rows) will be referenced where they are satisfied; however, these tables may also include forward references, at least in general, to what capabilities / requirements satisfy the referenced standard requirement.
 

asciidoc/volume1/tf1-ch-10-sdpi-p.adoc

@@ -26,7 +26,7 @@ For example, Operating Room / Surgery Point-of-Care Integration, ICU Point-of-Ca
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*: For SDPi 1.3 some actors and transactions have been deferred to a subsequent version, but are included here for completeness.
+a| *{supplement_note}*: Some actors and transactions have been deferred to a subsequent version, but are included here for completeness.
 Specifically:  SOMDS FHIR Gateway, SOMDS Sensor Gateway & SOMDS Smart App Platform, have been deferred.
 
 Deferred transactions have been so indicated in the transactions table.
@@ -434,7 +434,7 @@ See related discussion at <<vol3_clause_biceps_mapping_using_somds_connector_con
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*: For SDPi 1.3, the TF-3 SDC/BICEPS Mapping of SOMDS Connector Content Modules section is out-of-scope., but included above for completeness of this actor overview.
+a| *{supplement_note}*: The TF-3 SDC/BICEPS Mapping of SOMDS Connector Content Modules section is out-of-scope., but included above for completeness of this actor overview.
 |===
 
 Although the SDPi-P Profile _<<vol1_spec_sdpi_p_actor_somds_connector>>_ provides for non-SOMDS _protocol-specific_ adaptors, they establish the foundation for specifying system and application-specific interfaces such as for EHR or decision support systems (e.g., sepsis determination). See <<vol1_clause_sdpi_p_ensuring_time_synchronization>>, and <<vol1_clause_sdpi_p_aggregators_proxies_sensors>> for additional perspectives and concepts on how SOMDS Connectors may be implemented.
@@ -485,7 +485,7 @@ Generally, the <<vol1_spec_sdpi_p_actor_somds_v2_gateway>> supports messaging fr
 [%autowidth]
 [cols="1"]
 |===
-| *SDPi Supplement Version Note*: Detailed specifications for this actor are deferred to a later version of the SDPi Supplement.
+| *{supplement_note}*: Detailed specifications for this actor are deferred to a later version of the SDPi Supplement.
 |===
 
 [#vol1_spec_sdpi_p_actor_somds_sensor_gateway, reftext='SOMDS Sensor Gateway']
@@ -505,7 +505,7 @@ This also includes SOMDS integration of IoT (“Internet of Things”) architect
 [%autowidth]
 [cols="1"]
 |===
-| *SDPi Supplement Version Note*: Detailed specifications for this actor are deferred to a later version of the SDPi Supplement.
+| *{supplement_note}*: Detailed specifications for this actor are deferred to a later version of the SDPi Supplement.
 |===
 
 [#vol1_spec_sdpi_p_actor_somds_smart_app_platform, reftext='SOMDS Smart App Platform']
@@ -566,7 +566,7 @@ Note that although this SDPi-P content actor primarily supports information exch
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  Profile options are out-of-scope for this version of the supplement.
+a| *{supplement_note}*:  Profile options are out-of-scope for this version of the supplement.
 Future versions *_MAY_* include options such as the following (not in priority order):
 
 * Retrieve Remote Data
@@ -624,7 +624,7 @@ Future versions *_MAY_* include options such as the following (not in priority o
 [cols="1"]
 |===
 
-a| *SDPi Supplement Version Note*:  As indicated in <<vol1_figure_sdpi_p_actor_diagram>> above, there are no explicit grouped actors in this specification; however, there are abstract actors (<<vol1_spec_sdpi_p_actor_somds_participant>> and <<vol1_spec_sdpi_p_actor_somds_connector>>), and the <<vol1_spec_sdpi_p_actor_somds_connector>> may implement interfaces to <<vol1_spec_sdpi_p_actor_somds_provider>> or <<vol1_spec_sdpi_p_actor_somds_consumer>> to provide bidirectional exchanges with non-<<acronym_somds>> systems.
+a| *{supplement_note}*:  As indicated in <<vol1_figure_sdpi_p_actor_diagram>> above, there are no explicit grouped actors in this specification; however, there are abstract actors (<<vol1_spec_sdpi_p_actor_somds_participant>> and <<vol1_spec_sdpi_p_actor_somds_connector>>), and the <<vol1_spec_sdpi_p_actor_somds_connector>> may implement interfaces to <<vol1_spec_sdpi_p_actor_somds_provider>> or <<vol1_spec_sdpi_p_actor_somds_consumer>> to provide bidirectional exchanges with non-<<acronym_somds>> systems.
 
 These actor relationships do not represent typical IHE grouped actors, but should be represented in more explicit detail.
 The best approach for achieving that clarity and specificity will be addressed in a future version after further review and discussion by the supplement development team.
@@ -706,7 +706,7 @@ Specific <<vol1_clause_sdpi_p_profile_reftext>> transaction message bindings and
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -720,7 +720,7 @@ a| *SDPi Supplement Version Note*:  This section intentionally left blank for th
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -736,7 +736,7 @@ Integration of CT and ATNA (TBD) below in required groupings is assumed but shou
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -750,7 +750,7 @@ a| *SDPi Supplement Version Note*:  This section intentionally left blank for th
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -768,7 +768,7 @@ See Gateways in the actors discussion above … and below?
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -783,7 +783,7 @@ Given the discussion in Actors above, is this necessary here?  Or should some of
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -796,7 +796,7 @@ a| *SDPi Supplement Version Note*:  This section intentionally left blank for th
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////
@@ -809,7 +809,7 @@ a| *SDPi Supplement Version Note*:  This section intentionally left blank for th
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
+a| *{supplement_note}*:  This section intentionally left blank for the current version, but is a placeholder for content that will be added in the future.
 |===
 
 ////

asciidoc/volume1/tf1-ch-11-sdpi-r.adoc

@@ -7,7 +7,7 @@
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version 1.3 Note*:  This version of the <<acronym_sdpi_r>> Profile is built upon the foundational <<acronym_sdpi_p>> Profile but does not provide substantially more capabilities.
+a| *{supplement_note}*:  This version of the <<acronym_sdpi_r>> Profile is built upon the foundational <<acronym_sdpi_p>> Profile but does not provide substantially more capabilities.
 This is due to the fact that the primary purpose of this <<acronym_sdpi_r>> Profile, namely communication of medical data to accomplish intended medical purposes, requires the completion and integration of two emerging ISO/IEEE standards:  <<ref_ieee_11073_10700_2022>> and <<ref_ieee_11073_10701_2022>>.
 When these are published *_in 2023 / 2024_*, their requirements will be integrated into this supplement, with their <<term_implementation_conformance_statement>> added to <<vol1_appendix_b_referenced_standards_conformance>> below.
 Many of those requirements will be mapped to the actors and transactions and other elements in this supplement, including this <<acronym_sdpi_r>> Profile.
@@ -197,7 +197,7 @@ Actor Summary Definition:
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  The HL7 FHIR resources and related Point-of-Care Device FHIR Implementation Guide (PoCD FHIR IG) is still under active development.
+a| *{supplement_note}*:  The HL7 FHIR resources and related Point-of-Care Device FHIR Implementation Guide (PoCD FHIR IG) is still under active development.
 Initial mappings have been made from <<acronym_sdc>> to <<acronym_fhir>>; however, they are not yet ready for profiling and product implementation.
 When the FHIR specifications are finalized, then this actor will be fully specified in a future SDPI Supplement version.
 
@@ -216,7 +216,7 @@ See <<vol1_spec_sdpi_p_actor_somds_fhir_gateway>> for additional information.
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  This section is left intentionally blank to indicate capabilities that will be added in a future version of the SDPi Supplement.
+a| *{supplement_note}*:  This section is left intentionally blank to indicate capabilities that will be added in a future version of the SDPi Supplement.
 
 This option will enable <<vol1_spec_sdpi_r_actor_somds_medical_data_consumer>> systems to access information in remote systems that are not part of its <<acronym_somds>> network instance.  This access will be provided by either a <<vol1_spec_sdpi_r_actor_somds_dec_gateway>> or <<vol1_spec_sdpi_r_actor_somds_fhir_medical_data_gateway>>.
 For example, retrieving the latest laboratory information for a specific patient.
@@ -230,7 +230,7 @@ For example, retrieving the latest laboratory information for a specific patient
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  As indicated in <<vol1_figure_sdpi_r_actor_diagram>> above, there are four grouped actors:
+a| *{supplement_note}*:  As indicated in <<vol1_figure_sdpi_r_actor_diagram>> above, there are four grouped actors:
 
 [none]
 . <<vol1_spec_sdpi_r_actor_somds_medical_data_consumer>> with <<vol1_spec_sdpi_p_actor_somds_consumer>>
@@ -251,7 +251,7 @@ This section will be more completely detailed in a future version of the supplem
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version Note*:  An overview of the concepts for this <<vol1_clause_sdpi_r_profile_reftext>> will be provided in a future supplement version.
+a| *{supplement_note}*:  An overview of the concepts for this <<vol1_clause_sdpi_r_profile_reftext>> will be provided in a future supplement version.
 Note that this specification extends the concepts established in the base <<vol1_clause_sdpi_p_profile_reftext>>.
 
 |===
@@ -309,7 +309,7 @@ A primary source of safety requirements for this <<acronym_sdpi_r>> Profile come
 [%autowidth]
 [cols="1"]
 |===
-a| *SDPi Supplement Version 1.3 Note*:  The <<ref_ieee_11073_10700_2022>> and <<ref_ieee_11073_10701_2022>> standards are currently being published by the IEEE.
+a| *{supplement_note}*:  The <<ref_ieee_11073_10700_2022>> and <<ref_ieee_11073_10701_2022>> standards are currently being published by the IEEE.
 Once published, their requirements will be integrated into this supplement, with many of them being mapped to elements in this <<acronym_sdpi_r>> Profile.
 
 |===