updated Location type search parameter and examples for physicalType … (

#1034)
cerner · Jan 22, 2024 · 1ea0d04 · 1ea0d04
1 parent 68e733f
commit 1ea0d04
Show file tree

Hide file tree

Showing 3 changed files with 116 additions and 4 deletions.
diff --git a/content/millennium/r4/base/entities/location.md b/content/millennium/r4/base/entities/location.md
@@ -26,6 +26,7 @@ The following fields are returned if valued:
 * [Telecom](http://hl7.org/fhir/R4/location-definitions.html#Location.telecom){:target="_blank"}
 * [Address](http://hl7.org/fhir/R4/location-definitions.html#Location.address){:target="_blank"}
 * [Physical Type](http://hl7.org/fhir/R4/location-definitions.html#Location.physicalType){:target="_blank"}
+* [Type](https://www.hl7.org/fhir/R4/location-definitions.html#Location.type){:target="_blank"}
 * [Managing Organization](http://hl7.org/fhir/R4/location-definitions.html#Location.managingOrganization){:target="_blank"}
 * [Part Of](http://hl7.org/fhir/R4/location-definitions.html#Location.partOf){:target="_blank"}
 * [Extensions including custom attribute](#extensions){:target="_blank"}
@@ -62,6 +63,7 @@ Search for locations that meet supplied query parameters:
 ----------------------|-------------------------|--------------|-------------------------------------------------------
  `_id`                | Conditionally           | [`token`]    | The logical resource ID associated with the resource. This parameter is required if the `-physicalType` parameter is not used.
  `-physicalType`      | Conditionally           | [`token`]    | The location’s physical type. This parameter is required if the `_id` parameter is not used. Example: `http://terminology.hl7.org/CodeSystem/location-physical-type|ro`
+ `type`               | Conditionally           | [`token`]    | The location’s type. This parameter is required if the `_id` parameter is not used. Example: `PHARM`
  `identifier`         | No                      | [`token`]    | The location’s identifier. Example: `653385|FSI^~BUILD^~NU` 
  [`_count`]           | No                      | [`number`]   | The maximum number of results to return. Default: `100`
  `address`            | No                      | [`string`]   | Part of the location's address. Example: `123%20Main`
@@ -76,6 +78,8 @@ Search for locations that meet supplied query parameters:
 
 - When searching with the `-physicalType` parameter:
   - Searching by Cerner Millennium proprietary codes is not supported.
+- The `type` parameter
+  - Searching by Cerner Millennium proprietary codes is not supported.
 - When searching with the `-address-city` parameter:
   - Must include any of the following parameters: `address-state` or `address-postalcode`.
 - When searching with the `name` and `organization` parameters:
@@ -98,6 +102,28 @@ Search for locations that meet supplied query parameters:
 
 <%= disclaimer %>
 
+### Example with physicalType
+
+#### Request
+
+    GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?-physicalType=http://terminology.hl7.org/CodeSystem/location-physical-type|wa
+
+#### Response
+
+<%= headers status: 200 %>
+<%= json(:r4_location_physical_type_bundle) %>
+
+### Example with type
+
+#### Request
+
+    GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?type=Facility
+
+#### Response
+
+<%= headers status: 200 %>
+<%= json(:r4_location_physical_type_bundle) %>
+
 ### Example with identifier
 
 #### Request

diff --git a/lib/resources/example_json/r4_examples_location.rb b/lib/resources/example_json/r4_examples_location.rb
@@ -73,6 +73,19 @@ module Resources
         "state": 'AA',
         "country": 'Ireland'
       },
+      "type": [
+        {
+          "coding": [
+            {
+              "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222',
+              "code": '783',
+              "display": 'Facility(s)',
+              "userSelected": true
+            }
+          ],
+          "text": 'Facility(s)'
+        }
+      ],
       "physicalType": {
         "coding": [
           {
@@ -111,6 +124,44 @@ module Resources
       ]
     }.freeze
 
+    R4_LOCATION_TYPE_BUNDLE ||= {
+      "resourceType": 'Bundle',
+      "id": 'f4749f7a-e67d-49d1-8b92-ddbef46eae15',
+      "type": 'searchset',
+      "link": [
+        {
+          "relation": 'self',
+          "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?type=PHARM'
+        }
+      ],
+      "entry": [
+        {
+          "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?type=PHARM',
+          "resource": R4_LOCATION_ENTRY
+        }
+      ]
+    }.freeze
+
+    R4_LOCATION_PHYSICAL_TYPE_BUNDLE ||= {
+      "resourceType": 'Bundle',
+      "id": 'f4749f7a-e67d-49d1-8b92-ddbef46eae15',
+      "type": 'searchset',
+      "link": [
+        {
+          "relation": 'self',
+          "url": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?'\
+          '-physicalType=http://terminology.hl7.org/CodeSystem/location-physical-type|si'
+        }
+      ],
+      "entry": [
+        {
+          "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location?'\
+          '-physicalType=http://terminology.hl7.org/CodeSystem/location-physical-type|si',
+          "resource": R4_LOCATION_ENTRY
+        }
+      ]
+    }.freeze
+
     R4_LOCATION_ADDRESS_ENTRY ||= {
       "fullUrl": 'https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Location/20573078',
       "resource": {
@@ -149,6 +200,24 @@ module Resources
           "postalCode": '64111',
           "country": 'US'
         },
+        "type": [
+          {
+            "coding": [
+              {
+                "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222',
+                "code": '783',
+                "display": 'Facility(s)',
+                "userSelected": true
+              },
+              {
+                "system": 'http://terminology.hl7.org/CodeSystem/v3-RoleCode',
+                "code": 'Facility',
+                "display": 'Facility'
+              }
+            ],
+            "text": 'Facility(s)'
+          }
+        ],
         "physicalType": {
           "coding": [
             {
@@ -256,6 +325,19 @@ module Resources
               'ABC Taxi'
             ],
             "mode": 'instance',
+            "type": [
+              {
+                "coding": [
+                  {
+                    "system": 'https://fhir.cerner.com/ec2458f2-1e24-41c8-b71b-0e701af7583d/codeSet/222',
+                    "code": '783',
+                    "display": 'Facility(s)',
+                    "userSelected": true
+                  }
+                ],
+                "text": 'Facility(s)'
+              }
+            ],
             "telecom": [
               {
                 "system": 'phone',

diff --git a/lib/resources/r4/location.yaml b/lib/resources/r4/location.yaml
@@ -89,14 +89,18 @@ fields:
           info_link: http://hl7.org/fhir/R4/location-definitions.html#Location.telecom
 
   - name: type
-    type: code
+    type: List of CodeableConcept
     description: Indicates the type of function performed at the location.
     action: terminology
     binding:
-      description: Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.
+      description: Type of function performed at the location.
       terminology:
-        - display: Location Address Type
-          info_link: http://hl7.org/fhir/R4/datatypes-definitions.html#Address.type
+        - display: Location type
+          system: http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
+          info_link: https://www.hl7.org/fhir/R4/v3/ServiceDeliveryLocationRoleType/vs.html
+        - display: Millennium Location Types
+          system: https://fhir.cerner.com/&lt;EHR source id&gt;/codeSet/222
+          info_link: https://fhir.cerner.com/millennium/r4/proprietary-codes-and-systems/#code-set-222-location-type
 
   - name: use
     type: code