Argonaut Provider Directory CI Build
{
  "resourceType" : "CapabilityStatement",
  "id" : "client",
  "text" : {
    "status" : "additional",
    "div" : "<div xmlns="http://www.w3.org/1999/xhtml"><h3 id="client">Conformance requirements for the Argonaut Provider Directory Client</h3><ul id="markdown-toc"><li><a href="#client" id="markdown-toc-conformance-requirements-for-the-argonaut-provider-directory-client">Conformance requirements for the Argonaut Provider Directory Client</a><ul><li><a href="#behavior-1" id="markdown-toc-behavior-1">Behavior</a></li><li><a href="#security-1" id="markdown-toc-security-1">Security</a></li><li><a href="#resource--details-1" id="markdown-toc-resource--details-1">Resource  Details:</a><ul><li><a href="#endpoint-1" id="markdown-toc-endpoint-1">1. EndPoint</a></li><li><a href="#location-1" id="markdown-toc-location-1">2. Location</a></li><li><a href="#organization-1" id="markdown-toc-organization-1">3. Organization</a></li><li><a href="#practitioner-1" id="markdown-toc-practitioner-1">4. Practitioner</a></li><li><a href="#practitionerrole-1" id="markdown-toc-practitionerrole-1">5. PractitionerRole</a></li></ul></li></ul></li></ul><ul><li>FHIR Version: 3.0.0</li><li>Supported formats: xml, json</li><li>Published: 2017-04-30</li><li>Published by: Argonaut</li></ul><p>This section describes the expected capabilities of a client actor which is responsible for creating and initiating the queries for information. It is expected that this CapabilityStatement will be used in conjuction with the <a href="http://fhir.org/guides/argonaut-pd/capstatements.html#server">Argonaut Provider Directory Server CapabilityStatement</a>. Together they describe the basic expectations for the capabilities of a conformant client application.</p><h4 id="behavior-1">Behavior</h4><p>The Argonaut Provider Client <strong>SHALL</strong> support fetching and querying of one or more Argonaut Provider profile(s), using the supported RESTful interactions and search parameters declared in the <a href="http://fhir.org/guides/argonaut-pd/capstatements.html#server">Argonaut Provider Directory Server CapabilityStatement</a></p><p>The Argonaut Provider Client <strong>SHOULD</strong> Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.</p><h4 id="security-1">Security</h4><p>Argonaut Clent <strong>SHALL</strong> implement the security requirements documented in the <a href="http://hl7.org/fhir/us/core/security.html">US Core IG</a>.</p><p><strong>Summary of Argonaut Provider search criteria</strong></p><p>Specific client search capabilities are described in detail below in each of the resource sections. When a Server returns a PractitionerRole, Location, or Organization, an Endpoint <strong>MAY</strong> be included. The client application <strong>SHALL</strong> properly process a bundle when all resources are included, and be able to retrieve the Endpoint resource when not included.</p><h4 id="resource--details-1">Resource  Details:</h4><h5 id="endpoint-1">1. EndPoint</h5><p>Supported Profiles:  <a href="StructureDefinition-argo-endpoint.html">Argonaut Endpoint Profile</a></p><p>Search Criteria:</p><p>A Client <strong>SHALL</strong> be capable of fetching an Endpoint using:</p><ul><li><code class="highlighter-rouge">GET [base]/Endpoint?identifier=[system]|[code]</code></li><li><code class="highlighter-rouge">GET [base]/Endpoint?organization=[id]</code></li><li><code class="highlighter-rouge">GET [base]/Endpoint?name=[string]</code></li></ul><h5 id="location-1">2. Location</h5><p>Supported Profiles:  <a href="StructureDefinition-argo-location.html">Argonaut Location Profile</a></p><p>Search Criteria:</p><p>A client <strong>SHALL</strong> be capable of fetching a Location using:</p><ul><li><code class="highlighter-rouge">GET [base]/Location?identifier=[system]|[code]{&amp;_include=Location:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/Location?name=[string]{&amp;_include=Location:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/Location?address=[string]{&amp;_include=Location:endpoint}</code></li></ul><h5 id="organization-1">3. Organization</h5><p>Supported Profiles:  <a href="StructureDefinition-argo-organization.html">Argonaut Organization Profile</a></p><p>Search Criteria:</p><p>A client <strong>SHALL</strong> be capable of fetching an Organization using:</p><ul><li><code class="highlighter-rouge">GET [base]/Organization?identifier=[system]|[code]{&amp;_include=Organization:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/Organization?name=[string]{&amp;_include=Organization:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/Organization?address=[string]{&amp;_include=Organization:endpoint}</code></li></ul><h5 id="practitioner-1">4. Practitioner</h5><p>Supported Profiles:  <a href="StructureDefinition-argo-practitioner.html">Argonaut Practitioner Profile</a></p><p>Search Criteria:</p><p>A client <strong>SHALL</strong> be capable of fetching a Practitioner using:</p><ul><li><code class="highlighter-rouge">GET [base]/Practitioner?identifier=[system]|[code]</code></li><li><code class="highlighter-rouge">GET [base]/Practitioner?family=[string]&amp;given=[string]</code></li><li><code class="highlighter-rouge">GET [base]/Practitioner?name=[string]</code></li></ul><h5 id="practitionerrole-1">5. PractitionerRole</h5><p>Supported Profiles:  <a href="StructureDefinition-argo-practitionerrole.html">Argonaut PractitionerRole Profile</a></p><p>Search Criteria:</p><p>A client <strong>SHALL</strong> be capable of fetching a PractitionerRole using:</p><ul><li><code class="highlighter-rouge">GET [base]/PractitionerRole?practitioner.identifier=[system]|[code]{&amp;_include=PractitionerRole:practitioner&amp;_include=PractitionerRole:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/PractitionerRole?practitioner.family=[string]&amp;given=[string]{&amp;_include=PractitionerRole:practitioner&amp;_include=PractitionerRole:endpoint}</code></li><li><code class="highlighter-rouge">GET [base]/PractitionerRole?specialty=[system]|[code]{&amp;_include=PractitionerRole:practitioner&amp;_include=PractitionerRole:endpoint}</code></li></ul><p><br/></p></div>"
  },
  "url" : "http://fhir.org/guides/argonaut-pd/CapabilityStatement/client",
  "name" : "Argonaut Provider Directory Client",
  "status" : "draft",
  "date" : "2016-11-13",
  "publisher" : "Argonaut Project",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "other",
          "value" : "http://argonautwiki.hl7.org/"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of a client when conforming to the Argonaut Provider Directory Implementation Guide.",
  "kind" : "requirements",
  "fhirVersion" : "STU3",
  "acceptUnknown" : "extensions",
  "format" : [
    "xml",
    "json"
  ],
  "profile" : [
    {
      "reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitioner"
    },
    {
      "reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-location"
    },
    {
      "reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-endpoint"
    },
    {
      "reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitionerrole"
    },
    {
      "reference" : "http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-organization"
    }
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "'''The Argonaut Provider Directory Client''' ''SHOULD'' support querying of one or more FHIR resources using appropriate Argonaut Provider Directory profile(s), RESTful serach parameters and operations defined for the profile.",
      "security" : {
        "description" : "Argonaut Provider Directory Clients SHALL implement applicable security requirements documented in the Argonaut Provider Directory IG."
      },
      "resource" : [
        {
          "type" : "Practitioner",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider by id"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "family",
              "definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-family",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "given",
              "definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-given",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-identifier",
              "type" : "token"
            }
          ]
        },
        {
          "type" : "Organization",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Organization by id"
            }
          ],
          "searchInclude" : [
            "Organization:endpoint"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ]
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Organization-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/SearchParameter/Organization-address",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Organization-identifier",
              "type" : "token"
            }
          ]
        },
        {
          "type" : "Location",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Location by id"
            }
          ],
          "searchInclude" : [
            "Location:endpoint"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ]
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Location-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "address",
              "definition" : "http://hl7.org/fhir/SearchParameter/Location-address",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Location-identifier",
              "type" : "token"
            }
          ]
        },
        {
          "type" : "Endpoint",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider Endpoint by id"
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "name",
              "definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-name",
              "type" : "string"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "organization",
              "definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-organization",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "identifier",
              "definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-identifier",
              "type" : "token"
            }
          ]
        },
        {
          "type" : "PractitionerRole",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific Argonaut Provider Directory Provider PractitionerRole by id"
            }
          ],
          "searchInclude" : [
            "PractitionerRole:practitioner",
            "PractitionerRole:endpoint"
          ],
          "_searchInclude" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ]
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ]
            }
          ],
          "searchParam" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "practitioner",
              "definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "name" : "location",
              "definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-location",
              "type" : "reference"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "name" : "specialty",
              "definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty",
              "type" : "token"
            }
          ]
        }
      ]
    }
  ]
}