openapi: 3.0.1
info:
  title: Smile CDR
  contact: {}
servers:
- url: https://providerdirectoryapi.chpw.org
  description: Smile CDR
tags:
- name: System Level Operations
  description: Server-level operations
- name: HealthcareService
  description: "The HealthcareService FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/HealthcareService"
- name: InsurancePlan
  description: "The InsurancePlan FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/InsurancePlan"
- name: Location
  description: "The Location FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Location"
- name: OperationDefinition
  description: "The OperationDefinition FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/OperationDefinition"
- name: Organization
  description: "The Organization FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Organization"
- name: Practitioner
  description: "The Practitioner FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/Practitioner"
- name: PractitionerRole
  description: "The PractitionerRole FHIR resource type<br/>Base profile: http://hl7.org/fhir/StructureDefinition/PractitionerRole"
paths:
  /metadata:
    get:
      tags:
      - System Level Operations
      summary: "server-capabilities: Fetch the server FHIR CapabilityStatement"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
              example: |-
                {
                  "resourceType": "CapabilityStatement"
                }
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
              example: <CapabilityStatement xmlns="http://hl7.org/fhir"/>
  /HealthcareService/{id}:
    get:
      tags:
      - HealthcareService
      summary: "read-instance: Read HealthcareService instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /HealthcareService/{id}/_history/{version_id}:
    get:
      tags:
      - HealthcareService
      summary: "vread-instance: Read HealthcareService instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /HealthcareService:
    get:
      tags:
      - HealthcareService
      summary: "search-type: Search for HealthcareService instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /HealthcareService/_search:
    get:
      tags:
      - HealthcareService
      summary: "search-type: Search for HealthcareService instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /InsurancePlan/{id}:
    get:
      tags:
      - InsurancePlan
      summary: "read-instance: Read InsurancePlan instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /InsurancePlan/{id}/_history/{version_id}:
    get:
      tags:
      - InsurancePlan
      summary: "vread-instance: Read InsurancePlan instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /InsurancePlan:
    get:
      tags:
      - InsurancePlan
      summary: "search-type: Search for InsurancePlan instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /InsurancePlan/_search:
    get:
      tags:
      - InsurancePlan
      summary: "search-type: Search for InsurancePlan instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Location/{id}:
    get:
      tags:
      - Location
      summary: "read-instance: Read Location instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Location/{id}/_history/{version_id}:
    get:
      tags:
      - Location
      summary: "vread-instance: Read Location instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Location:
    get:
      tags:
      - Location
      summary: "search-type: Search for Location instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Location/_search:
    get:
      tags:
      - Location
      summary: "search-type: Search for Location instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /OperationDefinition/{id}:
    get:
      tags:
      - OperationDefinition
      summary: "read-instance: Read OperationDefinition instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Organization/{id}:
    get:
      tags:
      - Organization
      summary: "read-instance: Read Organization instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Organization/{id}/_history/{version_id}:
    get:
      tags:
      - Organization
      summary: "vread-instance: Read Organization instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Organization:
    get:
      tags:
      - Organization
      summary: "search-type: Search for Organization instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Organization/_search:
    get:
      tags:
      - Organization
      summary: "search-type: Search for Organization instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Practitioner/{id}:
    get:
      tags:
      - Practitioner
      summary: "read-instance: Read Practitioner instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Practitioner/{id}/_history/{version_id}:
    get:
      tags:
      - Practitioner
      summary: "vread-instance: Read Practitioner instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Practitioner:
    get:
      tags:
      - Practitioner
      summary: "search-type: Search for Practitioner instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /Practitioner/_search:
    get:
      tags:
      - Practitioner
      summary: "search-type: Search for Practitioner instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /PractitionerRole/{id}:
    get:
      tags:
      - PractitionerRole
      summary: "read-instance: Read PractitionerRole instance"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /PractitionerRole/{id}/_history/{version_id}:
    get:
      tags:
      - PractitionerRole
      summary: "vread-instance: Read PractitionerRole instance with specific version"
      parameters:
      - name: id
        in: path
        description: The resource ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "123"
      - name: version_id
        in: path
        description: The resource version ID
        required: true
        style: simple
        schema:
          minimum: 1
          type: string
        example: "1"
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /PractitionerRole:
    get:
      tags:
      - PractitionerRole
      summary: "search-type: Search for PractitionerRole instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
  /PractitionerRole/_search:
    get:
      tags:
      - PractitionerRole
      summary: "search-type: Search for PractitionerRole instances"
      description: This is a search type
      parameters:
      - name: _has
        in: query
        description: Return resources linked to by the given target
        required: false
        schema:
          type: string
      - name: _id
        in: query
        description: Only return resources with specified logical ID
        required: false
        schema:
          type: string
      - name: _lastUpdated
        in: query
        description: Only return resources which were last updated as specified by
          the given range
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: string
            format: date
      - name: _profile
        in: query
        description: Search for resources which have the given profile
        required: false
        schema:
          type: string
      - name: _source
        in: query
        description: Only return resources that originated from the specified source
        required: false
        schema:
          type: string
      responses:
        "200":
          description: Success
          content:
            application/fhir+json:
              schema:
                $ref: "#/components/schemas/FHIR-JSON-RESOURCE"
            application/fhir+xml:
              schema:
                $ref: "#/components/schemas/FHIR-XML-RESOURCE"
components:
  schemas:
    FHIR-JSON-RESOURCE:
      type: object
      description: A FHIR resource
    FHIR-XML-RESOURCE:
      type: object
      description: A FHIR resource