org.sql-on-fhir.ig 2.0.0

package/other/spec.internals

@@ -0,0 +1,88 @@
+{
+  "npm-name" : "org.sql-on-fhir.ig",
+  "ig-version" : "5.0.0",
+  "tool-version" : "5.0.0",
+  "tool-build" : "3",
+  "webUrl" : "https://sql-on-fhir.org/ig",
+  "date" : "2024-10-09",
+  "date-time" : "20241009031818+1000",
+  "paths" : {
+    "https://sql-on-fhir.org/ig/ImplementationGuide/org.sql-on-fhir.ig|2.0.0" : "index.html",
+    "https://sql-on-fhir.org/ig/ImplementationGuide/org.sql-on-fhir.ig" : "index.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/ShareableViewDefinition|2.0.0" : "StructureDefinition-ShareableViewDefinition.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/ShareableViewDefinition" : "StructureDefinition-ShareableViewDefinition.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/TabularViewDefinition|2.0.0" : "StructureDefinition-TabularViewDefinition.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/TabularViewDefinition" : "StructureDefinition-TabularViewDefinition.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition|2.0.0" : "StructureDefinition-ViewDefinition.html",
+    "https://sql-on-fhir.org/ig/StructureDefinition/ViewDefinition" : "StructureDefinition-ViewDefinition.html",
+    "https://sql-on-fhir.org/ig/Binary/PatientAddresses" : "Binary-PatientAddresses.html",
+    "https://sql-on-fhir.org/ig/Binary/PatientAndContactAddressUnion" : "Binary-PatientAndContactAddressUnion.html",
+    "https://sql-on-fhir.org/ig/Binary/PatientDemographics" : "Binary-PatientDemographics.html",
+    "https://sql-on-fhir.org/ig/Binary/ShareablePatientDemographics" : "Binary-ShareablePatientDemographics.html",
+    "https://sql-on-fhir.org/ig/Binary/UsCoreBloodPressures" : "Binary-UsCoreBloodPressures.html"
+  },
+  "pages" : {
+  },
+  "targets" : [
+    "searchform.html",
+    "functional-model.html",
+    "StructureDefinition-ViewDefinition.profile.history.html",
+    "Binary-UsCoreBloodPressures.change.history.html",
+    "StructureDefinition-TabularViewDefinition-mappings.html",
+    "Binary-PatientDemographics.html",
+    "StructureDefinition-TabularViewDefinition.profile.json.html",
+    "artifacts.html",
+    "StructureDefinition-TabularViewDefinition-definitions.html",
+    "index.html",
+    "StructureDefinition-ViewDefinition.html",
+    "Binary-ShareablePatientDemographics.xml.html",
+    "StructureDefinition-TabularViewDefinition-testing.html",
+    "StructureDefinition-TabularViewDefinition-examples.html",
+    "Binary-ShareablePatientDemographics.ttl.html",
+    "toc.html",
+    "StructureDefinition-ShareableViewDefinition-testing.html",
+    "StructureDefinition-ViewDefinition-testing.html",
+    "Binary-PatientAddresses.json.html",
+    "StructureDefinition-ViewDefinition.profile.ttl.html",
+    "Binary-PatientAddresses.change.history.html",
+    "Binary-UsCoreBloodPressures.json.html",
+    "Binary-ShareablePatientDemographics.change.history.html",
+    "StructureDefinition-ViewDefinition.profile.xml.html",
+    "Binary-ShareablePatientDemographics.json.html",
+    "StructureDefinition-ShareableViewDefinition.profile.json.html",
+    "StructureDefinition-ShareableViewDefinition.profile.xml.html",
+    "Binary-PatientAddresses.xml.html",
+    "Binary-PatientAddresses.html",
+    "StructureDefinition-ShareableViewDefinition.profile.ttl.html",
+    "StructureDefinition-TabularViewDefinition.html",
+    "Binary-PatientAddresses.ttl.html",
+    "Binary-PatientAndContactAddressUnion.change.history.html",
+    "StructureDefinition-ViewDefinition-examples.html",
+    "Binary-PatientDemographics.json.html",
+    "StructureDefinition-ViewDefinition-definitions.html",
+    "Binary-PatientAndContactAddressUnion.json.html",
+    "StructureDefinition-ShareableViewDefinition-examples.html",
+    "glossary.html",
+    "StructureDefinition-ShareableViewDefinition.html",
+    "StructureDefinition-ViewDefinition.profile.json.html",
+    "StructureDefinition-TabularViewDefinition.profile.history.html",
+    "Binary-ShareablePatientDemographics.html",
+    "StructureDefinition-ShareableViewDefinition-mappings.html",
+    "Binary-PatientAndContactAddressUnion.html",
+    "StructureDefinition-ViewDefinition-mappings.html",
+    "contributing.html",
+    "StructureDefinition-ShareableViewDefinition-definitions.html",
+    "StructureDefinition-TabularViewDefinition.profile.xml.html",
+    "Binary-UsCoreBloodPressures.xml.html",
+    "Binary-UsCoreBloodPressures.ttl.html",
+    "StructureDefinition-TabularViewDefinition.profile.ttl.html",
+    "Binary-PatientAndContactAddressUnion.xml.html",
+    "Binary-PatientDemographics.change.history.html",
+    "Binary-PatientDemographics.xml.html",
+    "Binary-PatientDemographics.ttl.html",
+    "StructureDefinition-ShareableViewDefinition.profile.history.html",
+    "Binary-UsCoreBloodPressures.html",
+    "Binary-PatientAndContactAddressUnion.ttl.html"
+  ],
+  "images" : []
+}

