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

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

## Resource Profile: NDH Endpoint Profile 

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

 
The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging. 

### Scope and Usage

The endpoint resource provides technical specifications for connecting to a specific location to transmit and retrieve information securely and accurately, according to the requirements of the endpoint owner. Unlike the CapabilityStatement, which describes the current system, the endpoint resource pertains to another system, potentially external to the current one. The endpoint could refer to locally hosted, regional, or national services.

Endpoint resources can be used to identify the location of endpoint details for various purposes, including referral requests to Organizations, OrganizationAffiliation, Locations, Practitioners, PractitionerRole or HealthcareServices. These resources can provide information on where to direct the referral request for efficient and effective care coordination.

Endpoint resources can also be useful for other purposes, such as facilitating preauthorization between insurance plans, network, and providers. They can be used to exchange information between care team members, allowing for seamless collaboration and communication among different healthcare providers involved in a patient's care. By utilizing endpoint resources, relevant information can be shared securely and efficiently, helping to improve the quality of care and patient outcomes.

### Boundaries and Relationships

#### CapabilityStatement vs Endpoint

The CapabilityStatement and the endpoint resource serve distinct purposes. While the CapabilityStatement describes the complete capability of a server, including the metadata of a specific server, the endpoint resource outlines the technical specifications for establishing connections and the intended purposes of such connections. The endpoint resource may only represent a small fraction of the server's capabilities, and it may not even function as a FHIR endpoint.

**Usages:**

* Refer to this Profile: [NDH Endpoint Reference](StructureDefinition-base-ext-endpoint-reference.md), [NDH HealthcareService Profile](StructureDefinition-ndh-HealthcareService.md), [NDH InsurancePlan Profile](StructureDefinition-ndh-InsurancePlan.md), [NDH Location Profile](StructureDefinition-ndh-Location.md)... Show 4 more, [NDH Network Profile](StructureDefinition-ndh-Network.md), [NDH Organization Profile](StructureDefinition-ndh-Organization.md), [NDH OrganizationAffiliation Profile](StructureDefinition-ndh-OrganizationAffiliation.md) and [NDH PractitionerRole](StructureDefinition-ndh-PractitionerRole.md)
* Examples for this Profile: [Endpoint for Acme of CT Portal](Endpoint-AcmeOfCTPortalEndpoint.md), [Endpoint for Coordination of Care](Endpoint-CoordinationOfCareEndpoint.md), [Endpoint for DirectTrust](Endpoint-DirectTrustEndpointAdtNotifications.md), [Endpoint for DirectTrust](Endpoint-DirectTrustEndpointReferrals.md)... Show 3 more, [Hans Solo Endpoint for DirectTrust](Endpoint-HansSoloDirectTrustEndpointReferrals.md), [Hans Solo Endpoint for Patient Access](Endpoint-HansSoloPatientAccessEndpoint.md) and [Endpoint for IHE](Endpoint-IheEndpoint.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-Endpoint)

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

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

