update known issues, added pattern HealhProfessionalReference

Nictiz · Nov 5, 2024 · ba1df31 · ba1df31
1 parent 94f2805
commit ba1df31
Show file tree

Hide file tree

Showing 6 changed files with 117 additions and 14 deletions.
diff --git a/known-issues.yml b/known-issues.yml
@@ -4,9 +4,31 @@
 
 issues should occur: true
 
+pattern-NlCoreHealthProfessionalReference:
+  ignored issues:
+    StructureDefinition:
+      - message: "Constraint failed: sd-pg-08: 'The title of the StructureDefinition should conform to the profiling guidelines'"
+        reason: The title is shown in the hosting profiles as the name of the datatype. "zib HealthProfessional Reference" is more descriptive than the title according to the profiling guidelines ("pattern NlCoreHealthProfessionalReference").
+
+pattern-ZibHealthProfessionalReference:
+  ignored issues:
+    StructureDefinition:
+      - message: "Constraint failed: sd-pg-08: 'The title of the StructureDefinition should conform to the profiling guidelines'"
+        reason: The title is shown in the hosting profiles as the name of the datatype. "zib HealthProfessional Reference" is more descriptive than the title according to the profiling guidelines ("pattern ZibHealthProfessionalReference").
+
+
 ---
 # The following issues are not "real" deviations stemming from design choices, but rather problems that pop up due to
 # shortcomings in tooling, the used terminology server, etc.
 # These might occur in one or more profiles, or in none if they have been fixed in the meantime. 
 
 issues should occur: false
+
+zib-Encounter:
+  ignored issues:
+    Encounter.participant:healthProfessional.individual:
+      - message: "Constraint failed: sd-zpg-03: 'References to other resource profiles should be added next to the HL7 base references, unless they are added on a slice."
+        reason: The restriction is set on a slice, but this cannot be automatically checked.
+    Encounter.participant:responsibleHealthProfessional.individual:
+      - message: "Constraint failed: sd-zpg-03: 'References to other resource profiles should be added next to the HL7 base references, unless they are added on a slice."
+        reason: The restriction is set on a slice, but this cannot be automatically checked.
diff --git a/nl-core/StructureDefinitions/nl-core-Encounter.xml b/nl-core/StructureDefinitions/nl-core-Encounter.xml
@@ -62,6 +62,21 @@
         <targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
       </type>
     </element>
+    <element id="Encounter.participant:responsibleHealthProfessional">
+      <path value="Encounter.participant" />
+      <sliceName value="responsibleHealthProfessional" />
+    </element>
+    <element id="Encounter.participant:responsibleHealthProfessional.individual">
+      <path value="Encounter.participant.individual" />
+      <short value="Persons involved in the encounter other than the patient" />
+      <definition value="Persons involved in the encounter other than the patient." />
+      <comment value="References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository." />
+      <type>
+        <code value="Reference" />
+        <profile value="http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference" />
+        <targetProfile value="http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole" />
+      </type>
+    </element>
     <element id="Encounter.reasonReference:problem">
       <path value="Encounter.reasonReference" />
       <sliceName value="problem" />

