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

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

## Resource Profile: NDH Network Profile 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Network | *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*:NdhNetwork |

 
A Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals that deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants in a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively. 

### Scope and Usage

* In The National Directory of Healthcare Providers & Services (NDH) IG, individuals and organizations are represented as participants in a Network through the practitionerRole and organizationAffiliation resources, respectively.
* The Network profile is based on USCore Organization Profile. However, the NPI and CLIA identifier types, which are Must-Support, are clearly intended for provider organizations only and are not expected to be populated for other organization types.
* The NDH Network and Organization profiles are both based on the Organization profile. To selectively query only Network profiles, search for type = 'ntwk'. To selectively query only Organization profiles, the type parameter is optional. However, you can provide any value defined in the [Organization Type Value Set](ValueSet-OrgTypeVS.md).
* When the contact is a department name, rather than a human (e.g., patient help line), include a blank family and given name, and provide the department name in contact.name.text.
* Note that the relationship between InsurancePlans and Networks is many-to-many. A plan may be associated with multiple networks, and a network may be associated with many plans. In this IG, this is modeled by having InsurancePlans reference networks (directionality of relationship supports this).
* To use the location-reference extension to indicate a network coverage area, the preferred form of reference is to create a Location instance with the State or region specified, and possibly provide a GeoJSON.

**Usages:**

* Refer to this Profile: [NDH Network Reference](StructureDefinition-base-ext-network-reference.md), [NDH New Patients](StructureDefinition-base-ext-newpatients.md), [NDH InsurancePlan Profile](StructureDefinition-ndh-InsurancePlan.md) and [NDH OrganizationAffiliation Profile](StructureDefinition-ndh-OrganizationAffiliation.md)
* Examples for this Profile: [ACME CT Premium Preferred Provider Network](Organization-AcmeofCTPremNet.md), [ACME CT Preferred Provider Network](Organization-AcmeofCTStdNet.md), [BlueCrossBlueShield CT PPO](Organization-BlueCrossBlueShield-CT-PPO.md), [Network1](Organization-Network1.md)... Show 4 more, [Network2](Organization-Network2.md), [NetworkGen1](Organization-NetworkGen1.md), [NetworkGen2](Organization-NetworkGen2.md) and [Social Service Housing Hub](Organization-SocialServiceHousingNetwork.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-Network)

### 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-Network.csv), [Excel](StructureDefinition-ndh-Network.xlsx), [Schematron](StructureDefinition-ndh-Network.sch) 

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

In order to obtain information related to the Network resource, which is a derivative of the Organization resource, it is necessary to include the **type=ntwk** parameter in your search query.

| | | |
| :--- | :--- | :--- |
| [coverage-area](SearchParameter-network-coverage-area.md) | reference | `GET [base]/Organization?type=ntwk&coverage-area.address-state=CT` |
| [verification-status](SearchParameter-verification-status.md) | token | `GET [base]/Organization?type=ntwk&verification-status=complete` |

This search returns networks have coverage in the State of CT.

