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 Secure Exchange Artifacts

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts Version: 1.0.0-ballot
Active as of 2024-06-17 Computable Name: SecureExchangeArtifacts

This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate’s current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.

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: This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.

  • secureExchangeArtifactsType: CodeableConcept: An Extension
  • certificate: base64Binary: An Extension
  • expirationDate: dateTime: An Extension

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NDH Secure Exchange Artifacts
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:secureExchangeArtifactsType S 1..1 Extension Secure Artifact Type
..... extension 0..0
..... url 1..1 uri "secureExchangeArtifactsType"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
.... extension:certificate S 0..1 Extension Certificate
..... extension 0..0
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... extension 0..0
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 dateTime Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NDH Secure Exchange Artifacts
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:secureExchangeArtifactsType S 1..1 Extension Secure Artifact Type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "secureExchangeArtifactsType"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
.... extension:certificate S 0..1 Extension Certificate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 dateTime Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the certificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process in digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. The expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. This extension should be used when the standard for exchange requires the discovery of the public key.

  • secureExchangeArtifactsType: CodeableConcept: An Extension
  • certificate: base64Binary: An Extension
  • expirationDate: dateTime: An Extension

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NDH Secure Exchange Artifacts
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:secureExchangeArtifactsType S 1..1 Extension Secure Artifact Type
..... extension 0..0
..... url 1..1 uri "secureExchangeArtifactsType"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
.... extension:certificate S 0..1 Extension Certificate
..... extension 0..0
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... extension 0..0
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 dateTime Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension NDH Secure Exchange Artifacts
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:secureExchangeArtifactsType S 1..1 Extension Secure Artifact Type
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "secureExchangeArtifactsType"
..... value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
.... extension:certificate S 0..1 Extension Certificate
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 dateTime Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:secureExchangeArtifactsType.value[x]extensibleNdhSecureExchangeArtifactsVS (a valid code from NDH Secure Exchange Artifacts Code System)
http://hl7.org/fhir/us/ndh/ValueSet/NdhSecureExchangeArtifactsVS
from this IG

Notes:

In a point-to-point security connection, such as payer-to-payer data exchange via Mutual TLS (mTLS), possessing a public certificate is essential to establish the mTLS connection.