Health Record Rights Method API

openapi: 3.2.0
info:
  title: Health Record Rights Index Method API
  version: '1'
  summary: Read-only JSON. Open, no sign-up, no key.
  description: Health record rights in countries and territories (scores out of 100, with sources), what each of the 50 states and DC adds to federal law (answers, no scores), and published real cases. Data version 1.0. Fields in v1 are never removed or renamed. Not legal advice.
  license:
    name: CC BY 4.0 (data and scores; quoted law, source titles and linked pages are not relicensed)
    url: https://creativecommons.org/licenses/by/4.0/
  contact:
    url: https://healthrecordrights.com/developers/
servers:
- url: https://healthrecordrights.com/api/v1
tags:
- name: Method
paths:
  /method:
    get:
      summary: How we score
      description: Categories and weights, bands, ties, the lead group, confidence and the state study rules.
      parameters: []
      responses:
        '200':
          description: The method.
          headers:
            ETag:
              schema:
                type: string
            Cache-Control:
              schema:
                type: string
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Envelope'
                - type: object
                  properties:
                    data:
                      type: object
        '400':
          description: A query parameter could not be used. The body says why.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found, with a plain message and, for a name or alias, the code to use.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests. Wait the number of seconds in Retry-After.
          headers:
            Retry-After:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getMethod
      tags:
      - Method
components:
  schemas:
    License:
      type: object
      properties:
        id:
          type: string
        url:
          type: string
        credit:
          type: string
        covers:
          type: string
        excludes:
          type: string
      required:
      - id
      - url
      - credit
    Error:
      allOf:
      - $ref: '#/components/schemas/Envelope'
      - type: object
        properties:
          data:
            type: 'null'
          error:
            type: object
            properties:
              status:
                type: integer
              code:
                type: string
                enum:
                - not_found
                - not_rated
                - use_code
                - not_covered
                - bad_request
                - method_not_allowed
                - rate_limited
                - server_error
                - gone
              message:
                type: string
              suggestions:
                type: array
                items:
                  type: object
                  properties:
                    code:
                      type: string
                    name:
                      type: string
                    url:
                      type: string
              removed:
                type: object
                properties:
                  id:
                    type: string
                  removedOn:
                    type: string
                  removalClass:
                    type: string
                    enum:
                    - window
                    - withdrawn
                description: 'A case taken down (410 only): its id, the day and why, as a class: past the two-year window (window) or withdrawn (withdrawn). Nothing else about the case is kept.'
            required:
            - status
            - code
            - message
    Envelope:
      type: object
      properties:
        api:
          const: v1
        version:
          type: string
          description: The index (data) version, like 1.0. Not the API version, which is api.
        asOf:
          type: string
          format: date
          description: The release date of the data, the same on every route. A country or state also carries its own date in data.
        dataSha256:
          type: string
          description: 'The release hash: SHA-256 of the country files behind the scores; the paper records the same hash. State answers are covered by statesSha256.'
        statesSha256:
          type: string
          description: 'State routes only: SHA-256 of the state files.'
        casesSha256:
          type: string
          description: 'Country and case routes: SHA-256 of the real cases, which the weekly refresh can change while dataSha256 stays the same.'
        casesAsOf:
          type: string
          format: date
          description: 'Country and case routes: the day the real cases last changed (a case added or taken off), from the changes journal. The index asOf is the data date and stays separate.'
        license:
          $ref: '#/components/schemas/License'
        citation:
          type: string
          description: How to cite the index.
        pageUrl:
          type: string
          description: The page on healthrecordrights.com that shows the same thing.
        data: {}
      required:
      - api
      - version
      - asOf
      - dataSha256
      - license
      - citation
      - pageUrl
      - data