National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot
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
| Active as of 2022-11-01 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="ndh-verification-server"/>
<meta>
<profile
value="http://hl7.org/fhir/StructureDefinition/CapabilityStatement"/>
</meta>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<br/>
<h2>General</h2>
<div class="table-wrapper">
<table class="grid">
<tbody>
<tr>
<th>Supported FHIR Version:</th>
<td>
4.0.1
</td>
</tr>
<tr>
<th>Supported exchange formats:</th>
<td>
xml, json
</td>
</tr>
</tbody>
</table>
</div>
<p>
<b>Jump to:</b>
</p>
<ul>
<li><a href="#server">REST server</a></li>
</ul>
<br/>
<a name="server"> </a>
<h2>REST server behavior</h2>
<div><div><p>NDH Verification Server</p>
</div></div>
<br/>
<h3>Resource summary</h3>
<div class="table-wrapper">
<table class="grid">
<thead>
<tr>
<th>Resource</th>
<th>Search</th>
<th>Read</th>
<th>Read Version</th>
<th>Instance History</th>
<th>Resource History</th>
<th>Create</th>
<th>Update</th>
<th>Delete</th>
<th>Operations</th>
</tr>
</thead>
<tbody>
<tr>
<th>
Endpoint
</th>
<td>
<a href="#Endpoint-search-type" title="Search all resources of the specified type based on some filter criteria.">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-read" title="Read the current state of the resource">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-vread" title="Read the state of a specific version of the resource">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-history-instance" title="Retrieve the history of the resource">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-history-type" title="Retrieve the history of the resource type">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-create" title="Create a new resource with a server assigned id">
SHALL
</a>
</td>
<td>
<a href="#Endpoint-update" title="Update an existing resource by its id or create it if it is new">
SHALL
</a>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th>
Location
</th>
<td>
<a href="#Location-search-type" title="Search all resources of the specified type based on some filter criteria.">
SHOULD
</a>
</td>
<td>
<a href="#Location-read" title="Read the current state of the resource">
SHOULD
</a>
</td>
<td>
<a href="#Location-vread" title="Read the state of a specific version of the resource">
SHOULD
</a>
</td>
<td>
<a href="#Location-history-instance" title="Retrieve the history of the resource">
SHOULD
</a>
</td>
<td>
<a href="#Location-history-type" title="Retrieve the history of the resource type">
SHOULD
</a>
</td>
<td>
<a href="#Location-create" title="Create a new resource with a server assigned id">
SHOULD
</a>
</td>
<td>
<a href="#Location-update" title="Update an existing resource by its id or create it if it is new">
SHOULD
</a>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th>
Organization
</th>
<td>
<a href="#Organization-search-type" title="Search all resources of the specified type based on some filter criteria.">
SHALL
</a>
</td>
<td>
<a href="#Organization-read" title="Read the current state of the resource">
SHALL
</a>
</td>
<td>
<a href="#Organization-vread" title="Read the state of a specific version of the resource">
SHALL
</a>
</td>
<td>
<a href="#Organization-history-instance" title="Retrieve the history of the resource">
SHALL
</a>
</td>
<td>
<a href="#Organization-history-type" title="Retrieve the history of the resource type">
SHALL
</a>
</td>
<td>
<a href="#Organization-create" title="Create a new resource with a server assigned id">
SHALL
</a>
</td>
<td>
<a href="#Organization-update" title="Update an existing resource by its id or create it if it is new">
SHALL
</a>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th>
Practitioner
</th>
<td>
<a href="#Practitioner-search-type" title="Search all resources of the specified type based on some filter criteria.">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-read" title="Read the current state of the resource">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-vread" title="Read the state of specific version of the resource">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-history-instance" title="Retrieve the history of the resource">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-history-type" title="Retrieve the history of the resource type">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-create" title="Create a new resource with a server assigned id">
SHALL
</a>
</td>
<td>
<a href="#Practitioner-update" title="Update an existing resource by its id or create it if it is new">
SHALL
</a>
</td>
<td>
</td>
<td>
</td>
</tr>
<tr>
<th>
PractitionerRole
</th>
<td>
<a href="#PractitionerRole-search-type" title="Search all resources of the specified type based on some filter criteria.">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-read" title="Read the current state of the resource">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-vread" title="Read the state of specific version of the resource">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-history-instance" title="Retrieve the history of the resource">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-history-type" title="Retrieve the history of the resource type">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-create" title="Create a new resource with a server assigned id">
SHOULD
</a>
</td>
<td>
<a href="#PractitionerRole-update" title="Update an existing resource by its id or create it if it is new">
SHOULD
</a>
</td>
<td>
</td>
<td>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/Endpoint.html">Endpoint</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="StructureDefinition-ndh-ndapi-Endpoint.html">National Directory API Endpoint Profile</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned</p>
<p>Reference policy: literal, local</p>
<!-- Note: description doesn't exist yet -->
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Name</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<b>
<a name="Endpoint-search-type"> </a>
<span>search-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Search all resources of the specified type based on some filter criteria.</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-read"> </a>
<span>read</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the current state of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-create"> </a>
<span>create</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Create a new resource with a server assigned id</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-update"> </a>
<span>update</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Update an existing resource by its id or create it if it is new</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-vread"> </a>
<span>vread</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the state of a specific version of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-history-instance"> </a>
<span>history-instance</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Endpoint-history-type"> </a>
<span>history-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Endpoint:organization</p>
<p>Supported Reverse-Includes: Location:endpoint, Location:endpoint, Organization:endpoint, Practitioner:practitioner-endpoint, PractitionerRole:endpoint</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Parameter Name</th>
<th style="text-align: center">Definition</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Type</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
usecase-type
</td>
<td>
<a href="SearchParameter-endpoint-usecase-type.html">EndpointUsecaseTypeSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint usecase type</p>
</div>
</td>
</tr>
<tr>
<td>
nonfhir-usecase-type
</td>
<td>
<a href="SearchParameter-endpoint-nonfhir-usecase-type.html">EndpointNonfhirUsecaseTypeSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint nonfhir usecase type</p>
</div>
</td>
</tr>
<tr>
<td>
trust-framework-type
</td>
<td>
<a href="SearchParameter-endpoint-trust-framework-type.html">EndpointTrustFrameworkTypeSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint trust framework type</p>
</div>
</td>
</tr>
<tr>
<td>
dynamic-registration-trust-profile
</td>
<td>
<a href="SearchParameter-endpoint-dynamic-registration-trust-profile.html">EndpointDynamicRegistrationTrustProfileSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint dynamic registration trust profile</p>
</div>
</td>
</tr>
<tr>
<td>
access-control-mechanism
</td>
<td>
<a href="SearchParameter-endpoint-access-control-mechanism.html">EndpointAccessControlMechanismSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint access control mechanism</p>
</div>
</td>
</tr>
<tr>
<td>
connection-type-version
</td>
<td>
<a href="SearchParameter-endpoint-connection-type-version.html">EndpointConnectionTypeVersionSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint connection type version</p>
</div>
</td>
</tr>
<tr>
<td>
ihe-connection-type
</td>
<td>
<a href="SearchParameter-endpoint-ihe-connection-type.html">EndpointIheConnectionTypeSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint ihe connection type</p>
</div>
</td>
</tr>
<tr>
<td>
verification-status
</td>
<td>
<a href="SearchParameter-endpoint-verification-status.html">EndpointVerificationStatusSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint verification status</p>
</div>
</td>
</tr>
<tr>
<td>
_filter
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-filter">http://hl7.org/fhir/SearchParameter/Resource-filter</a>
</td>
<td>
SHALL
</td>
<td>special
</td>
<td>
<div><p>supports a more sophisticated grammar for searching</p>
</div>
</td>
</tr>
<tr>
<td>
_id
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Logical id allows to retrive more than one in a single call</p>
</div>
</td>
</tr>
<tr>
<td>
_lastUpdated
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated">http://hl7.org/fhir/SearchParameter/Resource-lastUpdated</a>
</td>
<td>
SHALL
</td>
<td>date
</td>
<td>
<div><p>Allows filtering for only records that have changed since last query.</p>
</div>
</td>
</tr>
<tr>
<td>
connection-type
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Endpoint-connection-type">http://hl7.org/fhir/SearchParameter/Endpoint-connection-type</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Connection type</p>
</div>
</td>
</tr>
<tr>
<td>
identifier
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Endpoint-identifier">http://hl7.org/fhir/SearchParameter/Endpoint-identifier</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint identifier</p>
</div>
</td>
</tr>
<tr>
<td>
organization
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Endpoint-organization">http://hl7.org/fhir/SearchParameter/Endpoint-organization</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Organization that manages the Endpoint</p>
</div>
</td>
</tr>
<tr>
<td>
status
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Endpoint-status">http://hl7.org/fhir/SearchParameter/Endpoint-status</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Endpoint status</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/Location.html">Location</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="StructureDefinition-ndh-ndapi-Location.html">National Directory API Location Profile</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned</p>
<p>Reference policy: literal, local</p>
<!-- Note: description doesn't exist yet -->
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Name</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<b>
<a name="Location-create"> </a>
<span>create</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Create a new resource with a server assigned id</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-update"> </a>
<span>update</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Update an existing resource by its id or create it if it is new</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-search-type"> </a>
<span>search-type</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Search all resources of the specified type based on some filter criteria.</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-read"> </a>
<span>read</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Read the current state of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-vread"> </a>
<span>vread</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Read the state of a specific version of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-history-instance"> </a>
<span>history-instance</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Retrieve the history of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Location-history-type"> </a>
<span>history-type</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Retrieve the history of the resource type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Location:endpoint, Location:new-patient-from-network, Location:organization, Location:partof</p>
<p>Supported Reverse-Includes: PractitionerRole:location</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Parameter Name</th>
<th style="text-align: center">Definition</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Type</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
accessibility
</td>
<td>
<a href="SearchParameter-location-accessibility.html">LocationAccessibilitySearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Location accessibility</p>
</div>
</td>
</tr>
<tr>
<td>
contains
</td>
<td>
<a href="SearchParameter-location-contains.html">LocationContainsSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>special
</td>
<td>
<div><p>Location contains</p>
</div>
</td>
</tr>
<tr>
<td>
new-patient-from-network
</td>
<td>
<a href="SearchParameter-location-new-patient-from-network.html">LocationNewPatientFromNetworkSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>Location new patient from network</p>
</div>
</td>
</tr>
<tr>
<td>
new-patient
</td>
<td>
<a href="SearchParameter-location-new-patient.html">LocationNewPatientSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Location new patient</p>
</div>
</td>
</tr>
<tr>
<td>
_filter
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-filter">http://hl7.org/fhir/SearchParameter/Resource-filter</a>
</td>
<td>
SHOULD
</td>
<td>special
</td>
<td>
<div><p>supports a more sophisticated grammar for searching</p>
</div>
</td>
</tr>
<tr>
<td>
_id
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Logical id allows to retrive more than one in a single call</p>
</div>
</td>
</tr>
<tr>
<td>
_lastUpdated
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated">http://hl7.org/fhir/SearchParameter/Resource-lastUpdated</a>
</td>
<td>
SHOULD
</td>
<td>date
</td>
<td>
<div><p>Allows filtering for only records that have changed since last query.</p>
</div>
</td>
</tr>
<tr>
<td>
address
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address">http://hl7.org/fhir/SearchParameter/Location-address</a>
</td>
<td>
SHOULD
</td>
<td>string
</td>
<td>
<div><p>Location address</p>
</div>
</td>
</tr>
<tr>
<td>
address-city
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address-city">http://hl7.org/fhir/SearchParameter/Location-address-city</a>
</td>
<td>
SHOULD
</td>
<td>string
</td>
<td>
<div><p>Location address-city</p>
</div>
</td>
</tr>
<tr>
<td>
address-country
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address-country">http://hl7.org/fhir/SearchParameter/Location-address-country</a>
</td>
<td>
SHOULD
</td>
<td>string
</td>
<td>
<div><p>Location address-country</p>
</div>
</td>
</tr>
<tr>
<td>
address-postalcode
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address-postalcode">http://hl7.org/fhir/SearchParameter/Location-address-postalcode</a>
</td>
<td>
SHOULD
</td>
<td>string
</td>
<td>
<div><p>Location address-postalcode</p>
</div>
</td>
</tr>
<tr>
<td>
address-state
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address-state">http://hl7.org/fhir/SearchParameter/Location-address-state</a>
</td>
<td>
SHOULD
</td>
<td>string
</td>
<td>
<div><p>Location address-state</p>
</div>
</td>
</tr>
<tr>
<td>
address-use
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-address-use">http://hl7.org/fhir/SearchParameter/Location-address-use</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Location address-use</p>
</div>
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-endpoint">http://hl7.org/fhir/SearchParameter/Location-endpoint</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Location endpoint</p>
</div>
</td>
</tr>
<tr>
<td>
identifier
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-identifier">http://hl7.org/fhir/SearchParameter/Location-identifier</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Location identifier</p>
</div>
</td>
</tr>
<tr>
<td>
name
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-name">http://hl7.org/fhir/SearchParameter/Location-name</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Location name</p>
</div>
</td>
</tr>
<tr>
<td>
near
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-near">http://hl7.org/fhir/SearchParameter/Location-near</a>
</td>
<td>
SHALL
</td>
<td>special
</td>
<td>
<div><p>Location position</p>
</div>
</td>
</tr>
<tr>
<td>
partof
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-partof">http://hl7.org/fhir/SearchParameter/Location-partof</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Location partof</p>
</div>
</td>
</tr>
<tr>
<td>
organization
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-organization">http://hl7.org/fhir/SearchParameter/Location-organization</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>Location organization</p>
</div>
</td>
</tr>
<tr>
<td>
type
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Location-type">http://hl7.org/fhir/SearchParameter/Location-type</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Location type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/Organization.html">Organization</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="StructureDefinition-ndh-ndapi-Organization.html">National Directory API Organization Profile</a>
</li>
<li>
<a href="StructureDefinition-ndh-ndapi-Network.html">National Directory API Network Profile</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned</p>
<p>Reference policy: literal, local</p>
<!-- Note: description doesn't exist yet -->
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Name</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<b>
<a name="Organization-create"> </a>
<span>create</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Create a new resource with a server assigned id</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-update"> </a>
<span>update</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Update an existing resource by its id or create it if it is new</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-search-type"> </a>
<span>search-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Search all resources of the specified type based on some filter criteria.</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-read"> </a>
<span>read</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the current state of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-vread"> </a>
<span>vread</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the state of a specific version of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-history-instance"> </a>
<span>history-instance</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Organization-history-type"> </a>
<span>history-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Organization:endpoint, Organization:partof</p>
<p>Supported Reverse-Includes: Endpoint:organization, Location:organization, Location:new-patient-from-network, Practitioner:qualification-issuer, PractitionerRole:organization, PractitionerRole:network, PractitionerRole:new-patient-from-network</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Parameter Name</th>
<th style="text-align: center">Definition</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Type</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
coverage-area
</td>
<td>
<a href="SearchParameter-network-coverage-area.html">NetworkCoverageAreaSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>network organization type is needed for searching network coverage area</p>
</div>
</td>
</tr>
<tr>
<td>
_filter
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-filter">http://hl7.org/fhir/SearchParameter/Resource-filter</a>
</td>
<td>
SHALL
</td>
<td>special
</td>
<td>
<div><p>supports a more sophisticated grammar for searching</p>
</div>
</td>
</tr>
<tr>
<td>
_id
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Logical id allows to retrive more than one in a single call</p>
</div>
</td>
</tr>
<tr>
<td>
_lastUpdated
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated">http://hl7.org/fhir/SearchParameter/Resource-lastUpdated</a>
</td>
<td>
SHALL
</td>
<td>date
</td>
<td>
<div><p>Allows filtering for only records that have changed since last query.</p>
</div>
</td>
</tr>
<tr>
<td>
active
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-active">http://hl7.org/fhir/SearchParameter/Organization-active</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Organization active</p>
</div>
</td>
</tr>
<tr>
<td>
address
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address">http://hl7.org/fhir/SearchParameter/Organization-address</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization address</p>
</div>
</td>
</tr>
<tr>
<td>
address-city
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address-city">http://hl7.org/fhir/SearchParameter/Organization-address-city</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization address-city</p>
</div>
</td>
</tr>
<tr>
<td>
address-country
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address-country">http://hl7.org/fhir/SearchParameter/Organization-address-country</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization address-country</p>
</div>
</td>
</tr>
<tr>
<td>
address-postalcode
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address-postalcode">http://hl7.org/fhir/SearchParameter/Organization-address-postalcode</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization address-postalcode</p>
</div>
</td>
</tr>
<tr>
<td>
address-state
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address-state">http://hl7.org/fhir/SearchParameter/Organization-address-state</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization address-state</p>
</div>
</td>
</tr>
<tr>
<td>
address-use
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-address-use">http://hl7.org/fhir/SearchParameter/Organization-address-use</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Organization address-use</p>
</div>
</td>
</tr>
<tr>
<td>
endpoint
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-endpoint">http://hl7.org/fhir/SearchParameter/Organization-endpoint</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Organization endpoint</p>
</div>
</td>
</tr>
<tr>
<td>
identifier
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-identifier">http://hl7.org/fhir/SearchParameter/Organization-identifier</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Organization identifier</p>
</div>
</td>
</tr>
<tr>
<td>
name
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-name">http://hl7.org/fhir/SearchParameter/Organization-name</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>Organization name</p>
</div>
</td>
</tr>
<tr>
<td>
partof
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-partof">http://hl7.org/fhir/SearchParameter/Organization-partof</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Organization partof</p>
</div>
</td>
</tr>
<tr>
<td>
type
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Organization-type">http://hl7.org/fhir/SearchParameter/Organization-type</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Organization type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/Practitioner.html">Practitioner</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="StructureDefinition-ndh-ndapi-Practitioner.html">National Directory API Practitioner Profile</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned</p>
<p>Reference policy: literal, local</p>
<!-- Note: description doesn't exist yet -->
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Name</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<b>
<a name="Practitioner-create"> </a>
<span>create</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Create a new resource with a server assigned id</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-update"> </a>
<span>update</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Update an existing resource by its id or create it if it is new</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-read"> </a>
<span>read</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the current state of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-search-type"> </a>
<span>search-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Search all resources of the specified type based on some filter criteria.</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-vread"> </a>
<span>vread</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Read the state of specific version of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-history-instance"> </a>
<span>history-instance</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="Practitioner-history-type"> </a>
<span>history-type</span>
</b>
</td>
<td>
SHALL
</td>
<td>
<div><p>Retrieve the history of the resource type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: Practitioner:endpoint, Practitioner:qualification-issuer, Practitioner:verification-attestation-who</p>
<p>Supported Reverse-Includes: PractitionerRole:practitioner</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Parameter Name</th>
<th style="text-align: center">Definition</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Type</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
endpoint
</td>
<td>
<a href="SearchParameter-practitioner-endpoint.html">PractitionerEndpointSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Practitioner endpoint</p>
</div>
</td>
</tr>
<tr>
<td>
qualification-issuer
</td>
<td>
<a href="SearchParameter-practitioner-qualification-issuer.html">PractitionerQualificationIssuerSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>reference
</td>
<td>
<div><p>Practitioner qualification issuer</p>
</div>
</td>
</tr>
<tr>
<td>
qualification-code
</td>
<td>
<a href="SearchParameter-practitioner-qualification-code.html">PractitionerQualificationCodeSearchParameter</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Practitioner qualification code</p>
</div>
</td>
</tr>
<tr>
<td>
_filter
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-filter">http://hl7.org/fhir/SearchParameter/Resource-filter</a>
</td>
<td>
SHALL
</td>
<td>special
</td>
<td>
<div><p>supports a more sophisticated grammar for searching</p>
</div>
</td>
</tr>
<tr>
<td>
_id
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Logical id allows to retrive more than one in a single call</p>
</div>
</td>
</tr>
<tr>
<td>
_lastUpdated
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated">http://hl7.org/fhir/SearchParameter/Resource-lastUpdated</a>
</td>
<td>
SHALL
</td>
<td>date
</td>
<td>
<div><p>Allows filtering for only records that have changed since last query.</p>
</div>
</td>
</tr>
<tr>
<td>
active
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Practitioner-active">http://hl7.org/fhir/SearchParameter/Practitioner-active</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Whether this practitioner's record is in active use</p>
</div>
</td>
</tr>
<tr>
<td>
name
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Practitioner-name">http://hl7.org/fhir/SearchParameter/Practitioner-name</a>
</td>
<td>
SHALL
</td>
<td>string
</td>
<td>
<div><p>A portion of either family or given name of the practitioner</p>
</div>
</td>
</tr>
<tr>
<td>
gender
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/individual-gender">http://hl7.org/fhir/SearchParameter/individual-gender</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>Practitioner gender</p>
</div>
</td>
</tr>
<tr>
<td>
identifier
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Practitioner-identifier">http://hl7.org/fhir/SearchParameter/Practitioner-identifier</a>
</td>
<td>
SHALL
</td>
<td>token
</td>
<td>
<div><p>A practitioner's Identifier</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/PractitionerRole.html">PractitionerRole</a>
</h3>
<p>Supported Profile(s):</p>
<ul>
<li>
<a href="StructureDefinition-ndh-ndapi-PractitionerRole.html">National Directory API PractitionerRole</a>
</li>
</ul>
<h4>Behavior</h4>
<p>Versioning support: versioned</p>
<p>Reference policy: literal, local</p>
<!-- Note: description doesn't exist yet -->
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Name</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<b>
<a name="PractitionerRole-create"> </a>
<span>create</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Create a new resource with a server assigned id</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-update"> </a>
<span>update</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Update an existing resource by its id or create it if it is new</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-read"> </a>
<span>read</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Read the current state of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-search-type"> </a>
<span>search-type</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Search all resources of the specified type based on some filter criteria.</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-vread"> </a>
<span>vread</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Read the state of specific version of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-history-instance"> </a>
<span>history-instance</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Retrieve the history of the resource</p>
</div>
</td>
</tr>
<tr>
<td>
<b>
<a name="PractitionerRole-history-type"> </a>
<span>history-type</span>
</b>
</td>
<td>
SHOULD
</td>
<td>
<div><p>Retrieve the history of the resource type</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<h4>Search</h4>
<p>Supported Includes: PractitionerRole:location, PractitionerRole:network, PractitionerRole:new-patient-from-network, PractitionerRole:organization, PractitionerRole:practitioner, PractitionerRole:service</p>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th style="text-align: center">Parameter Name</th>
<th style="text-align: center">Definition</th>
<th style="text-align: center">Conformance</th>
<th style="text-align: center">Type</th>
<th style="text-align: center">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
network
</td>
<td>
<a href="SearchParameter-practitionerrole-network.html">PractitionerroleNetworkSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>PractitionerRole network</p>
</div>
</td>
</tr>
<tr>
<td>
new-patient
</td>
<td>
<a href="SearchParameter-practitionerrole-new-patient.html">PractitionerroleNewPatientSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>PractitionerRole new-patient</p>
</div>
</td>
</tr>
<tr>
<td>
new-patient-from-network
</td>
<td>
<a href="SearchParameter-practitionerrole-new-patient-from-network.html">PractitionerroleNewPatientFromNetworkSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>PractitionerRole new-patient from network</p>
</div>
</td>
</tr>
<tr>
<td>
location
</td>
<td>
<a href="SearchParameter-practitionerrole-location.html">PractitionerroleLocationSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>One of the locations at which this practitioner provides care</p>
</div>
</td>
</tr>
<tr>
<td>
organization
</td>
<td>
<a href="SearchParameter-practitionerrole-organization.html">PractitionerroleOrganizationSearchParameter</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>The identity of the organization the practitioner represents / acts on behalf of</p>
</div>
</td>
</tr>
<tr>
<td>
_filter
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-filter">http://hl7.org/fhir/SearchParameter/Resource-filter</a>
</td>
<td>
SHOULD
</td>
<td>special
</td>
<td>
<div><p>supports a more sophisticated grammar for searching</p>
</div>
</td>
</tr>
<tr>
<td>
_id
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-id">http://hl7.org/fhir/SearchParameter/Resource-id</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Logical id allows to retrive more than one in a single call</p>
</div>
</td>
</tr>
<tr>
<td>
_lastUpdated
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated">http://hl7.org/fhir/SearchParameter/Resource-lastUpdated</a>
</td>
<td>
SHOULD
</td>
<td>date
</td>
<td>
<div><p>Allows filtering for only records that have changed since last query.</p>
</div>
</td>
</tr>
<tr>
<td>
active
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-active">http://hl7.org/fhir/SearchParameter/PractitionerRole-active</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>Whether this practitioner's record is in active use</p>
</div>
</td>
</tr>
<tr>
<td>
identifier
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier">http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>A practitioner's Identifier</p>
</div>
</td>
</tr>
<tr>
<td>
practitioner
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner">http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>Practitioner that is able to provide the defined services for the organization</p>
</div>
</td>
</tr>
<tr>
<td>
role
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-role">http://hl7.org/fhir/SearchParameter/PractitionerRole-role</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>The practitioner can perform this role at for the organization</p>
</div>
</td>
</tr>
<tr>
<td>
service
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-service">http://hl7.org/fhir/SearchParameter/PractitionerRole-service</a>
</td>
<td>
SHOULD
</td>
<td>reference
</td>
<td>
<div><p>The list of healthcare services that this worker provides for this role's Organization/Location</p>
</div>
</td>
</tr>
<tr>
<td>
specialty
</td>
<td>
<a href="http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty">http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty</a>
</td>
<td>
SHOULD
</td>
<td>token
</td>
<td>
<div><p>The practitioner has this specialty at an organization</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
<valueCode value="pa"/>
</extension>
<url
value="http://hl7.org/fhir/us/ndh/CapabilityStatement/ndh-verification-server"/>
<version value="1.0.0-ballot"/>
<name value="NdhVerificationCapabilityStatement"/>
<title value="NDH Verification Server Capability Statement"/>
<status value="active"/>
<date value="2022-11-01"/>
<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="This Section describes the expected capabilities of the NDH Verification Server which is responsible
for receiving information from primary source. The complete list of FHIR profiles, RESTful operations,
and search parameters supported by NDH Verification Servers are defined."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<rest>
<mode value="server"/>
<documentation value="NDH Verification Server"/>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Endpoint"/>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Endpoint">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Endporint Resource, supportedProfile, interaction, search parameter"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Search all resources of the specified type based on some filter criteria."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation value="Read the current state of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Create a new resource with a server assigned id"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="update"/>
<documentation
value="Update an existing resource by its id or create it if it is new"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="vread"/>
<documentation
value="Read the state of a specific version of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-instance"/>
<documentation value="Retrieve the history of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-type"/>
<documentation value="Retrieve the history of the resource type"/>
</interaction>
<versioning value="versioned"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="Endpoint:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchRevInclude value="Location:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Location:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Organization:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Practitioner:practitioner-endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchRevInclude>
<searchRevInclude value="PractitionerRole:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="usecase-type"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-usecase-type"/>
<type value="token"/>
<documentation value="Endpoint usecase type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="nonfhir-usecase-type"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-nonfhir-usecase-type"/>
<type value="token"/>
<documentation value="Endpoint nonfhir usecase type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="trust-framework-type"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-trust-framework-type"/>
<type value="token"/>
<documentation value="Endpoint trust framework type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="dynamic-registration-trust-profile"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-dynamic-registration-trust-profile"/>
<type value="token"/>
<documentation value="Endpoint dynamic registration trust profile"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="access-control-mechanism"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-access-control-mechanism"/>
<type value="token"/>
<documentation value="Endpoint access control mechanism"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="connection-type-version"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-connection-type-version"/>
<type value="token"/>
<documentation value="Endpoint connection type version"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="ihe-connection-type"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-ihe-connection-type"/>
<type value="token"/>
<documentation value="Endpoint ihe connection type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="verification-status"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/endpoint-verification-status"/>
<type value="token"/>
<documentation value="Endpoint verification status"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_filter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-filter"/>
<type value="special"/>
<documentation
value="supports a more sophisticated grammar for searching"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Logical id allows to retrive more than one in a single call"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="connection-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-connection-type"/>
<type value="token"/>
<documentation value="Connection type"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-identifier"/>
<type value="token"/>
<documentation value="Endpoint identifier"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="organization"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-organization"/>
<type value="reference"/>
<documentation value="Organization that manages the Endpoint"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-status"/>
<type value="token"/>
<documentation value="Endpoint status"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="Location"/>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Location">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation
value="Location Resource, supportedProfile, interaction, search parameter"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="create"/>
<documentation
value="Create a new resource with a server assigned id"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="Update an existing resource by its id or create it if it is new"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Search all resources of the specified type based on some filter criteria."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation value="Read the current state of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
<documentation
value="Read the state of a specific version of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
<documentation value="Retrieve the history of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-type"/>
<documentation value="Retrieve the history of the resource type"/>
</interaction>
<versioning value="versioned"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="Location:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="Location:new-patient-from-network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="Location:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="Location:partof">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchRevInclude value="PractitionerRole:location">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="accessibility"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/location-accessibility"/>
<type value="token"/>
<documentation value="Location accessibility"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="contains"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/location-contains"/>
<type value="special"/>
<documentation value="Location contains"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="new-patient-from-network"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/location-new-patient-from-network"/>
<type value="reference"/>
<documentation value="Location new patient from network"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="new-patient"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/location-new-patient"/>
<type value="token"/>
<documentation value="Location new patient"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_filter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-filter"/>
<type value="special"/>
<documentation
value="supports a more sophisticated grammar for searching"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Logical id allows to retrive more than one in a single call"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address"/>
<type value="string"/>
<documentation value="Location address"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-city"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-city"/>
<type value="string"/>
<documentation value="Location address-city"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-country"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-country"/>
<type value="string"/>
<documentation value="Location address-country"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-postalcode"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-postalcode"/>
<type value="string"/>
<documentation value="Location address-postalcode"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-state"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-state"/>
<type value="string"/>
<documentation value="Location address-state"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="address-use"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address-use"/>
<type value="token"/>
<documentation value="Location address-use"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="endpoint"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-endpoint"/>
<type value="reference"/>
<documentation value="Location endpoint"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-identifier"/>
<type value="token"/>
<documentation value="Location identifier"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-name"/>
<type value="string"/>
<documentation value="Location name"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="near"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-near"/>
<type value="special"/>
<documentation value="Location position"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="partof"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-partof"/>
<type value="reference"/>
<documentation value="Location partof"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="organization"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-organization"/>
<type value="reference"/>
<documentation value="Location organization"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-type"/>
<type value="token"/>
<documentation value="Location type"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Organization"/>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Organization">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Network">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Organization Resource, supportedProfile, interaction, search parameter"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Create a new resource with a server assigned id"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="update"/>
<documentation
value="Update an existing resource by its id or create it if it is new"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Search all resources of the specified type based on some filter criteria."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation value="Read the current state of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="vread"/>
<documentation
value="Read the state of a specific version of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-instance"/>
<documentation value="Retrieve the history of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-type"/>
<documentation value="Retrieve the history of the resource type"/>
</interaction>
<versioning value="versioned"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="Organization:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchInclude value="Organization:partof">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchRevInclude value="Endpoint:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Location:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Location:new-patient-from-network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchRevInclude value="Practitioner:qualification-issuer">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchRevInclude>
<searchRevInclude value="PractitionerRole:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchRevInclude value="PractitionerRole:network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchRevInclude value="PractitionerRole:new-patient-from-network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="coverage-area"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/network-coverage-area"/>
<type value="reference"/>
<documentation
value="network organization type is needed for searching network coverage area"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_filter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-filter"/>
<type value="special"/>
<documentation
value="supports a more sophisticated grammar for searching"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Logical id allows to retrive more than one in a single call"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="active"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-active"/>
<type value="token"/>
<documentation value="Organization active"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address"/>
<type value="string"/>
<documentation value="Organization address"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-city"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address-city"/>
<type value="string"/>
<documentation value="Organization address-city"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-country"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address-country"/>
<type value="string"/>
<documentation value="Organization address-country"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-postalcode"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address-postalcode"/>
<type value="string"/>
<documentation value="Organization address-postalcode"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-state"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address-state"/>
<type value="string"/>
<documentation value="Organization address-state"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address-use"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-address-use"/>
<type value="token"/>
<documentation value="Organization address-use"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="endpoint"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-endpoint"/>
<type value="reference"/>
<documentation value="Organization endpoint"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-identifier"/>
<type value="token"/>
<documentation value="Organization identifier"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-name"/>
<type value="string"/>
<documentation value="Organization name"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="partof"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-partof"/>
<type value="reference"/>
<documentation value="Organization partof"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-type"/>
<type value="token"/>
<documentation value="Organization type"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Practitioner"/>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-Practitioner">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<documentation
value="Practitioner Resource, supportedProfile, interaction, search parameter"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Create a new resource with a server assigned id"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="update"/>
<documentation
value="Update an existing resource by its id or create it if it is new"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation value="Read the current state of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Search all resources of the specified type based on some filter criteria."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="vread"/>
<documentation
value="Read the state of specific version of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-instance"/>
<documentation value="Retrieve the history of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="history-type"/>
<documentation value="Retrieve the history of the resource type"/>
</interaction>
<versioning value="versioned"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="Practitioner:endpoint">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchInclude value="Practitioner:qualification-issuer">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchInclude value="Practitioner:verification-attestation-who">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</searchInclude>
<searchRevInclude value="PractitionerRole:practitioner">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchRevInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="endpoint"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitioner-endpoint"/>
<type value="reference"/>
<documentation value="Practitioner endpoint"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="qualification-issuer"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitioner-qualification-issuer"/>
<type value="reference"/>
<documentation value="Practitioner qualification issuer"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="qualification-code"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitioner-qualification-code"/>
<type value="token"/>
<documentation value="Practitioner qualification code"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_filter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-filter"/>
<type value="special"/>
<documentation
value="supports a more sophisticated grammar for searching"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Logical id allows to retrive more than one in a single call"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="active"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Practitioner-active"/>
<type value="token"/>
<documentation
value="Whether this practitioner's record is in active use"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Practitioner-name"/>
<type value="string"/>
<documentation
value="A portion of either family or given name of the practitioner"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="gender"/>
<definition
value="http://hl7.org/fhir/SearchParameter/individual-gender"/>
<type value="token"/>
<documentation value="Practitioner gender"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Practitioner-identifier"/>
<type value="token"/>
<documentation value="A practitioner's Identifier"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="PractitionerRole"/>
<supportedProfile
value="http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-ndapi-PractitionerRole">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</supportedProfile>
<documentation
value="PractitionerRole Resource, supportedProfile, interaction, search parameter"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="create"/>
<documentation
value="Create a new resource with a server assigned id"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="Update an existing resource by its id or create it if it is new"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="read"/>
<documentation value="Read the current state of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="search-type"/>
<documentation
value="Search all resources of the specified type based on some filter criteria."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="vread"/>
<documentation
value="Read the state of specific version of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-instance"/>
<documentation value="Retrieve the history of the resource"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="history-type"/>
<documentation value="Retrieve the history of the resource type"/>
</interaction>
<versioning value="versioned"/>
<referencePolicy value="literal"/>
<referencePolicy value="local"/>
<searchInclude value="PractitionerRole:location">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:new-patient-from-network">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:organization">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:practitioner">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchInclude value="PractitionerRole:service">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
</searchInclude>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="network"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-network"/>
<type value="reference"/>
<documentation value="PractitionerRole network"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="new-patient"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-new-patient"/>
<type value="token"/>
<documentation value="PractitionerRole new-patient"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="new-patient-from-network"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-new-patient-from-network"/>
<type value="reference"/>
<documentation value="PractitionerRole new-patient from network"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="location"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-location"/>
<type value="reference"/>
<documentation
value="One of the locations at which this practitioner provides care"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="organization"/>
<definition
value="http://hl7.org/fhir/us/ndh/SearchParameter/practitionerrole-organization"/>
<type value="reference"/>
<documentation
value="The identity of the organization the practitioner represents / acts on behalf of"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_filter"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-filter"/>
<type value="special"/>
<documentation
value="supports a more sophisticated grammar for searching"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Logical id allows to retrive more than one in a single call"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation
value="Allows filtering for only records that have changed since last query."/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="active"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-active"/>
<type value="token"/>
<documentation
value="Whether this practitioner's record is in active use"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier"/>
<type value="token"/>
<documentation value="A practitioner's Identifier"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="practitioner"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner"/>
<type value="reference"/>
<documentation
value="Practitioner that is able to provide the defined services for the organization"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="role"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-role"/>
<type value="token"/>
<documentation
value="The practitioner can perform this role at for the organization"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="service"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-service"/>
<type value="reference"/>
<documentation
value="The list of healthcare services that this worker provides for this role's Organization/Location"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="specialty"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty"/>
<type value="token"/>
<documentation
value="The practitioner has this specialty at an organization"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
IG © 2023+ HL7 International / Patient Administration. Package hl7.fhir.us.ndh#1.0.0-ballot based on FHIR 4.0.1. Generated 2024-03-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change