#102 Rework directory structure, review of the contents, add glossary…

… terms.

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

@@ -34,6 +34,11 @@
 |
 .^| [[acronym_csf,CSF]] CSF
 
+.^| [[term_coded_attribute, Coded Attribute]] Coded Attribute
+| A BICEPS participant model extension that allows for a <<actor_somds_provider>> to provide attributes from the first partition of the IEEE 11073-10101 nomenclature. Specified in <<vol3_clause_coded_attribute>>.
+|
+.^|
+
 .^| [[term_integratec_clinical_environment,Integrated Clinical Environment (ICE)]] Integrated Clinical Environment
 | Environment that combines interoperable heterogeneous POINT-OF-CARE (PoC) MEDICAL DEVICEs and other equipment integrated to create a medical device system for the care of a single high acuity patient. (See ISO/IEEE 11073-20701 and AAMI 2700-1).
 |
@@ -105,6 +110,11 @@ implements a service-oriented #SDC# architecture composed of service providers a
 |
 .^| [[acronym_sfc,SFC]] SFC
 
+.^| [[term_q_name, QName]] QName
+| XML Schema QName. In this specification, QNames are encoded as `{<namespace>}<local-name>`.
+|
+.^|
+
 .^| ...
 | ...
 | ...
@@ -118,6 +128,5 @@ implements a service-oriented #SDC# architecture composed of service providers a
 [[property_somds_provider_uid]]SOMDS Provider UID:: A globally unique identifier for a <<actor_somds_provider>> that is stable across re-initializations.
 [[property_discovery_scope]]Discovery Scope:: A set of zero to many identifiers that allows for organizing <<actor_somds_provider>>s into logical groups.
 [[property_transport_address]] Transport Address:: A physical endpoint address that can be used to communicate with a <<actor_somds_provider>>.
-[[property_q_name]] QName:: XML Schema QName. In this specification, QNames are encoded as `{<namespace>}<local-name>`.
 
 

SDPi_Supplement/asciidoc/volume1/tf1-ch-b-ref-standards-conformance.adoc

@@ -36,6 +36,11 @@ NOTE: the following section was moved from the mothership document to here for i
 
 * [[[ws_transfer_2006, WS-Transfer:2006]]] Web Services Transfer (WS-Transfer), W3C Standard, 27 September 2006, available at https://www.w3.org/Submission/WS-Transfer/
 
+* [[[iso_iec_14977_1996, ISO/IEC 14977:1996]]] ISO/IEC 14977, Information technology - Syntactic
+metalanguage - Extended BNF, 15 December 1996, available at https://standards.iso.org/ittf/PubliclyAvailableStandards/s026153_ISO_IEC_14977_1996(E).zip
+
+* [[[rfc_3986, RFC 3986]]] T. Berners-Lee et al., RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, January 2005, available at https://www.rfc-editor.org/rfc/rfc3986
+
 // Appendix B.3
 === IEEE Implementation Conformance Statement (ICS) Table Overview
 

SDPi_Supplement/asciidoc/volume2/dev-25/tf2-ch-a-mdpws-dev-25.adoc

@@ -51,7 +51,7 @@ include::../../listings/vol2-clause-appendix-a-mdpws-dev-25-transfer-response.xm
 
 `s12:Envelope/s12:Body/wsm:Metadata/wsm:MetadataSection/dpws:Relationship/dpws:Hosted/dpws:Types`:: Designates available <<payload_dev_25_get_metadata_biceps_services>> by providing a list of service types that contains at least one or more of the BICEPS services as mapped in <<vol2_table_appendix_mdpws_dev_25_hosted_types>>.
 
