National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

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 1.0.0-ballot 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

Extension: NDH Trust Framework

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework Version: 1.0.0-ballot
Active as of 2024-03-28 Computable Name: TrustFramework

A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).

Context of Use

This extension may be used on the following element(s):

  • Element ID Endpoint

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Complex Extension: A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).

  • trustFrameworkType: CodeableConcept: An Extension
  • qualifier: string: An Extension
  • signedArtifact: base64Binary: An Extension
  • publicCertificate: base64Binary: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNDH Trust Framework
... extension 1..*ExtensionExtension
... extension:trustFrameworkType S1..1ExtensionTrust Framework Type
.... extension 0..0
.... url 1..1uri"trustFrameworkType"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Trust Framework Type Value Set (extensible)
... extension:qualifier S0..1ExtensionA 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
.... url 1..1uri"qualifier"
.... value[x] 1..1stringValue of extension
.... extension 0..0
.... url 1..1uri"signedArtifact"
.... value[x] 1..1base64BinaryValue of extension
... extension:publicCertificate 0..1ExtensionPublic 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
.... url 1..1uri"publicCertificate"
.... value[x] 1..1base64BinaryValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNDH Trust Framework
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:trustFrameworkType S1..1ExtensionTrust Framework Type
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"trustFrameworkType"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Trust Framework Type Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"qualifier"
.... value[x] 1..1stringValue of extension
... extension:signedArtifact 0..1ExtensionBy 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..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"signedArtifact"
.... value[x] 1..1base64BinaryValue of extension
... extension:publicCertificate 0..1ExtensionPublic 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..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"publicCertificate"
.... value[x] 1..1base64BinaryValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: A trust framework typically requires the use of signed artifacts and public certificates to ensure security, integrity, and trust in digital communications and transactions. For trust frameworks that use private PKI there is no need to use this extension unless the goals is to provide access to endpoints via the endpoint reference on any of the relevant resources (e.g., careteam, healthcareService).

  • trustFrameworkType: CodeableConcept: An Extension
  • qualifier: string: An Extension
  • signedArtifact: base64Binary: An Extension
  • publicCertificate: base64Binary: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNDH Trust Framework
... extension 1..*ExtensionExtension
... extension:trustFrameworkType S1..1ExtensionTrust Framework Type
.... extension 0..0
.... url 1..1uri"trustFrameworkType"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Trust Framework Type Value Set (extensible)
... extension:qualifier S0..1ExtensionA 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
.... url 1..1uri"qualifier"
.... value[x] 1..1stringValue of extension
.... extension 0..0
.... url 1..1uri"signedArtifact"
.... value[x] 1..1base64BinaryValue of extension
... extension:publicCertificate 0..1ExtensionPublic 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
.... url 1..1uri"publicCertificate"
.... value[x] 1..1base64BinaryValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionNDH Trust Framework
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:trustFrameworkType S1..1ExtensionTrust Framework Type
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"trustFrameworkType"
.... value[x] 0..1CodeableConceptValue of extension
Binding: Trust Framework Type Value Set (extensible)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"qualifier"
.... value[x] 1..1stringValue of extension
... extension:signedArtifact 0..1ExtensionBy 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..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"signedArtifact"
.... value[x] 1..1base64BinaryValue of extension
... extension:publicCertificate 0..1ExtensionPublic 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..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"publicCertificate"
.... value[x] 1..1base64BinaryValue of extension
... url 1..1uri"http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-trustFramework"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:trustFrameworkType.value[x]extensibleTrustFrameworkTypeVS (a valid code from Trust FrameworkType Code System)
http://hl7.org/fhir/us/ndh/ValueSet/TrustFrameworkTypeVS
from this IG

Notes:

For establishing a peer-to-peer connection, compatibility across various trust frameworks is essential. For instance, when considering the aspect of the CareQuality, it’s important to identify the specific endpoint involved. Traditionally, for such interactions, an organization might direct you to use the Health Information Exchange (HIE). However, in the current scenario, it might be more appropriate to utilize the Integrating the Healthcare Enterprise (IHE) framework for these specific needs. This approach is particularly relevant because some required connections may not be within the organization but might exist as non-HIE endpoints. When operating within a trusted framework, it becomes crucial to know which organizations are part of this trust network and the corresponding endpoints for communication. This understanding acknowledges that while frameworks like TEFCA (Trusted Exchange Framework and Common Agreement) are significant, there are other external frameworks and connections to consider. Therefore, we should focus on these three aspects: cross-framework compatibility, identifying endpoints within the trust framework, and acknowledging the existence of external networks beyond TEFCA.