Merge pull request #77 from HL7/ACOM-GHS-support

Updated suppression reasons & examples in consumer page

Author: ErikMoll

FHIR-phd.xml

@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<specification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ballotUrl="http://hl7.org/fhir/uv/phd/2025Sep" ciUrl="http://build.fhir.org/ig/HL7/phd" defaultVersion="2.0.0-ballot2" defaultWorkgroup="dev" gitUrl="https://github.com/HL7/PHD" url="http://hl7.org/fhir/uv/phd">
+<specification xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ballotUrl="http://hl7.org/fhir/uv/phd/2025Sep" ciUrl="http://build.fhir.org/ig/HL7/phd" defaultVersion="1.1.0" defaultWorkgroup="dev" gitUrl="https://github.com/HL7/PHD" url="http://hl7.org/fhir/uv/phd">
 <version code="current" url="http://build.fhir.org/ig/HL7/phd"/>
 <version code="2.0.0-ballot2" url="http://hl7.org/fhir/uv/phd/2025Sep"/>
-<version code="2.0.0-ballot" deprecated="true" url="http://hl7.org/fhir/uv/phd/2024Sep"/>
 <version code="1.1.0" url="http://hl7.org/fhir/uv/phd/STU1.1"/>
+<version code="2.0.0-ballot" deprecated="true" url="http://hl7.org/fhir/uv/phd/2024Sep"/>
 <version code="1.0.0" deprecated="true" url="http://hl7.org/fhir/uv/phd/STU1"/>
 <version code="0.3.0" deprecated="true" url="http://hl7.org/fhir/uv/phd/2019May"/>
 <version code="0.2.0" deprecated="true" url="http://hl7.org/fhir/uv/phd/2019Jan"/>

input/ignoreWarnings.txt

