National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism | Version: 2.0.0-current | ||||
| Standards status: Trial-use Active as of 2026-04-22 | Maturity Level: 4 | Computable Name: EndpointAccessControlMechanism | |||
Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems.
They standardize methods to secure endpoints, ensuring interoperability and security.
In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example,
the Unified Data Access Profile (UDAP) uses JWT access tokens.
Context of Use
This extension may be used on the following element(s)
Endpoint
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Endpoint Access Control Mechanism | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism" | |
![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | extensible | Endpoint Access Control Mechanism Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Endpoint Access Control Mechanism | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism" | |
![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | extensible | Endpoint Access Control Mechanism Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Simple Extension with the type CodeableConcept: Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems.
They standardize methods to secure endpoints, ensuring interoperability and security.
In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example,
the Unified Data Access Profile (UDAP) uses JWT access tokens.
Maturity: 4
Differential ViewDifferential View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Endpoint Access Control Mechanism | |
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism" | |
![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | extensible | Endpoint Access Control Mechanism Value Set | 📦2.0.0-current | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Extension | NDH Endpoint Access Control Mechanism | |
![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | ||
![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-endpointAccessControlMechanism" | |
![]() ![]() |
1..1 | CodeableConcept | Value of extension Binding: Endpoint Access Control Mechanism Value Set (extensible) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.value[x] | Base | extensible | Endpoint Access Control Mechanism Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Simple Extension with the type CodeableConcept: Endpoint access control mechanisms protect and manage access to healthcare endpoints, ensuring secure data exchange between systems.
They standardize methods to secure endpoints, ensuring interoperability and security.
In certain use cases requiring system scalability and flexibility, different profiles may be utilized based on the chosen access control mechanism. For example,
the Unified Data Access Profile (UDAP) uses JWT access tokens.
Maturity: 4
Other representations of profile: CSV, Excel, Schematron