diff --git a/nl-core/StructureDefinitions/pattern-NlCoreHealthProfessionalReference.xml b/nl-core/StructureDefinitions/pattern-NlCoreHealthProfessionalReference.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<StructureDefinition xmlns="http://hl7.org/fhir">
+  <id value="pattern-NlCoreHealthProfessionalReference" />
+  <text>
+    <status value="empty" /><div xmlns="http://www.w3.org/1999/xhtml">No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.</div></text>
+  <url value="http://nictiz.nl/fhir/StructureDefinition/pattern-NlCoreHealthProfessionalReference" />
+  <name value="PatternNlCoreHealthProfessionalReference" />
+  <title value="Reference" />
+  <status value="draft" />
+  <publisher value="Nictiz" />
+  <contact>
+    <name value="Nictiz" />
+    <telecom>
+      <system value="url" />
+      <value value="https://www.nictiz.nl" />
+      <use value="work" />
+    </telecom>
+  </contact>
+  <description value="A Reference datatype profile for referring [zib HealthProfessional](https://zibs.nl/wiki/HealthProfessional-v4.0(2024EN)) from other zib profiles. This datatype profile is used in various resource profiles and is never instantiated directly." />
+  <purpose value="This profile provides guidance to implementers on how to refer instances of this zib. Profilers should use this datatype profile for all references to zib HealthProfessional (`type.profile`). In addition, profile &lt;http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-PractitionerRole&gt; should be constrained to &lt;http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole&gt; in the list of `type.targetProfile`'s. The original list of `type.targetProfile`'s should not be restricted.&#xD;&#xA;&#xD;&#xA;The `.title` of this profile is simply 'Reference' instead of 'nl core HealthProfessional Reference', as is expected following the profiling guidelines. This deviation from the guidelines is the result of the `.title` being used to render the profile in various tooling (mainly Simplifier), and the latter title would result in a rendering that is deemed confusing in some cases (see [MM-3854](https://bits.nictiz.nl/browse/MM-3854))." />
+  <copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
+  <fhirVersion value="4.0.1" />
+  <kind value="complex-type" />
+  <abstract value="false" />
+  <type value="Reference" />
+  <baseDefinition value="http://nictiz.nl/fhir/StructureDefinition/pattern-ZibHealthProfessionalReference" />
+  <derivation value="constraint" />
+  <differential>
+    <element id="Reference">
+      <path value="Reference" />
+      <comment value="Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [nl-core-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [nl-core-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/nl-core-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.&#xD;&#xA;&#xD;&#xA;In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the nl-core-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
+    </element>
+  </differential>
+</StructureDefinition>
diff --git a/zib/StructureDefinitions/ext-Encounter.CommentEncounterReason.xml b/zib/StructureDefinitions/ext-Encounter.CommentEncounterReason.xml
@@ -5,7 +5,7 @@
     <status value="empty" /><div xmlns="http://www.w3.org/1999/xhtml">No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.</div></text>
   <url value="http://nictiz.nl/fhir/StructureDefinition/ext-Encounter.CommentEncounterReason" />
   <name value="ExtEncounterCommentEncounterReason" />
-  <title value="ext Encounter.Comment" />
+  <title value="ext Encounter.CommentEncounterReason" />
   <status value="draft" />
   <publisher value="Nictiz" />
   <contact>

diff --git a/zib/StructureDefinitions/pattern-ZibHealthProfessionalReference.xml b/zib/StructureDefinitions/pattern-ZibHealthProfessionalReference.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<StructureDefinition xmlns="http://hl7.org/fhir">
+  <id value="pattern-ZibHealthProfessionalReference" />
+  <text>
+    <status value="empty" /><div xmlns="http://www.w3.org/1999/xhtml">No narrative is provided for definitional resources. A human-readable rendering can be found in the implementation guide(s) where this resource is used.</div></text>
+  <url value="http://nictiz.nl/fhir/StructureDefinition/pattern-ZibHealthProfessionalReference" />
+  <name value="PatternZibHealthProfessionalReference" />
+  <title value="Reference" />
+  <status value="draft" />
+  <publisher value="Nictiz" />
+  <contact>
+    <name value="Nictiz" />
+    <telecom>
+      <system value="url" />
+      <value value="https://www.nictiz.nl" />
+      <use value="work" />
+    </telecom>
+  </contact>
+  <description value="A Reference datatype profile for referring [zib HealthProfessional](https://zibs.nl/wiki/HealthProfessional-v4.0(2024EN)) from other zib profiles. This datatype profile is used in various resource profiles and is never instantiated directly." />
+  <purpose value="This profile provides guidance to implementers on how to refer instances of this zib. Profilers should use this datatype profile for all references to zib HealthProfessional (`type.profile`). In addition, profile &lt;http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-PractitionerRole&gt; should be added to the list of `type.targetProfile`'s. The original list of `type.targetProfile`'s should not be restricted.&#xD;&#xA;&#xD;&#xA;The `.title` of this profile is simply 'Reference' instead of 'zib HealthProfessional Reference', as is expected following the profiling guidelines. This deviation from the guidelines is the result of the `.title` being used to render the profile in various tooling (mainly Simplifier), and the latter title would result in a rendering that is deemed confusing in some cases (see [MM-3854](https://bits.nictiz.nl/browse/MM-3854))." />
+  <copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
+  <fhirVersion value="4.0.1" />
+  <kind value="complex-type" />
+  <abstract value="false" />
+  <type value="Reference" />
+  <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Reference" />
+  <derivation value="constraint" />
+  <differential>
+    <element id="Reference">
+      <path value="Reference" />
+      <comment value="Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [zib-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [zib-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.&#xD;&#xA;&#xD;&#xA;In rare circumstances, there is only a Practitioner instance, in which case it is that instance which will be referenced here. However, since this should be the exception, the zib-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
+    </element>
+  </differential>
+</StructureDefinition>
diff --git a/zib/StructureDefinitions/zib-Encounter.xml b/zib/StructureDefinitions/zib-Encounter.xml
@@ -58,12 +58,7 @@
       <mapping>
         <identity value="zib-encounter-v6.0-2024EN" />
         <map value="NL-CM:15.1.3" />