@@ -11,26 +11,26 @@ The property 'partition' is not known for the system 'urn:iso:std:iso:11073:1010
 # These code systems are PHD specific
 Most code systems defined in HL7 IGs will need to move to THO later during the process. Consider giving this code system a THO URL now (See https://confluence.hl7.org/display/TSMG/Terminology+Play+Book, and/or talk to TSMG)
 
-# When a vital signs observation is also checked against the vital signs profile these warnings are generated. These are no real problems.
+# When a vital signs observation is also checked against the vital signs profile these warnings are generated. The vitals sign category element does not match the slice for the `phd` category. These are no real problems.
 This element does not match any known slice defined in the profile http://hl7.org/fhir/StructureDefinition/bp|4.0.1 (this may not be a problem, but you should check that it's not intended to match a slice)
 This element does not match any known slice defined in the profile http://hl7.org/fhir/StructureDefinition/oxygensat|4.0.1 (this may not be a problem, but you should check that it's not intended to match a slice)
 This element does not match any known slice defined in the profile http://hl7.org/fhir/StructureDefinition/heartrate|4.0.1 (this may not be a problem, but you should check that it's not intended to match a slice)
 This element does not match any known slice defined in the profile http://hl7.org/fhir/StructureDefinition/bodytemp|4.0.1 (this may not be a problem, but you should check that it's not intended to match a slice)
 
-# When a Phd compound observation is also a vital sign this warning is generated, but this is not a real problem.
+# When a Phd compound observation is also a vital sign this warning is generated. The LOINC coding does not match the slice for the MDC coding. This is not a real problem.
 This element does not match any known slice Defined in the profile http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCompoundNumericObservation|2.0.0-ballot2 (this may not be a problem, but you should check that it's not intended to match a slice)
 This element does not match any known slice defined in the profile http://hl7.org/fhir/uv/phd/StructureDefinition/PhdCompoundObservation|2.0.0-ballot2 (this may not be a problem, but you should check that it's not intended to match a slice)
 
 # This warning is generated when different categories are required in resources that comply with different profiles like vitals-signs and phd:
 None of the codings provided are in the value set 'Observation Category Codes' (http://hl7.org/fhir/ValueSet/observation-category|4.0.1), and a coding is recommended to come from this value set (codes = http://hl7.org/fhir/uv/phd/CodeSystem/PhdObservationCategories#phd)
 
-# With FHIR R4 there is no supported way to indicate the valueset for a property
+# Will be resolved after the ballot.
 The type of property 'code' is 'code', but no ValueSet information was found, so the codes will be validated as internal codes
 
-# This is generated for all observations that use the vital signs category. This warning can be ignored safely.
+# This is generated for all observations that use the vital signs category. The vitals sign category element does not match the slice for the `phd` category. This warning can be ignored safely.
 This element does not match any known slice defined in the profile http://hl7.org/fhir/uv/phd/StructureDefinition/PhdNumericObservation|2.0.0-ballot2 (this may not be a problem, but you should check that it's not intended to match a slice)
 
-# This informational message is out of our control.
+# This informational message is due to inheriting this extension from the core specification.
 The extension http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet|5.2.0 is deprecated
 
 # This warning is generated on purpose in two examples that use a private code on purpose. This warning can hence safely be ignored.

input/pagecontent/ProfileConsumers.md

@@ -419,30 +419,18 @@ The `property.type` is a CodeableConcept which tells what the property is. There
 ##### Time Synchronization
 There will always be a time synchronization entry. It is identified by a `property.type.coding.code="68220"`. It indicates the method the PHD uses to externally synchronize to a time reference. The value is a single valueCode entry. MDC codes express the possible synchronization methods. A table of the possible codes can be found in the time synchronization section [here](StructureDefinition-PhdDevice.html). This value is TIME_SYNC_NONE (532224) if the PHD does not support a synchronization protocol or has no time clock at all.
 
-An example of time synchronization property entry is shown below:
-{% fragment Device/phd-74E8FFFEFF051C00.001C05FFE874 JSON EXCEPT:property[4] %}
-
-
 ##### Time Capabilities
 The time capabilities defines the types of real time clocks supported, whether the time can be set, whether external time synchronization is possible, etc. Each capability is treated as an event, so most PHGs will only report the capability if the PHD indicates it has the capability. The value is a single valueCode which will be either "Y" if the PHD has the capability or "N" if not. Most PHGs will not report the "N" case as that would significantly increase the size of the resource on the wire.  There may be several such time capability property entries.
 
 The time capabilities property is indicated by the `property.type.code` having one of the ASN1ToHL7 codes of "68219.x" which is NOT a decimal number! The value is a valueCode with codes "Y" or "N".
 
-The example below gives the time capabilities of a market pulse oximeter:
-
-{% fragment Device/phd-74E8FFFEFF051C00.001C05FFE874 JSON ELIDE:property[5]|property[6]|property[7] %}
-
 #### Time Clock Resolutions
 The time clock resolutions is given by one of four MDC codes for each of the possible types of time clocks. Note that a PHD can only simultaneously support an absolute time (wall clock time with no offset) or base offset time (wall clock time with offset). A PHD may support both relative time clocks thus there could be up to three separate time resolution property entries though in most cases there is only one clock.
 
 The resolution value is a valueQuantity and it gives the time interval between clock 'pulses', regardless of the type of time clock, in units of microseconds.
 
 The property is indicated by the `property.type.code` having one of four MDC codes "68222, 68223, 68224, and 68226". The value is a valueQuantity.
 
-An example of a time resolution property for a relative time clock with a time resolution of of one second is shown below:
-{% fragment Device/phd-74E8FFFEFF051C00.001C05FFE874 JSON EXCEPT:property[8] %}
-
-
 #### Time Tick Resolution for R-R Intervals
 This section is only relevant for PHDs that support the Heart Rate or ECG specializations based on IEEE 11073-20601. It is not used for measurement timestamps but for measuring R-R intervals (time between electrocardiogram R-wave peaks) in ECG and Heart Rate specializations. The time tick resolution is a high frequency clock that is used to measure the time between R-wave peaks in an ECG trace.
 The number of ticks is reported in the `valueQuantity.value` element in Observations, not the effective[x] which is the time the measurement is taken. These special clocks typically have a resolution of 1024 Hz or better. When R-R intervals are reported, they are reported in units of these ticks, so one must know what the frequency of the clock is. The reason for this special clock is that R-R intervals have been traditionally timed using dedicated crystal oscillators.
@@ -454,16 +442,14 @@ The Regulation status is a set of states where only one state is defined. Regula
 
 The property is indicated by the `property.type.code` having the ASN1ToHL7 code "532354.x" where the only currently defined entry is x=0. The value is a valueCode which can have a value "Y" or "N". The twist here is that the state has been defined in the negative. ***Thus a code value of "N" means regulated.***  Note that since this is a state, the PHG is required to report both the "Y" and "N" values *if* the PHD reports a regulation status.
 
-An example of a regulated device is given [here](Device-phd-74E8FFFEFF051C00.001C05FFE874.html).
-
 #### Continua Certified PHD Interfaces
 This property contains a code that indicates a specialization and transport the PHD has been (self-)certified for. Note there is a difference between 'support' and 'certified' support. The Device specialization entries indicate what the PHD supports. Certified means the PHD has been (independently) placed through a set of extensive tests for the specialization and the transport over which the specialization operates. In the past, the Continua organization certified PHDs for compliance to its guidelines that referenced this IG.
 
 The property is indicated by the `property.type.code` having the MDC code "532353". The value is a code from the [ValueSet for PHD Interfaces](ValueSet-ContinuaPHDInterfaces.html) code system.
 
-An example of a property entry where a PHD is certified for the pulse oximeter specialization over both Bluetooth Low Energy, USB, and Continua version 1.0 where there was no transport indicated, is given below:
-
-{% fragment Device/phd-74E8FFFEFF051C00.001C05FFE874 JSON ELIDE:property[0] %}
+#### Example of a PHD Device Resource properties
+The fragment below shows the set of properties of an example PHD. Note that the time synchronization protocol is "none" and the time resolution is "relative" with a resolution of 1 second. The PHD is regulated and has certified interfaces.
+{% fragment Device/phd-74E8FFFEFF051C00.001C05FFE874 JSON EXCEPT:property %}
 
 ### The PHG Device Resource
 The PHG Device Resource, can, in theory have all the same entries as in the PHD Device Resource plus one additional property that gives the list of certified Health and Fitness interfaces (to downstream servers). A PHG can be certified for both proper operation with PHD specializations as well as proper operation with downstream servers. One of those 'Health and Fitness' interfaces is the upload to RESTFul FHIR servers. Some PHGs also support uploads of the data as PCD-01 and some support questionnaires.
@@ -479,7 +465,7 @@ This field states that the device is a PHG. This IG uses the MDC code MDC_MOC_VM
 
 #### Continua Certified Health and Fitness Interfaces
 
-The PHG can report the list of its certified Health and Fitness interfaces as a list of properties. Each of these properties report a code that indicates a Health and Fitness interface the PHG has been (self-)certified for. 
+In addition to the certified PHD interfaces the PHG can report its certified Health and Fitness interfaces as a list of properties. Each of these properties reports a code that indicates a Health and Fitness interface the PHG has been (self-)certified for.
 
 The property is indicated by the `property.type.code` having the MDC code "532355". The  `valueCode` comes from the [ContinuaHFS](CodeSystem-ContinuaHFS.html) code system.
 
@@ -498,7 +484,5 @@ The `identifier.value` and `identifier.system` entries are used to quantify the
 
 Note that a medical record number is considered PHI in some jurisdictions and use cases. Even when the medical record number is not in itself PHI, the fact that the PHG's communication will convey both the MRN and health data could put the whole communication into the realm of PHI.
 
-An example of a `Patient.identifier` following the XDS.b notation is given below:
-{% fragment Patient/patientExample-1 JSON EXCEPT:identifier %}
-
-An example of an unknown patient using the `identifier.type` "U" is given [here](Patient-patientExample-2.html)
+An example of a `Patient.identifier` following the XDS.b notation is given [here](Patient-patientExample-1.html).
+An example of an unknown patient using the `identifier.type` "U" is given [here](Patient-patientExample-2.html).