# NDH Location Profile - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0-current

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **NDH Location Profile**

## Resource Profile: NDH Location Profile 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location | *Version*:2.0.0-current | |
| * Standards status: *[Trial-use](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 4 | *Computable Name*:NdhLocation |

 
A Location is the physical place where healthcare services are provided, practitioners are employed, organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area. 

### Background & Scope

Traditionally, a location refers to the physical place where healthcare services are provided, practitioners are employed, and organizations are based. This information is captured by the position element. For the National Directory, there is a need to address insurance plan coverage areas and insurance provider network coverage areas. This information is defined by the location-boundary-geojson extension element.

**Usages:**

* Refer to this Profile: [NDH Location Reference](StructureDefinition-base-ext-location-reference.md), [NDH Qualification](StructureDefinition-base-ext-qualification.md), [NDH Via Intermediary](StructureDefinition-base-ext-via-intermediary.md), [NDH HealthcareService Profile](StructureDefinition-ndh-HealthcareService.md)... Show 4 more, [NDH InsurancePlan Profile](StructureDefinition-ndh-InsurancePlan.md), [NDH Location Profile](StructureDefinition-ndh-Location.md), [NDH OrganizationAffiliation Profile](StructureDefinition-ndh-OrganizationAffiliation.md) and [NDH PractitionerRole](StructureDefinition-ndh-PractitionerRole.md)
* Examples for this Profile: [OrgA CT Location 1](Location-HansSoloClinic.md), [Hartford Hospital Location 1](Location-HospLoc1.md), [Hartford Hospital Location 2](Location-HospLoc2.md), [HOPE FOOD DISPENSARY OF GREATER BALTIMORE](Location-Location-Social-Hope-CBO.md)... Show 9 more, [TOWSON FOOD DISPENSARY OF GREATER BALTIMORE COUNTY](Location-Location-Social-Towson-Food.md), [LocationGen1](Location-LocationGen1.md), [LocationGen2](Location-LocationGen2.md), [Welcome Home](Location-LocationWelcomeHome.md), [OrgA CT Location 1](Location-PharmLoc1.md), [OrgA CT Location 2](Location-PharmLoc2.md), [OrgA MA Location 1](Location-PharmLoc3.md), [OrgA MA Location 2](Location-PharmLoc4.md) and [State of CT Area](Location-StateOfCTLocation.md)
* CapabilityStatements using this Profile: [NDH Server Capability Statement](CapabilityStatement-ndh-server.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.us.ndh|current/StructureDefinition/ndh-Location)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-ndh-Location.csv), [Excel](StructureDefinition-ndh-Location.xlsx), [Schematron](StructureDefinition-ndh-Location.sch) 

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

| | | |
| :--- | :--- | :--- |
| [accessibility](SearchParameter-location-accessibility.md) | token | `GET [base]/Location?accessibility=cultcomp` |
| [contains](SearchParameter-location-contains.md) | special | `GET [base]/Location?contains=41.809006\|-71.41177` |
| [new-patient](SearchParameter-location-new-patient.md) | token | `GET [base]/Location?=new-patient=newpt` |
| [verification-status](SearchParameter-verification-status.md) | token | `GET [base]/Location?verification-status=complete` |

#### Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

Since there is no direct individual url for each Search Parameter defined by FHIR Serach Parameter Registry, we have provided the following links for you to access more information about them.