| | | |
| :--- | :--- | :--- |
| [access-control-mechanism](SearchParameter-endpoint-access-control-mechanism.md) | token | `GET [base]/Endpoint?endpoint-access-control-mechanism=mutual-tls` |
| [dynamic-registration-trust-profile](SearchParameter-endpoint-dynamic-registration-trust-profile.md) | token | `GET [base]/Endpoint?dynamic-registration-trust-profile=udap` |
| [ihe-connection-type](SearchParameter-endpoint-ihe-connection-type.md) | token | `GET [base]/Endpoint?ihe-connection-type=XCPD-InitGateway-PatientDiscovery-AsyncResponse` |
| [trust-framework-type](SearchParameter-endpoint-trust-framework-type.md) | token | `GET [base]/Endpoin?trust-framework-type=DirectTrust` |
| [verification-status](SearchParameter-verification-status.md) | token | `GET [base]/Endpoint?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)
* [Endpoint Search Parameter from Registry](https://hl7.org/fhir/R4/endpoint.html#search)

| | | |
| :--- | :--- | :--- |
| connection-type | token | `GET [base]/Endpoint?connection-type=hl7-fhir-rest` |
| identifier | token | `GET [base]/Endpoint?identifier={system}|{value}` |
| organization | reference | `GET [base]/Endpoint?organization.name=Hartford General Hospital` |
| status | token | `GET [base]/Endpoint?status=active` |

#### _include Search Parameter

| | |
| :--- | :--- |
| Endpoint:organization | `GET [base]/Endpoint?_include=Endpoint:organization` |

#### _revinclude Search parameter

| |
| :--- |
| HealthcareService:endpoint |
| InsurancePlan:endpoint |
| Location:endpoint |
| Organization:endpoint |
| OrganizationAffiliation:endpoint |
| Practitioner: endpoint |
| PractitionerRole:endpoint |
| VerifcationResult:target |

#### 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.



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ndh-Endpoint",
  "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-Endpoint",
  "version" : "2.0.0-current",
  "name" : "NdhEndpoint",
  "title" : "NDH Endpoint Profile",
  "status" : "active",
  "date" : "2026-03-30T14:03:58+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" : "The technical details of an endpoint that can be used for electronic services, such as a portal or FHIR REST services, messaging or operations, or DIRECT messaging.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "ndh-to-plannet-endpoint",
    "uri" : "http://hl7.org/fhir/us/davinci-pdex-plan-net",
    "name" : "NDH to Plan-Net Endpoint Mapping",
    "comment" : "Maps NDH Endpoint profile to the Plan-Net Endpoint 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" : "Endpoint",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Endpoint",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Endpoint",
      "path" : "Endpoint",
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint",
        "comment" : "Top-level mapping from NDH to Plan-Net"
      }]
    },
    {
      "id" : "Endpoint.meta.lastUpdated",
      "path" : "Endpoint.meta.lastUpdated",
      "min" : 1,
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.meta.lastUpdated",
        "comment" : ", is required in NDH"
      }]
    },
    {
      "id" : "Endpoint.extension",
      "path" : "Endpoint.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "ordered" : false,
        "rules" : "open"
      }
    },
    {
      "id" : "Endpoint.extension:implementation-guide",
      "path" : "Endpoint.extension",
      "sliceName" : "implementation-guide",
      "short" : "Implementation guide supported",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-implementation-guide"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:secure-exchange-artifacts",
      "path" : "Endpoint.extension",
      "sliceName" : "secure-exchange-artifacts",
      "short" : "Secure Exchange Artifacts store information about the type of public certificate, the certificate itself, \nand its expiration date. Issued by Certificate Authorities, public certificates are meant for sharing and verification in digital communications. Each certificate \nincludes an expiration date, essential for validating its current validity and maintaining security. This extension is used when the exchange standard requires the discovery of the public key.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:trust-framework",
      "path" : "Endpoint.extension",
      "sliceName" : "trust-framework",
      "short" : "A trust framework is a structured set of rules, policies, protocols, and standards that define how trust is established, managed, \nand maintained between different entities (such as organizations, systems, or users) involved in the exchange of healthcare information. It provides the guidelines and \ntechnical specifications that ensure secure, interoperable, and reliable data exchange.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:dynamic-registration",
      "path" : "Endpoint.extension",
      "sliceName" : "dynamic-registration",
      "short" : "Dynamic registration within a trust framework refers to a process where clients can register with a server or service provider \ndynamically and securely at runtime, rather than being pre-registered manually. This approach is often used in environments where scalability, flexibility, and security \nare crucial. Currently, dynamic registration is used in SMART and UDAP.",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-dynamicRegistration"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:associated-servers",
      "path" : "Endpoint.extension",
      "sliceName" : "associated-servers",
      "short" : "Store information about servers that may be associated with the current endpoint. It defines a set of servers that could be linked \nto this endpoint. If a server is associated, its type and URL will be included",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-associatedServers"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:access-control-mechanism",
      "path" : "Endpoint.extension",
      "sliceName" : "access-control-mechanism",
      "short" : "Access control mechanisms are designed to protect and manage access to healthcare endpoints, ensuring that data exchange \nbetween systems adheres to specific security protocols when needed.",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:endpoint-rank",
      "path" : "Endpoint.extension",
      "sliceName" : "endpoint-rank",
      "short" : "Preferred order for connecting to the endpoint",
      "min" : 0,
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-rank"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:ihe-specific-connection-type",
      "path" : "Endpoint.extension",
      "sliceName" : "ihe-specific-connection-type",
      "short" : "IHE Specific Connection Type",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-ihe-specific-connection-type"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:verification-status",
      "path" : "Endpoint.extension",
      "sliceName" : "verification-status",
      "short" : "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-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:testing-certification",
      "path" : "Endpoint.extension",
      "sliceName" : "testing-certification",
      "short" : "Endpoint Testing Certification",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-testing-certification"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.extension:environmentType",
      "path" : "Endpoint.extension",
      "sliceName" : "environmentType",
      "short" : "The type of environment exposed at this endpoint",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpoint-environment-type"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.identifier",
      "path" : "Endpoint.identifier",
      "mustSupport" : true,
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.identifier"
      }]
    },
    {
      "id" : "Endpoint.identifier.extension:identifier-status",
      "path" : "Endpoint.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-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.identifier.assigner",
      "path" : "Endpoint.identifier.assigner",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.identifier.assigner",
        "comment" : ", using NDH Organization Porfile"
      }]
    },
    {
      "id" : "Endpoint.status",
      "path" : "Endpoint.status",
      "fixedCode" : "active",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.connectionType",
      "path" : "Endpoint.connectionType",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/EndpointConnectionTypeVS"
      }
    },
    {
      "id" : "Endpoint.name",
      "path" : "Endpoint.name",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.managingOrganization",
      "path" : "Endpoint.managingOrganization",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }],
      "mustSupport" : true,
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.managingOrganization",
        "comment" : ", using NDH Organization Profile"
      }]
    },
    {
      "id" : "Endpoint.contact.extension:contactpoint-availabletime",
      "path" : "Endpoint.contact.extension",
      "sliceName" : "contactpoint-availabletime",
      "min" : 0,
      "max" : "*",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-contactpoint-availabletime"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.contact.extension:via-intermediary",
      "path" : "Endpoint.contact.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"]
      }],
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Not in Plan-Net",
        "comment" : ", NDH-specific"
      }]
    },
    {
      "id" : "Endpoint.contact.system",
      "path" : "Endpoint.contact.system",
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.contact.system"
      }]
    },
    {
      "id" : "Endpoint.contact.value",
      "path" : "Endpoint.contact.value",
      "mapping" : [{
        "identity" : "ndh-to-plannet-endpoint",
        "map" : "Endpoint.contact.value"
      }]
    },
    {
      "id" : "Endpoint.payloadType",
      "path" : "Endpoint.payloadType",
      "max" : "1",
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/EndpointPayloadTypeVS"
      }
    },
    {
      "id" : "Endpoint.payloadMimeType",
      "path" : "Endpoint.payloadMimeType",
      "mustSupport" : true,
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/EndpointFhirMimeTypeVS"
      }
    }]
  }
}

```