#### 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)
* [Network Search Parameter from Registry](https://hl7.org/fhir/R4/organization.html#search)

| | | |
| :--- | :--- | :--- |
| active | token | `GET [base]/Organization?type=ntwk&active=true` |
| address | string | `GET [base]/Organization?type=ntwk&address=123 Ravissant Dr` |
| address-city | string | `GET [base]/Organization?type=ntwk&address-city=Coconut Creek` |
| address-country | string | `GET [base]/Organization?type=ntwk&address-country=USA` |
| address-postalcode | string | `GET [base]/Organization?type=ntwk&address-postcode=12345` |
| address-state | string | `GET [base]/Organization?type=ntwk&address-state=FL` |
| address-use | token | `GET [base]/Organization?type=ntwk&address-use=work` |
| endpoint | reference | `GET [base]/Organization?type=ntwk&endpoint.connection-type=hl7-fhir-rest` |
| identifier | token | `GET [base]/Organization?type=ntwk&identifier=12345` |
| name | string | `GET [base]/Organization?type=ntwk&name=Florida Blue` |
| partof | reference | `GET [base]/Organization?type=ntwk&partof.name=Florida Blue` |
| type token | `GET [base]/Organization?type=ntwk` |   |

#### _include Search Parameter

| | |
| :--- | :--- |
| Organization:coverage-area | `GET [base]/Organization?type=ntwk&_include=Organization:coverage-area` |

#### _revinclude Search Parameter

| | |
| :--- | :--- |
| HealthcareService:network | `GET [base]/Organization?type=ntwk&_revinclude=HealthcareService:network` |
| HealthcareService:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=HealthcareService:new-patient-from-network` |
| InsurancePlan:coverage-network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:coverage-network` |
| InsurancePlan:plan-network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:plan-network` |
| InsurancePlan:network | `GET [base]/Organization?type=ntwk&_revinclude=InsurancePlan:network` |
| Location:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=Location:new-patient-from-network` |
| OrganizationAffiliation:network | `GET [base]/Organization?type=ntwk&_revinclude=OrganizationAffiliation:network` |
| PractitionerRole:network | `GET [base]/Organization?type=ntwk&_revinclude=PractitionerRole:network` |
| PractitionerRole:new-patient-from-network | `GET [base]/Organization?type=ntwk&_revinclude=PractitionerRole:new-patient-from-network` |



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ndh-Network",
  "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-Network",
  "version" : "2.0.0-current",
  "name" : "NdhNetwork",
  "title" : "NDH Network 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 Network refers to a healthcare provider insurance network. A healthcare provider insurance network is an aggregation of organizations and individuals \nthat deliver a set of services across a geography through health insurance products/plans. In the NDH IG, individuals and organizations are represented as participants \nin a National Directory Exchange Network through the practitionerRole and National Directory Exchange-organizationAffiliation resources, respectively.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "ndh-to-plannet-network",
    "uri" : "http://hl7.org/fhir/us/davinci-pdex-plan-net",
    "name" : "NDH to Plan-Net Network Mapping",
    "comment" : "Maps NDH Network profile to the Plan-Net Network profile, noting elements not present in Plan-Net."
  },
  {
    "identity" : "v2",
    "uri" : "http://hl7.org/v2",
    "name" : "HL7 v2 Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "servd",
    "uri" : "http://www.omg.org/spec/ServD/1.0/",
    "name" : "ServD"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Organization",
  "baseDefinition" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization|6.1.0",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Organization",
      "path" : "Organization",
      "mapping" : [{
        "identity" : "ndh-to-plannet-network",
        "map" : "Network",
        "comment" : "Top-level mapping from NDH to Plan-Net"
      }]
    },
    {
      "id" : "Organization.meta.lastUpdated",
      "path" : "Organization.meta.lastUpdated",
      "min" : 1,
      "mapping" : [{
        "identity" : "ndh-to-plannet-network",
        "map" : "Network.meta.lastUpdated",
        "comment" : ", is required in NDH"
      }]
    },
    {
      "id" : "Organization.extension",
      "path" : "Organization.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "Organization.extension:location",
      "path" : "Organization.extension",
      "sliceName" : "location",
      "short" : "Network coverage area",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-location-reference"]
      }]
    },
    {
      "id" : "Organization.extension:organization-period",
      "path" : "Organization.extension",
      "sliceName" : "organization-period",
      "short" : "Valid time period for this Network",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/StructureDefinition/organization-period|4.0.1"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-network",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Organization.extension:verification-status",
      "path" : "Organization.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-network",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Organization.identifier",
      "path" : "Organization.identifier",
      "mapping" : [{
        "identity" : "ndh-to-plannet-network",
        "map" : "Network.identifier"
      }]
    },
    {
      "id" : "Organization.identifier.extension:identifier-status",
      "path" : "Organization.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-network",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Organization.identifier.use",
      "path" : "Organization.identifier.use",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-use|4.0.1"
      }
    },
    {
      "id" : "Organization.identifier.type",
      "path" : "Organization.identifier.type",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/ValueSet/identifier-type|4.0.1"
      }
    },
    {
      "id" : "Organization.identifier.assigner",
      "path" : "Organization.identifier.assigner",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }]
    },
    {
      "id" : "Organization.identifier:NPI",
      "path" : "Organization.identifier",
      "sliceName" : "NPI",
      "max" : "0"
    },
    {
      "id" : "Organization.identifier:CLIA",
      "path" : "Organization.identifier",
      "sliceName" : "CLIA",
      "max" : "0"
    },
    {
      "id" : "Organization.active",
      "path" : "Organization.active",
      "fixedBoolean" : true
    },
    {
      "id" : "Organization.type",
      "path" : "Organization.type",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true,
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/NetworkTypeVS"
      }
    },
    {
      "id" : "Organization.address.state",
      "path" : "Organization.address.state",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state|6.1.0"
      }
    },
    {
      "id" : "Organization.partOf",
      "path" : "Organization.partOf",
      "short" : "The organization that manages this network",
      "min" : 1,
      "type" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy",
          "valueBoolean" : true
        }],
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Organization.contact.telecom.extension:contactpoint-availabletime",
      "path" : "Organization.contact.telecom.extension",
      "sliceName" : "contactpoint-availabletime",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime"]
      }]
    },
    {
      "id" : "Organization.contact.telecom.extension:via-intermediary",
      "path" : "Organization.contact.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" : "Organization.contact.address.state",
      "path" : "Organization.contact.address.state",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state|6.1.0"
      }
    },
    {
      "id" : "Organization.endpoint",
      "path" : "Organization.endpoint",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Endpoint"]
      }],
      "mustSupport" : true,
      "mapping" : [{
        "identity" : "ndh-to-plannet-network",
        "map" : "Network.endpoint",
        "comment" : ", using NDH Endpoint Profile"
      }]
    }]
  }
}

```
