webapi.yaml

openapi: "3.0.0"
info:
  version: 1.0.0
  title: COVID-19 Hokkaido API
  description: 北海道 新型コロナウイルスまとめサイトAPI
  contact:
    name: JUST Do It
    url: https://stopcovid19.hokkaido.dev/about/
  license:
    name: Attribution 4.0 International (CC BY 4.0)
    url: https://creativecommons.org/licenses/by/4.0/deed.ja
  
  x-logo:
    url: 'https://stopcovid19.hokkaido.dev/ogp.png'
    altText: COVID-19 Hokkaido API

servers:
  - url: https://stopcovid19.hokkaido.dev/api

tags:
  - name: 患者統計情報

paths:
  /current_patients.json:
    get:
      tags:
        - 患者統計情報
      summary: 現在患者数
      description: |
        現在患者数とは、陽性患者数から治療終了者数と死亡者数を除いた人数です。
        なお、ご覧いただいている時間によっては累計されている日付が違う場合がありますのでご注意ください。
        死亡者数は北海道のホームページを参照してください。<br>
        出典: 北海道 オープンデータポータル
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/date'
                        患者数:
                          $ref: '#/components/schemas/number_of_patients'
                        軽症中等症:
                          $ref: '#/components/schemas/mild_moderate'
                        重症:
                          $ref: '#/components/schemas/severe'
                        死亡: 
                          $ref: '#/components/schemas/dead'
                  last_update:
                    $ref: '#/components/schemas/last_update'
  /discharges_summary.json:
    get:
      tags:
        - 患者統計情報
      summary: 治療終了者数
      description: |
        治療終了者数とは道発表の「陰性確認済累計」と同じものです。
        「陰性確認済累計」とは、陽性の患者が軽快してから48時間後の1回目のPCR検査で陰性が確認され、それから12時間後の2回目のPCR検査でも陰性が確認された方の累計のことです。
        （3/9 鈴木知事のツイートから引用）<br>
        出典: 北海道 オープンデータポータル
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/datetime'
                        日治療終了数:
                          $ref: '#/components/schemas/number_of_daily_treatments'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /patients_summary.json:
    get:
      tags:
        - 患者統計情報
      summary: 陽性患者数
      description: |
        出典: 北海道 オープンデータポータル
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/datetime'
                        日陽性数:
                          $ref: '#/components/schemas/daily_positives'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /patients.json:
    get:
      tags:
        - 患者統計情報
      summary: 陽性患者の属性
      description: |
        出典: 北海道 オープンデータポータル
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        No:
                          $ref: '#/components/schemas/no'
                        リリース日:
                          $ref: '#/components/schemas/release_date'
                        曜日:
                          $ref: '#/components/schemas/day_of_week'
                        居住地:
                          $ref: '#/components/schemas/residence'
                        年代: 
                          $ref: '#/components/schemas/age'
                        性別:
                          $ref: '#/components/schemas/sex'
                        属性:
                          $ref: '#/components/schemas/type'
                        備考:
                          $ref: '#/components/schemas/remark'
                        補足:
                          $ref: '#/components/schemas/supplement'
                        退院:
                          $ref: '#/components/schemas/discharge'
                        周囲の状況:
                          $ref: '#/components/schemas/surrounding_situation'
                        濃厚接触者の状況:
                          $ref: '#/components/schemas/close_contact_situation'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /inspections.json:
    get:
      tags:
        - 患者統計情報
      summary: 検査数
      description: |
        3月3日以前のデータが公開されていないため、データは3月3日以降となります。<br>
        出典: 北海道 オープンデータポータル
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/datetime'
                        日検査数:
                          $ref: '#/components/schemas/daily_inspections'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /contacts.json:
    get:
      tags:
        - 患者統計情報
      summary: 新型コロナコールセンター相談件数
      description: |
        札幌市保健所値<br>
        出典: DATA-SMART CITY SAPPORO
      link: https://ckan.pf-sapporo.jp/dataset/covid_19_soudan
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/datetime'
                        曜日:
                          $ref: '#/components/schemas/day_of_week'
                        date:
                          $ref: '#/components/schemas/date'
                        short_date:
                          $ref: '#/components/schemas/short_date'
                        小計:
                          $ref: '#/components/schemas/subtotal'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /querents.json:
    get:
      tags:
        - 患者統計情報
      summary: 帰国者・接触者電話相談センター相談件数
      description: |
        札幌市保健所値<br>
        出典: DATA-SMART CITY SAPPORO
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        日付:
                          $ref: '#/components/schemas/datetime'
                        曜日:
                          $ref: '#/components/schemas/day_of_week'
                        date:
                          $ref: '#/components/schemas/date'
                        short_date:
                          $ref: '#/components/schemas/short_date'
                        小計:
                          $ref: '#/components/schemas/subtotal'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /main_summary.json:
    get:
      tags:
        - 患者統計情報
      description: COVID-19感染患者数情報
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      properties:
                        検査人数:
                          $ref: '#/components/schemas/inspection_number'
                        陽性者数:
                          $ref: '#/components/schemas/positives'
                        患者数:
                          $ref: '#/components/schemas/number_of_patients'
                        軽症・中等症者数:
                          $ref: '#/components/schemas/number_of_mild_moderate_patients'
                        重傷者数: 
                          $ref: '#/components/schemas/serious_injuries'
                        死亡者数:
                          $ref: '#/components/schemas/deaths'
                        陰性確認数:
                          $ref: '#/components/schemas/number_of_negative_confirmations'
                  last_update:
                    $ref: '#/components/schemas/last_update'

  /last_update.json:
    get:
      tags:
        - 患者統計情報
      summary: 全データの最終更新日時
      responses:
        '200':
          content:
           text/plain:
              schema:
                $ref: '#/components/schemas/last_update'