* [Search Parameter Registry](https://hl7.org/fhir/R4/searchparameter-registry.html)
* [Location Search Parameter from Registry](https://hl7.org/fhir/R4/location.html#search)

| | | |
| :--- | :--- | :--- |
| address | string | `GET [base]/Location?address=123 Ravissant ST` |
| address-city | string | `GET [base]/Location?address-city=Coconut Creek` |
| address-country | string | `GET [base]/Location?address-country=USA` |
| address-postalcode | string | `GET [base]/Location?address-postalcode=34997` |
| address-state | string | `GET [base]/Location?address-state=FL` |
| address-use | token | `GET [base]/Location?address-use=work` |
| organization | reference | `GET [base]/Location?organization.address-state=FL` |
| type | token | `GET [base]/Location?type=RH` |

#### _include Search Parameter

| | |
| :--- | :--- |
| Location:endpoint | `GET [base]/Location?_include=Location:endpoint` |
| Location:new-patient-from-network | `GET [base]/Location?_include=Location:new-patient-from-network` |
| Location:organization | `GET [base]/Location?_include=Location:organization` |
| Location:partof | `GET [base]/Location?_include=Location:partof` |

#### _revinclude Search Parameter

| |
| :--- |
| HealthcareService:coverage-area |
| HealthcareService:location |
| InsurancePlan:coverage-area |
| OrganizationAffiliation:location |
| PractitionerRole:location |

#### Special Search Parameters

The search parameters outlined above are straightforward for basic scenarios but have limitations in handling complex combination queries. To enhance these capabilities, employing the special search parameters [_filter](https://hl7.org/fhir/R5/search_filter.html#3.2.3) is recommended.

#### Search for locations with managing organization

The FHIR path for the managing organization is `Location.managingOrganization`, but the search parameter is `organization`. For example, to search for all locations assoicated with an managingOrganization has ID `Hospital` should write as:

`GET [base]/Location?organization=Organization/Hospital`

You can also search for locations associated with the managing organizations by name or other criteria. For example, to search for all locations associated with an organization with the name of `Hartford General Hospital`:

`GET [base]/Location?organization:Organization.name=Hartford General Hospital`

You can add additional search criteria to further narrow down your search results. For example, to search for all locations associated with the `Hartford General Hospital` organization that have a status of `active`:

`GET [base]/Location?organization:Organization.name=Hartford General Hospital&status=active`

#### Including other resources in search result

You can search for all Locations and their associated related resources (in this case, organization) which are managering some of locations. The _include parameter to indicate that the managingOrganization resources be included in the result.

`GET [base]//Location?_include=Location:organization`

#### Search location-boundary-geojson

GeoJSON encodes spatial data structures, including points, lines, polygons, and multi-part collections of these types. It is a common format for representing simple geographic features along with their non-spatial attributes. For example, a polygon area for Washington, D.C. is represented as:

```
{
  "type"": ""Feature",
  "geometry": {
    "type": "Polygon",
    "coordinates": [
      [
        [-77.119759, 38.934343],
        [-77.041697, 38.99511],
        [-76.910535, 38.892912],
        [-77.038088, 38.791015],
        [-77.119759, 38.934343]
      ]
    ]
  },
  "properties": {
    "name"": "Washington, D.C."
  }
}

```

##### How to populate the location-boundary-geojson data in Location resource

The data type of the location-boundary-geojson is Attachment, with the contentType set to application/geo+json and the data formatted as base64Binary. To represent a polygon area for Washington, D.C., you can use a JSON to Base64 converter to transform the JSON data into base64Binary format, which will look like this:

##### How to search location-boundary-geojson

The special contains search parameter tests whether the provided geocoded point(s) (expressed as [latitude]|[longitude] using the WGS84 datum) are within the defined boundary. Support for multiple points can also be provided using the , syntax, which is interpreted as the location returned in the search containing at least one of the provided coordinates. For example, for the Washington, D.C. polygon area:

`GET [base]/Location?contains=-77.119759|38.934343,-77.041697|38.99511,-76.910535|38.892912,-77.038088|38.791015,-77.119759|38.934343`



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ndh-Location",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 4,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location",
  "version" : "2.0.0-current",
  "name" : "NdhLocation",
  "title" : "NDH Location Profile",
  "status" : "active",
  "date" : "2026-03-23T21:58:05+00:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [{
    "name" : "HL7 International / Patient Administration",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/pafm"
    },
    {
      "system" : "email",
      "value" : "pafm@lists.hl7.org"
    }]
  }],
  "description" : "A Location is the physical place where healthcare services are provided, practitioners are employed, \n                 organizations are based, etc. Locations can range in scope from a room in a building to a geographic region/area.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "ndh-to-plannet-location",
    "uri" : "http://hl7.org/fhir/us/davinci-pdex-plan-net",
    "name" : "NDH to Plan-Net Location Mapping",
    "comment" : "Maps NDH Location profile to the Plan-Net Location profile, noting elements not present in Plan-Net."
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Location",
  "baseDefinition" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-location|6.1.0",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Location",
      "path" : "Location",
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Location",
        "comment" : "Top-level mapping from NDH to Plan-Net"
      }]
    },
    {
      "id" : "Location.meta.lastUpdated",
      "path" : "Location.meta.lastUpdated",
      "min" : 1,
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Location.meta.lastUpdated",
        "comment" : ", is required in NDH"
      }]
    },
    {
      "id" : "Location.extension",
      "path" : "Location.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "Location.extension:location-boundary-geojson",
      "path" : "Location.extension",
      "sliceName" : "location-boundary-geojson",
      "short" : "Associated Region (GeoJSON)",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/location-boundary-geojson|4.0.1"]
      }]
    },
    {
      "id" : "Location.extension:accessibility",
      "path" : "Location.extension",
      "sliceName" : "accessibility",
      "short" : "Accessibility",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-accessibility"]
      }]
    },
    {
      "id" : "Location.extension:newpatients",
      "path" : "Location.extension",
      "sliceName" : "newpatients",
      "short" : "New Patients",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-newpatients"]
      }]
    },
    {
      "id" : "Location.extension:verification-status",
      "path" : "Location.extension",
      "sliceName" : "verification-status",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-verification-status"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Location.identifier",
      "path" : "Location.identifier",
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Location.identifier"
      }]
    },
    {
      "id" : "Location.identifier.extension:identifier-status",
      "path" : "Location.identifier.extension",
      "sliceName" : "identifier-status",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-identifier-status"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Location.identifier.assigner",
      "path" : "Location.identifier.assigner",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }]
    },
    {
      "id" : "Location.status",
      "path" : "Location.status",
      "min" : 1,
      "fixedCode" : "active"
    },
    {
      "id" : "Location.operationalStatus",
      "path" : "Location.operationalStatus",
      "binding" : {
        "strength" : "preferred",
        "valueSet" : "http://terminology.hl7.org/ValueSet/v2-0116|2.0.0"
      }
    },
    {
      "id" : "Location.mode",
      "path" : "Location.mode",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/location-mode|4.0.1"
      }
    },
    {
      "id" : "Location.type",
      "path" : "Location.type",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType|3.0.0"
      }
    },
    {
      "id" : "Location.telecom",
      "path" : "Location.telecom",
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Location.telecom"
      }]
    },
    {
      "id" : "Location.telecom.extension:contactpoint-availabletime",
      "path" : "Location.telecom.extension",
      "sliceName" : "contactpoint-availabletime",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime"]
      }]
    },
    {
      "id" : "Location.telecom.extension:via-intermediary",
      "path" : "Location.telecom.extension",
      "sliceName" : "via-intermediary",
      "short" : "Via Intermediary",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-via-intermediary"]
      }]
    },
    {
      "id" : "Location.telecom.extension:language-speak",
      "path" : "Location.telecom.extension",
      "sliceName" : "language-speak",
      "short" : "Language Speak",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-language-speak"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Location.address.use",
      "path" : "Location.address.use",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/address-use|4.0.1"
      }
    },
    {
      "id" : "Location.address.type",
      "path" : "Location.address.type",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/address-type|4.0.1"
      }
    },
    {
      "id" : "Location.address.line",
      "path" : "Location.address.line",
      "max" : "4"
    },
    {
      "id" : "Location.address.state",
      "path" : "Location.address.state",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state|6.1.0"
      }
    },
    {
      "id" : "Location.address.country",
      "path" : "Location.address.country",
      "mustSupport" : true
    },
    {
      "id" : "Location.managingOrganization",
      "path" : "Location.managingOrganization",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }]
    },
    {
      "id" : "Location.partOf",
      "path" : "Location.partOf",
      "type" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
          "valueBoolean" : true
        }],
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Location"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Location.hoursOfOperation.daysOfWeek",
      "path" : "Location.hoursOfOperation.daysOfWeek",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/days-of-week|4.0.1"
      }
    },
    {
      "id" : "Location.endpoint",
      "path" : "Location.endpoint",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"]
      }],
      "mustSupport" : true,
      "mapping" : [{
        "identity" : "ndh-to-plannet-location",
        "map" : "Location.endpoint",
        "comment" : ", using NDH Endpoint Profile"
      }]
    }]
  }
}

```
