National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build 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 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

Extension: NDH Secure Exchange Artifacts

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts Version: 2.0.0-current
Standards status: Trial-use Maturity Level: 4 Computable Name: SecureExchangeArtifacts
Other Identifiers: OID:2.999.1.2.3.4.42.35

This extension enables NDH to publish key secure-exchange artifacts needed for trust establishment, including artifact type, certificate payload, and expiration, with extensible binding to NdhSecureExchangeArtifactsVS for interoperable certificate-discovery workflows; it is used in Endpoint.

Context of Use

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

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Extension
..... 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 Extension
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... extension 0..0 Extension
..... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:secureExchangeArtifactsType.​value[x] Base extensible Secure Exchange Artifacts Value Set 📦2.0.0-current This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Extension
Slice: Unordered, Open by value:url
..... 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 Extension
Slice: Unordered, Open by value:url
..... 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 Extension
Slice: Unordered, Open by value:url
..... 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

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:secureExchangeArtifactsType.​value[x] Base extensible Secure Exchange Artifacts Value Set 📦2.0.0-current This IG

Constraints

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

Complex Extension: This extension enables NDH to publish key secure-exchange artifacts needed for trust establishment, including artifact type, certificate payload, and expiration, with extensible binding to NdhSecureExchangeArtifactsVS for interoperable certificate-discovery workflows; it is used in Endpoint.

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

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Extension
..... 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 Extension
..... url 1..1 uri "certificate"
..... value[x] 1..1 base64Binary Value of extension
.... extension:expirationDate 0..1 Extension Expiration Date
..... extension 0..0 Extension
..... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Extension.extension:secureExchangeArtifactsType.​value[x] Base extensible Secure Exchange Artifacts Value Set 📦2.0.0-current This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. 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 Extension
Slice: Unordered, Open by value:url
..... 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 Extension
Slice: Unordered, Open by value:url
..... 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 Extension
Slice: Unordered, Open by value:url
..... 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

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:secureExchangeArtifactsType.​value[x] Base extensible Secure Exchange Artifacts Value Set 📦2.0.0-current This IG

Constraints

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

Complex Extension: This extension enables NDH to publish key secure-exchange artifacts needed for trust establishment, including artifact type, certificate payload, and expiration, with extensible binding to NdhSecureExchangeArtifactsVS for interoperable certificate-discovery workflows; it is used in Endpoint.

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

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

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.