Package | fhir.argonaut.pd |
Type | CapabilityStatement |
Id | server |
FHIR Version | R3 |
Source | http://fhir.org/guides/argonaut/pd/https://simplifier.net/resolve?scope=fhir.argonaut.pd@1.0.0&canonical=http://fhir.org/guides/argonaut-pd/CapabilityStatement/server |
URL | http://fhir.org/guides/argonaut-pd/CapabilityStatement/server |
Version | 1.0.0 |
Status | draft |
Date | 2017-04-15T00:00:00+10:00 |
Name | Argonaut Provider Directory Server |
Realm | us |
Authority | hl7 |
Description | This profile defines the expected capabilities of a server when conforming to the Argonaut Provider Directory Implementation Guide. |
Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
This section outlines conformance requirements for each of the Provider Directory actors identifying the specific profiles that need to be supported, the specific RESTful operations that need to be supported, and the search parameters that need to be supported. Note: The individual profiles identify the structural constraints, terminology bindings and invariants, however, implementers must refer to the conformance requirements for details on the RESTful operations, specific profiles and the search parameters applicable to each of the Provider Directory actors.
The Section describes the expected capabilities of the Provider Directory actor which is responsible for providing responses to the queries submitted by Client applications. It describes the complete list of FHIR profiles, RESTful operations, and search parameters supported by US Provider Directory Servers. Provider Directory Clients have the option of choosing from this list to access necessary data based on their local use cases and other contextual requirements.
Description: The Provider Directory Server SHALL:
US Provider Directory Servers SHALL:
Authorization: Bearer {server-specific-token-here}
HTTP 401
Unauthorized response code.Summary of Provider Directory search criteria
Specific server search capabilities are described in detail below in each of the resource sections. When returning a PractitionerRole, a Practitioner and Endpoint SHALL be included. When searching on Organization or Location, a server SHALL support the _include parameter for the endpoint parameter. The client application must properly process a bundle when all resources are included, and must be able to retrieve them when not included.
Resource Type | Supported Profiles | Supported Search parameters | Supported _includes |
---|---|---|---|
Endpoint | Argonaut Endpoint Profile | identifier, organization, name | |
Location | Argonaut Location Profile | identifier, name, address | Location:endpoint |
Organization | Argonaut Organization Profile | identifier, name, address | Organization:endpoint |
Practitioner | Argonaut Practitioner Profile | identifier, name | |
PractitionerRole | Argonaut PractitionerRole Profile | practitioner, specialty | PractitionerRole:practitioner, PractitionerRole:endpoint |
Supported Profiles: Argonaut Endpoint Profile
Search Criteria:
A server SHALL be capable of fetching an Endpoint using:
GET [base]/Endpoint?identifier=[system]|[code]
GET [base]/Endpoint?organization=[id]
GET [base]/Endpoint?name=[string]
Conformance | Parameter | Type | _include (see documentation) |
---|---|---|---|
SHALL | identifier | token | |
SHALL | name | string | |
SHALL | organization | reference |
Supported Profiles: Argonaut Location Profile
Search Criteria:
A server SHALL be capable of returning 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}
Search Parameters:
Conformance | Parameter | Type | _include (see documentation) |
---|---|---|---|
SHALL | identifier | token | Location:endpoint |
SHALL | name | string | Location:endpoint |
SHALL | address | string | Location:endpoint |
Supported Profiles: Argonaut Organization Profile
Search Criteria:
A server SHALL be capable of returning 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}
Conformance | Parameter | Type | _include (see documentation) |
---|---|---|---|
SHALL | identifier | token | Organization:endpoint |
SHALL | name | string | Organization:endpoint |
SHALL | address | string | Organization:endpoint |
Supported Profiles: Argonaut Practitioner Profile
Search Criteria:
A server SHALL be capable of returning a Practitioner using:
GET [base]/Practitioner?identifier=[system]|[code]
GET [base]/Practitioner?family=[string]&given=[string]
GET [base]/Practitioner?name=[string]
Conformance | Parameter | Type | _include (see documentation) |
---|---|---|---|
SHALL | identifier | token | |
SHALL | given | string | |
SHALL | family | string | |
SHALL | name | string |
Supported Profiles: Argonaut PractitionerRole Profile
Search Criteria:
A server SHALL be capable of returning 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}
A server MAY return a PractitionerRole using:
GET [base]/PractitionerRole?location.address-city=[city]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}
GET [base]/PractitionerRole?location.address-city=[city]&specialty=[string]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}
GET [base]/PractitionerRole?location.near=[lat],[long]&near-distance=[distance]{&_include=PractitionerRole:practitioner&_include=PractitionerRole:endpoint}
Search Parameters:
Conformance | Parameter | Type | _include (see documentation) |
---|---|---|---|
SHALL | practitioner.identifier | reference + token (chained parameter) | PractitionerRole:practitioner, PractitionerRole:endpoint |
SHALL | practitioner.family | reference + string (chained parameter) | PractitionerRole:practitioner, PractitionerRole:endpoint |
SHALL | specialty | token | PractitionerRole:practitioner, PractitionerRole:endpoint |
MAY | location.address | reference + string (chained parameter) | PractitionerRole:practitioner, PractitionerRole:endpoint |
MAY | location.near, location.distance | reference + token (chained parameter), reference + quantity (chained parameter) | PractitionerRole:practitioner, PractitionerRole:endpoint |
{ "resourceType": "CapabilityStatement", "id": "server", "text": { "status": "additional", "div": "<!-- snip (see above) -->" }, "url": "http://fhir.org/guides/argonaut-pd/CapabilityStatement/server", "version": "1.0.0", "name": "Argonaut Provider Directory Server", "status": "draft", "date": "2017-04-15T00:00:00+10:00", "publisher": "Argonaut Project", "contact": [ { "telecom": [ { "system": "other", "value": "{{ site.data.fhir.path }}" } ] } ], "description": "This profile defines the expected capabilities of a server when conforming to the Argonaut Provider Directory Implementation Guide.", "kind": "requirements", "fhirVersion": "3.0.0", "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": "server", "documentation": "The Argonaut Provider Directory Server SHALL support the Argonaut Provider Directory Profile:- Argonaut Provider Directory Endpoint- Argonaut Provider Directory Location- Argonaut Provider Directory Organization- Argonaut Provider Directory Practitioner- Argonaut Provider Directory PractitionerRole The Argonaut Provider Directory Server SHALL implement REST behavior according to the FHIR specification. The Argonaut Provider Directory Server SHALL support both json and xml resource formats for all Argonaut Provider Directory interactions.", "security": { "description": "Argonaut Provider Directory Servers SHALL implement the security requirements documented in the Argonaute Provider Directory IG." }, "resource": [ { "type": "Practitioner", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/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/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read", "documentation": "Allows retrieval of a specific Argonaut Provider Directory Provider by id" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "name", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-name", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "family", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-family", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "given", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-given", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "identifier", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-identifier", "type": "token" } ] }, { "type": "Organization", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/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/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read", "documentation": "Allows retrieval of a specific Argonaut Provider Directory Provider Organization by id" } ], "searchInclude": [ "Organization:endpoint" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "name", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Organization-name", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "address", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Organization-address", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "identifier", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Organization-identifier", "type": "token" } ] }, { "type": "Location", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/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/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read", "documentation": "Allows retrieval of a specific Argonaut Provider Directory Provider Location by id" } ], "searchInclude": [ "Location:endpoint" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "name", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Location-name", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "address", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Location-address", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "identifier", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Location-identifier", "type": "token" } ] }, { "type": "Endpoint", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/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/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read", "documentation": "Allows retrieval of a specific Argonaut Provider Directory Provider Endpoint by id" } ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "name", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-name", "type": "string" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "organization", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-organization", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "identifier", "definition": "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-identifier", "type": "token" } ] }, { "type": "PractitionerRole", "interaction": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/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/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "code": "read", "documentation": "Allows retrieval of a specific Argonaut Provider Directory Provider PractitionerRole by id" } ], "searchInclude": [ "PractitionerRole:practitioner", "PractitionerRole:endpoint" ], "searchParam": [ { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "practitioner", "definition": "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-practitioner", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "MAY" } ], "name": "location", "definition": "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-location", "type": "reference" }, { "extension": [ { "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation", "valueCode": "SHALL" } ], "name": "specialty", "definition": "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-specialty", "type": "token" } ] } ] } ] }