Argonaut Provider Directory Implementation Guide Version 1.0.0
This page is part of the Argonaut Provider Directory Guide (v1.0.0: Release) based on FHIR R3. This is the current published version. For a full list of available versions, see the Directory of published versions 
Formats: Narrative, XML, JSON, Turtle
Raw xml
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="client"/> <text> <status value="additional"/> <div xmlns="http://www.w3.org/1999/xhtml"> <ul id="markdown-toc"> <li><a href="#conformance-requirements-for-the-argonaut-provider-directory-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> <h3 id="conformance-requirements-for-the-argonaut-provider-directory-client">Conformance requirements for the Argonaut Provider Directory Client</h3> <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/r3/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/r3/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/STU1/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="http://fhir.org/guides/argonaut-pd/r3/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="http://fhir.org/guides/argonaut-pd/r3/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]{&_include=Location:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/Location?name=[string]{&_include=Location:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/Location?address=[string]{&_include=Location:endpoint}</code></li> </ul> <h5 id="organization-1">3. Organization</h5> <p>Supported Profiles: <a href="http://fhir.org/guides/argonaut-pd/r3/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]{&_include=Organization:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/Organization?name=[string]{&_include=Organization:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/Organization?address=[string]{&_include=Organization:endpoint}</code></li> </ul> <h5 id="practitioner-1">4. Practitioner</h5> <p>Supported Profiles: <a href="http://fhir.org/guides/argonaut-pd/r3/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]&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="http://fhir.org/guides/argonaut-pd/r3/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]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/PractitionerRole?practitioner.family=[string]&given=[string]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li> <li><code class="highlighter-rouge">GET [base]/PractitionerRole?specialty=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}</code></li> </ul> <p><br/></p> <br/> </div> </text> <url value="http://fhir.org/guides/argonaut-pd/CapabilityStatement/client"/> <version value="1.0.0"/> <name value="Argonaut Provider Directory Client"/> <status value="draft"/> <date value="2016-11-13T00:00:00+11:00"/> <publisher value="Argonaut Project"/> <contact> <telecom> <system value="other"/> <value value="http://argonautwiki.hl7.orgs/"/> </telecom> </contact> <description value="This profile defines the expected capabilities of a client when conforming to the Argonaut Provider Directory Implementation Guide."/> <kind value="requirements"/> <fhirVersion value="STU3"/> <acceptUnknown value="extensions"/> <format value="xml"/> <format value="json"/> <profile> <reference value="http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitioner"/> </profile> <profile> <reference value="http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-location"/> </profile> <profile> <reference value="http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-endpoint"/> </profile> <profile> <reference value="http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-practitionerrole"/> </profile> <profile> <reference value="http://fhir.org/guides/argonaut-pd/StructureDefinition/argo-organization"/> </profile> <rest> <mode value="client"/> <documentation value="'''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 value="Argonaut Provider Directory Clients SHALL implement applicable security requirements documented in the Argonaut Provider Directory IG."/> </security> <resource> <type value="Practitioner"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Provider Directory Provider by id"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Practitioner-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="family"/> <definition value="http://hl7.org/fhir/SearchParameter/Practitioner-family"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="given"/> <definition value="http://hl7.org/fhir/SearchParameter/Practitioner-given"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Practitioner-identifier"/> <type value="token"/> </searchParam> </resource> <resource> <type value="Organization"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Provider Directory Provider Organization by id"/> </interaction> <searchInclude value="Organization:endpoint"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="address"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-address"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Organization-identifier"/> <type value="token"/> </searchParam> </resource> <resource> <type value="Location"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Provider Directory Provider Location by id"/> </interaction> <searchInclude value="Location:endpoint"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Location-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="address"/> <definition value="http://hl7.org/fhir/SearchParameter/Location-address"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Location-identifier"/> <type value="token"/> </searchParam> </resource> <resource> <type value="Endpoint"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Provider Directory Provider Endpoint by id"/> </interaction> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="name"/> <definition value="http://hl7.org/fhir/SearchParameter/Endpoint-name"/> <type value="string"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="organization"/> <definition value="http://hl7.org/fhir/SearchParameter/Endpoint-organization"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Endpoint-identifier"/> <type value="token"/> </searchParam> </resource> <resource> <type value="PractitionerRole"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing Argonaut Provider Director Providers using search criteria defined for the Argonaut Provider Directory Use Cases"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific Argonaut Provider Directory Provider PractitionerRole by id"/> </interaction> <searchInclude value="PractitionerRole:practitioner"/> <searchInclude value="PractitionerRole:endpoint"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="practitioner"/> <definition value="http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="location"/> <definition value="http://hl7.org/fhir/SearchParameter/PractitionerRole-location"/> <type value="reference"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="specialty"/> <definition value="http://hl7.org/fhir/SearchParameter/PractitionerRole-specialty"/> <type value="token"/> </searchParam> </resource> </rest> </CapabilityStatement>
Argonaut Provider Directory fhir.argonaut.pd#1.0.0 ®© FHIR Version: 3.0.1 generated on Thu, Jun 15, 2017 20:26+1000. |
