National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

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

## : Endpoint Access Control Mechanism Code System - XML Representation

Page standards status: Trial-use | Maturity Level: 4

Raw xml | Download

    <CodeSystem xmlns="http://hl7.org/fhir">
      <id value="NdhEndpointAccessControlMechanismCS"/>
      <text>
        <status value="generated"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CodeSystem NdhEndpointAccessControlMechanismCS</b></p><a name="NdhEndpointAccessControlMechanismCS"> </a><a name="hcNdhEndpointAccessControlMechanismCS"> </a><p>This case-sensitive code system <code>http://hl7.org/fhir/us/ndh/CodeSystem/NdhEndpointAccessControlMechanismCS</code> defines the following codes:</p><table class="codes"><tr><td style="white-space:nowrap"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td></tr><tr><td style="white-space:nowrap">public<a name="NdhEndpointAccessControlMechanismCS-public"> </a></td><td>Public</td><td>Public access without any specific access control.</td></tr><tr><td style="white-space:nowrap">OAuth<a name="NdhEndpointAccessControlMechanismCS-OAuth"> </a></td><td>OAuth</td><td>OAuth (unspecified version see oauth.net).</td></tr><tr><td style="white-space:nowrap">SMART-on-FHIR<a name="NdhEndpointAccessControlMechanismCS-SMART-on-FHIR"> </a></td><td>SMART-on-FHIR</td><td>OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org/).</td></tr><tr><td style="white-space:nowrap">NTLM<a name="NdhEndpointAccessControlMechanismCS-NTLM"> </a></td><td>NTLM</td><td>Microsoft NTLM Authentication.</td></tr><tr><td style="white-space:nowrap">basic<a name="NdhEndpointAccessControlMechanismCS-basic"> </a></td><td>Basic</td><td>Basic authentication defined in HTTP specification.</td></tr><tr><td style="white-space:nowrap">Kerberos<a name="NdhEndpointAccessControlMechanismCS-Kerberos"> </a></td><td>Kerberos</td><td>see http://www.ietf.org/rfc/rfc4120.txt.</td></tr><tr><td style="white-space:nowrap">Certificates<a name="NdhEndpointAccessControlMechanismCS-Certificates"> </a></td><td>Certificates</td><td>SSL where client must have a certificate registered with the server.</td></tr><tr><td style="white-space:nowrap">opaque-access-token<a name="NdhEndpointAccessControlMechanismCS-opaque-access-token"> </a></td><td>Opaque Access Token</td><td>Uses an opaque token for access control, which is a token whose structure is not visible or meaningful to the client.</td></tr><tr><td style="white-space:nowrap">jwt-access-token<a name="NdhEndpointAccessControlMechanismCS-jwt-access-token"> </a></td><td>JWT Access Token</td><td>Uses a JSON Web Token (JWT) for access control, which is a compact, URL-safe means of representing claims to be transferred between two parties.</td></tr><tr><td style="white-space:nowrap">mutual-tls<a name="NdhEndpointAccessControlMechanismCS-mutual-tls"> </a></td><td>Mutual TLS</td><td>Uses mutual Transport Layer Security (TLS) where both client and server authenticate each other using certificates.</td></tr><tr><td style="white-space:nowrap">wss-saml-token<a name="NdhEndpointAccessControlMechanismCS-wss-saml-token"> </a></td><td>WSS SAML Token</td><td>Uses a Security Assertion Markup Language (SAML) token within the Web Services Security (WSS) framework for access control.</td></tr><tr><td style="white-space:nowrap">wss-username-token<a name="NdhEndpointAccessControlMechanismCS-wss-username-token"> </a></td><td>WSS User Name Token</td><td>Uses a username token within the WSS framework for access control.</td></tr><tr><td style="white-space:nowrap">wss-kerberos-token<a name="NdhEndpointAccessControlMechanismCS-wss-kerberos-token"> </a></td><td>WSS Kerberos Token</td><td>Uses a Kerberos token within the WSS framework for access control.</td></tr><tr><td style="white-space:nowrap">wss-x509-token<a name="NdhEndpointAccessControlMechanismCS-wss-x509-token"> </a></td><td>WSS X509 Token</td><td>Uses an X.509 certificate token within the WSS framework for access control.</td></tr><tr><td style="white-space:nowrap">wss-custom-token<a name="NdhEndpointAccessControlMechanismCS-wss-custom-token"> </a></td><td>WSS Custom Token</td><td>Uses a custom token within the WSS framework for access control.</td></tr></table></div>
      </text>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
        <valueCode value="pa"/>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
        <valueInteger value="4">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"/>
          </extension>
        </valueInteger>
      </extension>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
        <valueCode value="trial-use">
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
            <valueCanonical
                            value="http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"/>
          </extension>
        </valueCode>
      </extension>
      <url
           value="http://hl7.org/fhir/us/ndh/CodeSystem/NdhEndpointAccessControlMechanismCS"/>
      <version value="2.0.0-current"/>
      <name value="NdhEndpointAccessControlMechanismCS"/>
      <title value="Endpoint Access Control Mechanism Code System"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2026-03-30T14:03:58+00:00"/>
      <publisher value="HL7 International / Patient Administration"/>
      <contact>
        <name value="HL7 International / Patient Administration"/>
        <telecom>
          <system value="url"/>
          <value value="http://www.hl7.org/Special/committees/pafm"/>
        </telecom>
        <telecom>
          <system value="email"/>
          <value value="pafm@lists.hl7.org"/>
        </telecom>
      </contact>
      <description value="Endpoint Access Control Mechanism"/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="US"/>
          <display value="United States of America"/>
        </coding>
      </jurisdiction>
      <caseSensitive value="true"/>
      <content value="complete"/>
      <count value="15"/>
      <concept>
        <code value="public"/>
        <display value="Public"/>
        <definition value="Public access without any specific access control."/>
      </concept>
      <concept>
        <code value="OAuth"/>
        <display value="OAuth"/>
        <definition value="OAuth (unspecified version see oauth.net)."/>
      </concept>
      <concept>
        <code value="SMART-on-FHIR"/>
        <display value="SMART-on-FHIR"/>
        <definition
                    value="OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org/)."/>
      </concept>
      <concept>
        <code value="NTLM"/>
        <display value="NTLM"/>
        <definition value="Microsoft NTLM Authentication."/>
      </concept>
      <concept>
        <code value="basic"/>
        <display value="Basic"/>
        <definition value="Basic authentication defined in HTTP specification."/>
      </concept>
      <concept>
        <code value="Kerberos"/>
        <display value="Kerberos"/>
        <definition value="see http://www.ietf.org/rfc/rfc4120.txt."/>
      </concept>
      <concept>
        <code value="Certificates"/>
        <display value="Certificates"/>
        <definition
                    value="SSL where client must have a certificate registered with the server."/>
      </concept>
      <concept>
        <code value="opaque-access-token"/>
        <display value="Opaque Access Token"/>
        <definition
                    value="Uses an opaque token for access control, which is a token whose structure is not visible or meaningful to the client."/>
      </concept>
      <concept>
        <code value="jwt-access-token"/>
        <display value="JWT Access Token"/>
        <definition
                    value="Uses a JSON Web Token (JWT) for access control, which is a compact, URL-safe means of representing claims to be transferred between two parties."/>
      </concept>
      <concept>
        <code value="mutual-tls"/>
        <display value="Mutual TLS"/>
        <definition
                    value="Uses mutual Transport Layer Security (TLS) where both client and server authenticate each other using certificates."/>
      </concept>
      <concept>
        <code value="wss-saml-token"/>
        <display value="WSS SAML Token"/>
        <definition
                    value="Uses a Security Assertion Markup Language (SAML) token within the Web Services Security (WSS) framework for access control."/>
      </concept>
      <concept>
        <code value="wss-username-token"/>
        <display value="WSS User Name Token"/>
        <definition
                    value="Uses a username token within the WSS framework for access control."/>
      </concept>
      <concept>
        <code value="wss-kerberos-token"/>
        <display value="WSS Kerberos Token"/>
        <definition
                    value="Uses a Kerberos token within the WSS framework for access control."/>
      </concept>
      <concept>
        <code value="wss-x509-token"/>
        <display value="WSS X509 Token"/>
        <definition
                    value="Uses an X.509 certificate token within the WSS framework for access control."/>
      </concept>
      <concept>
        <code value="wss-custom-token"/>
        <display value="WSS Custom Token"/>
        <definition
                    value="Uses a custom token within the WSS framework for access control."/>
      </concept>
    </CodeSystem>