From 6064a0168dcfbcd4d1c894e8644e80698852f5ff Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Thu, 6 Oct 2022 13:42:40 -0500 Subject: [PATCH 1/9] add issuer_type=network --- METADATA.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/METADATA.md b/METADATA.md index 2ef3c5ca..2738920e 100644 --- a/METADATA.md +++ b/METADATA.md @@ -13,6 +13,7 @@ | `label` | A representative label for the issuer. Used when issuer name may be too long, misrepresentative, or provides more common nomenclature. | | `currently_issuing` | Boolean variable that indicates if an issuer is currently issuing. It is assumed an issuer is actively issuing if not included in metadata. | | `locations` | A list of locations (see below for details) that the issuer is associated with | +| `network_participants` | A list of participants. Populated when issuer_type is `network` (see below for details) | ## Issuer Type Representation @@ -31,6 +32,8 @@ A simple hierarchy provides an easier means to segregate government and non-gove | `governmental.city_county` | A city, county or governmental agency issuing for a city | | `governmental.health_jurisdiction` | A jurisdiction or governmental agency issuing for a jurisdiction | | `governmental.agency` | A governmental agency | +| `network` | A group of distinct organizations sharing a single issuer. | + ## Location Representation @@ -55,6 +58,26 @@ locations: [ ] ``` +## Network issuer type + +Specific organizations that share a `network` issuer are identified within a single entry in the metadata file. Each network_participant has a label and an issuer_type and may include a list of locations. + +```json + "network_participants": [{ + "label": "Clinic", + "issuer_type": "organization.health_system", + "locations": [{ + "state": "NY", + "country": "US" + }, + { + "state": "NJ", + "country": "US" + } + ] + }] +``` + [example-metadata.json](example-metadata.json) shows basic example representing what an entry in the metadata file would look like. [fhir-address-type]:https://www.hl7.org/fhir/datatypes.html#Address From 7484314463e9d99e25ab78bce0bbfe24f66c86d8 Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Thu, 6 Oct 2022 13:47:38 -0500 Subject: [PATCH 2/9] example of network issuer --- example-metadata.json | 53 +++++++++++++++++++++++++++++++------------ 1 file changed, 38 insertions(+), 15 deletions(-) diff --git a/example-metadata.json b/example-metadata.json index 72aceed5..8d78bb33 100644 --- a/example-metadata.json +++ b/example-metadata.json @@ -1,17 +1,40 @@ { - "issuer_metadata": [ - { - "canonical_iss": "https://simple.example.com", - "website": "https://simple.example.com/portal", - "help_line": "(555) 867-5309", - "issuer_type": [ - "governmental.state_province_territory" - ], - "label": "California", - "currently_issuing": false, - "locations": [ - { "state": "CA", "country": "US" } - ] - } - ] + "issuer_metadata": [{ + "canonical_iss": "https://simple.example.com", + "website": "https://simple.example.com/portal", + "help_line": "(555) 867-5309", + "issuer_type": [ + "governmental.state_province_territory" + ], + "label": "California", + "currently_issuing": false, + "locations": [{ + "state": "CA", + "country": "US" + }] + }, + { + "canonical_iss": "https://network.example.com", + "website": "https://network.example.com/portal", + "help_line": "(555) 623-5250", + "issuer_type": [ + "network" + ], + "label": "Network of SHC issuers", + "currently_issuing": true, + "network_participants": [{ + "label": "Clinic", + "issuer_type": "organization.health_system", + "locations": [{ + "state": "NY", + "country": "US" + }, + { + "state": "NJ", + "country": "US" + } + ] + }] + } + ] } From bb8382b79cab8e6d2d3f02224dc0273a2711102b Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Thu, 6 Oct 2022 13:54:25 -0500 Subject: [PATCH 3/9] improve example --- example-metadata.json | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/example-metadata.json b/example-metadata.json index 8d78bb33..0375fb3c 100644 --- a/example-metadata.json +++ b/example-metadata.json @@ -23,15 +23,19 @@ "label": "Network of SHC issuers", "currently_issuing": true, "network_participants": [{ - "label": "Clinic", + "label": "Coal Miner's Clinic", "issuer_type": "organization.health_system", "locations": [{ - "state": "NY", + "state": "KY", "country": "US" }, { - "state": "NJ", - "country": "US" + "label": "Citrix Workers of Northern California Clinic ", + "issuer_type": "organization.health_system", + "locations": [{ + "state": "CA", + "country": "US" + }] } ] }] From 369004fe399c3982ac43c88eedf327014fbc9530 Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Thu, 6 Oct 2022 14:52:17 -0500 Subject: [PATCH 4/9] nth time's the charm --- example-metadata.json | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/example-metadata.json b/example-metadata.json index 0375fb3c..fff0fc9e 100644 --- a/example-metadata.json +++ b/example-metadata.json @@ -23,22 +23,22 @@ "label": "Network of SHC issuers", "currently_issuing": true, "network_participants": [{ - "label": "Coal Miner's Clinic", - "issuer_type": "organization.health_system", - "locations": [{ + "label": "Coal Miner's Clinic", + "issuer_type": "organization.health_system", + "locations": [{ "state": "KY", "country": "US" - }, - { - "label": "Citrix Workers of Northern California Clinic ", - "issuer_type": "organization.health_system", - "locations": [{ - "state": "CA", - "country": "US" - }] - } - ] - }] + }] + }, + { + "label": "Citrix Workers of Northern California Clinic ", + "issuer_type": "organization.health_system", + "locations": [{ + "state": "CA", + "country": "US" + }] + } + ] } ] } From 3549c2967700cc2b623c0b5fb2dbb5c133584a32 Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Fri, 7 Oct 2022 22:16:55 -0500 Subject: [PATCH 5/9] Josh's feedback: rollout location and make mandatory > Document explicitly that the elements of the network_participants need to have have a label, locations, and issuer_type (with the same meaning that these properties have on top-level entries) > Roll up the locations from the network_participants into a locations on the top-level network, so existing "search by state" lookups will find networks (but keep them on the locations too, so future tools can tell which participants operate in which locations) Note that I'm leaving location as optional for the network participant, just as it is on the issuer. --- METADATA.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/METADATA.md b/METADATA.md index 2738920e..46f730cc 100644 --- a/METADATA.md +++ b/METADATA.md @@ -37,7 +37,7 @@ A simple hierarchy provides an easier means to segregate government and non-gove ## Location Representation -In order to best represent the reality of a SHC issuer issuing SHCs in multiple locations, an issuer can be associated to multiple country-state locations. +In order to best represent the reality of a SHC issuer issuing SHCs in multiple locations, an issuer can be associated to multiple country-state locations. In the case of `network` `issuer-type`s, this list of locations includes all of the locations of the network participants. This location representation is heavily inspired by the [FHIR `Address` type][fhir-address-type]. @@ -60,7 +60,7 @@ locations: [ ## Network issuer type -Specific organizations that share a `network` issuer are identified within a single entry in the metadata file. Each network_participant has a label and an issuer_type and may include a list of locations. +Specific organizations that share a `network` issuer are grouped together within a single entry in the metadata file. Each network_participant must have a label, an issuer_type, and should include a list of locations. (The meaning and value sets of `label`, `issuer-type`, and `locations` are defined above). ```json "network_participants": [{ From 4e0597345d543c25aa6c7cbb5971beaf63f62e37 Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Fri, 7 Oct 2022 22:21:22 -0500 Subject: [PATCH 6/9] indentation: spaces over tabs is a failure of the sw industry: discuss. (vim had it right) --- METADATA.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/METADATA.md b/METADATA.md index 46f730cc..44659758 100644 --- a/METADATA.md +++ b/METADATA.md @@ -63,19 +63,20 @@ locations: [ Specific organizations that share a `network` issuer are grouped together within a single entry in the metadata file. Each network_participant must have a label, an issuer_type, and should include a list of locations. (The meaning and value sets of `label`, `issuer-type`, and `locations` are defined above). ```json - "network_participants": [{ - "label": "Clinic", - "issuer_type": "organization.health_system", - "locations": [{ - "state": "NY", - "country": "US" - }, - { - "state": "NJ", - "country": "US" - } - ] - }] +"network_participants":[{ + "label":"Clinic", + "issuer_type":"organization.health_system", + "locations":[ + { + "state":"NY", + "country":"US" + }, + { + "state":"NJ", + "country":"US" + } + ] +} ``` [example-metadata.json](example-metadata.json) shows basic example representing what an entry in the metadata file would look like. From d28ea04943d29f031c833d30112afd21293de9f6 Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Fri, 7 Oct 2022 22:23:38 -0500 Subject: [PATCH 7/9] 2 space indent over tabs also json no longer validates --- example-metadata.json | 90 ++++++++++++++++++++++--------------------- 1 file changed, 47 insertions(+), 43 deletions(-) diff --git a/example-metadata.json b/example-metadata.json index fff0fc9e..04e0ce40 100644 --- a/example-metadata.json +++ b/example-metadata.json @@ -1,44 +1,48 @@ +"issuer_metadata": [{ + "canonical_iss":"https://simple.example.com", + "website":"https://simple.example.com/portal", + "help_line":"(555) 867-5309", + "issuer_type":[ + "governmental.state_province_territory" + ], + "label":"California", + "currently_issuing":false, + "locations":[ + { + "state":"CA", + "country":"US" + } + ] +}, { - "issuer_metadata": [{ - "canonical_iss": "https://simple.example.com", - "website": "https://simple.example.com/portal", - "help_line": "(555) 867-5309", - "issuer_type": [ - "governmental.state_province_territory" - ], - "label": "California", - "currently_issuing": false, - "locations": [{ - "state": "CA", - "country": "US" - }] - }, - { - "canonical_iss": "https://network.example.com", - "website": "https://network.example.com/portal", - "help_line": "(555) 623-5250", - "issuer_type": [ - "network" - ], - "label": "Network of SHC issuers", - "currently_issuing": true, - "network_participants": [{ - "label": "Coal Miner's Clinic", - "issuer_type": "organization.health_system", - "locations": [{ - "state": "KY", - "country": "US" - }] - }, - { - "label": "Citrix Workers of Northern California Clinic ", - "issuer_type": "organization.health_system", - "locations": [{ - "state": "CA", - "country": "US" - }] - } - ] - } - ] -} + "canonical_iss":"https://network.example.com", + "website":"https://network.example.com/portal", + "help_line":"(555) 623-5250", + "issuer_type":[ + "network" + ], + "label":"Network of SHC issuers", + "currently_issuing":true, + "network_participants":[ + { + "label":"Coal Miner's Clinic", + "issuer_type":"organization.health_system", + "locations":[ + { + "state":"KY", + "country":"US" + } + ] + }, + { + "label":"Citrix Workers of Northern California Clinic ", + "issuer_type":"organization.health_system", + "locations":[ + { + "state":"CA", + "country":"US" + } + ] + } + ] +}] From 0844a3bc56e5521d98aa036772f9bfe0b6e9d63f Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Fri, 7 Oct 2022 22:36:11 -0500 Subject: [PATCH 8/9] network.health_system --- METADATA.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/METADATA.md b/METADATA.md index 44659758..1b7bdc93 100644 --- a/METADATA.md +++ b/METADATA.md @@ -13,7 +13,7 @@ | `label` | A representative label for the issuer. Used when issuer name may be too long, misrepresentative, or provides more common nomenclature. | | `currently_issuing` | Boolean variable that indicates if an issuer is currently issuing. It is assumed an issuer is actively issuing if not included in metadata. | | `locations` | A list of locations (see below for details) that the issuer is associated with | -| `network_participants` | A list of participants. Populated when issuer_type is `network` (see below for details) | +| `network_participants` | A list of participants. Populated when `issuer_type` is `network.health_system` (see below for details). | ## Issuer Type Representation @@ -32,12 +32,12 @@ A simple hierarchy provides an easier means to segregate government and non-gove | `governmental.city_county` | A city, county or governmental agency issuing for a city | | `governmental.health_jurisdiction` | A jurisdiction or governmental agency issuing for a jurisdiction | | `governmental.agency` | A governmental agency | -| `network` | A group of distinct organizations sharing a single issuer. | +| `network.health_system` | A group of distinct clinical health systems or hospital sharing a single issuer. | ## Location Representation -In order to best represent the reality of a SHC issuer issuing SHCs in multiple locations, an issuer can be associated to multiple country-state locations. In the case of `network` `issuer-type`s, this list of locations includes all of the locations of the network participants. +In order to best represent the reality of a SHC issuer issuing SHCs in multiple locations, an issuer can be associated to multiple country-state locations. In the case of network issuers, `locations` is a comprehensive list of locations of its network participants. This location representation is heavily inspired by the [FHIR `Address` type][fhir-address-type]. @@ -58,9 +58,9 @@ locations: [ ] ``` -## Network issuer type +## Health Sytem Network issuer type -Specific organizations that share a `network` issuer are grouped together within a single entry in the metadata file. Each network_participant must have a label, an issuer_type, and should include a list of locations. (The meaning and value sets of `label`, `issuer-type`, and `locations` are defined above). +Specific clinical health systems or hospitals that share a `network.health_system` issuer may be grouped together within a single `network.health_system` entry in the metadata file. Each `network_participant` must have a label, an issuer_type, and should include a list of locations. (The meaning and value sets of `label`, `issuer-type`, and `locations` are defined above). ```json "network_participants":[{ From 119911200095c4bc0ffa9b5fa61f86408334f74c Mon Sep 17 00:00:00 2001 From: Isaac Vetter Date: Tue, 11 Oct 2022 13:19:10 -0500 Subject: [PATCH 9/9] syntax correction Co-authored-by: Josh Mandel --- METADATA.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/METADATA.md b/METADATA.md index 1b7bdc93..7ece591a 100644 --- a/METADATA.md +++ b/METADATA.md @@ -76,7 +76,7 @@ Specific clinical health systems or hospitals that share a `network.health_syste "country":"US" } ] -} +}] ``` [example-metadata.json](example-metadata.json) shows basic example representing what an entry in the metadata file would look like.