Skip to content

Commit 72eb665

Browse files
ToddCooperToddCooper
committed
Supplement - First TF1 content with references
First pass at moving structural content from the standard to the supplement/ space.
1 parent 76d032e commit 72eb665

6 files changed

Lines changed: 242 additions & 7 deletions

‎asciidoc/sdpi-standard.adoc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,10 +125,10 @@ The complete detailed content will remain in the sdpi-standard document as it ha
125125
Editorial Task List (prioritized) for this Supplement:
126126

127127
. Title Page - Update & review
128-
. Find and update all uses of "supplement" throughout current document
129-
.. In labels used for referencing
130-
.. In standard note sections
131-
.. ... ?
128+
. [.line-through]#Find and update all uses of "supplement" throughout current document#
129+
.. [.line-through]#In labels used for referencing#
130+
.. [.line-through]#In standard note sections#
131+
.. [.line-through]#... ?#
132132
. Add front matter not IHE TF based, but for a standalone document:
133133
.. Introduction: Gemini, Gemini TF Profile Standard, SDPi in particular;
134134
... Include Unique Features of TF Profile Standard (incl. embedded requirements, ... )

‎asciidoc/sdpi-supplement.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ include::sdpi-supplement-intro.adoc[]
172172
//
173173
// = Volume 1 -- Profiles
174174
//
175-
//include::volume1/tf1-main.adoc[]
175+
include::supplement/sdpi-supplement-tf1.adoc[]
176176

177177
// Appendix A
178178
////

