From 37ce27138db8ad2f53ebdad5eeac2c26de5defd8 Mon Sep 17 00:00:00 2001 From: David Gregorczyk <54440227+d-gregorczyk@users.noreply.github.com> Date: Fri, 3 May 2024 15:55:28 +0200 Subject: [PATCH] #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 | 1 + asciidoc/document-declarations.adoc | 2 +- asciidoc/sdpi-supplement-intro.adoc | 3 +- asciidoc/sdpi-supplement.adoc | 1 + asciidoc/volume0/tf0-ch-9-copyrights.adoc | 2 +- asciidoc/volume0/tf0-ch-d-glossary.adoc | 2 +- ...mance-statement-ieee-11073-10207-2017.adoc | 2 +- asciidoc/volume1/tf1-ch-10-sdpi-p.adoc | 28 +++++++++---------- asciidoc/volume1/tf1-ch-11-sdpi-r.adoc | 12 ++++---- asciidoc/volume1/tf1-ch-12-sdpi-a.adoc | 12 ++++---- asciidoc/volume1/tf1-ch-13-sdpi-xc.adoc | 8 +++--- asciidoc/volume1/tf1-ch-2-overview.adoc | 8 +++--- ...f1-ch-a-requirements-interoperability.adoc | 12 ++++---- .../tf1-ch-b-ref-standards-conformance.adoc | 6 ++-- .../volume1/use-cases/tf1-ch-c-60601-1-8.adoc | 2 +- .../volume1/use-cases/tf1-ch-c-use-cases.adoc | 8 +++--- .../gateways/tf2-ch-b-gateway-dec.adoc | 2 +- .../tf3-ch-8.3.2.9.5-extension-gender.adoc | 2 +- .../volume3/tf3-ch-8.3.2-biceps-content.adoc | 8 +++--- .../volume3/tf3-ch-8.7.1-infusion-pump.adoc | 4 +-- asciidoc/volume3/tf3-ch-8.7.2-ventilator.adoc | 4 +-- asciidoc/volume3/tf3-ch-8.7.4-surgical.adoc | 4 +-- asciidoc/volume3/tf3-main.adoc | 20 ++++++------- 23 files changed, 78 insertions(+), 75 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0857b04..1bbd533 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -18,6 +18,7 @@ Each section shall contain a list of action items of the following format: `>, with discussion related to how it will be expanded in future versions of the supplement; . *_<> Sections_* (see <>) 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. |=== diff --git a/asciidoc/sdpi-supplement.adoc b/asciidoc/sdpi-supplement.adoc index bad248f..70cbcbd 100644 --- a/asciidoc/sdpi-supplement.adoc +++ b/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 diff --git a/asciidoc/volume0/tf0-ch-9-copyrights.adoc b/asciidoc/volume0/tf0-ch-9-copyrights.adoc index 4de57db..89f3ea5 100644 --- a/asciidoc/volume0/tf0-ch-9-copyrights.adoc +++ b/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., <>. It may also need to be updated for <>, which is needing to be renewed. diff --git a/asciidoc/volume0/tf0-ch-d-glossary.adoc b/asciidoc/volume0/tf0-ch-d-glossary.adoc index cdf1cbb..4719cf7 100644 --- a/asciidoc/volume0/tf0-ch-d-glossary.adoc +++ b/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] diff --git a/asciidoc/volume1/conformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc b/asciidoc/volume1/conformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc index e0ea0a9..503abe6 100644 --- a/asciidoc/volume1/conformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc +++ b/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 <> 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 <> 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. diff --git a/asciidoc/volume1/tf1-ch-10-sdpi-p.adoc b/asciidoc/volume1/tf1-ch-10-sdpi-p.adoc index 0997e7f..ed4ea02 100644 --- a/asciidoc/volume1/tf1-ch-10-sdpi-p.adoc +++ b/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 <>_ 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 <>, and <> for additional perspectives and concepts on how SOMDS Connectors may be implemented. @@ -485,7 +485,7 @@ Generally, the <> 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 <> above, there are no explicit grouped actors in this specification; however, there are abstract actors (<> and <>), and the <> may implement interfaces to <> or <> to provide bidirectional exchanges with non-<> systems. +a| *{supplement_note}*: As indicated in <> above, there are no explicit grouped actors in this specification; however, there are abstract actors (<> and <>), and the <> may implement interfaces to <> or <> to provide bidirectional exchanges with non-<> 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 <> 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. |=== //// diff --git a/asciidoc/volume1/tf1-ch-11-sdpi-r.adoc b/asciidoc/volume1/tf1-ch-11-sdpi-r.adoc index f111600..99b734f 100644 --- a/asciidoc/volume1/tf1-ch-11-sdpi-r.adoc +++ b/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 <> Profile is built upon the foundational <> Profile but does not provide substantially more capabilities. +a| *{supplement_note}*: This version of the <> Profile is built upon the foundational <> Profile but does not provide substantially more capabilities. This is due to the fact that the primary purpose of this <> Profile, namely communication of medical data to accomplish intended medical purposes, requires the completion and integration of two emerging ISO/IEEE standards: <> and <>. When these are published *_in 2023 / 2024_*, their requirements will be integrated into this supplement, with their <> added to <> below. Many of those requirements will be mapped to the actors and transactions and other elements in this supplement, including this <> 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 <> to <>; 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 <> 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 <> systems to access information in remote systems that are not part of its <> network instance. This access will be provided by either a <> or <>. 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 <> above, there are four grouped actors: +a| *{supplement_note}*: As indicated in <> above, there are four grouped actors: [none] . <> with <> @@ -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 <> will be provided in a future supplement version. +a| *{supplement_note}*: An overview of the concepts for this <> will be provided in a future supplement version. Note that this specification extends the concepts established in the base <>. |=== @@ -309,7 +309,7 @@ A primary source of safety requirements for this <> Profile come [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version 1.3 Note*: The <> and <> standards are currently being published by the IEEE. +a| *{supplement_note}*: The <> and <> 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 <> Profile. |=== diff --git a/asciidoc/volume1/tf1-ch-12-sdpi-a.adoc b/asciidoc/volume1/tf1-ch-12-sdpi-a.adoc index c418f8e..6d42ba1 100644 --- a/asciidoc/volume1/tf1-ch-12-sdpi-a.adoc +++ b/asciidoc/volume1/tf1-ch-12-sdpi-a.adoc @@ -7,7 +7,7 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version 1.3 Note*: This initial version of the <> Profile is built upon the foundational <> Profile but adds services specialized for the communication and management of medical device alerting. +a| *{supplement_note}*: This initial version of the <> Profile is built upon the foundational <> Profile but adds services specialized for the communication and management of medical device alerting. Additionally, since the primary purpose of this specification is the communication of medical alert information to accomplish intended medical purposes, it will require the completion and integration of the emerging ISO/IEEE 11073 Alert <> standard <>. When this new standard is published *_in 2024_*, its requirements will be integrated into this supplement, with its <> added to <>. Many of those requirements will be mapped to the actors, transactions and other specifications in this specification. @@ -274,7 +274,7 @@ If a <> is being created, it may incorporate both << [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This section is intentionally left incomplete blank to indicate capabilities that will be added in a future version of the SDPi Supplement. +a| *{supplement_note}*: This section is intentionally left incomplete blank to indicate capabilities that will be added in a future version of the SDPi Supplement. As stated elsewhere, the completion of the <> standard is required before this profile can be completed (beyond alert reporting for DIS capabilities), and that is especially the case for alert delegation. *_The sequence diagram below for delegation is provided for informative purposes only and will be finalized when the IEEE standard and this profile option are completed._* @@ -309,7 +309,7 @@ include::../plantuml/vol1-figure-sdpi-a-delegation-example-sequence-diagram.puml [%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 <> systems to safely and reliably receive from <> systems user (clinician) acknowledgement of previously reported alert conditions. This option will enable the <> [DEV-43] transaction. @@ -324,7 +324,7 @@ This option will enable the <> systems to receive [DEV-04]/[PCD-04] transactions from an ACM Alert Manager and then act as a <> to communicate the signals to <> systems This option will enable the <> to respond to <> [DEV-38] and <> [DEV-40] transactions, and to initiate <> [DEV-39] transactions. @@ -338,7 +338,7 @@ This option will enable the <> to resp [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: As indicated in <> above, there are four grouped actors: +a| *{supplement_note}*: As indicated in <> above, there are four grouped actors: [none] . <> with <> @@ -360,7 +360,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 <> will be provided in a future supplement version. +a| *{supplement_note}*: An overview of the concepts for this <> will be provided in a future supplement version. Note that this specification extends the concepts established in the base <>. |=== diff --git a/asciidoc/volume1/tf1-ch-13-sdpi-xc.adoc b/asciidoc/volume1/tf1-ch-13-sdpi-xc.adoc index 585a202..83c2a68 100644 --- a/asciidoc/volume1/tf1-ch-13-sdpi-xc.adoc +++ b/asciidoc/volume1/tf1-ch-13-sdpi-xc.adoc @@ -7,7 +7,7 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This SDPi-xC (External Control) Profile Section is generally out-of-scope for the SDPi 1.3 version (see https://github.com/orgs/IHE/projects/6/views/1["Gemini SDPi Releases" Github project]); however, it is provided here to indicate the intended direction of the SDPi Profiles, with details being added in subsequent versions. Depending on capabilities, some very basic controls may need to be provided in 2024 as part of the 1.x or 2.0 versions, especially around external adjustment of settings (e.g., alert limits or to trigger a blood-pressure reading). +a| *{supplement_note}*: This SDPi-xC (External Control) Profile Section is generally out-of-scope for this version of the profile (see https://github.com/orgs/IHE/projects/6/views/1["Gemini SDPi Releases" Github project]); however, it is provided here to indicate the intended direction of the SDPi Profiles, with details being added in subsequent versions. Depending on capabilities, some very basic controls may need to be provided in 2024 as part of the 1.x or 2.0 versions, especially around external adjustment of settings (e.g., alert limits or to trigger a blood-pressure reading). |=== @@ -139,7 +139,7 @@ No options are specified for this specification. [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: As indicated in <> above, there are two grouped actors: +a| *{supplement_note}*: As indicated in <> above, there are two grouped actors: [none] . <> with <> @@ -157,7 +157,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 <> will be provided in a future supplement version. +a| *{supplement_note}*: An overview of the concepts for this <> will be provided in a future supplement version. Note that this specification extends the concepts established in the base <>. |=== @@ -168,7 +168,7 @@ Note that this specification extends the concepts established in the base <> capabilities of the <> Profile, but adds support for *_medical device external control capabilities_*. diff --git a/asciidoc/volume1/tf1-ch-a-requirements-interoperability.adoc b/asciidoc/volume1/tf1-ch-a-requirements-interoperability.adoc index 411a7b3..165f2c5 100644 --- a/asciidoc/volume1/tf1-ch-a-requirements-interoperability.adoc +++ b/asciidoc/volume1/tf1-ch-a-requirements-interoperability.adoc @@ -9,8 +9,8 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This appendix provides informative (vs. normative) information related to the unique way in which this supplement integrates requirements, both from referenced foundational standards and within this specification. -*For SDPi 1.3*, given its non-normative nature, full detailing of the concepts and specifications is deferred to a subsequent revision of the specification. +a| *{supplement_note}*: This appendix provides informative (vs. normative) information related to the unique way in which this supplement integrates requirements, both from referenced foundational standards and within this specification. +Given its non-normative nature, full detailing of the concepts and specifications is deferred to a subsequent revision of the specification. So, please excuse the incomplete sections with "placeholder" version notes! There is value, though, in giving the existing content a quick review and providing feedback that would inform subsequent revisions of the specification. @@ -107,7 +107,7 @@ How does this address the "interoperability trust gap"? By integrating SES dire [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: For SDPi 1.3, the inclusion of SES Considerations sections is early and will be significantly extended in subsequent versions of the specification. +a| *{supplement_note}*: The inclusion of SES Considerations sections is early and will be significantly extended in subsequent versions of the specification. Especially when requirements from the <> standards are included in SDPi 1.4 and following. Note: When the <> standards are integrated into this specification, then specific requirements will be directly linked to these <> Considerations sections. @@ -156,7 +156,7 @@ No additional security requirements and considerations are identified for this t [%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. |=== //// @@ -274,7 +274,7 @@ In some cases, it may be necessary to provide bi-directional bindings; however, [%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. |=== //// @@ -306,7 +306,7 @@ NOTE: Verification Cases will be used to perform verification of "satisfy" usage [%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. |=== //// diff --git a/asciidoc/volume1/tf1-ch-b-ref-standards-conformance.adoc b/asciidoc/volume1/tf1-ch-b-ref-standards-conformance.adoc index 0393bef..a04808c 100644 --- a/asciidoc/volume1/tf1-ch-b-ref-standards-conformance.adoc +++ b/asciidoc/volume1/tf1-ch-b-ref-standards-conformance.adoc @@ -6,7 +6,7 @@ [%autowidth] [cols="1"] |=== -| *SDPi Supplement Version Note*: The inclusion of a References appendix is unique for IHE Technical Framework specifications. +| *{supplement_note}*: The inclusion of a References appendix is unique for IHE Technical Framework specifications. Typically, referenced standards sections are distributed throughout the specifications where appropriate; however, standards from other organizations (e.g., IEEE, ISO, IEC) typically have a "Normative References" clause and when desired a "Bibliography" clause. Also, integration of explicit standards' <> specifications (e.g., <> <> tables) is unique, but needed to support requirements interoperability. @@ -83,7 +83,7 @@ Ultimately, the content of this appendix may be rearranged and even relocated; h [%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. |=== //// @@ -97,7 +97,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. |=== //// diff --git a/asciidoc/volume1/use-cases/tf1-ch-c-60601-1-8.adoc b/asciidoc/volume1/use-cases/tf1-ch-c-60601-1-8.adoc index cf4df80..2b31f44 100644 --- a/asciidoc/volume1/use-cases/tf1-ch-c-60601-1-8.adoc +++ b/asciidoc/volume1/use-cases/tf1-ch-c-60601-1-8.adoc @@ -8,7 +8,7 @@ The following is a quick guide to the functionality of DIS, CDIS, DAS and CDAS systems and how we have used and interpreted them for the purpose of this IHE Profile Supplement. Please refer to the next section on Definitions from <> for normative definitions for these terms. -NOTE: Note that the 1.3 version of the SDPi Profile only supports the Distributed Information System (DIS) model detailed below. +NOTE: Note that the {ihe_supplement_sdpi_revision_short} version of the SDPi Profile only supports the Distributed Information System (DIS) model detailed below. The other models are anticipated for subsequent versions. diff --git a/asciidoc/volume1/use-cases/tf1-ch-c-use-cases.adoc b/asciidoc/volume1/use-cases/tf1-ch-c-use-cases.adoc index d331725..0439209 100644 --- a/asciidoc/volume1/use-cases/tf1-ch-c-use-cases.adoc +++ b/asciidoc/volume1/use-cases/tf1-ch-c-use-cases.adoc @@ -11,7 +11,7 @@ [%autowidth] [cols="1"] |=== -| *SDPi Supplement Version Note*: This initial section of Appendix C is informative and is still being detailed. Completion is deferred to version 1.x or later. +| *{supplement_note}*: This initial section of Appendix C is informative and is still being detailed. Completion is deferred to version 1.x or later. It provides general background detail around how general (non-technology specific) clinical use case specifications are being utilized in this supplement. *REVIEWER QUESTION*: Please review the intended topics and identify any additional content that should be considered. Especialy helpful would be references to related standards and materials that would inform the approach taken in this appendix. @@ -33,7 +33,7 @@ Looking to leverage this wealth of use cases in considering SDPi, a "compendium [%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. |=== //// @@ -46,7 +46,7 @@ a| *SDPi Supplement Version Note*: This section intentionally left blank for th [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This section contains initial content that will be greatly expanded in future versions. +a| *{supplement_note}*: This section contains initial content that will be greatly expanded in future versions. |=== //// @@ -70,7 +70,7 @@ Each Use Case (also called a Feature in Gherkin) is organized as follows: [%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. |=== //// diff --git a/asciidoc/volume2/gateways/tf2-ch-b-gateway-dec.adoc b/asciidoc/volume2/gateways/tf2-ch-b-gateway-dec.adoc index 7e16a08..b6197e0 100644 --- a/asciidoc/volume2/gateways/tf2-ch-b-gateway-dec.adoc +++ b/asciidoc/volume2/gateways/tf2-ch-b-gateway-dec.adoc @@ -291,7 +291,7 @@ NOTE: For further information, please refer to the <>. [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: In this version of the SDPi Supplement, this section needs to be updated in order to be compliant with the <>. +a| *{supplement_note}*: In this version of the SDPi Supplement, this section needs to be updated in order to be compliant with the <>. The following issues need more investigations and discussions: * Mapping of the <>-provided device types to SNOMED codes diff --git a/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.9.5-extension-gender.adoc b/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.9.5-extension-gender.adoc index 8db9a37..19ac318 100644 --- a/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.9.5-extension-gender.adoc +++ b/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.9.5-extension-gender.adoc @@ -5,7 +5,7 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: As mentioned in the main text below, <> does not currently provide sex and gender semantic support at the same level of detail as foundational existing and emerging standards. +a| *{supplement_note}*: As mentioned in the main text below, <> does not currently provide sex and gender semantic support at the same level of detail as foundational existing and emerging standards. The following sex & gender harmonization policy will be taken in this and future SDPi specification versions until clear direction is available. [none] diff --git a/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc b/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc index e289fed..0dd2cbe 100644 --- a/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc +++ b/asciidoc/volume3/tf3-ch-8.3.2-biceps-content.adoc @@ -53,12 +53,12 @@ NOTE: A detailed description of this <> description information [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This version of the supplement does not fully support profiles of all the elements in the descriptive model, including: +a| *{supplement_note}*: This version of the supplement does not fully support profiles of all the elements in the descriptive model, including: * Service Control Object (SCO) and Operations * Battery objects -Additionally, only limited support for the *_AlertSystem_* (and related objects), and for the *_SystemContext_* types are provided in SDPi 1.3. +Additionally, only limited support for the *_AlertSystem_* (and related objects), and for the *_SystemContext_* types are provided in SDPi {ihe_supplement_sdpi_revision_short}. Subsequent versions of the specification will address complete functionality. |=== @@ -76,7 +76,7 @@ The basic containment from MDS to VMD to Channel to Metric is maintained within [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This clause is intentionally left blank for this version. +a| *{supplement_note}*: This clause is intentionally left blank for this version. Future versions will include general discussion about how BICEPS-based content is formally mapped to that of other protocols, typically utilizing a <>. |=== @@ -203,7 +203,7 @@ NOTE: This includes OIDs for private codes as detailed in <> standards community is evaluating the use of safety class elements in the BICEPS specification (see <>), and the related https://github.com/IHE/DEV.SDPi/issues/11[Github Issue #11 _Topic: SDPi-xC with Mixed Device Safety Classes_]. +a| *{supplement_note}*: The <> standards community is evaluating the use of safety class elements in the BICEPS specification (see <>), and the related https://github.com/IHE/DEV.SDPi/issues/11[Github Issue #11 _Topic: SDPi-xC with Mixed Device Safety Classes_]. The result of that discussion will directly impact the BICEPS SES Considerations Section below. For this version of the specification, the following wording has been suggested: diff --git a/asciidoc/volume3/tf3-ch-8.7.1-infusion-pump.adoc b/asciidoc/volume3/tf3-ch-8.7.1-infusion-pump.adoc index 9d5ac92..16bc298 100644 --- a/asciidoc/volume3/tf3-ch-8.7.1-infusion-pump.adoc +++ b/asciidoc/volume3/tf3-ch-8.7.1-infusion-pump.adoc @@ -22,8 +22,8 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: Content for this section will be extended in SDPi 1.x and subsequent versions. -The initial content will reflect what is provided in SDPi 1.3 <>. +a| *{supplement_note}*: Content for this section will be extended in SDPi 1.x and subsequent versions. +The initial content will reflect what is provided in SDPi {ihe_supplement_sdpi_revision_short} <>. |=== diff --git a/asciidoc/volume3/tf3-ch-8.7.2-ventilator.adoc b/asciidoc/volume3/tf3-ch-8.7.2-ventilator.adoc index b40339f..f9325f5 100644 --- a/asciidoc/volume3/tf3-ch-8.7.2-ventilator.adoc +++ b/asciidoc/volume3/tf3-ch-8.7.2-ventilator.adoc @@ -19,6 +19,6 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: Content for this section will be extended in SDPi 1.x and subsequent versions. -The initial content will reflect what is provided in SDPi 1.3 <>. +a| *{supplement_note}*: Content for this section will be extended in SDPi 1.x and subsequent versions. +The initial content will reflect what is provided in SDPi {ihe_supplement_sdpi_revision_short} <>. |=== diff --git a/asciidoc/volume3/tf3-ch-8.7.4-surgical.adoc b/asciidoc/volume3/tf3-ch-8.7.4-surgical.adoc index 4e0d7fe..a760e1f 100644 --- a/asciidoc/volume3/tf3-ch-8.7.4-surgical.adoc +++ b/asciidoc/volume3/tf3-ch-8.7.4-surgical.adoc @@ -21,6 +21,6 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: Content for this section will be extended in SDPi 1.x and subsequent versions. -The initial content will reflect what is provided in SDPi 1.3 <>. +a| *{supplement_note}*: Content for this section will be extended in SDPi 1.x and subsequent versions. +The initial content will reflect what is provided in SDPi {ihe_supplement_sdpi_revision_short} <>. |=== diff --git a/asciidoc/volume3/tf3-main.adoc b/asciidoc/volume3/tf3-main.adoc index f9cfc47..36a03d0 100644 --- a/asciidoc/volume3/tf3-main.adoc +++ b/asciidoc/volume3/tf3-main.adoc @@ -13,7 +13,7 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: The organization of this Volume 3 supplement factors in two major changes: +a| *{supplement_note}*: The organization of this Volume 3 supplement factors in two major changes: . IHE Supplement template (2020), with content mapped from the <> specification; @@ -30,7 +30,7 @@ For the existing TF-3 content in the <>, especially Secti *_Updating the existing IHE DEV Technical Framework content will be either deferred to a later version of this SDPi supplement or will be accomplished through a specific Change Proposal (CP) to the published IHE DEV TF-3._* -Additionally, for this version of SDPi 1.3, it isn't clear how best to address a similar division of the device specialization sections (e.g., infusion pump or ventilator). +Additionally, for this version of SDPi, it isn't clear how best to address a similar division of the device specialization sections (e.g., infusion pump or ventilator). Version note boxes (like this one) have therefore been added to the specializations section and a single BICEPS subsection has been added. Subsequent versions of the specification may address this more comprehensively. @@ -45,7 +45,7 @@ Subsequent versions of the specification may address this more comprehensively. [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 Section 3 (text immediately after the section header) to this SDPi 1.3 TF-3 Section 8.1 +| Move IHE PCD 2019 TF-3 Section 3 (text immediately after the section header) to this SDPi {ihe_supplement_sdpi_revision_short} TF-3 Section 8.1 |=== //// @@ -58,14 +58,14 @@ Subsequent versions of the specification may address this more comprehensively. [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 sections 3.1 to this SDPi 1.3 TF-3 Section 8.2 +| Move IHE PCD 2019 TF-3 sections 3.1 to this SDPi {ihe_supplement_sdpi_revision_short} TF-3 Section 8.2 |=== [%noheader] [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: The content in the IHE PCD 2019 TF-3 3.1 Section will need to be edited to be agnostic to the underlying protocol, with protocol specifics being relegated to subsections in <> below. +a| *{supplement_note}*: The content in the IHE PCD 2019 TF-3 3.1 Section will need to be edited to be agnostic to the underlying protocol, with protocol specifics being relegated to subsections in <> below. |=== @@ -80,7 +80,7 @@ a| *SDPi Supplement Version Note*: The content in the IHE PCD 2019 TF-3 3.1 Sect [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 sections 3.2 to 3.7 to this SDPi 1.3 TF-3 Section 8.3.1.2 TO 8.3.1..7 +| Move IHE PCD 2019 TF-3 sections 3.2 to 3.7 to this SDPi {ihe_supplement_sdpi_revision_short} TF-3 Section 8.3.1.2 TO 8.3.1..7 A new 8.3.1.1 Section should be added to the Classic DIM content section that addresses basic reporting. This content would be extracted from the existing (2019) Section 3.1, where that content is specific to the Classi DIM (see related note above). @@ -102,7 +102,7 @@ include::mdib-report-retrofit/tf3-ch-8.3.2.9-mdib-report-retrofit.adoc[] [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: This is a place holder section for content modules related to the Personal Health Device (PHD) semantics defined in the IEEE 11073-10206 and 11073-20601 standards. +a| *{supplement_note}*: This is a place holder section for content modules related to the Personal Health Device (PHD) semantics defined in the IEEE 11073-10206 and 11073-20601 standards. Though there are no PHD requirements in this supplement, there are PHD profiles that may be integrated into the IHE DEV Technical Framework, and as a result may add content to this section. |=== @@ -112,7 +112,7 @@ Though there are no PHD requirements in this supplement, there are PHD profiles [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 Section 4 Reserved to this SDPi 1.3 TF-3 Section 8.4 +| Move IHE PCD 2019 TF-3 Section 4 Reserved to this SDPi {ihe_supplement_sdpi_revision_short} TF-3 Section 8.4 |=== === RESERVED @@ -120,7 +120,7 @@ Though there are no PHD requirements in this supplement, there are PHD profiles [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 Section 5 Reserved to this SDPi 1.3 TF-3 Section 8.5 +| Move IHE PCD 2019 TF-3 Section 5 Reserved to this SDPi {ihe_supplement_sdpi_revision_short} TF-3 Section 8.5 |=== === RESERVED @@ -128,7 +128,7 @@ Though there are no PHD requirements in this supplement, there are PHD profiles [%noheader] [cols="1"] |=== -| Move IHE PCD 2019 TF-3 Section 6 Reserved to this SDPi 1.3 TF-3 Section 8.6 +| Move IHE PCD 2019 TF-3 Section 6 Reserved to this {ihe_supplement_sdpi_revision_short} TF-3 Section 8.6 |=== // 8.7