Unverified Commit f215c6af authored by Maxime Lefrançois's avatar Maxime Lefrançois
Browse files

doc generated from pipeline

parent 8719ccdf
Loading
Loading
Loading
Loading
Loading
+2 −0
Original line number Diff line number Diff line
@@ -7,3 +7,5 @@ saref-pipeline.jar
.DS_Store
target
catalog-v001.xml

documentation/ts_*
+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ SAREF4EHAW extension has been specified and formalized by investigating EHAW dom
SAREF4EHAW mainly reuses the following existing ontologies: SAREF (see ETSI TS 103 264 [1]), SmartBAN (see ETSI TS 103 378 [2]), SAREF4ENVI (see ETSI TS 103 410-2 [3]) and SSN (see [i.1]). SAREF4EHAW modular ontology will be fully specified and formalized in clause 4.2 of the present document. Figure 1 presents the high level view of the envisioned model of SAREF4EHAW ontology. In Figure 1, classes directly imported from SAREF ontology are in yellow, classes directly imported from SAREF4ENVI ontology are in pink and finally classes specifically developed for SAREF4EHAW are in blue.


<figure id="Figure_1">
<figure>
        <img data-docx-width="20.49cm" src="diagrams/SAREF4EHAW_Model.jpg" alt="High level view of the envisioned semantic model for SAREF4EHAW ontology"/>
        <figcaption>Figure 1: High level view of the envisioned semantic model for SAREF4EHAW ontology</figcaption>
    </figure>
+18 −18
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ As already introduced in clause 4.1 of the present document SAREF4EHAW is an OWL
A detailed view of SAREF4EHAW HealthActor module is depicted in Figure 2.


<figure id="Figure_2">
<figure>
        <img data-docx-width="25.14cm" src="diagrams/S4EHAW-HealthActor.jpg" alt="Detailed view of SAREF4EHAW HealthActor module"/>
        <figcaption>Figure 2: Detailed view of SAREF4EHAW HealthActor module</figcaption>
    </figure>
@@ -41,7 +41,7 @@ Caregiver, Patient, User, Helper and ResponsibleParty are all sub-classes of Hea
The object properties defined for SAREF4EHAW HealthActor module are described in Table 2. The data properties defined for SAREF4EHAW HealthActor module are described in Table 3.


<table id="Table_2" data-docx-preferred-width="4.69cm 3.50cm 4.00cm 5.19cm">
<table data-docx-preferred-width="4.69cm 3.50cm 4.00cm 5.19cm">
  <caption>Table 2: List of object properties of SAREF4EHAW HealthActor module</caption>
  <tr>
    <th>Object property</th>
@@ -114,7 +114,7 @@ The object properties defined for SAREF4EHAW HealthActor module are described in



<table id="Table_3" data-docx-preferred-width="3.94cm 4.25cm 3.00cm 6.25cm">
<table data-docx-preferred-width="3.94cm 4.25cm 3.00cm 6.25cm">
  <caption>Table 3: List of data properties of SAREF4EHAW HealthActor module</caption>
  <tr>
    <th>Data Property</th>
@@ -180,8 +180,8 @@ The object properties defined for SAREF4EHAW HealthActor module are described in
A detailed view of SAREF4EHAW Ban module is depicted in Figure 3.


<figure id="Figure_3">
        <img data-docx-width="24.12cm" src="diagrams/S4EHAW-Ban.jpg" alt="Detailed view of SAREF4EHAW Ban module"/>
<figure>
        <img data-docx-width="24.12cm" data-docx-crop-t="-0.07767"  data-docx-crop-b="1e-05" src="diagrams/S4EHAW-Ban.jpg" alt="Detailed view of SAREF4EHAW Ban module"/>
        <figcaption>Figure 3: Detailed view of SAREF4EHAW Ban module</figcaption>
    </figure>

@@ -201,7 +201,7 @@ As shown in Figure 3, a BAN has:
The object properties defined for SAREF4EHAW Ban module are described in Table 4. The data properties defined for SAREF4EHAW Ban module are described in Table 5.


<table id="Table_4" data-docx-preferred-width="4.69cm 2.25cm 5.25cm 5.19cm">
<table data-docx-preferred-width="4.69cm 2.25cm 5.25cm 5.19cm">
  <caption>Table 4: List of object properties of SAREF4EHAW Ban module</caption>
  <tr>
    <th>Object property</th>
@@ -250,7 +250,7 @@ The object properties defined for SAREF4EHAW Ban module are described in Table 4



