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
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 Argonaut Provider Directory Server CapabilityStatement. Together they describe the basic expectations for the capabilities of a conformant client application.
The Argonaut Provider Client SHALL support fetching and querying of one or more Argonaut Provider profile(s), using the supported RESTful interactions and search parameters declared in the Argonaut Provider Directory Server CapabilityStatement
The Argonaut Provider Client SHOULD Declare a CapabilityStatement identifying the list of profiles, operations, search parameter supported.
Argonaut Clent SHALL implement the security requirements documented in the US Core IG.
Summary of Argonaut Provider search criteria
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 MAY be included. The client application SHALL properly process a bundle when all resources are included, and be able to retrieve the Endpoint resource when not included.
Supported Profiles: Argonaut Endpoint Profile
Search Criteria:
A Client SHALL be capable of fetching an Endpoint using:
GET [base]/Endpoint?identifier=[system]|[code]
GET [base]/Endpoint?organization=[id]
GET [base]/Endpoint?name=[string]
Supported Profiles: Argonaut Location Profile
Search Criteria:
A client SHALL be capable of fetching a Location using:
GET [base]/Location?identifier=[system]|[code]{&_include=Location:endpoint}
GET [base]/Location?name=[string]{&_include=Location:endpoint}
GET [base]/Location?address=[string]{&_include=Location:endpoint}
Supported Profiles: Argonaut Organization Profile
Search Criteria:
A client SHALL be capable of fetching an Organization using:
GET [base]/Organization?identifier=[system]|[code]{&_include=Organization:endpoint}
GET [base]/Organization?name=[string]{&_include=Organization:endpoint}
GET [base]/Organization?address=[string]{&_include=Organization:endpoint}
Supported Profiles: Argonaut Practitioner Profile
Search Criteria:
A client SHALL be capable of fetching a Practitioner using:
GET [base]/Practitioner?identifier=[system]|[code]
GET [base]/Practitioner?family=[string]&given=[string]
GET [base]/Practitioner?name=[string]
Supported Profiles: Argonaut PractitionerRole Profile
Search Criteria:
A client SHALL be capable of fetching a PractitionerRole using:
GET [base]/PractitionerRole?practitioner.identifier=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}
GET [base]/PractitionerRole?practitioner.family=[string]&given=[string]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}
GET [base]/PractitionerRole?specialty=[system]|[code]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}