issue #3641 - package US Core 5.0.0 artifacts

and refine our approach for src/test/java tools to avoid the need to have a different set of the same classes for each version of the IG Signed-off-by: Lee Surprenant <lmsurpre@us.ibm.com>
LinuxForHealth · May 18, 2022 · 90d8322 · 90d8322
1 parent 6053a0f
commit 90d8322
Show file tree

Hide file tree

Showing 418 changed files with 225,159 additions and 1,000 deletions.
diff --git a/conformance/fhir-ig-us-core/CHANGELOG → conformance/fhir-ig-us-core/CHANGELOG.md b/conformance/fhir-ig-us-core/CHANGELOG → conformance/fhir-ig-us-core/CHANGELOG.md
@@ -1,4 +1,5 @@
-# US Core 3.1.1 (Version 2) - STU311
+# Changes 
+## US Core 3.1.1 (Version 2) - STU311
 Source - http://hl7.org/fhir/us/core/STU3.1.1/
 - Removed 3.1.0 Artifacts
 - Updated to 3.1.1 Artifacts STU3.1.1
@@ -20,14 +21,35 @@ Source - http://hl7.org/fhir/us/core/STU3.1.1/
 - Updated Examples to point to 3.1.1 profile
 - Update the StructureDefinitions and other artifacts for 3.1.1 internal references with target profiles and valueset bindings.
 