<table id="Table_5" data-docx-preferred-width="3.44cm 5.05cm 2.45cm 6.50cm">
<table data-docx-preferred-width="3.44cm 5.05cm 2.45cm 6.50cm">
  <caption>Table 5: List of data properties of SAREF4EHAW Ban module</caption>
  <tr>
    <th>Data Property</th>
@@ -304,7 +304,7 @@ The object properties defined for SAREF4EHAW Ban module are described in Table 4
A detailed view of SAREF4EHAW HealthDevice module is depicted in Figure 4.


<figure id="Figure_4">
<figure>
        <img data-docx-width="22.42cm" src="diagrams/S4EHAW-HealthDevice.jpg" alt="Detailed view of SAREF4EHAW HealthDevice module"/>
        <figcaption>Figure 4: Detailed view of SAREF4EHAW HealthDevice module</figcaption>
    </figure>
@@ -335,7 +335,7 @@ Finally and for reducing duplication with SAREF documentation, the reader is ref
The object properties defined for SAREF4EHAW HealthDevice module are described in Table 6. The data properties defined for SAREF4EHAW HealthDevice module are described in Table 7.


<table id="Table_6" data-docx-preferred-width="3.99cm 3.49cm 3.98cm 5.94cm">
<table data-docx-preferred-width="3.99cm 3.49cm 3.98cm 5.94cm">
  <caption>Table 6: List of object properties of SAREF4EHAW HealthDevice module</caption>
  <tr>
    <th>Object property</th>
@@ -414,7 +414,7 @@ The object properties defined for SAREF4EHAW HealthDevice module are described i



<table id="Table_7" data-docx-preferred-width="4.69cm 4.25cm 2.25cm 6.25cm">
<table data-docx-preferred-width="4.69cm 4.25cm 2.25cm 6.25cm">
  <caption>Table 7: List of data properties of SAREF4EHAW HealthDevice module</caption>
  <tr>
    <th>Data Property</th>
