Fast Healthcare Interoperability Resources (FHIR)

naftiko: 1.0.0-alpha2
info:
  label: Fast Healthcare Interoperability Resources (FHIR)
  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://
  tags:
  - Fhir
  - API
  created: '2026-05-06'
  modified: '2026-05-06'
capability:
  consumes:
  - type: http
    namespace: fhir
    baseUri: https://api.example.com
    description: Fast Healthcare Interoperability Resources (FHIR) HTTP API.
    resources:
    - name: metadata
      path: /metadata
      operations:
      - name: metadata
        method: GET
        description: Fast Healthcare Interoperability Resources Return the server's capability statement
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: allergyintolerance
      path: /AllergyIntolerance
      operations:
      - name: searchallergyintolerance
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type AllergyIntolerance based on a
          set of criteria
        inputParameters:
        - name: clinical-status
          in: query
          type: string
          description: '**active | inactive | resolved** **NOTE**: This US Core SearchParameter definition extends the usage
            context of the [Conformance expectation extension](http://h'
        - name: patient
          in: query
          type: string
          description: '**Who the sensitivity is for** **NOTE**: This US Core SearchParameter definition extends the usage
            context of the [Conformance expectation extension](http://hl7'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createallergyintolerance
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: allergyintolerance-rid
      path: /AllergyIntolerance/{rid}
      operations:
      - name: readallergyintolerance
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateallergyintolerance
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchallergyintolerance
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteallergyintolerance
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: allergyintolerance-rid-history
      path: /AllergyIntolerance/{rid}/_history
      operations:
      - name: histinstallergyintolerance
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: allergyintolerance-rid-history-hid
      path: /AllergyIntolerance/{rid}/_history/{hid}
      operations:
      - name: vreadallergyintolerance
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: allergyintolerance-history
      path: /AllergyIntolerance/_history
      operations:
      - name: histtypeallergyintolerance
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careplan
      path: /CarePlan
      operations:
      - name: searchcareplan
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type CarePlan based on a set of criteria
        inputParameters:
        - name: category
          in: query
          type: string
          description: '**Type of plan** **NOTE**: This US Core SearchParameter definition extends the usage context of the
            [Conformance expectation extension](http://hl7.org/fhir/R4/e'
        - name: date
          in: query
          type: string
          description: '**Time period plan covers** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.or'
        - name: patient
          in: query
          type: string
          description: '**Who the care plan is for** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.o'
        - name: status
          in: query
          type: string
          description: '**draft | active | on-hold | revoked | completed | entered-in-error | unknown** **NOTE**: This US
            Core SearchParameter definition extends the usage context of t'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcareplan
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careplan-rid
      path: /CarePlan/{rid}
      operations:
      - name: readcareplan
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecareplan
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchcareplan
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecareplan
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careplan-rid-history
      path: /CarePlan/{rid}/_history
      operations:
      - name: histinstcareplan
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careplan-rid-history-hid
      path: /CarePlan/{rid}/_history/{hid}
      operations:
      - name: vreadcareplan
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careplan-history
      path: /CarePlan/_history
      operations:
      - name: histtypecareplan
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careteam
      path: /CareTeam
      operations:
      - name: searchcareteam
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type CareTeam based on a set of criteria
        inputParameters:
        - name: patient
          in: query
          type: string
          description: '**Who care team is for** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.org/f'
        - name: role
          in: query
          type: string
          description: Returns CareTeam resources with a participant role matching the specified code.
        - name: status
          in: query
          type: string
          description: '**proposed | active | suspended | inactive | entered-in-error** **NOTE**: This US Core SearchParameter
            definition extends the usage context of the [Conformance '
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcareteam
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careteam-rid
      path: /CareTeam/{rid}
      operations:
      - name: readcareteam
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecareteam
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchcareteam
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecareteam
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careteam-rid-history
      path: /CareTeam/{rid}/_history
      operations:
      - name: histinstcareteam
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careteam-rid-history-hid
      path: /CareTeam/{rid}/_history/{hid}
      operations:
      - name: vreadcareteam
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: careteam-history
      path: /CareTeam/_history
      operations:
      - name: histtypecareteam
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: condition
      path: /Condition
      operations:
      - name: searchcondition
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type Condition based on a set of criteria
        inputParameters:
        - name: abatement-date
          in: query
          type: string
          description: '**Date-related abatements (dateTime and period)** **NOTE**: This US Core SearchParameter definition
            extends the usage context of the [Conformance expectation ex'
        - name: asserted-date
          in: query
          type: string
          description: Returns conditions with an [assertedDate extension](http://hl7.org/fhir/StructureDefinition/condition-assertedDate)
            matching the specified date (dateTime).
        - name: category
          in: query
          type: string
          description: '**The category of the condition** **NOTE**: This US Core SearchParameter definition extends the usage
            context of the [Conformance expectation extension](http://'
        - name: clinical-status
          in: query
          type: string
          description: '**The clinical status of the condition** **NOTE**: This US Core SearchParameter definition extends
            the usage context of the [Conformance expectation extension]('
        - name: code
          in: query
          type: string
          description: '**Code for the condition** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.org'
        - name: encounter
          in: query
          type: string
          description: '**Encounter created as part of** **NOTE**: This US Core SearchParameter definition extends the usage
            context of the [Conformance expectation extension](http://h'
        - name: onset-date
          in: query
          type: string
          description: '**Date related onsets (dateTime and Period)** **NOTE**: This US Core SearchParameter definition extends
            the usage context of the [Conformance expectation extens'
        - name: patient
          in: query
          type: string
          description: '**Who has the condition?** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.org'
        - name: recorded-date
          in: query
          type: string
          description: '**Date record was first recorded** **NOTE**: This US Core SearchParameter definition extends the usage
            context of the [Conformance expectation extension](http:/'
        - name: _lastUpdated
          in: query
          type: string
          description: '**When the resource version last changed** **NOTE**: This US Core SearchParameter definition extends
            the usage context of the [Conformance expectation extension'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcondition
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: condition-rid
      path: /Condition/{rid}
      operations:
      - name: readcondition
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecondition
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchcondition
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecondition
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: condition-rid-history
      path: /Condition/{rid}/_history
      operations:
      - name: histinstcondition
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: condition-rid-history-hid
      path: /Condition/{rid}/_history/{hid}
      operations:
      - name: vreadcondition
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: condition-history
      path: /Condition/_history
      operations:
      - name: histtypecondition
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coverage
      path: /Coverage
      operations:
      - name: searchcoverage
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type Coverage based on a set of criteria
        inputParameters:
        - name: patient
          in: query
          type: string
          description: '**Retrieve coverages for a patient** **NOTE**: This US Core SearchParameter definition extends the
            usage context of the [Conformance expectation extension](http'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcoverage
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coverage-rid
      path: /Coverage/{rid}
      operations:
      - name: readcoverage
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatecoverage
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchcoverage
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletecoverage
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coverage-rid-history
      path: /Coverage/{rid}/_history
      operations:
      - name: histinstcoverage
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coverage-rid-history-hid
      path: /Coverage/{rid}/_history/{hid}
      operations:
      - name: vreadcoverage
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coverage-history
      path: /Coverage/_history
      operations:
      - name: histtypecoverage
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: device
      path: /Device
      operations:
      - name: searchdevice
        method: GET
        description: Fast Healthcare Interoperability Resources Search all resources of type Device based on a set of criteria
        inputParameters:
        - name: patient
          in: query
          type: string
          description: '**Patient information, if the resource is affixed to a person** **NOTE**: This US Core SearchParameter
            definition extends the usage context of the [Conformance '
        - name: status
          in: query
          type: string
          description: '**active | inactive | entered-in-error | unknown** **NOTE**: This US Core SearchParameter definition
            extends the usage context of the [Conformance expectation e'
        - name: type
          in: query
          type: string
          description: '**The type of the device** **NOTE**: This US Core SearchParameter definition extends the usage context
            of the [Conformance expectation extension](http://hl7.org'
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createdevice
        method: POST
        description: Fast Healthcare Interoperability Resources Create a new resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: device-rid
      path: /Device/{rid}
      operations:
      - name: readdevice
        method: GET
        description: Fast Healthcare Interoperability Resources Read the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatedevice
        method: PUT
        description: Fast Healthcare Interoperability Resources Update the current state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: patchdevice
        method: PATCH
        description: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch
          - a series of change commands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deletedevice
        method: DELETE
        description: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search
          etc)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: device-rid-history
      path: /Device/{rid}/_history
      operations:
      - name: histinstdevice
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: string
          description: Only include resource versions that were created at or after the given instant in time
        - name: _at
          in: query
          type: string
          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)
        - name: _list
          in: query
          type: string
          description: Only include resource versions that are referenced in the specified list (current list references are
            allowed)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: device-rid-history-hid
      path: /Device/{rid}/_history/{hid}
      operations:
      - name: vreaddevice
        method: GET
        description: Fast Healthcare Interoperability Resources Read a past state of the resource
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: device-history
      path: /Device/_history
      operations:
      - name: histtypedevice
        method: GET
        description: Fast Healthcare Interoperability Resources Read the past states of the resource
        inputParameters:
        - name: _since
          in: query
          type: s

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fhir/refs/heads/main/capabilities/fhir-capability.yaml