-# US Core 4.0.0 - STU4
+## US Core 4.0.0 - STU4
 Source - https://www.hl7.org/fhir/us/core/stu4/
 - Examples are under src/test/resources/JSON/400
 - Replace all narrative text with minimal placeholder for space efficiency
 - Revised Endpoint in the Practitioner endpoint so it points to relative path, not absolute path
 - Move provenance-1 constraint from Provenance.agent.onBehalfOf to Provenance.agent and fix the expression (https://jira.hl7.org/browse/FHIR-36328)
 - Fix Condition constraint us-core-1 expression (https://jira.hl7.org/browse/FHIR-36336) 
 - Replace the packaged USPS valueset with an expanded version obtained from https://tx.fhir.org/r4/ValueSet/$expand?url=http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state on 2022-03-28
+- Added version id to each targetProfile canonical reference (e.g. `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient` -> `http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0`)
+- Added version id to each valueSet binding target (e.g. `http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs` -> `http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0`)
 
-# Re-check after each update to the IG
-- Update the http://hl7.org/fhir/us/core/ValueSet-us-core-usps-state.html valueset from https://tx.fhir.org (if needed)
+
+## US Core 5.0.0 - STU5
+Source - https://hl7.org/fhir/us/core/stu5/
+- Modified ig-r4.json to remove parameters that aren't valid in FHIR R4
+- Replace &reg; with ® in the following examples:
+  - Procedure-defib-implant.json
+  - Encounter-example-1.json
+
+
+# Steps to update
+
+1. download the npm package for whatever version of us core you want (and note what downloads we used from where in this file)
+2. update `src/main/resources` with the latest conformance artifacts and `src/test/resources` with the latest examples
+3. if its a new version
+  - ensure references from the previous package are version-specific (e.g. to avoid a 3.1.1 profile from picking up a 5.0.0 valueset during validation)
+  - add a new provider (`src/main/java` and `src/main/resources/META-INF`)
+  - create tests for this new version (copy tests from the existing versions into a new package for this version)
+3. update the http://hl7.org/fhir/us/core/ValueSet-us-core-usps-state.html valueset from https://tx.fhir.org (if needed)
+  - https://tx.fhir.org/r4/ValueSet/$expand?url=http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state
+4. execute ResourceProcessor.java from src/test/java with the proper arguments
+5. execute SearchParameterAugmenter from src/test/java with the proper arguments
diff --git a/conformance/fhir-ig-us-core/pom.xml b/conformance/fhir-ig-us-core/pom.xml
@@ -20,6 +20,13 @@
             <artifactId>fhir-registry</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>${project.groupId}</groupId>
+            <artifactId>fhir-registry</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+            <type>test-jar</type>
+        </dependency>
         <dependency>
             <groupId>org.testng</groupId>
             <artifactId>testng</artifactId>

diff --git a/...ance/fhir-ig-us-core/src/main/java/com/ibm/fhir/ig/us/core/USCore500ResourceProvider.java b/...ance/fhir-ig-us-core/src/main/java/com/ibm/fhir/ig/us/core/USCore500ResourceProvider.java
@@ -0,0 +1,16 @@
+/*
+ * (C) Copyright IBM Corp. 2022
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package com.ibm.fhir.ig.us.core;
+
+import com.ibm.fhir.registry.util.PackageRegistryResourceProvider;
+
+public class USCore500ResourceProvider extends PackageRegistryResourceProvider {
+    @Override
+    public String getPackageId() {
+        return "hl7.fhir.us.core.500";
+    }
+}
diff --git a/...c/main/resources/META-INF/services/com.ibm.fhir.registry.spi.FHIRRegistryResourceProvider b/...c/main/resources/META-INF/services/com.ibm.fhir.registry.spi.FHIRRegistryResourceProvider
@@ -1,2 +1,3 @@
 com.ibm.fhir.ig.us.core.USCore311ResourceProvider
-com.ibm.fhir.ig.us.core.USCore400ResourceProvider
+com.ibm.fhir.ig.us.core.USCore400ResourceProvider
+com.ibm.fhir.ig.us.core.USCore500ResourceProvider
diff --git a/...core/400/package/StructureDefinition-head-occipital-frontal-circumference-percentile.json b/...core/400/package/StructureDefinition-head-occipital-frontal-circumference-percentile.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1437,7 +1437,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1484,7 +1484,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3441,7 +3441,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/...ain/resources/hl7/fhir/us/core/400/package/StructureDefinition-pediatric-bmi-for-age.json b/...ain/resources/hl7/fhir/us/core/400/package/StructureDefinition-pediatric-bmi-for-age.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1437,7 +1437,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1484,7 +1484,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3441,7 +3441,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/...sources/hl7/fhir/us/core/400/package/StructureDefinition-pediatric-weight-for-height.json b/...sources/hl7/fhir/us/core/400/package/StructureDefinition-pediatric-weight-for-height.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1437,7 +1437,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1484,7 +1484,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3441,7 +3441,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/...esources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-allergyintolerance.json b/...esources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-allergyintolerance.json
@@ -895,7 +895,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -1813,7 +1813,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],

diff --git a/...in/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-blood-pressure.json b/...in/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-blood-pressure.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1436,7 +1436,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1483,7 +1483,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3086,7 +3086,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -3593,7 +3593,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -4393,7 +4393,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/...core/src/main/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-bmi.json b/...core/src/main/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-bmi.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1436,7 +1436,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1483,7 +1483,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3440,7 +3440,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/.../main/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-body-height.json b/.../main/resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-body-height.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1436,7 +1436,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1483,7 +1483,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3443,7 +3443,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {

diff --git a/.../resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-body-temperature.json b/.../resources/hl7/fhir/us/core/400/package/StructureDefinition-us-core-body-temperature.json
@@ -72,7 +72,7 @@
     "kind": "resource",
     "abstract": false,
     "type": "Observation",
-    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs",
+    "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-vital-signs|4.0.0",
     "derivation": "constraint",
     "snapshot": {
         "element": [
@@ -1436,7 +1436,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {
@@ -1483,7 +1483,7 @@
                     {
                         "code": "Reference",
                         "targetProfile": [
-                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
+                            "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient|4.0.0"
                         ]
                     }
                 ],
@@ -3443,7 +3443,7 @@
                 "binding": {
                     "strength": "extensible",
                     "description": "The vital sign codes from the base FHIR and US Core Vital Signs.",
-                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs"
+                    "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-vital-signs|4.0.0"
                 },
                 "mapping": [
                     {