FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: CapabilityStatement/client

Packagefhir.argonaut.pd
TypeCapabilityStatement
Idclient
FHIR VersionR3
Sourcehttp://fhir.org/guides/argonaut/pd/https://simplifier.net/resolve?scope=fhir.argonaut.pd@1.0.0&canonical=http://fhir.org/guides/argonaut-pd/CapabilityStatement/client
URLhttp://fhir.org/guides/argonaut-pd/CapabilityStatement/client
Version1.0.0
Statusdraft
Date2016-11-13T00:00:00+11:00
NameArgonaut Provider Directory Client
Realmus
Authorityhl7
DescriptionThis profile defines the expected capabilities of a client when conforming to the Argonaut Provider Directory Implementation Guide.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Conformance requirements for the Argonaut Provider Directory Client

  • FHIR Version: 3.0.0
  • Supported formats: xml, json
  • Published: 2017-04-30
  • Published by: Argonaut

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.

Behavior

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.

Security

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.

Resource Details:

1. Endpoint

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]
2. Location

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}
3. Organization

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}
4. Practitioner

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]
5. PractitionerRole

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}




Source

{
  "resourceType": "CapabilityStatement",
  "id": "client",
  "text": {
    "status": "additional",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.org/guides/argonaut-pd/CapabilityStatement/client",
  "version": "1.0.0",
  "name": "Argonaut Provider Directory Client",
  "status": "draft",
  "date": "2016-11-13T00:00:00+11:00",
  "publisher": "Argonaut Project",
  "contact": [
    {
      "telecom": [
        {
          "system": "other",
          "value": "http://argonautwiki.hl7.orgs/"
        }
      ]
    }
  ],
  "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/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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "family",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-family",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Practitioner-given",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Organization-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Organization-address",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Location-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Location-address",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-name",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "organization",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/Endpoint-organization",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/STU3/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "name": "specialty",
              "definition": "http://hl7.org/fhir/STU3/SearchParameter/PractitionerRole-specialty",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}