@@ -566,7 +566,7 @@ A functional device is a sub-class of SAREF _Device_ class (_rdfs:subClassOf rel
A detailed view of SAREF4EHAW Function module is depicted in Figure 5.


<figure id="Figure_5">
<figure>
        <img data-docx-width="17.82cm" src="diagrams/S4EHAW-Function.jpg" alt="Detailed view of SAREF4EHAW Function module"/>
        <figcaption>Figure 5: Detailed view of SAREF4EHAW Function module</figcaption>
    </figure>
@@ -581,7 +581,7 @@ As shown in Figure 5, a function has:
* Data, that has both data constraints (such as validity or legal constraints) and measurement (single or time series measurements) that are measured in a given unit of measure, as depicted in Figure 5 (_DataConstraint, Measurement_ and _TimeSeriesMeasurement classes_).
* The _TimeSeriesMeasurement_ is inspired on existing classes from other standards in the health domain (listed in Table 8). This class represents a sequence of data in a successive equally spaced points in time (i.e. with a fixed frequency) measured by a health device, e.g. ECG time series data measured by an ECG device during a recording session. 

<table id="Table_8" data-docx-preferred-width="4.74cm 4.25cm 8.12cm">
<table data-docx-preferred-width="4.74cm 4.25cm 8.12cm">
  <caption>Table 8: Classes representing Time Series from other data models</caption>
  <tr>
    <th>Class</th>
@@ -632,7 +632,7 @@ Finally and for reducing duplication with both SAREF and SAREF4ENVI documentatio
The object properties defined for SAREF4EHAW Function module are described in Table 9. The data properties defined for SAREF4EHAW Function module are described in Table 10.


<table id="Table_9" data-docx-preferred-width="4.69cm 3.75cm 4.00cm 4.94cm">
<table data-docx-preferred-width="4.69cm 3.75cm 4.00cm 4.94cm">
  <caption>Table 9: List of object properties of SAREF4EHAW Function module</caption>
  <tr>
    <th>Object property</th>
@@ -700,7 +700,7 @@ The object properties defined for SAREF4EHAW Function module are described in Ta



<table id="Table_10" data-docx-preferred-width="3.94cm 4.25cm 3.25cm 6.00cm">
<table data-docx-preferred-width="3.94cm 4.25cm 3.25cm 6.00cm">
  <caption>Table 10: List of data properties of SAREF4EHAW Function module</caption>
  <tr>
    <th>Data Property</th>
@@ -772,8 +772,8 @@ The object properties defined for SAREF4EHAW Function module are described in Ta
A detailed view of SAREF4EHAW Service module is depicted in Figure 6.


<figure id="Figure_6">
        <img data-docx-width="22.28cm" src="diagrams/S4EHAW-Service.jpg" alt="Detailed view of SAREF4EHAW Service module"/>
<figure>
        <img data-docx-width="22.28cm" data-docx-crop-t="-0.04593"  data-docx-crop-b="1e-05" src="diagrams/S4EHAW-Service.jpg" alt="Detailed view of SAREF4EHAW Service module"/>
        <figcaption>Figure 6: Detailed view of SAREF4EHAW Service module</figcaption>
    </figure>

@@ -796,7 +796,7 @@ Finally and for reducing duplication with SAREF documentation, the reader is ref
The object properties defined for SAREF4EHAW Service module are described in Table 11. The data properties defined for SAREF4EHAW Service module are described in Table 12.


<table id="Table_11" data-docx-preferred-width="4.19cm 3.00cm 5.25cm 4.94cm">
<table data-docx-preferred-width="4.19cm 3.00cm 5.25cm 4.94cm">
  <caption>Table 11: List of object properties of SAREF4EHAW Service module</caption>
  <tr>
    <th>Object property</th>
@@ -833,7 +833,7 @@ The object properties defined for SAREF4EHAW Service module are described in Tab



<table id="Table_12" data-docx-preferred-width="3.94cm 3.75cm 3.25cm 6.50cm">
<table data-docx-preferred-width="3.94cm 3.75cm 3.25cm 6.50cm">
  <caption>Table 12: List of data properties of SAREF4EHAW Function module</caption>
  <tr>
    <th>Data Property</th>
+13 −13
Original line number Diff line number Diff line
@@ -13,7 +13,7 @@ This use case is about a patient of around 50 years old, Bob, with overeating ha
* SpireStone and ScanWatch wearables, as well as TUCKY thermometer, are health devices (`s4ehaw:HealthDevice`) that are attached to Bob (`s4ehaw:isAttachedTo` property).
* Finally Bob monitoring BAN has Bob has contact (`s4ehaw:hasContact` property).

<figure id="Figure_7">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image8.jpeg" alt="Patient Bob individuals"/>
        <figcaption>Figure 7: Patient Bob individuals</figcaption>
    </figure>
@@ -24,7 +24,7 @@ Figure 8 depicts the SpireStone wearable device (a `s4ehaw:HealthDevice`) of Bob



<figure id="Figure_8">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image9.jpeg" alt="BobSpireStone HealthDevice individuals"/>
        <figcaption>Figure 8: BobSpireStone HealthDevice individuals</figcaption>
    </figure>
@@ -38,7 +38,7 @@ Each of `BobSpireHealth` sensors has a certain function (`saref:hasFunction` pro



<figure id="Figure_9">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image10.jpeg" alt="Respiration function individuals"/>
        <figcaption>Figure 9: Respiration function individuals</figcaption>
    </figure>
@@ -50,7 +50,7 @@ Figure 9 shows that `Respiration` measurement function has data (`s4ehaw:hasData
Figure 10 depicts the ScanWatch wearable device (a `s4ehaw:HealthDevice`) of Bob (a `s4ehaw:Patient`), as described using SAREF4EHAW extension.


<figure id="Figure_10">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image11.jpeg" alt="Bob's Scan Watch individuals"/>
        <figcaption>Figure 10: Bob's Scan Watch individuals</figcaption>
    </figure>
@@ -62,7 +62,7 @@ As depicted in Figure 10, Bob is using the Withings_ScanWatch wearable (a `s4eha
Figure 11 describes the `Oxymeter` measurement function (a `s4ehaw:MeasurementFunction`): it has data (`s4ehaw:hasData` property), a SPO2 level (a `s4ehaw:Data`).


<figure id="Figure_11">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image12.jpeg" alt="Oxymeter Function individuals"/>
        <figcaption>Figure 11: Oxymeter Function individuals</figcaption>
    </figure>
@@ -71,7 +71,7 @@ Figure 11 describes the `Oxymeter` measurement function (a `s4ehaw:MeasurementFu
Figure 12 shows the `SystolicPressureSens` measurement function which has data (`s4ehaw:hasData` property) the `SystolicPressure` (a `s4ehaw:Data`). It is measured in ( a `s4ehaw:unitOfMeasure`) mmHG.


<figure id="Figure_12">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image13.jpeg" alt="Systolic Pressure function Individuals"/>
        <figcaption>Figure 12: Systolic Pressure function Individuals</figcaption>
    </figure>
@@ -80,7 +80,7 @@ Figure 12 shows the `SystolicPressureSens` measurement function which has data (
Figure 13 describes the third device which is the TUCKY Thermometer (a `s4ehaw:HealthDevice`) of Bob (a `s4ehaw:Patient`) called `BobBodyThermo`. It is a sensor patch that is ideally placed (`s4ehaw:hasLocation` property) on the body surface under the armpit (`ArmpitLocation,` a `s4ehaw:BodySurfaceLocation`) and which function is to measure accurately the body temperature in degree Celsius.


<figure id="Figure_13">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image14.jpeg" alt="Bob's Thermometer Health device individuals"/>
        <figcaption>Figure 13: Bob's Thermometer Health device individuals</figcaption>
    </figure>
@@ -89,7 +89,7 @@ Figure 13 describes the third device which is the TUCKY Thermometer (a `s4ehaw:H
Figure 14 describes the `BodyThermometer` measurement function (a `s4ehaw:MeasurementFunction`).


<figure id="Figure_14">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image15.jpeg" alt="Body's temperature function individuals"/>
        <figcaption>Figure 14: Body's temperature function individuals</figcaption>
    </figure>
@@ -101,7 +101,7 @@ As depicted in Figure 14, the `BodyThermometer` measurement function has data (`
Figure 15 describes `BobMonitorBan`, the BAN (a `s4ehaw:Ban`) that Bob (a `s4ehaw:Patient`) uses (`s4ehaw:usesBan` property) for vital parameters monitoring purposes.` 


<figure id="Figure_15">
<figure>
        <img data-docx-width="17.00cm" src="diagrams/image16.jpeg" alt="Bob's BAN individuals"/>
        <figcaption>Figure 15: Bob's BAN individuals</figcaption>
    </figure>
@@ -147,8 +147,8 @@ An `ECG Device` registers the `Heart Electrical Activity` through electrodes att
Figure 16 illustrates the composition of the ECG device (a `s4heaw:HealthWearable`) of this example. The ECG device ECG_unit_T9JRN42 is an `s4ehaw:HealthDevice` and an `s4ehaw:HealthWearable` that is composed of 4 leads (`ECGLead_I_`, `ECGLead_II_`, `ECGLead_III_` and `ECGLead_Vx_RL`) and three accelerometer sensors (X, Y and Z). The acceleration data can be used by the EWS to detect collisions (e.g. car accidents) and correlate with the ECG data for detecting heart damages. The ECG device plays the role of a recorder in the complex event (action) of a `s4ehaw:MeasurementCollectionSession` (the ECG recording session `s4ehawInst:RecordingECGSession_01`). In SAREF, this complex action can be classified as a `saref:Task` that an ECG device `saref:accomplishes`. The `s4ehaw:hasParticipant` (same meaning as in UFO-B [i.2]) relationship between the ECG Recording Session and the person under ECG monitoring is represented through the `s4ehaw:hasActivity`.


<figure id="Figure_16">
        <img data-docx-width="15.44cm" src="diagrams/image17.png" alt="Composition of ECG device with a recording measurement session"/>
<figure>
        <img data-docx-width="15.44cm" data-docx-crop-l="0.22349"  data-docx-crop-r="0.14413"  data-docx-crop-t="0.23027"  data-docx-crop-b="0.0677" src="diagrams/image17.png" alt="Composition of ECG device with a recording measurement session"/>
        <figcaption>Figure 16: Composition of ECG device with a recording measurement session</figcaption>
    </figure>

@@ -170,8 +170,8 @@ The term `s4ehaw:TimeSeriesMeasurement` refers to a time series of a sequence of
The `saref:hasValue` property limits the value domain of a `Measurement` to exactly one number. The `s4ehaw:hasValues` property was added to overcome this issue, in which a `s4ehaw:TimeSeriesMeasurements` can instantiate this property multiple times as an ordered (depending on the serialization format) array of numbers. The size of this array should reflect the frequency of the time series measurement and, if not, it shows a possible issue on missing measurements in the Bluetooth communication between the ECG device and the mobile application. 


<figure id="Figure_17">
        <img data-docx-width="15.62cm" src="diagrams/image18.png" alt="An ECG time series measurement "/>
<figure>
        <img data-docx-width="15.62cm" data-docx-crop-l="0.23186"  data-docx-crop-r="0.10244"  data-docx-crop-t="0.26792"  data-docx-crop-b="0.12319" src="diagrams/image18.png" alt="An ECG time series measurement "/>
        <figcaption>Figure 17: An ECG time series measurement </figcaption>
    </figure>

+14 −12
Original line number Diff line number Diff line
### Normative references
# References

## Normative references

* <a id="[0]">[0]</a> [ETSI TS 103 410-8 (V1.1.1)](https://www.etsi.org/deliver/etsi_ts/103400_103499/10341008/01.01.01_60/ts_10341008v010101p.pdf): "SmartM2M;; Extension to SAREF; Part 8: eHealth/Ageing-well Domain".
* <a id="[1]">[1]</a>	ETSI TS 103 264 (V3.1.1) (2020-02): "SmartM2M; Smart Applications; Reference Ontology and oneM2M Mapping".
@@ -7,55 +9,55 @@
* <a id="[4]">[4]</a>	ETSI TS 103 410-9 (V1.1.1) (2020-07): "SmartM2M; Extension to SAREF; Part 9: Wearables Domain".


### Informative references
## Informative references

* <a id="[i.1]">[i.1]</a>	W3C SSN documentation.

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://www.w3.org/2005/Incubator/ssn/ssnx/ssn](https://www.w3.org/2005/Incubator/ssn/ssnx/ssn).

* <a id="[i.2]">[i.2]</a>	B. Gonçalves, G. Guizzardi, J. G.Pereira Filho: "Using an ECG reference ontology for semantic interoperability of ECG data", Journal of Biomedical Informatics, vol. 44, issue 1, pp. 126-136, February 2011.
* <a id="[i.3]">[i.3]</a>	HL7 FHIR<sup>®</sup>: "Fast Healthcare Interoperability Resources".

!!! alert-info "NOTE 1:"
!!! alert alert-info "NOTE 1:"
    Available at [http://www.hl7.org/](http://www.hl7.org/).


!!! alert-info "NOTE 2:"
!!! alert alert-info "NOTE 2:"
    FHIR<sup>®</sup> is an example of an existing eHealth standard. This information is given for the convenience of users of the present document and does not constitute an endorsement by ETSI of this standard.

* <a id="[i.4]">[i.4]</a>	S. Cox: "Observations and measurements-xml implementation" OGC document, 2011 (also published as ISO/DIS 19156).

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://www.ogc.org/standards/om](https://www.ogc.org/standards/om).

* <a id="[i.5]">[i.5]</a>	HL7 annotated ECG (aECG) R1 and R2 (US realm).

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://www.hl7.org/implement/standards/product_brief.cfm?product_id=102](https://www.hl7.org/implement/standards/product_brief.cfm?product_id=102).

* <a id="[i.6]">[i.6]</a>	Digital Imaging and Communications in Medicine (DICOM<sup>®</sup>) international standard.

!!! alert-info "NOTE 1:"
!!! alert alert-info "NOTE 1:"
    Available at [https://www.dicomstandard.org/](https://www.dicomstandard.org/).


!!! alert-info "NOTE 2:"
!!! alert alert-info "NOTE 2:"
    DICOM<sup>®</sup> is an example of an existing eHealth standard. This information is given for the convenience of users of the present document and does not constitute an endorsement by ETSI of this standard.

* <a id="[i.7]">[i.7]</a>	ETSI TR 103 509 (V1.1.1) (2019-10): "SmartM2M; SAREF extension investigation; Requirements for eHealth/Ageing-well".
* <a id="[i.8]">[i.8]</a>	IETF RFC 6068: "The 'mailto' URI Scheme".

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://tools.ietf.org/html/rfc6068](https://tools.ietf.org/html/rfc6068).

* <a id="[i.9]">[i.9]</a>	ISO 6709: "Standard representation of geographic point location by coordinates".

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://www.iso.org/fr/standard/39242.html](https://www.iso.org/fr/standard/39242.html).

* <a id="[i.10]">[i.10]</a>	IEEE**™** 802.15.6: "IEEE Standard for Local and metropolitan area networks - Part 15.6: Wireless Body Area Networks".

!!! alert-info "NOTE:"
!!! alert alert-info "NOTE:"
    Available at [https://standards.ieee.org/standard/802_15_6-2012.html](https://standards.ieee.org/standard/802_15_6-2012.html).