Fast Healthcare Interoperability Resources History API

openapi: 3.0.2
info:
  title: Fast Healthcare Interoperability Resources (FHIR) AllergyIntolerance  History API
  description: This Section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by the US Core Requestors. The complete list of FHIR profiles, RESTful operations, and search parameters supported by US Core Servers are defined. Systems implementing this capability statement should meet the ONC 2015 Common Clinical Data Set (CCDS) access requirement for Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) and the ONC [U.S. Core Data for Interoperability (USCDI) Version 4 July 2023](https://www.healthit.gov/sites/isa/files/2023-07/Final-USCDI-Version-4-July-2023-Final.pdf).
  license:
    name: Creative Commons Zero v1.0 Universal
    url: http://spdx.org/licenses/CC0-1.0.html
  version: 7.0.0
  contact:
    name: HL7 International / Cross-Group Projects
    email: cgp@lists.HL7.org
    url: http://www.hl7.org/Special/committees/cgp
tags:
- name: ' History'
paths:
  /_history:
    summary: Read a past version of resource instance of all types
    description: Access a previous versions of all types
    get:
      summary: Fast Healthcare Interoperability Resources Read the past states of all resources
      operationId: histAll
      responses:
        '200':
          description: the resources being returned
          content:
            application/fhir+json:
              schema:
                $ref: https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle
            application/fhir+xml:
              schema:
                $ref: https://hl7.org/fhir/R4/Bundle.xsd
        default:
          description: Error, with details
          content:
            application/fhir+json:
              schema:
                $ref: https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome
            application/fhir+xml:
              schema:
                $ref: https://hl7.org/fhir/R4/OperationOutcome.xsd
      parameters:
      - $ref: '#/components/parameters/summary'
      - $ref: '#/components/parameters/format'
      - $ref: '#/components/parameters/pretty'
      - $ref: '#/components/parameters/elements'
      - $ref: '#/components/parameters/count'
      - name: _since
        in: query
        description: Only include resource versions that were created at or after the given instant in time
        schema:
          type: string
          pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?
      - name: _at
        in: query
        description: Only include resource versions that were current at some point during the time period specified in the date time value (see Search notes on date searching)
        schema:
          type: string
          pattern: ([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\.[0-9]+)?(Z|(\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?
      - name: _list
        in: query
        description: Only include resource versions that are referenced in the specified list (current list references are allowed)
        schema:
          type: string
      tags:
      - ' History'
components:
  parameters:
    pretty:
      name: _pretty
      in: query
      description: Ask for a pretty printed response for human convenience
      allowEmptyValue: true
      style: form
      schema:
        type: boolean
    format:
      name: _format
      in: query
      description: 'Specify alternative response formats by their MIME-types (when a client is unable acccess accept: header)'
      allowEmptyValue: true
      style: form
      schema:
        type: string
        format: mime-type
    count:
      name: _count
      in: query
      description: The maximum number of search results on a page. The server is not bound to return the number requested, but cannot return more
      schema:
        type: number
    summary:
      name: _summary
      in: query
      description: Requests the server to return a designated subset of the resource
      allowEmptyValue: true
      style: form
      schema:
        type: string
        enum:
        - 'true'
        - text
        - data
        - count
        - 'false'
    elements:
      name: _elements
      in: query
      description: Requests the server to return a collection of elements from the resource
      allowEmptyValue: true
      style: form
      explode: false
      schema:
        type: array
        format: string
        items:
          format: string
externalDocs:
  url: http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server
  description: FHIR CapabilityStatement