‎asciidoc/supplement/sdpi-supplement-document-declarations.adoc‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
2+
////
3+
FORWARD DECLARATIONS FOR THE DOCUMENT
4+
5+
NOTES:
6+
1) The items defined below are forward declarations to define labels for the entire document
7+
2) VARIABLES are used not because the content may vary (such as transaction #'s) but
8+
3) They can get expanded anywhere including in section headings
9+
10+
////
11+
12+
[#supplement_clause_forward_declarations,sdpi_offset=clear]
13+
== Standard Forward Declarations
14+
15+
[%noheader]
16+
[%autowidth]
17+
[cols="1"]
18+
|===
19+
a| *{standard_note}*:
20+
21+
*Standalone SDPi:* _REWORK this section to make it a permanent Forward Declarations, perhaps refactoring it into something that is not labeled "Forward Declarations"!_
22+
23+
The following table is included in this version of the standard 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.
24+
"Forward" means that they are used BEFORE the document section in which they are formally defined.
25+
Since AsciiDoc is a one-pass processor, forward declarations are required.
26+
27+
There was no clear way of defining these replacement definitions in a way that is "under the hood" and not visible to the reader.
28+
The following table was thus created but may be moved or otherwise implemented in subsequent standard versions.
29+
30+
Suggestions appreciated!
31+
32+
NOTE: Forward Declarations in the following table are being added "on demand" or when needed and not comprehensively for every acronym defined in the document that is not also included in the Glossary.
33+
34+
|===
35+
36+
37+
[%autowidth]
38+
[cols="^1,^2,1,^2"]
39+
|===
40+
|Acronym |Label |Section Defined In | Type
41+
42+
| [[supplement_acronym_aars,AARS]] AARS
43+
| [[supplement_label_use_case_name_aars,Alerts to Alert Recording Systems]] Alerts to Alert Recording Systems
44+
| <<supplement_vol1_clause_appendix_c_use_case_aars>>
45+
| Use Case
46+
47+
| [[supplement_acronym_acns,ACNS]] ACNS
48+
| [[supplement_label_use_case_name_acns,Alerts to Clinician Notification Systems]] Alerts to Clinician Notification Systems
49+
| <<supplement_vol1_clause_appendix_c_use_case_acns>>
50+
| Use Case
51+
52+
| [[supplement_acronym_agw,AGW]] AGW
53+
| [[supplement_label_system_type_name_agw,Alert Gateway]] Alert Gateway
54+
| <<supplement_vol3_clause_system_type_nomenclature_extensions>>
55+
| System Type
56+
57+
| [[supplement_acronym_cs,CS]] CS
58+
| [[supplement_label_system_type_name_cs,Central Station]] Central Station
59+
| <<supplement_vol3_clause_system_type_nomenclature_extensions>>
60+
| System Type
61+
62+
| [[supplement_acronym_dgw,DGW]] DGW
63+
| [[supplement_label_system_type_name_dgw,Data Gateway]] Data Gateway
64+
| <<supplement_vol3_clause_system_type_nomenclature_extensions>>
65+
| System Type
66+
67+
| [[supplement_acronym_ddes,DDES]] DDES
68+
| [[supplement_label_use_case_name_ddes,Device Data to Enterprise Systems]] Device Data to Enterprise Systems
69+
| <<supplement_vol1_clause_appendix_c_use_case_ddes>>
70+
| Use Case
71+
72+
| [[supplement_acronym_mdpws,MDPWS]] MDPWS
73+
| [[supplement_label_use_case_name_mdpws,Medical Devices Communication Profile for Web Services]] Medical Devices Communication Profile for Web Services
74+
| <<supplement_ref_ieee_11073_20702_2016>>
75+
| Standard
76+
77+
| [[supplement_acronym_sas,SAS]] SAS
78+
| [[supplement_label_system_type_name_sas,Smart Alerting System]] Smart Alerting System
79+
| <<supplement_vol3_clause_system_type_nomenclature_extensions>>
80+
| System Type
81+
82+
| [[supplement_acronym_sicdmp,SICDmp]] SICDmp
83+
| [[supplement_label_use_case_name_sicdmp,Standalone ICU Dashboard Multiple Patient]] Standalone ICU Dashboard Multiple Patient
84+
| <<supplement_vol1_clause_appendix_c_use_case_sicdmp>>
85+
| Use Case
86+
87+
| [[supplement_acronym_sicdsp,SICDsp]] SICDsp
88+
| [[supplement_label_use_case_name_sicdsp,Standalone ICU Dashboard Single Patient]] Standalone ICU Dashboard Single Patient
89+
| <<supplement_vol1_clause_appendix_c_use_case_sicdsp>>
90+
| Use Case
91+
92+
| [[supplement_acronym_stad,STAD]] STAD
93+
| [[supplement_label_use_case_name_stad,Synchronized Time Across Devices]] Synchronized Time Across Devices
94+
| <<supplement_vol1_clause_appendix_c_use_case_stad>>
95+
| Use Case
96+
97+
|===

‎asciidoc/supplement/sdpi-supplement-intro.adoc‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,11 @@ These known limitations and forward-looking content include:
3939
|===
4040

4141
// Forward declarations of common labels & acronyms & variables
42-
include::document-declarations.adoc[]
42+
include::sdpi-supplement-document-declarations.adoc[]
4343

4444
// Define oids for referenced standards
45-
include::std-oid-definitions.adoc[]
45+
// #Standalone TO DO - Do we need to include OID definitions in this document?#
46+
// include::std-oid-definitions.adoc[]
4647

4748
[#supplement_clause_sdpi_supplement_overview]
4849
== SDPi Supplement Overview

‎asciidoc/supplement/sdpi-supplement-std-oid-definitions.adoc‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
////
2+
Define oids for standards referenced in requirements.
3+
////
4+
5+
// The SDPI profile described in this documentation
6+
:sdpi_oid.sdpi: 1.3.6.1.4.1.19376.1.6.2.10.1.1.1
7+
8+
// The SDPi plug-and-trust profile described in this documentation
9+
:sdpi_oid.sdpi-p: 1.3.6.1.4.1.19376.1.6.2.11
10+
11+
// The SDPi alerting profile described in this documentation
12+
:sdpi_oid.sdpi-a: 1.3.6.1.4.1.19376.1.6.2.x
13+
14+
// The SDPi reporting profile described in this documentation
15+
:sdpi_oid.sdpi-r: 1.3.6.1.4.1.19376.1.6.2.x
16+
17+
// The SDPi external control profile described in this documentation
18+
:sdpi_oid.sdpi-xC: 1.3.6.1.4.1.19376.1.6.2.x
19+

‎asciidoc/supplement/sdpi-supplement-tf1.adoc‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
[#vol1_clause_profiles, supplement_sdpi_volume_caption=1]
2+
= Volume 1 -- Profiles
3+
4+
// == Profiles
5+
6+
// TF-1:2 Devices Integration Profiles
7+
8+
[#supplement_vol1_clause_devices_integration_profiles,sdpi_offset=2]
9+
== Devices Integration Profiles
10+
11+
// 2.2
12+
[#suupplement_vol1_clause_ses_considerations_requirements,sdpi_offset=2]
13+
=== Safety, Effectiveness and Security - Requirements and Considerations
14+
15+
// 2.3
16+
[#suupplement_vol1_clause_integration_profiles_overview]
17+
=== Integration Profiles Overview
18+
19+
20+
[#suupplement_vol1_clause_sdpi_integration_profiles_overview]
21+
==== Service-oriented Device Point-of-care Interoperability (SDPi)
22+
23+
24+
[#suupplement_vol1_clause_sdpi_scope]
25+
===== SDPi Profiles – Scope of Application
26+
27+
28+
[#supplement_vol1_clause_sdpi_overview_framework]
29+
===== SDPi Profiles – Overview & Framework
30+
31+
// Standalone TO DO - Do we have to specialize the "footnote:[...]" as well?
32+
33+
// TF-1:10 SDPi Plug-and-Trust Profile
34+
35+
[#supplement_vol1_clause_sdpi_p_profile,sdpi_offset=10,role=profile,profile-id=sdpi-p,reftext="Plug-and-trust Profile",oid-arcs=.11]
36+
== Service-oriented Device Point-of-care Interoperability – Plug-and-trust (SDPi-P) Profile
37+
[#supplement_vol1_clause_sdpi_p_profile_reftext,reftext="SDPi-P Profile"]
38+
39+
The SDPi-Plug-and-trust ([[supplement_acronym_sdpi_p,SDPi-P]] SDPi-P) Profile supports foundational seamless connectivity, information exchange and service invocation as defined in the SDPi architecture detailed in <<supplement_vol1_clause_sdpi_overview_framework>>.
40+
Whereas the related SDPi Profiles for reporting, alerting and external control are explicitly intended to support medical care capabilities, the SDPi-P Profile focuses on basic healthcare device interoperability.
41+
All the capabilities defined in SDPi-P are leveraged by and extended in the medically focused profiles.
42+
This foundational profile not only supports medical device interoperability ("<<supplement_acronym_mdi>>"), providing for “plug-and-play” capabilities, but also with a tightly integrated “trust” framework (see <<supplement_vol1_appendix_a_requirements_management_for_p_n_t_interperability>>).
43+
The establishment of a trusted ecosystem of medical and non-medical devices and applications footnote:[Note that SDPi-P supports application interoperability including “Software as a Medical Device” (<<acronym_samd>>).] begins at the start of discovery and a secure connection. Therefore, the profile's name: <<supplement_term_plug_and_trust>>.
44+
45+
_This_ is primarily an IHE transport profile footnote:[See the IHE Technical Frameworks General Introduction for a more detailed description of IHE profile types, published at https://profiles.ihe.net/GeneralIntro/[profiles.ihe.net/GeneralIntro/].], although it does define several content modules detailed in IHE Devices TF-3.
46+
It supports the transactions and information exchanged in accordance to a Service-Oriented Architecture (SOA) specialized for high-acuity points of care (e.g., operating table or ICU bed), defined as a <<supplement_term_service_oriented_medical_device_system>>.
47+
All the SDPi-P actors are therefore scoped with “<<supplement_acronym_somds>>” to clearly identify their application context and scope.
48+
49+
Although all information exchanged between SDPi-P <<supplement_acronym_somds>> participating systems and applications must conform to the basic <<supplement_acronym_sdc>>/<<supplement_acronym_biceps>> content module requirements footnote:[See <<vol3_clause_sdc_biceps_semantic_content_module>>. ], content modules have been defined for common high-acuity medical devices such as infusion pumps, ventilators and physiologic monitors.
50+
51+
Note that future IHE _workflow profiles_ may be defined that build upon the transport and content module foundation established by the SDPi-P profile.
52+
For example, Operating Room / Surgery Point-of-Care Integration, ICU Point-of-Care Integration, or more service-focused profiles such as Point-of-Care Identity Management (PCIM) for device-patient association management, or Silent ICU / Quiet Hospital, where the acute point-of-care is integrated with enterprise systems around device alerting and alert distribution to provide an improved environment of care (reduced noise level and improved safety) and clinician interaction.
53+
54+
55+
56+
// TF-1:11 SDPi - Reporting Profile
57+
58+
[#supplement_vol1_clause_sdpi_r_profile,sdpi_offset=11,role=profile,profile-id=sdpi-r,reftext="Reporting Profile",oid-arcs=.12]
59+
== Service-oriented Device Point-of-care Interoperability – Reporting (SDPi-R) Profile
60+
61+
62+
// TF-1:12 SDPi - Alerting Profile
63+
64+
[#supplement_vol1_clause_sdpi_a_profile,sdpi_offset=12,role=profile,profile-id=sdpi-a,reftext="Alerting Profile",oid-arcs=.13]
65+
== Service-oriented Device Point-of-care Interoperability – Alerting (SDPi-A) Profile
66+
67+
68+
// TF-1:13 SDPi - External Control Profile
69+
70+
[#supplement_vol1_clause_sdpi_xc_profile,sdpi_offset=13,role=profile,profile-id=sdpi-xc,reftext="External Control Profile",oid-arcs=.14]
71+
== Service-oriented Device Point-of-care Interoperability – external Control (SDPi-xC) Profile
72+
73+
// TF-1:A Appendix A
74+
[appendix#supplement_vol1_appendix_a_requirements_management_for_p_n_t_interperability,sdpi_offset=A]
75+
== Requirements Management for Plug-and-Trust Interoperability
76+
77+
78+
// TF-1:B Appendix B
79+
[appendix#supplement_vol1_appendix_b_references,sdpi_offset=B]
80+
== References
81+
82+
83+
// TF-1:C Appendix C
84+
85+
[appendix#supplement_vol1_appendix_c_dpi_use_cases,sdpi_offset=C]
86+
== Device Point-of-care Interoperability (DPI) Use Cases
87+
88+
:var_use_case_id: 1
89+
[#supplement_vol1_clause_appendix_c_use_case_stad,sdpi_offset=2]
90+
[role=use-case,use-case-id=stad,sdpi_feature="Synchronized Time Across Devices",oid-arcs=".1"]
91+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_stad>> (<<supplement_acronym_stad>>)
92+
93+
:var_use_case_id: 2
94+
[#supplement_vol1_clause_appendix_c_use_case_sicdsp,sdpi_offset=3]
95+
[role=use-case,use-case-id=sicdsp,sdpi_feature="Single Patient Standalone ICU Dashboard",oid-arcs=".2"]
96+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_sicdsp>> (<<supplement_acronym_sicdsp>>)
97+
98+
:var_use_case_id: 3
99+
[#vsupplement_ol1_clause_appendix_c_use_case_sicdmp,sdpi_offset=4]
100+
[role=use-case,use-case-id=sicdmp,sdpi_feature="Multiple Patient Standalone ICU Dashboard",oid-arcs=".3"]
101+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_sicdmp>> (<<supplement_acronym_sicdmp>>)
102+
103+
:var_use_case_id: 4
104+
[#supplement_vol1_clause_appendix_c_use_case_ddes,sdpi_offset=5]
105+
[role=use-case,use-case-id=ddes,sdpi_feature="Device Data to Enterprise Systems",oid-arcs=".4"]
106+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_ddes>> (<<supplement_acronym_ddes>>)
107+
108+
:var_use_case_id: 5
109+
[#supplement_vol1_clause_appendix_c_use_case_acns,sdpi_offset=6]
110+
[role=use-case,use-case-id=acns,sdpi_feature="Alerts to Clinician Notification Systems",oid-arcs=".5"]
111+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_acns>> (<<supplement_acronym_acns>>)
112+
113+
:var_use_case_id: 6
114+
[#supplement_vol1_clause_appendix_c_use_case_aars,sdpi_offset=7]
115+
[role=use-case,use-case-id=aars,sdpi_feature="Alerts to Alert Recording Systems",oid-arcs=".6"]
116+
=== Use Case Feature {var_use_case_id}: <<supplement_label_use_case_name_aars>> (<<supplement_acronym_aars>>)
117+
118+

0 commit comments

Comments
 (0)