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