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.16.840.1.113883.4.642.40.43.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.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Extension 0..* Extension NDH Secure Exchange Artifacts
Extension.extension 1..* Extension Extension
Extension.Slices for extension Content/Rules for all slices
Extension.Slices for extension.extension:secureExchangeArtifactsType This element must be supported. 1..1 Extension Secure Artifact Type
Extension.Slices for extension.extension:secureExchangeArtifactsType.extension 0..0 Extension
Extension.Slices for extension.extension:secureExchangeArtifactsType.url 1..1 uri "secureExchangeArtifactsType"
Extension.Slices for extension.extension:secureExchangeArtifactsType.value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
Extension.Slices for extension.extension:certificate This element must be supported. 0..1 Extension Certificate
Extension.Slices for extension.extension:certificate.extension 0..0 Extension
Extension.Slices for extension.extension:certificate.url 1..1 uri "certificate"
Extension.Slices for extension.extension:certificate.value[x] 1..1 base64Binary Value of extension
Extension.Slices for extension.extension:expirationDate 0..1 Extension Expiration Date
Extension.Slices for extension.extension:expirationDate.extension 0..0 Extension
Extension.Slices for extension.extension:expirationDate.url 1..1 uri "expirationDate"
Extension.Slices for extension.extension:expirationDate.value[x] 1..1 dateTime Value of extension
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: doco
Extension 0..* Extension NDH Secure Exchange Artifacts
Extension.id 0..1 string Unique id for inter-element referencing
Extension.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.Slices for extension.extension:secureExchangeArtifactsType This element must be supported. 1..1 Extension Secure Artifact Type
Extension.Slices for extension.extension:secureExchangeArtifactsType.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:secureExchangeArtifactsType.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
Extension.Slices for extension.extension:secureExchangeArtifactsType.url 1..1 uri "secureExchangeArtifactsType"
Extension.Slices for extension.extension:secureExchangeArtifactsType.value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
Extension.Slices for extension.extension:certificate This element must be supported. 0..1 Extension Certificate
Extension.Slices for extension.extension:certificate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:certificate.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
Extension.Slices for extension.extension:certificate.url 1..1 uri "certificate"
Extension.Slices for extension.extension:certificate.value[x] 1..1 base64Binary Value of extension
Extension.Slices for extension.extension:expirationDate 0..1 Extension Expiration Date
Extension.Slices for extension.extension:expirationDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:expirationDate.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
Extension.Slices for extension.extension:expirationDate.url 1..1 uri "expirationDate"
Extension.Slices for extension.extension:expirationDate.value[x] 1..1 dateTime Value of extension
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

This structure is derived from Extension

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 View

This structure is derived from Extension

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

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: doco
Extension 0..* Extension NDH Secure Exchange Artifacts
Extension.id 0..1 string Unique id for inter-element referencing
Extension.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.Slices for extension.extension:secureExchangeArtifactsType This element must be supported. 1..1 Extension Secure Artifact Type
Extension.Slices for extension.extension:secureExchangeArtifactsType.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:secureExchangeArtifactsType.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
Extension.Slices for extension.extension:secureExchangeArtifactsType.url 1..1 uri "secureExchangeArtifactsType"
Extension.Slices for extension.extension:secureExchangeArtifactsType.value[x] 1..1 CodeableConcept Value of extension
Binding: Secure Exchange Artifacts Value Set (extensible)
Extension.Slices for extension.extension:certificate This element must be supported. 0..1 Extension Certificate
Extension.Slices for extension.extension:certificate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:certificate.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
Extension.Slices for extension.extension:certificate.url 1..1 uri "certificate"
Extension.Slices for extension.extension:certificate.value[x] 1..1 base64Binary Value of extension
Extension.Slices for extension.extension:expirationDate 0..1 Extension Expiration Date
Extension.Slices for extension.extension:expirationDate.id 0..1 string Unique id for inter-element referencing
Extension.Slices for extension.extension:expirationDate.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
Extension.Slices for extension.extension:expirationDate.url 1..1 uri "expirationDate"
Extension.Slices for extension.extension:expirationDate.value[x] 1..1 dateTime Value of extension
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

This structure is derived from Extension

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.