components:
  schemas:
    datetime:
      summary: 日付
      type: string
      format: date-time
      example: "2020-02-19T08:00:00.000Z"
    day_of_week:
      summary: 曜日
      type: string
      example: 月
    number_of_patients:
      summary: 患者数
      type: integer
      example: 3
    mild_moderate:
      summary: 軽症中等症
      type: integer
      example: 22
    severe:
      summary: 重症
      type: integer
      example: 10
    dead: 
      summary: 死亡
      type: integer
      example: 10
    inspection_number:
      summary: 検査人数
      type: integer
      example: 10
    positives: 
      summary: 陽性者数
      type: integer
      example: 10
    daily_positives: 
      summary: 日陽性数
      type: integer
      example: 10
    number_of_mild_moderate_patients: 
      summary: 軽症・中等症者数
      type: integer
      example: 10
    serious_injuries: 
      summary: 重傷者数
      type: integer
      example: 10
    deaths: 
      summary: 死亡者数
      type: integer
      example: 10
    number_of_negative_confirmations: 
      summary: 陰性確認数
      type: integer
      example: 10

    remark:
      summary: 備考
      type: string
      example: 10

    9-17時:
      summary: 9-17時
      type: integer
      example: ""
    13-17:
      summary: 9-13時
      type: integer
      example: ""
    17-21:
      summary: 9-13時
      type: integer
      example: ""
    9-17:
      summary: 9-17時
      type: integer
      example: ""
    17-after9:
      summary: 17-翌9時
      type: integer
      example: ""
    date:
      summary: 日付
      type: string
      example: "2020-02-19"
    short_date:
      summary: 日付
      type: string
      example: 02/19
    subtotal:
      summary: 小計
      type: integer
      example: 350
    number_of_daily_treatments:
      summary: 日治療終了数
      type: integer
      example: 1
    daily_inspections:
      summary: 日検査数
      type: integer
      example: 1
    w:
      summary: w
      type: string
      example: ""
    no:
      summary: "No"
      type: integer
      example: 1
    release_date:
      summary: リリース日
      type: string
      format: date-time
      example: "2020-01-28T00:00"
    residence:
      summary: 居住地
      type: string
      example: 札幌市
    age:
      summary: 年代
      type: string
      example: 40代
    sex:
      summary: 性別
      type: string
      example: 女性
    type:
      summary: 属性
      type: string
      example: "自営業"
    supplement:
      summary: 補足
      type: string
      example: ""
    discharge:
      summary: 退院
      type: string
      example: ""
    surrounding_situation:
      summary: 周囲の状況
      type: string
      example: "なし"
    close_contact_situation:
      summary: 濃厚接触者の状況
      type: string
      example: "濃厚接触者を特定し 健康観察終了"
    last_update:
      type: string
      format: date-time
      example: "2020-04-05T12:53:45.081937+09:00"