-        <comment value="StartDateTime (implicit, main mapping is on `Encounter.period`)" />
-      </mapping>
-      <mapping>
-        <identity value="zib-encounter-v6.0-2024EN" />
-        <map value="NL-CM:15.1.4" />
-        <comment value="EndDateTime (implicit, main mapping is on `Encounter.period`)" />
+        <comment value="DateTime (implicit, main mapping is on `Encounter.period`)" />
       </mapping>
     </element>
     <element id="Encounter.class">
@@ -156,14 +151,7 @@
     <element id="Encounter.participant:responsibleHealthProfessional">
       <path value="Encounter.participant" />
       <sliceName value="responsibleHealthProfessional" />
-      <short value="ResponsableHealthProfessional" />
-      <alias value="VerantwoordelijkBehandelaar" />
       <max value="1" />
-      <mapping>
-        <identity value="zib-encounter-v6.0-2024EN" />
-        <map value="NL-CM:15.1.18" />
-        <comment value="ResponsableHealthProfessional" />
-      </mapping>
     </element>
     <element id="Encounter.participant:responsibleHealthProfessional.type">
       <path value="Encounter.participant.type" />
@@ -186,16 +174,26 @@
     </element>
     <element id="Encounter.participant:responsibleHealthProfessional.individual">
       <path value="Encounter.participant.individual" />
+      <short value="ResponsableHealthProfessional" />
+      <definition value="The health professional who is responsible at the time of the encounter for the treatment of the patient's stated health problem." />
+      <comment value="Each occurrence of the zib HealthProfessional is normally represented by _two_ FHIR resources: a PractitionerRole resource (instance of [zib-HealthProfessional-PractitionerRole](http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-PractitionerRole)) and a Practitioner resource (instance of [zib-HealthProfessional-Practitioner](http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-Practitioner)). The Practitioner resource is referenced from the PractitionerRole instance. For this reason, sending systems should fill the reference to the PractitionerRole instance here, and not the Practitioner resource. Receiving systems can then retrieve the reference to the Practitioner resource from that PractitionerRole instance.&#xD;&#xA;&#xD;&#xA;In rare circumstances, there is only a Practitioner instance, in which case it is that instance which can be referenced on the `Encounter.participant` element (due to open slicing). Since this should be the exception, the zib-HealthProfessional-Practitioner profile is not explicitly mentioned as a target profile." />
+      <alias value="VerantwoordelijkBehandelaar" />
       <type>
         <code value="Reference" />
         <profile value="http://nictiz.nl/fhir/StructureDefinition/pattern-ZibHealthProfessionalReference" />
         <targetProfile value="http://nictiz.nl/fhir/StructureDefinition/zib-HealthProfessional-PractitionerRole" />
       </type>
+      <mapping>
+        <identity value="zib-encounter-v6.0-2024EN" />
+        <map value="NL-CM:15.1.18" />
+        <comment value="ResponsableHealthProfessional" />
+      </mapping>
     </element>
     <element id="Encounter.period.start">
       <path value="Encounter.period.start" />
       <short value="DateTime" />
       <definition value="The date and time at which the encounter took or will take place." />
+      <alias value="DatumTijd" />
       <mapping>
         <identity value="zib-encounter-v6.0-2024EN" />
         <map value="NL-CM:15.1.3" />