Publication 1.1 (#193)

* Addressed MJ's Volume 0 & 1 Comments per #189 ... all issues addressed except "n." for transaction section numbering. * Fix appendix numbering issue in references (#190) (#191) * Fix appendix numbering issue in references. * #189 Add changelog entry. Co-authored-by: David Gregorczyk <[email protected]> * #189 Re-arrange changelog entries. * Publication 1.1 reference numbering issue (#194) * #189 Fix missing volume prefix in section references. * #189 Add changelog entry. * Addressed MJ Comments from 13.07.2023 in #189 See CHANGELOG.md for details. * Updated "Section Section" Problem Removed the superfluous "Section" before a referenced section. * #189 Change broken note blocks. Align title of collapsible Notes blocks. * Updated "DEV" Usage Per IHE Publications instructions in #189 (#189 (comment)) * #189 Make transaction numbers in brackets appear after transaction name in PlantUML files. * Final IHE Publication Fixes Updated per fix requests ... 1:12.2.2: The transaction number in front of the transaction name (vs. name then number) 1:12.2.3: The transaction number in front of the transaction name (vs. name then number) Under Figure 2:3.35.4-1, DEV-35, DEV-27, DEV-38 are missing brackets Same in the caution boxes under Figures 2:3.36.4-1, 2:3.37.4-1, 2:3.38.4-1, and 2:3.40.4-1 as well * Updated Title Page Dates Added "Build Date" and "Publication Date" --------- Co-authored-by: David Gregorczyk <[email protected]> Co-authored-by: David Gregorczyk <[email protected]>
IHE · Jul 20, 2023 · 569421f · 569421f
1 parent a7c6b16
commit 569421f
Show file tree

Hide file tree

Showing 66 changed files with 268 additions and 266 deletions.
diff --git a/...-converter/src/main/kotlin/org/sdpi/asciidoc/extension/ReferenceSanitizerPostprocessor.kt b/...-converter/src/main/kotlin/org/sdpi/asciidoc/extension/ReferenceSanitizerPostprocessor.kt
@@ -82,7 +82,7 @@ class ReferenceSanitizerPostprocessor(
 
             val anchorText = (encodedLabel?.let { decodeLabel(it) }) ?: item.refText
             when (item.source) {
-                LabelSource.SECTION -> anchor.text(anchorText ?: "$sectionSig${item.label}")
+                LabelSource.SECTION -> anchor.text(anchorText ?: "$sectionSig${item.prefix}:${item.label}")
                 LabelSource.TABLE_OR_FIGURE -> anchor.text(anchorText ?: item.label)
                 LabelSource.APPENDIX -> anchor.text(anchorText ?: "$appendixSig${item.prefix}:${item.label}")
                 LabelSource.VOLUME -> anchor.text(anchorText ?: "$chapterSig${item.prefix}")

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,14 +33,20 @@ Each section shall contain a list of action items of the following format: `<bri
 - Open/Closed Issues sections have been revised. Sections are now generated automatically from Github issues ([#20](https://github.com/IHE/DEV.SDPi/issues/20)).
 - Created a common section for the ACM and DEC gateways such that requirement numbers are not duplicated anymore ([#53](https://github.com/IHE/DEV.SDPi/issues/53).  
 - Rephrase R1542 to make sure, that system functions not being available don't lead to unnecessary alarms ([#180] (https://github.com/IHE/DEV.SDPi/issues/180)). 
-- Moved requirements R1542 & R1543 to the SDPi-P SES / Effectiveness section from Github issues ([#182](https://github.com/IHE/DEV.SDPi/issues/182))
-
+- Moved requirements R1542 & R1543 to the SDPi-P SES / Effectiveness section from Github issues ([#182](https://github.com/IHE/DEV.SDPi/issues/182)).
 
 ### Removed
 
 ### Editorial Fixes
 
+- Wrong appendix numbering in references ([#189](https://github.com/IHE/DEV.SDPi/issues/189)).
+- Missing volume number in section references ([#189](https://github.com/IHE/DEV.SDPi/issues/189)).
+- Updated all references to the sdpi-fhir Github ([#162](https://github.com/IHE/DEV.SDPi/issues/162))
+- Addressed editorial issues from the IHE Publications review ([#189](https://github.com/IHE/DEV.SDPi/issues/189))
 - Wrong appendix numbering in references ([#189](https://github.com/IHE/DEV.SDPi/issues/189))).
+- All instances of "i.e." or "e.g." replaced with "i.e.," and "e.g.,", respectivelly ([#189](https://github.com/IHE/DEV.SDPi/issues/189))).
+- Normalized "profile" to "Profile" where appropriate ([#189](https://github.com/IHE/DEV.SDPi/issues/189))).
+- Normalized "section" to "Section" when it was referring to a specific clause within the document ([#189](https://github.com/IHE/DEV.SDPi/issues/189))).
 
 ## [1.0.1] - 2023-04-14
 
@@ -52,4 +58,3 @@ Each section shall contain a list of action items of the following format: `<bri
 - Replaced high-lighting from "Closed Issues" section with correct list ([#139](https://github.com/IHE/DEV.SDPi/issues/139)).
 - Remove leading dashes from table and figure captions if the section number is empty ([#144](https://github.com/IHE/DEV.SDPi/issues/144)).
 - Reviewed all "Verson Note" and version-specific (i.e, 1.0) content and either reworded or removed ([#148](https://github.com/IHE/DEV.SDPi/issues/148))
-- Updated all references to the sdpi-fhir Github ([#162](https://github.com/IHE/DEV.SDPi/issues/162))
diff --git a/asciidoc/plantuml/vol2-figure-dev-23-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-23-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-23] Announce Network Presence==
+==SDPi Announce Network Presence [DEV-23]==
 |||
 group unsecured
     provider ->> consumer: Hello(Provider UID, Discovery Scope)

diff --git a/asciidoc/plantuml/vol2-figure-dev-24-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-24-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-24] Discover Network Topology==
+==SDPi Discover Network Topology [DEV-24]==
 
 alt
     consumer ->> provider: Probe(Discovery Scope)

diff --git a/asciidoc/plantuml/vol2-figure-dev-25-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-25-sequence.puml
@@ -8,7 +8,7 @@ autonumber
 participant "$str_sdpi_p_somds_cons" as sdpi_somds_consumer
 participant "$str_sdpi_p_somds_prov" as sdpi_somds_provider
 
-==SDPi [DEV-25]  Discover BICEPS Services==
+==SDPi Discover BICEPS Services [DEV-25]==
 
 sdpi_somds_consumer -> sdpi_somds_provider: GetMetadata()
 sdpi_somds_consumer <<-- sdpi_somds_provider: GetMetadataResponse(BICEPS Services, Device Metadata, Model Metadata)

diff --git a/asciidoc/plantuml/vol2-figure-dev-27-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-27-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-27] Manage BICEPS Subscription==
+==SDPi Manage BICEPS Subscription [DEV-27]==
 
 consumer -> provider: Subscribe(Filter, Expiration Time)
 consumer <<-- provider: SubscribeResponse(Subscription Manager, Expiration Time)

diff --git a/asciidoc/plantuml/vol2-figure-dev-28-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-28-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-28] Notify Change in System Context and Capabilities  ==
+==SDPi Notify Change in System Context and Capabilities [DEV-28]==
 
 
 consumer <<- provider: Notification(EpisodicContextReport)

diff --git a/asciidoc/plantuml/vol2-figure-dev-29-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-29-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-29] Publish BICEPS Update Reports  ==
+==SDPi Publish BICEPS Update Reports [DEV-29]==
 opt
 consumer <<- provider: Notification(EpisodicAlertReport)
 end

diff --git a/asciidoc/plantuml/vol2-figure-dev-30-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-30-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-30] Discover BICEPS Content  ==
+==SDPi Discover BICEPS Content [DEV-30]==
 
 consumer -> provider: GetMdib()
 consumer <<-- provider: GetMdibResponse(MdDescription, MdState [incl. ContextStates])

diff --git a/asciidoc/plantuml/vol2-figure-dev-34-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-34-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-34] Announce Network Departure==
+==SDPi Announce Network Departure [DEV-34]==
 |||
 group unsecured
     provider ->> consumer: Bye(Provider UID)

diff --git a/asciidoc/plantuml/vol2-figure-dev-35-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-35-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-35] Establish Medical Data Exchange==
+==SDPi Establish Medical Data Exchange [DEV-35]==
 
 consumer -> provider: Subscribe(Filter, Expiration Time)
 consumer <<-- provider: SubscribeResponse(Subscription Manager, Expiration Time)

diff --git a/asciidoc/plantuml/vol2-figure-dev-36-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-36-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-36] Publish Medical Data  ==
+==SDPi Publish Medical Data [DEV-36]==
 
 
 consumer <<- provider: Notification(EpisodicMetricReport)

diff --git a/asciidoc/plantuml/vol2-figure-dev-37-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-37-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-37] Retrieve Medical Data  ==
+==SDPi Retrieve Medical Data [DEV-37]==
 
 consumer -> provider: GetMdib()
 consumer <<-- provider: GetMdibResponse(MdDescription, MdState [incl. ContextStates])

diff --git a/asciidoc/plantuml/vol2-figure-dev-38-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-38-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-==SDPi [DEV-38] Establish Medical Alert Exchange==
+==SDPi Establish Medical Alert Exchange [DEV-38]==
 
 consumer -> provider: Subscribe(Filter, Expiration Time)
 consumer <<-- provider: SubscribeResponse(Subscription Manager, Expiration Time)

diff --git a/asciidoc/plantuml/vol2-figure-dev-39-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-39-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-39] Publish Medical Alert Update  ==
+==SDPi Publish Medical Alert Update [DEV-39]==
 
 
 consumer <<- provider: Notification(EpisodicAlertReport)

