From 8e440067ab9d1c1b51bfa738aca5751b395e1ab1 Mon Sep 17 00:00:00 2001 From: "Todd \"AFC!\" Cooper" Date: Thu, 6 Apr 2023 11:04:55 -0700 Subject: [PATCH] 126 prep text for trial implementation (#133) * updated the Foreword section (for TI), the revision label, the publication month Note: would like to see the revision date be added manually versus {local date} as the build date may not coincide with the actual "Publication" date * Pre-Trial Implementation Publication Edits Reworked the Intro comment box for Trial Implementation (vs. reviewer for public comment and before). Addressed common typo ("SPDi"). * Reordered the Forward Declarations section Moved the forward declarations section under the Forward section so it is less "in your face" confusing. * Corrected double loading of forward declarations Removed the early inclusion of the declarations file. --------- Co-authored-by: Mary Jungers --- asciidoc/sdpi-supplement-intro.adoc | 22 +++++--------- asciidoc/sdpi-supplement.adoc | 29 +++---------------- .../volume1/use-cases/tf1-ch-c-use-cases.adoc | 2 +- .../volume2/gateways/tf2-ch-b-gateway-v2.adoc | 2 +- .../tf3-ch-8.3.2.8-extension-gender.adoc | 2 +- 5 files changed, 15 insertions(+), 42 deletions(-) diff --git a/asciidoc/sdpi-supplement-intro.adoc b/asciidoc/sdpi-supplement-intro.adoc index 0c6c0ea..4d6920d 100644 --- a/asciidoc/sdpi-supplement-intro.adoc +++ b/asciidoc/sdpi-supplement-intro.adoc @@ -6,26 +6,20 @@ [%autowidth] [cols="1"] |=== -a| *SDPi 1.0 Supplement -- _Public Comment Review Version_ -- Note*: +a| *SDPi 1.0 Supplement -- _Trial Implementation Version_ -- Note*: -This release of the SDPi 1.0 supplement is intended for *IHE Public Comment review*, with a focus on both technical content as well editorial maturity (e.g., clarity, grammar, formatting, etc.). -It is recognized that there are both technical and editorial issues that need to be resolved before the Trial Implementation version is released. Known issues with this Public Comment version include: +This first release of the SDPi 1.0 Trial Implementation supplement represents a major multi-year milestone, enabling prototyping and testing of device-to-device plug-and-trust interoperability. +It is recognized, though, that this is an *initial* 1.0 release and in that sense is understandably incomplete with work continuing for 1.1 and subsequent versions. +These known limitations include: -. The content is scoped per the *_SDPi 1.0 version capabilities specification_* (see link:SDPi-Editorial-Planning-and-Versions#sdpi-version-10-detail-[wiki article "SDPi Version 1.0 (Detail)"]), though future capabilities may be included in a Reviewer Note; *_continued development of SDPi 1.x and beyond will begin early in 2023 DURING the 1.0 review periods_*; -. Supplement organization is *_based on the IHE Supplement Template from 2020 and 2022 (v10.6)_*; as a supplement to the IHE Devices technical framework, the section allocation and organization anticipates the IHE PCD 2019 (see <>) being updated into an IHE DEV 2022 version that also conforms to the updated IHE Techncial Feramework template(s); -. This supplement includes (4) SDPi profiles; however, the general IHE Supplement Template 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 for clarity; + +. The content is scoped per the *_SDPi 1.0 version capabilities specification_* (see https://github.com/IHE/DEV.SDPi/wiki/SDPi-Editorial-Planning-and-Versions#sdpi-version-10-detail-[wiki article "SDPi Version 1.0 (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 . *Open / Closed Issues tables* -- for SDPi 1.0 there is an initial approach that integrates with the Gemini SES+MDI program work flow (from Confluence issues to Github Issues to specification content); however, there is discussion around how to better improve this in future . *Requirements boxes* (e.g., "R1234") have been added especially in TF-2 and some in TF-3; this is an initial approach that *_will be significantly expanded in future versions of the supplement_*; an initial approach is provided in <>, 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 SDPi 1.x and subsequent 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; -. *FOR THE PUBLIC COMMENT* version of the supplement, the document source was migrated from the IHE sdpi-fhir Github to a new IHE DEV.SDPi profile-specific Github repository; links to the old repository may remain or may be updated to the new depending on the material being referenced (e.g., in open / closed issues). - -*"SDPi 1.0 Supplement Note"* boxes are provided throughout the document to help guide reviewers and to ask specific questions for feedback requested by the supplement editors. - -*REVIEWER FOCUS*: Please review the document especially with a technical and general organizational focus. -Does the information flow logically and sufficiently for adopters and implementers? -Is the text clear and sufficient or do specific subject areas need to be expanded or reworked. -Do the links work and lead to the right "best" destinations? +. *"SDPi 1.0 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 c31584e..faaa3ec 100644 --- a/asciidoc/sdpi-supplement.adoc +++ b/asciidoc/sdpi-supplement.adoc @@ -19,16 +19,10 @@ :ihe_supplement_sdpi_revision: 1.0.0 :ihe_supplement_sdpi_revision_date: {localdatetime} -:ihe_supplement_sdpi_revision_label: Draft for Public Comment -:ihe_supplement_sdpi_publication_month: February 28, 2023 +:ihe_supplement_sdpi_revision_label: Trial Implementation +:ihe_supplement_sdpi_publication_month: April 7, 2023 :ihe_supplement_sdpi_public_comment_submission_deadline: March 28, 2023 -//// - -#TODO: David G. says "use CSS style ober blank lines"# - -//// - {empty} + [subs=attributes] @@ -74,22 +68,13 @@ See https://profiles.ihe.net/DEV/[*HERE*] for Trial Implementation and Final Tex {empty} + -// Forward declarations of common labels & acronyms & variables -include::document-declarations.adoc[] - [#supplement_clause_foreword,sdpi_offset=clear] = Foreword -//// - -#PUB TODO: MARY - VERIFY THAT THIS IS THE RIGHT DESIGNATION FOR THE IHE Devices TF revision; should this be IHE PCD 2019 version 9? Or the forthcoming 2023 version? Should we reference the IHE PCD OR have more explanatory text or ... ???# +This is a supplement to the IHE Devices Technical Framework. Each supplement undergoes a process of public comment and trial implementation before being incorporated into the volumes of the Technical Frameworks. -//// - -This is a supplement to the IHE Devices Technical Framework Revision 10.0. Each supplement undergoes a process of public comment and trial implementation before being incorporated into the volumes of the Technical Frameworks. - -This supplement is published on {ihe_supplement_sdpi_publication_month} for Public Comment. Comments are invited and can be submitted at http://www.ihe.net/Public_Comment/#domainname. In order to be considered in development of the Trial Implementation version of the supplement, comments must be received by {ihe_supplement_sdpi_public_comment_submission_deadline}. +This supplement is published on {ihe_supplement_sdpi_publication_month} for Trial Implementation and may be available for testing at subsequent IHE Connectathons. The supplement may be amended based on the results of testing. Following successful testing it will be incorporated into the Devices Technical Framework. Comments are invited and can be submitted at https://www.ihe.net/DEV_Public_Comments/[Devices Public Comments] or by submitting a https://github.com/IHE/DEV.SDPi/issues/new/choose[GitHub Issue]. This supplement describes changes to the existing technical framework documents. @@ -110,12 +95,6 @@ Information about the organization of IHE Technical Frameworks and Supplements a The current version of the IHE Devices Technical Framework can be found at https://profiles.ihe.net/DEV/[DEV Technical Framework]. -//// - -#PUB TODO: MARY - This is where you insert the "Comments may be submitted on IHE ... templates ..." clause# - -//// - include::sdpi-supplement-intro.adoc[] include::sdpi-supplement-issues.adoc[] 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 e37002d..b1ff111 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 mostly informative and is still being detailed. Completion is deferred until the Public Comment version or version 1.x or later. +| *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. 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. diff --git a/asciidoc/volume2/gateways/tf2-ch-b-gateway-v2.adoc b/asciidoc/volume2/gateways/tf2-ch-b-gateway-v2.adoc index ae87360..d939557 100644 --- a/asciidoc/volume2/gateways/tf2-ch-b-gateway-v2.adoc +++ b/asciidoc/volume2/gateways/tf2-ch-b-gateway-v2.adoc @@ -5,7 +5,7 @@ [%autowidth] [cols="1"] |=== -a| *SDPi Supplement Version Note*: Complete mappings from <> to HL7 V2 are specified in the <> and <> sections below. This includes general SDC-to-HL7 V2 mappings that are common in both gateway specifications. This general V2 mapping section will be editorially updated with the content from these two gateway specifications before Public Comment Publication. +a| *SDPi Supplement Version Note*: Complete mappings from <> to HL7 V2 are specified in the <> and <> sections below. This includes general SDC-to-HL7 V2 mappings that are common in both gateway specifications. This general V2 mapping section will be editorially updated with the content from these two gateway specifications in a subsequent 1.x version of the supplement. |=== diff --git a/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.8-extension-gender.adoc b/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.8-extension-gender.adoc index 75ee577..5c10e63 100644 --- a/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.8-extension-gender.adoc +++ b/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.3.2.8-extension-gender.adoc @@ -6,7 +6,7 @@ [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. -The following sex & gender harmonization policy will be taken in this and future SPDi specification versions until clear direction is available. +The following sex & gender harmonization policy will be taken in this and future SDPi specification versions until clear direction is available. [none] . *STANDARDIZATION NOTE:* There is active work to finalize the informatics standards related to sex and gender, including within HL7, SNOMED, ISO/TC215 and in other standards development organizations.