-.Filter mapping of BICEPS services to <<property_q_name>>s.
+.Filter mapping of BICEPS services to <<term_q_name>>s.
 [#vol2_table_appendix_mdpws_dev_25_hosted_types, cols="1,2"]
 |===
 |BICEPS service |Web Service XML Schema QName

SDPi_Supplement/asciidoc/volume2/discovery-scopes/tf2-ch-a-mdpws-discovery-scopes.adoc

@@ -0,0 +1,114 @@
+:var_uri_percent_unreserved: https://www.rfc-editor.org/rfc/rfc3986#section-2.3
+:var_uri_percent_encoding: https://www.rfc-editor.org/rfc/rfc3986#section-2.1
+
+==== Discovery Scopes
+
+<<ieee_11073_20701_2018>> specifies requirements as to encode certain <<acronym_mdib>> data as WS-Discovery Scopes provided by <<actor_somds_provider>>s. This clause further details encoding rules for production specifications and attributes as laid out in the IEEE 11073-10101 nomenclature.
+
+===== Encoding of Production Specifications
+
+.R0009
+[sdpi_requirement#r0009,sdpi_req_level=may]
+****
+If a manufacturer of a <<actor_somds_provider>> intends to include MDS production specifications in the WS-Discovery Scopes of the <<actor_somds_provider>>, the <<actor_somds_provider>> shall encode the production specifications by using the rules in <<vol2_listing_encoding_production_specification_mds>>.
+
+.Notes
+[%collapsible]
+====
+NOTE: The URI encoding of production specifications is defined by the Extended Backus-Naur Form <<iso_iec_14977_1996>> in <<vol2_listing_encoding_production_specification>>.
+
+NOTE: Manufacturers can also encode metadata information as production specification, according to the mapping in <<vol3_table_production_specifications_mapping>>.
+====
+
+.Examples
+[%collapsible]
+====
+URIs of a manufacturer name and serial number:
+
+- `sdc.mds.prodspec:MediHealth:531970`
+- `sdc.mds.prodspec:DE12345678:531972,urn%3Aoid%3A1.3.111.2.11073.10101.3`
+====
+****
+
+.Encoding rules for production specifications
+[source#vol2_listing_encoding_production_specification]
+----
+Char ::= unreserved | pct-encoded
+CharSequenceNz ::= Char { Char }
+CodingSystem ::= CharSequenceNz
+CodingSystemVersion ::= CharSequenceNz
+Code ::= CharSequenceNz
+CodedValue ::= Code [ ',' CodingSystem [ ',' CodingSystemVersion ] ]
+Root ::= CharSequenceNz
+Extension ::= CharSequenceNz
+InstanceIdentifier ::= Root [ ',' Extension ]
+ProductionSpec ::= { Char }
+SpecType ::= CodedValue
+ComponentId ::= InstanceIdentifier
+ProductionSpecification ::= ProductionSpec ':' SpecType [ ':' ComponentId ]
+----
+
+[NOTE]
+====
+- `unreserved` is specified in <<rfc_3986>>, {var_uri_percent_unreserved}[2.3. Unreserved Characters]
+- `pct-encoded` is specified in <<rfc_3986>>, {var_uri_percent_encoding}[2.1. Percent-Encoding]
+====
+
+.Encoding rules for MDS production specifications
+[source#vol2_listing_encoding_production_specification_mds]
+----
+Scheme ::= 'sdc.mds.prodspec'
+MdsProductionSpecification ::= Scheme ':' ProductionSpecification
+----
+
+NOTE: `ProductionSpecification` is specified in <<vol2_listing_encoding_production_specification>>.
+
+===== Encoding of Attributes
+
+.R0010
+[sdpi_requirement#r0010,sdpi_req_level=may]
+****
+If a manufacturer of a <<actor_somds_provider>> intends to include MDS attributes in the WS-Discovery Scopes of the <<actor_somds_provider>>, the <<actor_somds_provider>> shall encode the attributes by using the rules in <<vol2_listing_encoding_attribute_mds>>.
+
+.Notes
+[%collapsible]
+====
+NOTE: The URI encoding of attributes is defined by the Extended Backus-Naur Form <<iso_iec_14977_1996>> in <<vol2_listing_encoding_attribute>>.
+====
+
+.Examples
+[%collapsible]
+====
+URI of a Soft ID: `sdc.mds.attr:PatMon03:67886`
+====
+****
+
+.Encoding rules for attributes
+[source#vol2_listing_encoding_attribute]
+----
+Char ::= unreserved | pct-encoded
+CharSequenceNz ::= Char { Char }
+CodingSystem ::= CharSequenceNz
+CodingSystemVersion ::= CharSequenceNz
+Code ::= CharSequenceNz
+CodedValue ::= Code [ ',' CodingSystem [ ',' CodingSystemVersion ] ]
+AttributeValue ::= { Char }
+AttributeCode ::= CodedValue
+Attribute ::=  AttributeValue ':'  AttributeCode
+----
+
+[NOTE]
+====
+- `unreserved` is specified in <<rfc_3986>>, {var_uri_percent_unreserved}[2.3. Unreserved Characters]
+- `pct-encoded` is specified in <<rfc_3986>>, {var_uri_percent_encoding}[2.1. Percent-Encoding]
+====
+
+.Encoding rules for MDS attribute specifications
+[source#vol2_listing_encoding_attribute_mds]
+----
+Scheme ::= 'sdc.mds.attr'
+MdsAttribute ::= Scheme ':' Attribute
+----
+
+NOTE: `Attribute` is specified in <<vol2_listing_encoding_attribute>>.
+

SDPi_Supplement/asciidoc/volume2/tf2-ch-a-mdpws.adoc

@@ -49,4 +49,6 @@ include::dev-30/tf2-ch-a-mdpws-dev-30.adoc[]
 
 === Amendments and Corrigenda
 
-include::connect-time-algorithm/tf2-ch-a-mdpws-connect-time-algorithm.adoc[]
+include::connect-time-algorithm/tf2-ch-a-mdpws-connect-time-algorithm.adoc[]
+
+include::discovery-scopes/tf2-ch-a-mdpws-discovery-scopes.adoc[]

SDPi_Supplement/asciidoc/volume2/tf2-main.adoc

@@ -129,6 +129,7 @@ include::dev-30/tf2-dev-30.adoc[]
 //*_See the Word document for what this is supposed to look like_*.
 
 include::tf2-ch-a-mdpws.adoc[]
+
 include::tf2-ch-b-gateways.adoc[]
 
 

SDPi_Supplement/asciidoc/volume3/biceps-content-module/tf3-ch-8.2.2-applicable-attribute-type-codes.adoc

@@ -5,7 +5,7 @@
 .R0009
 [sdpi_requirement#r0009,sdpi_req_level=shall]
 ****
-If available by the manufacturer of a <<actor_somds_provider>>, the <<actor_somds_provider>> shall include every attribute listed in <<vol3_table_attributes>> its MDS descriptors.
+If available by the manufacturer of a <<actor_somds_provider>>, the <<actor_somds_provider>> shall include every attribute listed in <<vol3_table_attributes>> in its MDS descriptors.
 
 .Notes
 [%collapsible]
@@ -14,7 +14,7 @@ NOTE: Other attributes may be used for types that are not listed in <<vol3_table
 ====
 ****
 
-.Attributes to be provided by a <<actor_somds_provider>> in MDS descriptors if available
+.Attribute provisions by <<actor_somds_provider>>s in MDS descriptors
 [#vol3_table_attributes,cols="2,3,1,1"]
 |===
 |RefId |Description| IEEE 11073-10101 <Partition>::<Code>| Context-free Code

SDPi_Supplement/asciidoc/volume3/biceps-content-module/tf3-ch-8.2.2-applicable-productions-specification-type-codes.adoc

@@ -5,18 +5,18 @@
 .R0008
 [sdpi_requirement#r0008,sdpi_req_level=shall]
 ****
-If available by the manufacturer of a <<actor_somds_provider>>, the <<actor_somds_provider>> shall include every production specification listed in <<vol3_table_production_specifications>> in its MDSs, unless a BICEPS Participant Model mapping exists.
+If available by the manufacturer of a <<actor_somds_provider>>, the <<actor_somds_provider>> shall include every production specification listed in <<vol3_table_production_specifications>> in its MDSs, unless a mapping to the BICEPS participant model exists.
 
 .Notes
 [%collapsible]
 ====
-NOTE: <<vol3_table_production_specifications_mapping>> shows the mapping to the BICEPS Participant Model. A dash in the column _{var_column_pm_mapping}_ signifies a non-existent mapping.
+NOTE: <<vol3_table_production_specifications_mapping>> shows the mapping between IEEE 11073-10101 RefIds and the BICEPS Participant Model. A dash in the column _{var_column_pm_mapping}_ signifies a non-existent mapping.
 
 NOTE: Other production specifications may be used for types that are not listed in <<vol3_table_production_specifications>>.
 ====
 ****
 
-.Production specifications to be provided by a <<actor_somds_provider>> if available
+.Production specification provisions by <<actor_somds_provider>>s
 [#vol3_table_production_specifications,cols="2,3,1,1"]
 |===
 |RefId |Description| IEEE 11073-10101 <Partition>::<Code>| Context-free Code
@@ -74,7 +74,7 @@ NOTE: Other production specifications may be used for types that are not listed
 
 |===
 
-.Production specifications mappings to the BICEPS Participant Model
+.Production specification mappings to the BICEPS Participant Model
 [#vol3_table_production_specifications_mapping,cols="1,2"]
 |===
 |RefId |{var_column_pm_mapping}

SDPi_Supplement/asciidoc/volume3/biceps-extension-provisions/tf2-ch-a-xml-schemas-coded-attribute.adoc

@@ -0,0 +1,6 @@
+=== Coded Attribute XML Schema
+
+[source,xml]
+----
+include::../../../sources/extension-models/coded-attribute/CodedAttribute.xsd[]
+----

SDPi_Supplement/asciidoc/volume3/biceps-extension-provisions/tf3-ch-8.2.2-extension-coded-attribute.adoc

@@ -1,6 +1,7 @@
+[#vol3_clause_coded_attribute]
 ====== Coded Attribute
 
-BICEPS does not provide means to generically add attributes from the first partition of the IEEE 11073-10101 nomenclature to the MDIB.
+BICEPS does not provide means to generically add attributes from the first partition of the IEEE 11073-10101 nomenclature to the <<acronym_mdib>>.
 This becomes challenging if there are attributes required by <<actor_somds_provider>>s to provide information that is not covered by the BICEPS participant model.
 
 For example, BICEPS only supports the following MDS meta information below the `pm:Mds/pm:MetaData` element:
@@ -16,7 +17,7 @@ For example, BICEPS only supports the following MDS meta information below the `
 Some statically configured meta information like firmware versions or software versions can be added by means of production specification elements.
 However, attributes like equipment labels do not exist and cannot be conveyed by using production specifications.
 
-This profile specifies the _Coded Attribute_ extension that allows for a <<actor_somds_provider>> to provide attributes from the first partition of the IEEE 11073-10101 nomenclature for which there is no information item specified in the BICEPS participant model.
+This profile specifies the <<term_coded_attribute>> extension that allows for a <<actor_somds_provider>> to provide attributes from the first partition of the IEEE 11073-10101 nomenclature for which there is no information item specified in the BICEPS participant model.
 
 [sdpi_level=+1]
 ====== Model

SDPi_Supplement/asciidoc/volume3/tf3-ch-a-xml-schemas.adoc

@@ -0,0 +1,4 @@
+[appendix#vol3_appendix_a_xml_schemas,sdpi_offset=A]
+== BICEPS Extension Provisions XML Schemas
+
+include::biceps-extension-provisions/tf2-ch-a-xml-schemas-coded-attribute.adoc[]

SDPi_Supplement/asciidoc/volume3/tf3-main.adoc

@@ -31,10 +31,4 @@ include::tf3-ch-8.3.3-physiologic-monitor.adoc[]
 
 include::tf3-ch-8.3.4-surgical.adoc[]
 
-[appendix#vol3_xml_schema_coded_attribute,sdpi_offset=A]
-== CodedAttribute XML Schema
-
-[source,xml]
-----
-include::../../sources/extension-models/coded-attribute/CodedAttribute.xsd[]
-----
+include::tf3-ch-a-xml-schemas.adoc[]