interopiO® Argonaut Provider Directory Implementation

Description

The Argonaut project Provider Directory guide is based upon the FHIR STU3 API and contains the foundation for a robust provider directory. It describes the use cases and search expectations for finding a practitioner or organization. It outlines the key data elements for any provider directory and basic query guidance.

Profiles

Argonauts provides several FHIR profiles that sets minimum expectations for the specified resources to searching for and fetching. It identifies which core elements, extensions, vocabularies and value sets shall be present in the resource when using this profile.

• Argonaut Provider Directory Endpoint
• Argonaut Provider Directory Location
• Argonaut Provider Directory Organization
• Argonaut Provider Directory Practitioner
• Argonaut Provider Directory PractitionerRole

Implemented functionalities

[base] - URL of the used gateway

• Get metadata

  Query: GET [base]/metadata

• Search for practitioner by given and family name

  Query: GET [base]/Practitioner?given=[string]&family=[string]

  Query description: You may provide full or part of the given and/or family name. You may provide one or both of the parameters (given, family).

  Example: https://interopio.com/gateway/fhir/test/test-01/argonaut-gateway/Practitioner?given=KATHARINE&family=FROTHINGHAM

  Result: List of practitioners.
  
  
  

• Search for practitioner by specialty

  Query: GET [base]/Practitioner?specialty=[code]

  Query description: Provide valid specialty code where specialty code is one of https://www.fhir.org/guides/argonaut/pd/ValueSet-provider-specialty.html
  Example: https://interopio.com/gateway/fhir/test/test-01/argonaut-gateway/Practitioner?specialty=101YM0800X

  Result: List of practitioners.

   

   

• Search for practitioner by organization

  Query: GET [base]/Practitioner?organization=[string]

  Query description: Provide full or part of the organization name.

  Example: https://interopio.com/gateway/fhir/test/test-01/argonaut-gateway/Practitioner?organization=Alliance

  Result: List of practitioners.

   
  
  

• Search for organization by name

  Query: GET [base]/Organization?name=[string]

  Query description: Provide full or part of the organization name.

  Example: https://interopio.com/gateway/fhir/test/test-01/argonaut-gateway/Organization?name=Alliance HomeCare

  Return: List of organizations.
  
  
  

• Search for organization by address

  Query: GET [base]/Organization?address=[string]

  Query description: Provide full or part of the organization address.

  Example: https://interopio.com/gateway/fhir/test/test-01/argonaut-gateway/Organization?address=900 N 1st St

  Return: List of organizations.