National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build
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-security-details | Version: 2.0.0-current | ||||
| Standards status: Trial-use | Maturity Level: 4 | Computable Name: SecurityDetails | |||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.43.42.36 | |||||
This extension enables NDH to communicate endpoint trust-framework security context, including framework type, qualifiers, signed artifacts, and public certificates, with extensible TrustFrameworkTypeVS binding to support consistent policy interpretation across trust communities; it is used in Endpoint.
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.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:  |
|---|---|---|---|---|
  Extension |
0..* | Extension | NDH Security Details | |
  extension |
1..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:trustFrameworkType |
1..1 | Extension | Trust Framework Type | |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "trustFrameworkType" | |
  value[x] |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
| extension:qualifier |
0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community. Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "qualifier" | |
 value[x] |
1..1 | string | Value of extension | |
| extension:signedArtifact |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved in the data exchange is legitimate and that their digital identity has been properly validated. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "signedArtifact" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
 extension:publicCertificate |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of online interactions. | |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "publicCertificate" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
 value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
 Extension |
0..* | Extension | NDH Security Details | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:trustFrameworkType |
1..1 | Extension | Trust Framework Type | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "trustFrameworkType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
| extension:qualifier |
0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community.
Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "qualifier" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:signedArtifact |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that
signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved
in the data exchange is legitimate and that their digital identity has been properly validated. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "signedArtifact" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| extension:publicCertificate |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish
secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a
secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of
online interactions. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "publicCertificate" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Extension
Summary
Complex Extension: This extension enables NDH to communicate endpoint trust-framework security context, including framework type, qualifiers, signed artifacts, and public certificates, with extensible TrustFrameworkTypeVS binding to support consistent policy interpretation across trust communities; it is used in Endpoint.
Maturity: 4
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NDH Security Details | |
| extension |
1..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:trustFrameworkType |
1..1 | Extension | Trust Framework Type | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "trustFrameworkType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
| extension:qualifier |
0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community. Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "qualifier" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:signedArtifact |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved in the data exchange is legitimate and that their digital identity has been properly validated. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "signedArtifact" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| extension:publicCertificate |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of online interactions. | |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "publicCertificate" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | NDH Security Details | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:trustFrameworkType |
1..1 | Extension | Trust Framework Type | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "trustFrameworkType" | |
| value[x] |
0..1 | CodeableConcept | Value of extension Binding: Trust Framework Type Value Set (extensible) | |
| extension:qualifier |
0..1 | Extension | A qualifier associates with an endpoint to provide additional context or information about that endpoint in a trust framework community.
Qualifiers are used to help other members of the community understand the capabilities, compliance status, or other relevant characteristics of an endpoint. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "qualifier" | |
| value[x] |
1..1 | string | Value of extension | |
| extension:signedArtifact |
0..1 | Extension | By utilizing a signed artifact, you can identify which Certificate Authority has issued the certificate for the entity that
signed the artifact. Verifying the issuing Certificate Authority is crucial because it adds an additional layer of trust and security, ensuring that the entity involved
in the data exchange is legitimate and that their digital identity has been properly validated. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "signedArtifact" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| extension:publicCertificate |
0..1 | Extension | Public certificates help in affirming that an entity is indeed who they claim to be. These certificates are used to establish
secure connections via the Mutual TLS (Transport Layer Security) protocol. Public certificates issued by Certificate Authorities are fundamental in establishing a
secure and trustworthy digital environment. They enable secure communication, ensure data integrity, and facilitate authentication and trust across a wide range of
online interactions. | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | Extension Slice: Unordered, Open by value:url Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | ||
| url |
1..1 | uri | "publicCertificate" | |
| value[x] |
1..1 | base64Binary | Value of extension | |
| url |
1..1 | uri | "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-security-details" | |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:trustFrameworkType.value[x] | Base | extensible | Trust Framework Type Value Set | 📦2.0.0-current | This IG |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from Extension
Summary
Complex Extension: This extension enables NDH to communicate endpoint trust-framework security context, including framework type, qualifiers, signed artifacts, and public certificates, with extensible TrustFrameworkTypeVS binding to support consistent policy interpretation across trust communities; it is used in Endpoint.
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 International / Patient Administration.
Package hl7.fhir.us.ndh#2.0.0-current based on FHIR 4.0.1.
Generated
2026-10-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change