This section describes the expected capabilities of the US Core Server actor which is responsible for providing responses to the queries submitted by US Core Requestors. Implementations meet ONC 2015 Common Clinical Data Set (CCDS) Patient Selection 170.315(g)(7) and Application Access - Data Category Request 170.315(g)(8) requirements as well as USCDI Version 4 (July 2023).
openapi: 3.0.2
info:
title: 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://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: [email protected]
url: http://www.hl7.org/Special/committees/cgp
externalDocs:
url: http://hl7.org/fhir/us/core/CapabilityStatement/us-core-server
description: FHIR CapabilityStatement
paths:
"/metadata":
summary: Access to the Server's Capability Statement
description: All FHIR Servers return a CapabilityStatement that describes what services they perform
get:
summary: Fast Healthcare Interoperability Resources Return the server's capability statement
operationId: metadata
responses:
'200':
description: the capbility statement
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CapabilityStatement
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CapabilityStatement.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/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/elements"
tags:
- Metadata
"/AllergyIntolerance":
summary: Manager for resources of type AllergyIntolerance
description: 'The Manager for resources of type AllergyIntolerance: provides services to manage the collection of all the AllergyIntolerance instances'
get:
summary: Fast Healthcare Interoperability Resources Search all resources of type AllergyIntolerance based on a set of criteria
operationId: searchAllergyIntolerance
responses:
'200':
description: the resource 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/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/elements"
- name: clinical-status
in: query
description: "**active | inactive | resolved** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
schema:
type: string
- name: patient
in: query
description: "**Who the sensitivity is for** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
schema:
type: string
tags:
- AllergyIntolerance
post:
summary: Fast Healthcare Interoperability Resources Create a new resource
operationId: createAllergyIntolerance
requestBody:
description: The new state of the resource
required: true
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.xsd
responses:
'200':
description: the resource being returned after being updated
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.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"
tags:
- AllergyIntolerance
"/AllergyIntolerance/{rid}":
summary: Read/Write/etc resource instance of type AllergyIntolerance
description: Access to services to manage the state of a single resource of type AllergyIntolerance
get:
summary: Fast Healthcare Interoperability Resources Read the current state of the resource
operationId: readAllergyIntolerance
responses:
'200':
description: the resource being returned
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- AllergyIntolerance
put:
summary: Fast Healthcare Interoperability Resources Update the current state of the resource
operationId: updateAllergyIntolerance
requestBody:
description: The new state of the resource
required: true
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.xsd
responses:
'200':
description: the resource being returned after being updated
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- AllergyIntolerance
patch:
summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands
operationId: patchAllergyIntolerance
requestBody:
description: The new state of the resource
required: true
content:
application/json-patch+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters
application/xml-patch+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.xsd
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/Parameters.xsd
responses:
'200':
description: the resource being returned after being patched
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- AllergyIntolerance
delete:
summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc)
operationId: deleteAllergyIntolerance
responses:
'204':
description: If the resource is deleted - no content is returned
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
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/rid"
tags:
- AllergyIntolerance
"/AllergyIntolerance/{rid}/_history":
summary: Read past versions of resource instance of type AllergyIntolerance
description: Access to previous versions of a single resource of type AllergyIntolerance
get:
summary: Fast Healthcare Interoperability Resources Read the past states of the resource
operationId: histinstAllergyIntolerance
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/rid"
- "$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:
- AllergyIntolerance
"/AllergyIntolerance/{rid}/_history/{hid}":
summary: Read a past version of resource instance of type AllergyIntolerance
description: Access a to specified previous version of a single resource of type AllergyIntolerance
get:
summary: Fast Healthcare Interoperability Resources Read a past state of the resource
operationId: vreadAllergyIntolerance
responses:
'200':
description: the resource being returned
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag for that version
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/AllergyIntolerance
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/AllergyIntolerance.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/rid"
- "$ref": "#/components/parameters/hid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- AllergyIntolerance
"/AllergyIntolerance/_history":
summary: Read past versions of resources of type AllergyIntolerance
description: Access to previous versions of resourcez of type AllergyIntolerance
get:
summary: Fast Healthcare Interoperability Resources Read the past states of the resource
operationId: histtypeAllergyIntolerance
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:
- AllergyIntolerance
"/CarePlan":
summary: Manager for resources of type CarePlan
description: 'The Manager for resources of type CarePlan: provides services to manage the collection of all the CarePlan instances'
get:
summary: Fast Healthcare Interoperability Resources Search all resources of type CarePlan based on a set of criteria
operationId: searchCarePlan
responses:
'200':
description: the resource 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/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/elements"
- name: category
in: query
description: "**Type of plan** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
schema:
type: string
- name: date
in: query
description: "**Time period plan covers** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
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: patient
in: query
description: "**Who the care plan is for** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
schema:
type: string
- name: status
in: query
description: "**draft | active | on-hold | revoked | completed | entered-in-error | unknown** \n**NOTE**: This US Core SearchParameter definition extends the usage context of the\n[Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html)\n - multipleAnd\n - multipleOr\n - comparator\n - modifier\n - chain"
schema:
type: string
tags:
- CarePlan
post:
summary: Fast Healthcare Interoperability Resources Create a new resource
operationId: createCarePlan
requestBody:
description: The new state of the resource
required: true
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.xsd
responses:
'200':
description: the resource being returned after being updated
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.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"
tags:
- CarePlan
"/CarePlan/{rid}":
summary: Read/Write/etc resource instance of type CarePlan
description: Access to services to manage the state of a single resource of type CarePlan
get:
summary: Fast Healthcare Interoperability Resources Read the current state of the resource
operationId: readCarePlan
responses:
'200':
description: the resource being returned
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- CarePlan
put:
summary: Fast Healthcare Interoperability Resources Update the current state of the resource
operationId: updateCarePlan
requestBody:
description: The new state of the resource
required: true
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.xsd
responses:
'200':
description: the resource being returned after being updated
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- CarePlan
patch:
summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands
operationId: patchCarePlan
requestBody:
description: The new state of the resource
required: true
content:
application/json-patch+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters
application/xml-patch+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.xsd
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/Parameters.xsd
responses:
'200':
description: the resource being returned after being patched
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
content:
application/fhir+json:
schema:
"$ref": https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CarePlan
application/fhir+xml:
schema:
"$ref": https://hl7.org/fhir/R4/CarePlan.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/rid"
- "$ref": "#/components/parameters/summary"
- "$ref": "#/components/parameters/format"
- "$ref": "#/components/parameters/pretty"
- "$ref": "#/components/parameters/elements"
tags:
- CarePlan
delete:
summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc)
operationId: deleteCarePlan
responses:
'204':
description: If the resource is deleted - no content is returned
headers:
ETag:
description: Version from Resource.meta.version as a weak ETag
schema:
type: string
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/rid"
tags:
- CarePlan
"/CarePlan/{rid}/_history":
summary: Read past versions of resource instance of type CarePlan
description: Access to previous versions of a single resource of type CarePlan
get:
summary: Fast Healthcare Interoperability Resources Read the past states of the resource
operationId: histinstCarePlan
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/rid"
- "$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)))?)?)
# --- truncated at 32 KB (523 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fhir/refs/heads/main/openapi/fhir-openapi-original.yml