# NDH Secure Exchange Artifacts - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0-current

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **NDH Secure Exchange Artifacts**

## 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](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 4 | *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**

**Usage info**

**Usages:**

* Use this Extension: [NDH Endpoint Profile](StructureDefinition-ndh-Endpoint.md)
* Examples for this Extension: [Endpoint for Acme of CT Portal](Endpoint-AcmeOfCTPortalEndpoint.md) and [Endpoint for Coordination of Care](Endpoint-CoordinationOfCareEndpoint.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.us.ndh|current/StructureDefinition/base-ext-secureExchangeArtifacts)

### Formal Views of Extension Content

 [Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-base-ext-secureExchangeArtifacts.csv), [Excel](StructureDefinition-base-ext-secureExchangeArtifacts.xlsx), [Schematron](StructureDefinition-base-ext-secureExchangeArtifacts.sch) 

#### Terminology Bindings

#### Constraints

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



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "base-ext-secureExchangeArtifacts",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 4,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts",
  "version" : "2.0.0-current",
  "name" : "SecureExchangeArtifacts",
  "title" : "NDH Secure Exchange Artifacts",
  "status" : "active",
  "date" : "2026-03-23T21:58:05+00:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [{
    "name" : "HL7 International / Patient Administration",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/pafm"
    },
    {
      "system" : "email",
      "value" : "pafm@lists.hl7.org"
    }]
  }],
  "description" : "This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the \ncertificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process \nin digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. \nThe expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. \nThis extension should be used when the standard for exchange requires the discovery of the public key.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "complex-type",
  "abstract" : false,
  "context" : [{
    "type" : "element",
    "expression" : "Endpoint"
  }],
  "type" : "Extension",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Extension",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Extension",
      "path" : "Extension",
      "short" : "NDH Secure Exchange Artifacts",
      "definition" : "This extension is designed to store information about the type of public certificate, the public certificate itself, and the expiration date of the \ncertificate. Public certificates, issued by Certificate Authorities, are intended for sharing and inspection by others as part of the trust and verification process \nin digital communications. Each certificate includes an expiration date, which is a crucial piece of information easily accessible to anyone examining the certificate. \nThe expiration date plays a significant role in validating the certificate's current validity and in maintaining security within digital communications. \nThis extension should be used when the standard for exchange requires the discovery of the public key."
    },
    {
      "id" : "Extension.extension",
      "path" : "Extension.extension",
      "min" : 1
    },
    {
      "id" : "Extension.extension:secureExchangeArtifactsType",
      "path" : "Extension.extension",
      "sliceName" : "secureExchangeArtifactsType",
      "short" : "Secure Artifact Type",
      "min" : 1,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Extension.extension:secureExchangeArtifactsType.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:secureExchangeArtifactsType.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "secureExchangeArtifactsType"
    },
    {
      "id" : "Extension.extension:secureExchangeArtifactsType.value[x]",
      "path" : "Extension.extension.value[x]",
      "min" : 1,
      "type" : [{
        "code" : "CodeableConcept"
      }],
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/NdhSecureExchangeArtifactsVS"
      }
    },
    {
      "id" : "Extension.extension:certificate",
      "path" : "Extension.extension",
      "sliceName" : "certificate",
      "short" : "Certificate",
      "min" : 0,
      "max" : "1",
      "mustSupport" : true
    },
    {
      "id" : "Extension.extension:certificate.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:certificate.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "certificate"
    },
    {
      "id" : "Extension.extension:certificate.value[x]",
      "path" : "Extension.extension.value[x]",
      "min" : 1,
      "type" : [{
        "code" : "base64Binary"
      }]
    },
    {
      "id" : "Extension.extension:expirationDate",
      "path" : "Extension.extension",
      "sliceName" : "expirationDate",
      "short" : "Expiration Date",
      "min" : 0,
      "max" : "1"
    },
    {
      "id" : "Extension.extension:expirationDate.extension",
      "path" : "Extension.extension.extension",
      "max" : "0"
    },
    {
      "id" : "Extension.extension:expirationDate.url",
      "path" : "Extension.extension.url",
      "fixedUri" : "expirationDate"
    },
    {
      "id" : "Extension.extension:expirationDate.value[x]",
      "path" : "Extension.extension.value[x]",
      "min" : 1,
      "type" : [{
        "code" : "dateTime"
      }]
    },
    {
      "id" : "Extension.url",
      "path" : "Extension.url",
      "fixedUri" : "http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-secureExchangeArtifacts"
    },
    {
      "id" : "Extension.value[x]",
      "path" : "Extension.value[x]",
      "max" : "0"
    }]
  }
}

```
