Encourage population of Address.country to fix FHIR-45137

HL7 · Mar 29, 2024 · 74aa010 · 74aa010
1 parent 70f0f42
commit 74aa010
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 28 deletions.
diff --git a/input/pages/brands.md b/input/pages/brands.md
@@ -44,7 +44,7 @@ Each Brand includes the following information intended to support an app-based c
 | Logo |to be displayed on a card, and link to logo use terms/agreements | 0..1 |
 | Aliases | e.g., former names like "General Health Associates" for filtering/search | 0..* |
 | Identifiers | supporting cross-publisher references or links to external data sets such as the NPI Registry. | 0..* |
-| Locations | zip codes and street addresses associated with the Brand | 0..* |
+| Locations | Places associated with the Brand (e.g., states, cities, or street addresses) | 0..* |
 | Categories | clinical, insurance, laboratory, imaging, pharmacy, network, aggregator --- for filtering/search | 0..* |
 | Portal Details | describes a portal this Brand offers to users **See the table below**.| 0..* |
 {:.grid}
@@ -239,7 +239,10 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza
     "value" : "https://brand.example.com"
   }],
   // Locations (e.g., zip codes and/or street addresses) associated with the Brand.
-  // The following combinations are allowed:
+  // The following combinations are allowed, and as a best practice to ensure
+  // consistent worldwide adoption, the Address.country data element can be
+  // populated inside any of these with an ISO 3166-1 alpha-2 country code.
+:
   // * State
   // * City, state
   // * City, state, zip code
@@ -248,9 +251,11 @@ This annotated example illustrates how a Brand is represented as a FHIR Organiza
   "address" : [{
     "city" : "Boston",
     "state" : "MA",
-    "postalCode" : "02111"
+    "postalCode" : "02111",
+    "country": "US"
   }, {
-    "postalCode" : "02139"
+    "postalCode" : "02139",
+    "country": "US"
   }],
   // These endpoints are already listed above in association with their portal.
   // They are repeated here as a convenience for clients that do not know how

diff --git a/input/resources/Bundle-example1.json b/input/resources/Bundle-example1.json
@@ -75,16 +75,19 @@
             "line": ["4015 Lake Otis Pkwy"],
             "city": "Anchorage",
             "state": "AK",
-            "postalCode": "99508"
+            "postalCode": "99508",
+            "country": "US"
           },
           {
-            "state": "...(more here)..."
+            "state": "...(more here)...",
+            "country": "US"
           },
           {
             "line": ["123 Main St"],
             "city": "Madison",
             "state": "WI",
-            "postalCode": "53726"
+            "postalCode": "53726",
+            "country": "US"
           }
         ],
         "endpoint": [

diff --git a/input/resources/Bundle-example2.json b/input/resources/Bundle-example2.json
@@ -83,51 +83,63 @@
         "address": [
           {
             "city": "Madison",
-            "state": "WI"
+            "state": "WI",
+            "country": "US"
           },
           {
             "city": "Anamosa",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Cedar Rapids",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Des Moines",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Dubuque",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Fort Dodge",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Grinnell",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Marshalltown",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Peoria",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Pekin",
-            "state": "I"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Muscatine",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           },
           {
             "city": "Sioux City",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           }
         ],
         "endpoint": [
@@ -189,7 +201,8 @@
         "address": [
           {
             "city": "Lake City",
-            "state": "IA"
+            "state": "IA",
+            "country": "US"
           }
         ],
         "partOf": {
@@ -244,7 +257,8 @@
         "address": [
           {
             "city": "Madison",
-            "state": "WI"
+            "state": "WI",
+            "country": "US"
           }
         ],
         "partOf": {

diff --git a/input/resources/Bundle-example4.json b/input/resources/Bundle-example4.json
@@ -69,15 +69,18 @@
         "address": [
           {
             "city": "Napa",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           },
           {
             "city": "Sonoma",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           },
           {
             "city": "St Helena",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           }
         ],
         "endpoint": [
@@ -153,15 +156,18 @@
         "address": [
           {
             "city": "Sonoma",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           },
           {
             "city": "San Rafael",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           },
           {
             "city": "Santa Rosa",
-            "state": "CA"
+            "state": "CA",
+            "country": "US"
           }
         ],
         "endpoint": [

diff --git a/input/resources/StructureDefinition-patient-access-brand.json b/input/resources/StructureDefinition-patient-access-brand.json
@@ -161,7 +161,7 @@
         "id": "Organization.address",
         "path": "Organization.address",
         "short": "Locations (e.g., zip codes and/or street addresses) associated with the Brand.",
-        "definition": "Locations (e.g., zip codes and/or street addresses) associated with the Brand. The following combinations are allowed:\n  * State\n  * City, state\n  * City, state, zip code\n  * Street address, city, state, zip code\n  * zip code alone\n",
+        "definition": "Locations (e.g., zip codes and/or street addresses) associated with the Brand. The following combinations are allowed, and as a best practice to ensure consistent worldwide adoption, the Address.country data element can be populated inside any of these with an ISO 3166-1 alpha-2 country code:\n  * State\n  * City, state\n  * City, state, zip code\n  * Street address, city, state, zip code\n  * zip code alone\n",
         "mustSupport": true
       },
       {