package/other/validation-oo.json

@@ -0,0 +1 @@
+{"resourceType":"Bundle","type":"collection","timestamp":"2024-10-09T15:18:41.450+10:00","entry":[{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/ImplementationGuide-org.sql-on-fhir.ig","resource":{"resourceType":"OperationOutcome","id":"ImplementationGuide-org.sql-on-fhir.ig"}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/StructureDefinition-ShareableViewDefinition","resource":{"resourceType":"OperationOutcome","id":"StructureDefinition-ShareableViewDefinition","issue":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source","valueString":"InstanceValidator"}],"severity":"warning","code":"business-rule","details":{"text":"The definition for the element 'ViewDefinition.resource' binds to the value set 'http://hl7.org/fhir/ValueSet/resource-types' which is experimental, but this structure is not labeled as experimental"},"expression":["StructureDefinition/ShareableViewDefinition: StructureDefinition.snapshot.element[13].binding"]}]}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/StructureDefinition-TabularViewDefinition","resource":{"resourceType":"OperationOutcome","id":"StructureDefinition-TabularViewDefinition","issue":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source","valueString":"InstanceValidator"}],"severity":"warning","code":"business-rule","details":{"text":"The definition for the element 'ViewDefinition.resource' binds to the value set 'http://hl7.org/fhir/ValueSet/resource-types' which is experimental, but this structure is not labeled as experimental"},"expression":["StructureDefinition/TabularViewDefinition: StructureDefinition.snapshot.element[13].binding"]}]}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/StructureDefinition-ViewDefinition","resource":{"resourceType":"OperationOutcome","id":"StructureDefinition-ViewDefinition","issue":[{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-line","valueInteger":1},{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-col","valueInteger":103636},{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source","valueString":"InstanceValidator"},{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-message-id","valueCode":"TYPE_SPECIFIC_CHECKS_DT_XHTML_MULTIPLE_MATCHES"}],"severity":"warning","code":"invalid","details":{"text":"Hyperlink '#ViewDefinition.select' at 'div/table/tr/td/a' for 'select' resolves to multiple targets ($/differential/element/id, $/snapshot/element/id, $/text/div/table/tr/td/a/@name)"},"expression":["StructureDefinition/ViewDefinition: StructureDefinition.text.div"]},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source","valueString":"InstanceValidator"}],"severity":"warning","code":"business-rule","details":{"text":"The definition for the element 'ViewDefinition.resource' binds to the value set 'http://hl7.org/fhir/ValueSet/resource-types' which is experimental, but this structure is not labeled as experimental"},"expression":["StructureDefinition/ViewDefinition: StructureDefinition.differential.element[13].binding"]},{"extension":[{"url":"http://hl7.org/fhir/StructureDefinition/operationoutcome-issue-source","valueString":"InstanceValidator"}],"severity":"warning","code":"business-rule","details":{"text":"The definition for the element 'ViewDefinition.resource' binds to the value set 'http://hl7.org/fhir/ValueSet/resource-types' which is experimental, but this structure is not labeled as experimental"},"expression":["StructureDefinition/ViewDefinition: StructureDefinition.snapshot.element[13].binding"]}]}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/Binary-PatientAddresses","resource":{"resourceType":"OperationOutcome","id":"Binary-PatientAddresses"}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/Binary-PatientAndContactAddressUnion","resource":{"resourceType":"OperationOutcome","id":"Binary-PatientAndContactAddressUnion"}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/Binary-PatientDemographics","resource":{"resourceType":"OperationOutcome","id":"Binary-PatientDemographics"}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/Binary-ShareablePatientDemographics","resource":{"resourceType":"OperationOutcome","id":"Binary-ShareablePatientDemographics"}},{"fullUrl":"https://sql-on-fhir.org/ig/OperationOutcome/Binary-UsCoreBloodPressures","resource":{"resourceType":"OperationOutcome","id":"Binary-UsCoreBloodPressures"}}]}

package/other/validation-summary.json

@@ -0,0 +1 @@
+{"ImplementationGuide/org.sql-on-fhir.ig":{"errors":0,"warnings":0},"StructureDefinition/ShareableViewDefinition":{"errors":0,"warnings":1},"StructureDefinition/TabularViewDefinition":{"errors":0,"warnings":1},"StructureDefinition/ViewDefinition":{"errors":0,"warnings":3},"Binary/PatientAddresses":{"errors":0,"warnings":0},"Binary/PatientAndContactAddressUnion":{"errors":0,"warnings":0},"Binary/PatientDemographics":{"errors":0,"warnings":0},"Binary/ShareablePatientDemographics":{"errors":0,"warnings":0},"Binary/UsCoreBloodPressures":{"errors":0,"warnings":0}}

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name" : "org.sql-on-fhir.ig",
+  "version" : "2.0.0",
+  "tools-version" : 3,
+  "type" : "IG",
+  "date" : "20241009151748",
+  "license" : "CC0-1.0",
+  "canonical" : "https://sql-on-fhir.org/ig",
+  "url" : "https://sql-on-fhir.org/ig/2.0.0",
+  "title" : "SQL on FHIR",
+  "description" : "A specification for defining portable views of FHIR data that can be easily queried using tools such as SQL. (built Wed, Oct 9, 2024 15:17+1000+10:00)",
+  "fhirVersions" : ["5.0.0"],
+  "dependencies" : {
+    "hl7.terminology.r5" : "6.0.2",
+    "hl7.fhir.uv.extensions.r5" : "5.1.0"
+  },
+  "author" : "SQL on FHIR Working Group",
+  "maintainers" : [{
+    "name" : "SQL on FHIR Working Group",
+    "url" : "https://sql-on-fhir.org"
+  }],
+  "directories" : {
+    "lib" : "package",
+    "example" : "example"
+  },
+  "jurisdiction" : "http://unstats.un.org/unsd/methods/m49/m49.htm#001"
+}

package/tests/basic.json

@@ -0,0 +1,496 @@
+{
+  "title": "basic",
+  "description": "basic view definition",
+  "fhirVersion": ["5.0.0", "4.0.1", "3.0.2"],
+  "resources": [
+    {
+      "resourceType": "Patient",
+      "id": "pt1",
+      "name": [
+        {
+          "family": "F1"
+        }
+      ],
+      "active": true
+    },
+    {
+      "resourceType": "Patient",
+      "id": "pt2",
+      "name": [
+        {
+          "family": "F2"
+        }
+      ],
+      "active": false
+    },
+    {
+      "resourceType": "Patient",
+      "id": "pt3"
+    }
+  ],
+  "tests": [
+    {
+      "title": "basic attribute",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1"
+        },
+        {
+          "id": "pt2"
+        },
+        {
+          "id": "pt3"
+        }
+      ]
+    },
+    {
+      "title": "boolean attribute with false",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              },
+              {
+                "name": "active",
+                "path": "active",
+                "type": "boolean"
+              }
+            ]
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1",
+          "active": true
+        },
+        {
+          "id": "pt2",
+          "active": false
+        },
+        {
+          "id": "pt3",
+          "active": null
+        }
+      ]
+    },
+    {
+      "title": "two columns",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              },
+              {
+                "name": "last_name",
+                "path": "name.family.first()",
+                "type": "string"
+              }
+            ]
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1",
+          "last_name": "F1"
+        },
+        {
+          "id": "pt2",
+          "last_name": "F2"
+        },
+        {
+          "id": "pt3",
+          "last_name": null
+        }
+      ]
+    },
+    {
+      "title": "two selects with columns",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          },
+          {
+            "column": [
+              {
+                "name": "last_name",
+                "path": "name.family.first()",
+                "type": "string"
+              }
+            ]
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1",
+          "last_name": "F1"
+        },
+        {
+          "id": "pt2",
+          "last_name": "F2"
+        },
+        {
+          "id": "pt3",
+          "last_name": null
+        }
+      ]
+    },
+    {
+      "title": "where - 1",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ],
+        "where": [
+          {
+            "path": "active.exists() and active = true"
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1"
+        }
+      ]
+    },
+    {
+      "title": "where - 2",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ],
+        "where": [
+          {
+            "path": "active.exists() and active = false"
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt2"
+        }
+      ]
+    },
+    {
+      "title": "where returns non-boolean for some cases",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ],
+        "where": [
+          {
+            "path": "active"
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1"
+        }
+      ]
+    },
+    {
+      "title": "where as expr - 1",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ],
+        "where": [
+          {
+            "path": "name.family.exists() and name.family = 'F2'"
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt2"
+        }
+      ]
+    },
+    {
+      "title": "where as expr - 2",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "status": "active",
+        "select": [
+          {
+            "column": [
+              {
+                "name": "id",
+                "path": "id",
+                "type": "id"
+              }
+            ]
+          }
+        ],
+        "where": [
+          {
+            "path": "name.family.exists() and name.family = 'F1'"
+          }
+        ]
+      },
+      "expect": [
+        {
+          "id": "pt1"
+        }
+      ]
+    },
+    {
+      "title": "select & column",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "select": [
+          {
+            "column": [
+              {
+                "path": "id",
+                "name": "c_id",
+                "type": "id"
+              }
+            ],
+            "select": [
+              {
+                "column": [
+                  {
+                    "path": "id",
+                    "name": "s_id",
+                    "type": "id"
+                  }
+                ]
+              }
+            ]
+          }
+        ]
+      },
+      "expect": [
+        {
+          "c_id": "pt1",
+          "s_id": "pt1"
+        },
+        {
+          "c_id": "pt2",
+          "s_id": "pt2"
+        },
+        {
+          "c_id": "pt3",
+          "s_id": "pt3"
+        }
+      ]
+    },
+    {
+      "title": "column ordering",
+      "tags": ["shareable"],
+      "view": {
+        "resource": "Patient",
+        "select": [
+          {
+            "column": [
+              {
+                "path": "'A'",
+                "name": "a",
+                "type": "string"
+              },
+              {
+                "path": "'B'",
+                "name": "b",
+                "type": "string"
+              }
+            ],
+            "select": [
+              {
+                "forEach": "name",
+                "column": [
+                  {
+                    "path": "'C'",
+                    "name": "c",
+                    "type": "string"
+                  },
+                  {
+                    "path": "'D'",
+                    "name": "d",
+                    "type": "string"
+                  }
+                ]
+              }
+            ],
+            "unionAll": [
+              {
+                "column": [
+                  {
+                    "path": "'E1'",
+                    "name": "e",
+                    "type": "string"
+                  },
+                  {
+                    "path": "'F1'",
+                    "name": "f",
+                    "type": "string"
+                  }
+                ]
+              },
+              {
+                "column": [
+                  {
+                    "path": "'E2'",
+                    "name": "e",
+                    "type": "string"
+                  },
+                  {
+                    "path": "'F2'",
+                    "name": "f",
+                    "type": "string"
+                  }
+                ]
+              }
+            ]
+          },
+          {
+            "column": [
+              {
+                "path": "'G'",
+                "name": "g",
+                "type": "string"
+              },
+              {
+                "path": "'H'",
+                "name": "h",
+                "type": "string"
+              }
+            ]
+          }
+        ]
+      },
+      "expectColumns": ["a", "b", "c", "d", "e", "f", "g", "h"],
+      "expect": [
+        {
+          "a": "A",
+          "b": "B",
+          "c": "C",
+          "d": "D",
+          "e": "E1",
+          "f": "F1",
+          "g": "G",
+          "h": "H"
+        },
+        {
+          "a": "A",
+          "b": "B",
+          "c": "C",
+          "d": "D",
+          "e": "E2",
+          "f": "F2",
+          "g": "G",
+          "h": "H"
+        },
+        {
+          "a": "A",
+          "b": "B",
+          "c": "C",
+          "d": "D",
+          "e": "E1",
+          "f": "F1",
+          "g": "G",
+          "h": "H"
+        },
+        {
+          "a": "A",
+          "b": "B",
+          "c": "C",
+          "d": "D",
+          "e": "E2",
+          "f": "F2",
+          "g": "G",
+          "h": "H"
+        }
+      ]
+    }
+  ]
+}