diff --git a/asciidoc/plantuml/vol2-figure-dev-40-sequence.puml b/asciidoc/plantuml/vol2-figure-dev-40-sequence.puml
@@ -9,7 +9,7 @@ autonumber
 participant "$str_somds_consumer" as consumer
 participant "$str_somds_provider" as provider
 
-== SDPi [DEV-40] Medical Alert Status  ==
+==SDPi Medical Alert Status [DEV-40]==
 
 consumer -> provider: GetMdib()
 consumer <<-- provider: GetMdibResponse(MdDescription, MdState [incl. ContextStates])

diff --git a/asciidoc/plantuml/vol2-figure-xyz.puml b/asciidoc/plantuml/vol2-figure-xyz.puml
@@ -8,7 +8,7 @@ autonumber
 participant "$str_sdpi_p_somds_cons" as sdpi_somds_consumer
 participant "$str_sdpi_p_somds_prov" as sdpi_somds_provider
 
-== SDPi [DEV-23]  Announce Network Presence ==
+==SDPi Announce Network Presence [DEV-23]==
 |||
 group unsecured
 '    sdpi_somds_provider -> sdpi_somds_consumer: SDC: Hello(EndpointReference, Types, Scopes, [XAddrs])

diff --git a/asciidoc/sdpi-supplement-intro.adoc b/asciidoc/sdpi-supplement-intro.adoc
@@ -14,7 +14,7 @@ These known limitations include:
 
 
 . The content is scoped per the *_SDPi 1.1 version capabilities specification_* (see https://github.com/IHE/DEV.SDPi/wiki/SDPi-Editorial-Planning-and-Versions#sdpi-version-11-detail---[wiki article "SDPi Version 1.1 (Detail)"]), though future capabilities may be included in a Version Note
-. This supplement includes (4) SDPi profiles, though the typical IHE supplement is organized for a single profile; as a result, some adjustments have been made, especially in the supplement overview section where there is a general SDPi overview and then basic overviews for each of the profiles; challenging areas include profile "options" where there are FOUR sections vs. one; it is a work in progress and feedback is appreciated, especially to enhance clarity
+. This supplement includes (4) SDPi Profiles, though the typical IHE supplement is organized for a single profile; as a result, some adjustments have been made, especially in the supplement overview section where there is a general SDPi overview and then basic overviews for each of the Profiles; challenging areas include profile "options" where there are FOUR sections vs. one; it is a work in progress and feedback is appreciated, especially to enhance clarity
 . *Open / Closed Issues tables* -- for SDPi 1.1 the approach for the open / closed issues section has been integrated with the Github Issues that are related to this release; it is expected that this automation will continue to evolve in subsequent releases;
 . *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 SDPi 1.x and subsequent versions;
@@ -45,8 +45,8 @@ To that end, the supplement includes updates to all (3) IHE DEV TF volumes, incl
 *TF-1  Profiles*
 
 * General overview of the SDPi architectural approach & integrated set of profiles
-* Profile specific sections
-* Related appendices, for example the integration of this family of SDPi profiles with other sources of requirements - use cases or reference standards
+* Profile-specific sections
+* Related appendices, for example the integration of this family of SDPi Profiles with other sources of requirements - use cases or reference standards
 
 *TF-2  Transactions*
 

diff --git a/asciidoc/sdpi-supplement.adoc b/asciidoc/sdpi-supplement.adoc
@@ -23,7 +23,7 @@
 :ihe_supplement_sdpi_revision: 1.1.0
 :ihe_supplement_sdpi_revision_date: {localdatetime}
 :ihe_supplement_sdpi_revision_label: Trial Implementation
-:ihe_supplement_sdpi_publication_month: July 14, 2023
+:ihe_supplement_sdpi_publication_month: July 21, 2023
 :ihe_supplement_sdpi_public_comment_submission_deadline: N/A
 
 {empty} +
@@ -60,7 +60,10 @@
 [cols="1,4"]
 [frame=none,grid=none]
 |===
-| *Date:*
+| *Publication Date:*
+| {ihe_supplement_sdpi_publication_month}
+
+| *Build Date:*
 | {ihe_supplement_sdpi_revision_date}
 
 | *Author:*

diff --git a/asciidoc/volume0/tf0-ch-9-copyrights.adoc b/asciidoc/volume0/tf0-ch-9-copyrights.adoc
@@ -7,7 +7,7 @@ IHE technical documents refer to, and make use of, a number of standards develop
 [%noheader]
 [cols="1"]
 |===
-|Amend section 9.1 by adding the following new Section 9.1.5:
+|Amend Section 9.1 by adding the following new Section 9.1.5:
 |===
 
 [sdpi_offset=5]
@@ -33,7 +33,7 @@ IEEE^®^ and IEEE 11073^®^ are registered trademarks of the The Institute of El
 
 * Additionally, the IHE profile specifications may include summarization and references to specific content and in a few cases, inclusion of a graphic that would then point the reader back to standard for detailed review. For example, 11073-10207, Figure 2 "BICEPS component decomposition".
 
-* Finally, all three of these standards have integrated requirement designations. For example, 11073-20701, section (10.1) "R0064: An SDC PARTICIPANT SHOULD utilize the highest TLS version." These requirements may also be referenced (at least by Rxxxx designator) to indicate when and how they are addressed in the IHE specification(s). IHE agrees to share with the 11073 working groups any iteration of its derivative work for the benefits of the 11073 community of users.
+* Finally, all three of these standards have integrated requirement designations. For example, 11073-20701, Section (10.1) "R0064: An SDC PARTICIPANT SHOULD utilize the highest TLS version." These requirements may also be referenced (at least by Rxxxx designator) to indicate when and how they are addressed in the IHE specification(s). IHE agrees to share with the 11073 working groups any iteration of its derivative work for the benefits of the 11073 community of users.
 
 . IHE understands and agrees that the following shall appear in each section where the material is used:
 

diff --git a/asciidoc/volume0/tf0-ch-a-actors.adoc b/asciidoc/volume0/tf0-ch-a-actors.adoc
@@ -6,7 +6,7 @@
 [%autowidth]
 [cols="1"]
 |===
-|Add the following _*new or modified*_ actors to the IHE Technical Frameworks General Introduction https://profiles.ihe.net/GeneralIntro/ch-A.html[Appendix A].
+|Add the following *_new or modified_* actors to the IHE Technical Frameworks General Introduction https://profiles.ihe.net/GeneralIntro/ch-A.html[Appendix A].
 |===
 
 ////

diff --git a/asciidoc/volume0/tf0-main.adoc b/asciidoc/volume0/tf0-main.adoc
@@ -26,12 +26,12 @@ include::tf0-ch-d-glossary.adoc[]
 
 === XML Namespaces
 
-The XML namespace URI that is used by this profile is: `urn:oid:1.3.6.1.4.1.19376.1.6.2.10.1.1.1`.
+The XML namespace URI that is used by this specification is: `urn:oid:1.3.6.1.4.1.19376.1.6.2.10.1.1.1`.
 
-<<vol0_table_xml_namespaces>> lists XML namespaces and prefixes that are used in this profile.
+<<vol0_table_xml_namespaces>> lists XML namespaces and prefixes that are used in this specification.
 The choice of any namespace prefix is arbitrary and not semantically significant.
 
-.Prefixes and XML namespaces used in this profile.
+.Prefixes and XML namespaces used in this specification.
 [#vol0_table_xml_namespaces,cols="1,5,2",width=100%,]
 |===
 |Prefix |XML Namespace |Specification
@@ -42,7 +42,7 @@ The choice of any namespace prefix is arbitrary and not semantically significant
 
 |sdpi
 |urn:oid:1.3.6.1.4.1.19376.1.6.2.10.1.1.1
-|This profile
+|This specification
 
 |wsa
 |http://www.w3.org/2005/08/addressing

diff --git a/...onformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc b/...onformance-statements/tf1-ch-c-conformance-statement-ieee-11073-10207-2017.adoc
@@ -39,7 +39,7 @@ ADD IEEE:  *Remote Control ICS table here*
 ===== Context Processing
 
 NOTE: Context processing pertains to effective utilization of context information like workflow (e.g., orders) info, patient demographics and locations.
-A general concept should be described how to cope with contexts in terms of SDPi, i.e. device coupling mechanisms should be described informally in TF-1 and formally in TF-2 (as transaction?).
+A general concept should be described how to cope with contexts in terms of SDPi, i.e., device coupling mechanisms should be described informally in TF-1 and formally in TF-2 (as transaction?).
 
 ADD IEEE:  *Context Processing ICS table here*