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: cgp@lists.HL7.org 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)))?)?)?" - 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: - CarePlan "/CarePlan/{rid}/_history/{hid}": summary: Read a past version of resource instance of type CarePlan description: Access a to specified previous version of a single resource of type CarePlan get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadCarePlan 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/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/hid" - "$ref": "#/components/parameters/summary" - "$ref": "#/components/parameters/format" - "$ref": "#/components/parameters/pretty" - "$ref": "#/components/parameters/elements" tags: - CarePlan "/CarePlan/_history": summary: Read past versions of resources of type CarePlan description: Access to previous versions of resourcez of type CarePlan get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeCarePlan 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: - CarePlan "/CareTeam": summary: Manager for resources of type CareTeam description: 'The Manager for resources of type CareTeam: provides services to manage the collection of all the CareTeam instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type CareTeam based on a set of criteria operationId: searchCareTeam 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: patient in: query description: "**Who care team 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: role in: query description: Returns CareTeam resources with a participant role matching the specified code. schema: type: string - name: status in: query description: "**proposed | active | suspended | inactive | entered-in-error** \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: - CareTeam post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createCareTeam 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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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: - CareTeam "/CareTeam/{rid}": summary: Read/Write/etc resource instance of type CareTeam description: Access to services to manage the state of a single resource of type CareTeam get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readCareTeam 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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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: - CareTeam put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateCareTeam 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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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: - CareTeam patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchCareTeam 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/CareTeam 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/CareTeam.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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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: - CareTeam delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteCareTeam 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: - CareTeam "/CareTeam/{rid}/_history": summary: Read past versions of resource instance of type CareTeam description: Access to previous versions of a single resource of type CareTeam get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstCareTeam 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: - CareTeam "/CareTeam/{rid}/_history/{hid}": summary: Read a past version of resource instance of type CareTeam description: Access a to specified previous version of a single resource of type CareTeam get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadCareTeam 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/CareTeam application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/CareTeam.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: - CareTeam "/CareTeam/_history": summary: Read past versions of resources of type CareTeam description: Access to previous versions of resourcez of type CareTeam get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeCareTeam 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: - CareTeam "/Condition": summary: Manager for resources of type Condition description: 'The Manager for resources of type Condition: provides services to manage the collection of all the Condition instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Condition based on a set of criteria operationId: searchCondition 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: abatement-date in: query description: "**Date-related abatements (dateTime and period)** \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: asserted-date in: query description: Returns conditions with an [assertedDate extension](http://hl7.org/fhir/StructureDefinition/condition-assertedDate) matching the specified date (dateTime). 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: category in: query description: "**The category of the condition** \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: clinical-status in: query description: "**The clinical status of the condition** \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: code in: query description: "**Code for the condition** \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: encounter in: query description: "**Encounter created as part of** \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: onset-date in: query description: "**Date related onsets (dateTime and Period)** \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 has the condition?** \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: recorded-date in: query description: "**Date record was first recorded** \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: _lastUpdated in: query description: "**When the resource version last changed** \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)))?)?)?" tags: - Condition post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createCondition 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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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: - Condition "/Condition/{rid}": summary: Read/Write/etc resource instance of type Condition description: Access to services to manage the state of a single resource of type Condition get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readCondition 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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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: - Condition put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateCondition 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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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: - Condition patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchCondition 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/Condition 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/Condition.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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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: - Condition delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteCondition 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: - Condition "/Condition/{rid}/_history": summary: Read past versions of resource instance of type Condition description: Access to previous versions of a single resource of type Condition get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstCondition 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: - Condition "/Condition/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Condition description: Access a to specified previous version of a single resource of type Condition get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadCondition 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/Condition application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Condition.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: - Condition "/Condition/_history": summary: Read past versions of resources of type Condition description: Access to previous versions of resourcez of type Condition get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeCondition 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: - Condition "/Coverage": summary: Manager for resources of type Coverage description: 'The Manager for resources of type Coverage: provides services to manage the collection of all the Coverage instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Coverage based on a set of criteria operationId: searchCoverage 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: patient in: query description: "**Retrieve coverages for a patient** \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: - Coverage post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createCoverage 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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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: - Coverage "/Coverage/{rid}": summary: Read/Write/etc resource instance of type Coverage description: Access to services to manage the state of a single resource of type Coverage get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readCoverage 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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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: - Coverage put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateCoverage 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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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: - Coverage patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchCoverage 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/Coverage 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/Coverage.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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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: - Coverage delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteCoverage 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: - Coverage "/Coverage/{rid}/_history": summary: Read past versions of resource instance of type Coverage description: Access to previous versions of a single resource of type Coverage get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstCoverage 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: - Coverage "/Coverage/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Coverage description: Access a to specified previous version of a single resource of type Coverage get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadCoverage 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/Coverage application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Coverage.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: - Coverage "/Coverage/_history": summary: Read past versions of resources of type Coverage description: Access to previous versions of resourcez of type Coverage get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeCoverage 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: - Coverage "/Device": summary: Manager for resources of type Device description: 'The Manager for resources of type Device: provides services to manage the collection of all the Device instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Device based on a set of criteria operationId: searchDevice 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: patient in: query description: "**Patient information, if the resource is affixed to a person** \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: "**active | inactive | 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 - name: type in: query description: "**The type of the device** \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: - Device post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createDevice 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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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: - Device "/Device/{rid}": summary: Read/Write/etc resource instance of type Device description: Access to services to manage the state of a single resource of type Device get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readDevice 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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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: - Device put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateDevice 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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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: - Device patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchDevice 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/Device 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/Device.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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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: - Device delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteDevice 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: - Device "/Device/{rid}/_history": summary: Read past versions of resource instance of type Device description: Access to previous versions of a single resource of type Device get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstDevice 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: - Device "/Device/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Device description: Access a to specified previous version of a single resource of type Device get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadDevice 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/Device application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Device.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: - Device "/Device/_history": summary: Read past versions of resources of type Device description: Access to previous versions of resourcez of type Device get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeDevice 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: - Device "/DiagnosticReport": summary: Manager for resources of type DiagnosticReport description: 'The Manager for resources of type DiagnosticReport: provides services to manage the collection of all the DiagnosticReport instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type DiagnosticReport based on a set of criteria operationId: searchDiagnosticReport 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: "**Which diagnostic discipline/department created the report** \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: code in: query description: "**The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result** \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: "**The clinically relevant time of the report** \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: _lastUpdated in: query description: "**When the resource version last changed** \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: "**The subject of the report if a patient** \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: "**The status of the report** \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: - DiagnosticReport post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createDiagnosticReport 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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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: - DiagnosticReport "/DiagnosticReport/{rid}": summary: Read/Write/etc resource instance of type DiagnosticReport description: Access to services to manage the state of a single resource of type DiagnosticReport get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readDiagnosticReport 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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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: - DiagnosticReport put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateDiagnosticReport 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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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: - DiagnosticReport patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchDiagnosticReport 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/DiagnosticReport 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/DiagnosticReport.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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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: - DiagnosticReport delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteDiagnosticReport 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: - DiagnosticReport "/DiagnosticReport/{rid}/_history": summary: Read past versions of resource instance of type DiagnosticReport description: Access to previous versions of a single resource of type DiagnosticReport get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstDiagnosticReport 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: - DiagnosticReport "/DiagnosticReport/{rid}/_history/{hid}": summary: Read a past version of resource instance of type DiagnosticReport description: Access a to specified previous version of a single resource of type DiagnosticReport get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadDiagnosticReport 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/DiagnosticReport application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DiagnosticReport.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: - DiagnosticReport "/DiagnosticReport/_history": summary: Read past versions of resources of type DiagnosticReport description: Access to previous versions of resourcez of type DiagnosticReport get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeDiagnosticReport 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: - DiagnosticReport "/DocumentReference": summary: Manager for resources of type DocumentReference description: 'The Manager for resources of type DocumentReference: provides services to manage the collection of all the DocumentReference instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type DocumentReference based on a set of criteria operationId: searchDocumentReference 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: category in: query description: "**Categorization of document** \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: "**When this document reference was created** \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/what is the subject of the document** \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: period in: query description: "**Time of service that is being documented** \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: status in: query description: "**current | superseded | entered-in-error** \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: type in: query description: "**Kind of document (LOINC if possible)** \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: - DocumentReference post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createDocumentReference 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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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: - DocumentReference "/DocumentReference/{rid}": summary: Read/Write/etc resource instance of type DocumentReference description: Access to services to manage the state of a single resource of type DocumentReference get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readDocumentReference 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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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: - DocumentReference put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateDocumentReference 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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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: - DocumentReference patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchDocumentReference 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/DocumentReference 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/DocumentReference.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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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: - DocumentReference delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteDocumentReference 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: - DocumentReference "/DocumentReference/{rid}/_history": summary: Read past versions of resource instance of type DocumentReference description: Access to previous versions of a single resource of type DocumentReference get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstDocumentReference 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: - DocumentReference "/DocumentReference/{rid}/_history/{hid}": summary: Read a past version of resource instance of type DocumentReference description: Access a to specified previous version of a single resource of type DocumentReference get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadDocumentReference 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/DocumentReference application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/DocumentReference.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: - DocumentReference "/DocumentReference/_history": summary: Read past versions of resources of type DocumentReference description: Access to previous versions of resourcez of type DocumentReference get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeDocumentReference 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: - DocumentReference "/Encounter": summary: Manager for resources of type Encounter description: 'The Manager for resources of type Encounter: provides services to manage the collection of all the Encounter instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Encounter based on a set of criteria operationId: searchEncounter 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: class in: query description: "**Classification of patient encounter** \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: "**A date within the period the Encounter lasted** \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: _lastUpdated in: query description: "**When the resource version last changed** \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: discharge-disposition in: query description: Returns encounters with an discharge-disposition matching the specified code. schema: type: string - name: identifier in: query description: "**Identifier(s) by which this encounter is known** \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: location in: query description: "**Location the encounter takes place** \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: "**The patient or group present at the encounter** \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: "**planned | arrived | triaged | in-progress | onleave | finished | cancelled +** \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: type in: query description: "**Specific type of encounter** \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: - Encounter post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createEncounter 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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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: - Encounter "/Encounter/{rid}": summary: Read/Write/etc resource instance of type Encounter description: Access to services to manage the state of a single resource of type Encounter get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readEncounter 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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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: - Encounter put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateEncounter 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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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: - Encounter patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchEncounter 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/Encounter 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/Encounter.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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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: - Encounter delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteEncounter 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: - Encounter "/Encounter/{rid}/_history": summary: Read past versions of resource instance of type Encounter description: Access to previous versions of a single resource of type Encounter get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstEncounter 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: - Encounter "/Encounter/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Encounter description: Access a to specified previous version of a single resource of type Encounter get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadEncounter 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/Encounter application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Encounter.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: - Encounter "/Encounter/_history": summary: Read past versions of resources of type Encounter description: Access to previous versions of resourcez of type Encounter get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeEncounter 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: - Encounter "/Endpoint": summary: Manager for resources of type Endpoint description: 'The Manager for resources of type Endpoint: provides services to manage the collection of all the Endpoint instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Endpoint based on a set of criteria operationId: searchEndpoint 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" tags: - Endpoint post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createEndpoint 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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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: - Endpoint "/Endpoint/{rid}": summary: Read/Write/etc resource instance of type Endpoint description: Access to services to manage the state of a single resource of type Endpoint get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readEndpoint 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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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: - Endpoint put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateEndpoint 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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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: - Endpoint patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchEndpoint 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/Endpoint 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/Endpoint.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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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: - Endpoint delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteEndpoint 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: - Endpoint "/Endpoint/{rid}/_history": summary: Read past versions of resource instance of type Endpoint description: Access to previous versions of a single resource of type Endpoint get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstEndpoint 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: - Endpoint "/Endpoint/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Endpoint description: Access a to specified previous version of a single resource of type Endpoint get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadEndpoint 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/Endpoint application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Endpoint.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: - Endpoint "/Endpoint/_history": summary: Read past versions of resources of type Endpoint description: Access to previous versions of resourcez of type Endpoint get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeEndpoint 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: - Endpoint "/Goal": summary: Manager for resources of type Goal description: 'The Manager for resources of type Goal: provides services to manage the collection of all the Goal instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Goal based on a set of criteria operationId: searchGoal 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: description in: query schema: type: string description: |- **The code or text describing the goal** **NOTE**: This US Core SearchParameter definition extends the usage context of the [Conformance expectation extension](http://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html) - multipleAnd - multipleOr - comparator - modifier - chain - name: lifecycle-status in: query description: "**proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected** \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 this goal is intended 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: target-date in: query description: "**Reach goal on or before** \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)))?)?)?" tags: - Goal post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createGoal 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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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: - Goal "/Goal/{rid}": summary: Read/Write/etc resource instance of type Goal description: Access to services to manage the state of a single resource of type Goal get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readGoal 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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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: - Goal put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateGoal 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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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: - Goal patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchGoal 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/Goal 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/Goal.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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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: - Goal delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteGoal 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: - Goal "/Goal/{rid}/_history": summary: Read past versions of resource instance of type Goal description: Access to previous versions of a single resource of type Goal get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstGoal 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: - Goal "/Goal/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Goal description: Access a to specified previous version of a single resource of type Goal get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadGoal 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/Goal application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Goal.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: - Goal "/Goal/_history": summary: Read past versions of resources of type Goal description: Access to previous versions of resourcez of type Goal get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeGoal 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: - Goal "/HealthcareService": summary: Manager for resources of type HealthcareService description: 'The Manager for resources of type HealthcareService: provides services to manage the collection of all the HealthcareService instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type HealthcareService based on a set of criteria operationId: searchHealthcareService 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" tags: - HealthcareService post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createHealthcareService 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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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: - HealthcareService "/HealthcareService/{rid}": summary: Read/Write/etc resource instance of type HealthcareService description: Access to services to manage the state of a single resource of type HealthcareService get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readHealthcareService 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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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: - HealthcareService put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateHealthcareService 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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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: - HealthcareService patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchHealthcareService 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/HealthcareService 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/HealthcareService.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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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: - HealthcareService delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteHealthcareService 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: - HealthcareService "/HealthcareService/{rid}/_history": summary: Read past versions of resource instance of type HealthcareService description: Access to previous versions of a single resource of type HealthcareService get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstHealthcareService 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: - HealthcareService "/HealthcareService/{rid}/_history/{hid}": summary: Read a past version of resource instance of type HealthcareService description: Access a to specified previous version of a single resource of type HealthcareService get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadHealthcareService 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/HealthcareService application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/HealthcareService.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: - HealthcareService "/HealthcareService/_history": summary: Read past versions of resources of type HealthcareService description: Access to previous versions of resourcez of type HealthcareService get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeHealthcareService 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: - HealthcareService "/Immunization": summary: Manager for resources of type Immunization description: 'The Manager for resources of type Immunization: provides services to manage the collection of all the Immunization instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Immunization based on a set of criteria operationId: searchImmunization 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: date in: query description: "**Vaccination (non)-Administration Date** \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: "**The patient for the vaccination record** \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: "**Immunization event status** \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: - Immunization post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createImmunization 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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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: - Immunization "/Immunization/{rid}": summary: Read/Write/etc resource instance of type Immunization description: Access to services to manage the state of a single resource of type Immunization get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readImmunization 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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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: - Immunization put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateImmunization 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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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: - Immunization patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchImmunization 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/Immunization 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/Immunization.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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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: - Immunization delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteImmunization 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: - Immunization "/Immunization/{rid}/_history": summary: Read past versions of resource instance of type Immunization description: Access to previous versions of a single resource of type Immunization get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstImmunization 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: - Immunization "/Immunization/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Immunization description: Access a to specified previous version of a single resource of type Immunization get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadImmunization 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/Immunization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Immunization.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: - Immunization "/Immunization/_history": summary: Read past versions of resources of type Immunization description: Access to previous versions of resourcez of type Immunization get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeImmunization 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: - Immunization "/Location": summary: Manager for resources of type Location description: 'The Manager for resources of type Location: provides services to manage the collection of all the Location instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Location based on a set of criteria operationId: searchLocation 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: address in: query schema: type: string description: "**A (part of the) address of the location** \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" - name: address-city in: query schema: type: string description: "**A city specified in an address** \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" - name: address-postalcode in: query schema: type: string description: "**A postal code specified in an address** \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" - name: address-state in: query schema: type: string description: "**A state specified in an address** \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" - name: name in: query schema: type: string description: "**A portion of the location's name or alias** \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" tags: - Location post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createLocation 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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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: - Location "/Location/{rid}": summary: Read/Write/etc resource instance of type Location description: Access to services to manage the state of a single resource of type Location get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readLocation 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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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: - Location put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateLocation 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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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: - Location patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchLocation 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/Location 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/Location.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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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: - Location delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteLocation 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: - Location "/Location/{rid}/_history": summary: Read past versions of resource instance of type Location description: Access to previous versions of a single resource of type Location get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstLocation 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: - Location "/Location/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Location description: Access a to specified previous version of a single resource of type Location get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadLocation 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/Location application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Location.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: - Location "/Location/_history": summary: Read past versions of resources of type Location description: Access to previous versions of resourcez of type Location get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeLocation 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: - Location "/Media": summary: Manager for resources of type Media description: 'The Manager for resources of type Media: provides services to manage the collection of all the Media instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Media based on a set of criteria operationId: searchMedia 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" tags: - Media post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createMedia 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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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: - Media "/Media/{rid}": summary: Read/Write/etc resource instance of type Media description: Access to services to manage the state of a single resource of type Media get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readMedia 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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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: - Media put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateMedia 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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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: - Media patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchMedia 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/Media 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/Media.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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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: - Media delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteMedia 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: - Media "/Media/{rid}/_history": summary: Read past versions of resource instance of type Media description: Access to previous versions of a single resource of type Media get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstMedia 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: - Media "/Media/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Media description: Access a to specified previous version of a single resource of type Media get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadMedia 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/Media application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Media.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: - Media "/Media/_history": summary: Read past versions of resources of type Media description: Access to previous versions of resourcez of type Media get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeMedia 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: - Media "/Medication": summary: Manager for resources of type Medication description: 'The Manager for resources of type Medication: provides services to manage the collection of all the Medication instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Medication based on a set of criteria operationId: searchMedication 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" tags: - Medication post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createMedication 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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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: - Medication "/Medication/{rid}": summary: Read/Write/etc resource instance of type Medication description: Access to services to manage the state of a single resource of type Medication get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readMedication 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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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: - Medication put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateMedication 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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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: - Medication patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchMedication 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/Medication 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/Medication.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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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: - Medication delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteMedication 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: - Medication "/Medication/{rid}/_history": summary: Read past versions of resource instance of type Medication description: Access to previous versions of a single resource of type Medication get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstMedication 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: - Medication "/Medication/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Medication description: Access a to specified previous version of a single resource of type Medication get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadMedication 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/Medication application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Medication.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: - Medication "/Medication/_history": summary: Read past versions of resources of type Medication description: Access to previous versions of resourcez of type Medication get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeMedication 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: - Medication "/MedicationDispense": summary: Manager for resources of type MedicationDispense description: 'The Manager for resources of type MedicationDispense: provides services to manage the collection of all the MedicationDispense instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type MedicationDispense based on a set of criteria operationId: searchMedicationDispense 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: patient in: query description: "**The identity of a patient to list dispenses 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: "**Returns dispenses with a specified dispense status** \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: type in: query description: "**Returns dispenses of a specific type** \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: - MedicationDispense post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createMedicationDispense 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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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: - MedicationDispense "/MedicationDispense/{rid}": summary: Read/Write/etc resource instance of type MedicationDispense description: Access to services to manage the state of a single resource of type MedicationDispense get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readMedicationDispense 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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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: - MedicationDispense put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateMedicationDispense 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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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: - MedicationDispense patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchMedicationDispense 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/MedicationDispense 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/MedicationDispense.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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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: - MedicationDispense delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteMedicationDispense 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: - MedicationDispense "/MedicationDispense/{rid}/_history": summary: Read past versions of resource instance of type MedicationDispense description: Access to previous versions of a single resource of type MedicationDispense get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstMedicationDispense 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: - MedicationDispense "/MedicationDispense/{rid}/_history/{hid}": summary: Read a past version of resource instance of type MedicationDispense description: Access a to specified previous version of a single resource of type MedicationDispense get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadMedicationDispense 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/MedicationDispense application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationDispense.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: - MedicationDispense "/MedicationDispense/_history": summary: Read past versions of resources of type MedicationDispense description: Access to previous versions of resourcez of type MedicationDispense get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeMedicationDispense 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: - MedicationDispense "/MedicationRequest": summary: Manager for resources of type MedicationRequest description: 'The Manager for resources of type MedicationRequest: provides services to manage the collection of all the MedicationRequest instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type MedicationRequest based on a set of criteria operationId: searchMedicationRequest 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: authoredon in: query description: "**Return prescriptions written on this date** \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: encounter in: query description: "**Return prescriptions with this encounter identifier** \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: intent in: query description: "**Returns prescriptions with different intents** \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: "**Returns prescriptions for a specific patient** \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: "**Status of the prescription** \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: - MedicationRequest post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createMedicationRequest 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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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: - MedicationRequest "/MedicationRequest/{rid}": summary: Read/Write/etc resource instance of type MedicationRequest description: Access to services to manage the state of a single resource of type MedicationRequest get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readMedicationRequest 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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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: - MedicationRequest put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateMedicationRequest 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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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: - MedicationRequest patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchMedicationRequest 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/MedicationRequest 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/MedicationRequest.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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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: - MedicationRequest delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteMedicationRequest 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: - MedicationRequest "/MedicationRequest/{rid}/_history": summary: Read past versions of resource instance of type MedicationRequest description: Access to previous versions of a single resource of type MedicationRequest get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstMedicationRequest 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: - MedicationRequest "/MedicationRequest/{rid}/_history/{hid}": summary: Read a past version of resource instance of type MedicationRequest description: Access a to specified previous version of a single resource of type MedicationRequest get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadMedicationRequest 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/MedicationRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/MedicationRequest.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: - MedicationRequest "/MedicationRequest/_history": summary: Read past versions of resources of type MedicationRequest description: Access to previous versions of resourcez of type MedicationRequest get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeMedicationRequest 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: - MedicationRequest "/Observation": summary: Manager for resources of type Observation description: 'The Manager for resources of type Observation: provides services to manage the collection of all the Observation instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Observation based on a set of criteria operationId: searchObservation 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: "**The classification of the type of observation** \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: code in: query description: "**The code of the observation type** \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: "**Obtained date/time. If the obtained element is a period, a date that falls in the period** \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: _lastUpdated in: query description: "**When the resource version last changed** \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: "**The subject that the observation is about (if patient)** \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: "**The status of the observation** \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: - Observation post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createObservation 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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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: - Observation "/Observation/{rid}": summary: Read/Write/etc resource instance of type Observation description: Access to services to manage the state of a single resource of type Observation get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readObservation 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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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: - Observation put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateObservation 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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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: - Observation patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchObservation 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/Observation 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/Observation.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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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: - Observation delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteObservation 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: - Observation "/Observation/{rid}/_history": summary: Read past versions of resource instance of type Observation description: Access to previous versions of a single resource of type Observation get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstObservation 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: - Observation "/Observation/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Observation description: Access a to specified previous version of a single resource of type Observation get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadObservation 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/Observation application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Observation.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: - Observation "/Observation/_history": summary: Read past versions of resources of type Observation description: Access to previous versions of resourcez of type Observation get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeObservation 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: - Observation "/Organization": summary: Manager for resources of type Organization description: 'The Manager for resources of type Organization: provides services to manage the collection of all the Organization instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Organization based on a set of criteria operationId: searchOrganization 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: address in: query schema: type: string description: "**A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text** \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" - name: name in: query schema: type: string description: "**A portion of the organization's name or alias** \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" tags: - Organization post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createOrganization 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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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: - Organization "/Organization/{rid}": summary: Read/Write/etc resource instance of type Organization description: Access to services to manage the state of a single resource of type Organization get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readOrganization 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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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: - Organization put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateOrganization 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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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: - Organization patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchOrganization 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/Organization 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/Organization.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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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: - Organization delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteOrganization 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: - Organization "/Organization/{rid}/_history": summary: Read past versions of resource instance of type Organization description: Access to previous versions of a single resource of type Organization get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstOrganization 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: - Organization "/Organization/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Organization description: Access a to specified previous version of a single resource of type Organization get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadOrganization 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/Organization application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Organization.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: - Organization "/Organization/_history": summary: Read past versions of resources of type Organization description: Access to previous versions of resourcez of type Organization get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeOrganization 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: - Organization "/Patient": summary: Manager for resources of type Patient description: 'The Manager for resources of type Patient: provides services to manage the collection of all the Patient instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Patient based on a set of criteria operationId: searchPatient 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: birthdate in: query description: "**The patient's date of birth** \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: death-date in: query description: "**The date of death has been provided and satisfies this search value** \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: family in: query description: "**A portion of the family name of the patient** \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: gender in: query description: "**Gender of the patient** \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: given in: query schema: type: string description: "**A portion of the given name of the patient** \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" - name: identifier in: query description: "**A patient identifier** \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: name in: query schema: type: string description: "**A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text** \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" tags: - Patient post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createPatient 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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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: - Patient "/Patient/{rid}": summary: Read/Write/etc resource instance of type Patient description: Access to services to manage the state of a single resource of type Patient get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readPatient 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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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: - Patient put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updatePatient 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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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: - Patient patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchPatient 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/Patient 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/Patient.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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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: - Patient delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deletePatient 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: - Patient "/Patient/{rid}/_history": summary: Read past versions of resource instance of type Patient description: Access to previous versions of a single resource of type Patient get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstPatient 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: - Patient "/Patient/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Patient description: Access a to specified previous version of a single resource of type Patient get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadPatient 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/Patient application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Patient.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: - Patient "/Patient/_history": summary: Read past versions of resources of type Patient description: Access to previous versions of resourcez of type Patient get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypePatient 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: - Patient "/Practitioner": summary: Manager for resources of type Practitioner description: 'The Manager for resources of type Practitioner: provides services to manage the collection of all the Practitioner instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Practitioner based on a set of criteria operationId: searchPractitioner 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: identifier in: query description: "**A practitioner's Identifier** \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: name in: query schema: type: string description: "**A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text** \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" tags: - Practitioner post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createPractitioner 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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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: - Practitioner "/Practitioner/{rid}": summary: Read/Write/etc resource instance of type Practitioner description: Access to services to manage the state of a single resource of type Practitioner get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readPractitioner 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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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: - Practitioner put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updatePractitioner 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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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: - Practitioner patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchPractitioner 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/Practitioner 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/Practitioner.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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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: - Practitioner delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deletePractitioner 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: - Practitioner "/Practitioner/{rid}/_history": summary: Read past versions of resource instance of type Practitioner description: Access to previous versions of a single resource of type Practitioner get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstPractitioner 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: - Practitioner "/Practitioner/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Practitioner description: Access a to specified previous version of a single resource of type Practitioner get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadPractitioner 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/Practitioner application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Practitioner.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: - Practitioner "/Practitioner/_history": summary: Read past versions of resources of type Practitioner description: Access to previous versions of resourcez of type Practitioner get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypePractitioner 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: - Practitioner "/PractitionerRole": summary: Manager for resources of type PractitionerRole description: 'The Manager for resources of type PractitionerRole: provides services to manage the collection of all the PractitionerRole instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type PractitionerRole based on a set of criteria operationId: searchPractitionerRole 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: practitioner in: query description: "**Practitioner that is able to provide the defined services for the organization** \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: specialty in: query description: "**The practitioner has this specialty at an organization** \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: - PractitionerRole post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createPractitionerRole 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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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: - PractitionerRole "/PractitionerRole/{rid}": summary: Read/Write/etc resource instance of type PractitionerRole description: Access to services to manage the state of a single resource of type PractitionerRole get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readPractitionerRole 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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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: - PractitionerRole put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updatePractitionerRole 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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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: - PractitionerRole patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchPractitionerRole 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/PractitionerRole 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/PractitionerRole.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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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: - PractitionerRole delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deletePractitionerRole 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: - PractitionerRole "/PractitionerRole/{rid}/_history": summary: Read past versions of resource instance of type PractitionerRole description: Access to previous versions of a single resource of type PractitionerRole get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstPractitionerRole 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: - PractitionerRole "/PractitionerRole/{rid}/_history/{hid}": summary: Read a past version of resource instance of type PractitionerRole description: Access a to specified previous version of a single resource of type PractitionerRole get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadPractitionerRole 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/PractitionerRole application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/PractitionerRole.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: - PractitionerRole "/PractitionerRole/_history": summary: Read past versions of resources of type PractitionerRole description: Access to previous versions of resourcez of type PractitionerRole get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypePractitionerRole 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: - PractitionerRole "/Procedure": summary: Manager for resources of type Procedure description: 'The Manager for resources of type Procedure: provides services to manage the collection of all the Procedure instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Procedure based on a set of criteria operationId: searchProcedure 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: code in: query description: "**A code to identify a procedure** \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: "**When the procedure was performed** \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: "**Search by subject - a patient** \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: "**preparation | in-progress | not-done | on-hold | stopped | 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: - Procedure post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createProcedure 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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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: - Procedure "/Procedure/{rid}": summary: Read/Write/etc resource instance of type Procedure description: Access to services to manage the state of a single resource of type Procedure get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readProcedure 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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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: - Procedure put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateProcedure 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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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: - Procedure patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchProcedure 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/Procedure 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/Procedure.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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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: - Procedure delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteProcedure 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: - Procedure "/Procedure/{rid}/_history": summary: Read past versions of resource instance of type Procedure description: Access to previous versions of a single resource of type Procedure get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstProcedure 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: - Procedure "/Procedure/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Procedure description: Access a to specified previous version of a single resource of type Procedure get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadProcedure 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/Procedure application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Procedure.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: - Procedure "/Procedure/_history": summary: Read past versions of resources of type Procedure description: Access to previous versions of resourcez of type Procedure get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeProcedure 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: - Procedure "/Provenance": summary: Manager for resources of type Provenance description: 'The Manager for resources of type Provenance: provides services to manage the collection of all the Provenance instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Provenance based on a set of criteria operationId: searchProvenance 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" tags: - Provenance post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createProvenance 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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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: - Provenance "/Provenance/{rid}": summary: Read/Write/etc resource instance of type Provenance description: Access to services to manage the state of a single resource of type Provenance get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readProvenance 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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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: - Provenance put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateProvenance 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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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: - Provenance patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchProvenance 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/Provenance 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/Provenance.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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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: - Provenance delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteProvenance 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: - Provenance "/Provenance/{rid}/_history": summary: Read past versions of resource instance of type Provenance description: Access to previous versions of a single resource of type Provenance get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstProvenance 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: - Provenance "/Provenance/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Provenance description: Access a to specified previous version of a single resource of type Provenance get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadProvenance 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/Provenance application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Provenance.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: - Provenance "/Provenance/_history": summary: Read past versions of resources of type Provenance description: Access to previous versions of resourcez of type Provenance get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeProvenance 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: - Provenance "/Questionnaire": summary: Manager for resources of type Questionnaire description: 'The Manager for resources of type Questionnaire: provides services to manage the collection of all the Questionnaire instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Questionnaire based on a set of criteria operationId: searchQuestionnaire 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" tags: - Questionnaire post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createQuestionnaire 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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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: - Questionnaire "/Questionnaire/{rid}": summary: Read/Write/etc resource instance of type Questionnaire description: Access to services to manage the state of a single resource of type Questionnaire get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readQuestionnaire 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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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: - Questionnaire put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateQuestionnaire 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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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: - Questionnaire patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchQuestionnaire 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/Questionnaire 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/Questionnaire.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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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: - Questionnaire delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteQuestionnaire 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: - Questionnaire "/Questionnaire/{rid}/_history": summary: Read past versions of resource instance of type Questionnaire description: Access to previous versions of a single resource of type Questionnaire get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstQuestionnaire 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: - Questionnaire "/Questionnaire/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Questionnaire description: Access a to specified previous version of a single resource of type Questionnaire get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadQuestionnaire 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/Questionnaire application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Questionnaire.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: - Questionnaire "/Questionnaire/_history": summary: Read past versions of resources of type Questionnaire description: Access to previous versions of resourcez of type Questionnaire get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeQuestionnaire 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: - Questionnaire "/QuestionnaireResponse": summary: Manager for resources of type QuestionnaireResponse description: 'The Manager for resources of type QuestionnaireResponse: provides services to manage the collection of all the QuestionnaireResponse instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type QuestionnaireResponse based on a set of criteria operationId: searchQuestionnaireResponse 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: authored in: query description: "**When the questionnaire response was last changed** \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: "**The patient that is the subject of the questionnaire response** \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: questionnaire in: query description: "**The questionnaire the answers are provided 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: "**The status of the questionnaire response** \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: - QuestionnaireResponse post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createQuestionnaireResponse 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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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: - QuestionnaireResponse "/QuestionnaireResponse/{rid}": summary: Read/Write/etc resource instance of type QuestionnaireResponse description: Access to services to manage the state of a single resource of type QuestionnaireResponse get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readQuestionnaireResponse 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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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: - QuestionnaireResponse put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateQuestionnaireResponse 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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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: - QuestionnaireResponse patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchQuestionnaireResponse 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/QuestionnaireResponse 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/QuestionnaireResponse.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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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: - QuestionnaireResponse delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteQuestionnaireResponse 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: - QuestionnaireResponse "/QuestionnaireResponse/{rid}/_history": summary: Read past versions of resource instance of type QuestionnaireResponse description: Access to previous versions of a single resource of type QuestionnaireResponse get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstQuestionnaireResponse 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: - QuestionnaireResponse "/QuestionnaireResponse/{rid}/_history/{hid}": summary: Read a past version of resource instance of type QuestionnaireResponse description: Access a to specified previous version of a single resource of type QuestionnaireResponse get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadQuestionnaireResponse 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/QuestionnaireResponse application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/QuestionnaireResponse.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: - QuestionnaireResponse "/QuestionnaireResponse/_history": summary: Read past versions of resources of type QuestionnaireResponse description: Access to previous versions of resourcez of type QuestionnaireResponse get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeQuestionnaireResponse 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: - QuestionnaireResponse "/RelatedPerson": summary: Manager for resources of type RelatedPerson description: 'The Manager for resources of type RelatedPerson: provides services to manage the collection of all the RelatedPerson instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type RelatedPerson based on a set of criteria operationId: searchRelatedPerson 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: name in: query schema: type: string description: "**A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text** \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" - name: patient in: query description: "**The patient this related person is related to** \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: - RelatedPerson post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createRelatedPerson 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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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: - RelatedPerson "/RelatedPerson/{rid}": summary: Read/Write/etc resource instance of type RelatedPerson description: Access to services to manage the state of a single resource of type RelatedPerson get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readRelatedPerson 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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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: - RelatedPerson put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateRelatedPerson 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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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: - RelatedPerson patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchRelatedPerson 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/RelatedPerson 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/RelatedPerson.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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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: - RelatedPerson delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteRelatedPerson 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: - RelatedPerson "/RelatedPerson/{rid}/_history": summary: Read past versions of resource instance of type RelatedPerson description: Access to previous versions of a single resource of type RelatedPerson get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstRelatedPerson 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: - RelatedPerson "/RelatedPerson/{rid}/_history/{hid}": summary: Read a past version of resource instance of type RelatedPerson description: Access a to specified previous version of a single resource of type RelatedPerson get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadRelatedPerson 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/RelatedPerson application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/RelatedPerson.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: - RelatedPerson "/RelatedPerson/_history": summary: Read past versions of resources of type RelatedPerson description: Access to previous versions of resourcez of type RelatedPerson get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeRelatedPerson 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: - RelatedPerson "/ServiceRequest": summary: Manager for resources of type ServiceRequest description: 'The Manager for resources of type ServiceRequest: provides services to manage the collection of all the ServiceRequest instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type ServiceRequest based on a set of criteria operationId: searchServiceRequest 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: authored in: query description: "**Date request signed** \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: category in: query description: "**Classification of service** \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: code in: query description: "**What is being requested/ordered** \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: "**Search by subject - a patient** \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: - ServiceRequest post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createServiceRequest 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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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: - ServiceRequest "/ServiceRequest/{rid}": summary: Read/Write/etc resource instance of type ServiceRequest description: Access to services to manage the state of a single resource of type ServiceRequest get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readServiceRequest 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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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: - ServiceRequest put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateServiceRequest 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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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: - ServiceRequest patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchServiceRequest 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/ServiceRequest 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/ServiceRequest.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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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: - ServiceRequest delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteServiceRequest 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: - ServiceRequest "/ServiceRequest/{rid}/_history": summary: Read past versions of resource instance of type ServiceRequest description: Access to previous versions of a single resource of type ServiceRequest get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstServiceRequest 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: - ServiceRequest "/ServiceRequest/{rid}/_history/{hid}": summary: Read a past version of resource instance of type ServiceRequest description: Access a to specified previous version of a single resource of type ServiceRequest get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadServiceRequest 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/ServiceRequest application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/ServiceRequest.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: - ServiceRequest "/ServiceRequest/_history": summary: Read past versions of resources of type ServiceRequest description: Access to previous versions of resourcez of type ServiceRequest get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeServiceRequest 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: - ServiceRequest "/Specimen": summary: Manager for resources of type Specimen description: 'The Manager for resources of type Specimen: provides services to manage the collection of all the Specimen instances' get: summary: Fast Healthcare Interoperability Resources Search all resources of type Specimen based on a set of criteria operationId: searchSpecimen 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: _id in: query schema: type: string description: "**Logical id of this artifact** \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" - name: patient in: query schema: type: string description: "**The patient the specimen comes from** \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" tags: - Specimen post: summary: Fast Healthcare Interoperability Resources Create a new resource operationId: createSpecimen 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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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: - Specimen "/Specimen/{rid}": summary: Read/Write/etc resource instance of type Specimen description: Access to services to manage the state of a single resource of type Specimen get: summary: Fast Healthcare Interoperability Resources Read the current state of the resource operationId: readSpecimen 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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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: - Specimen put: summary: Fast Healthcare Interoperability Resources Update the current state of the resource operationId: updateSpecimen 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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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: - Specimen patch: summary: Fast Healthcare Interoperability Resources Change the current state of the resource by providing a patch - a series of change commands operationId: patchSpecimen 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/Specimen 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/Specimen.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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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: - Specimen delete: summary: Fast Healthcare Interoperability Resources Delete the resource so that it no exists (no read, search etc) operationId: deleteSpecimen 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: - Specimen "/Specimen/{rid}/_history": summary: Read past versions of resource instance of type Specimen description: Access to previous versions of a single resource of type Specimen get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histinstSpecimen 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: - Specimen "/Specimen/{rid}/_history/{hid}": summary: Read a past version of resource instance of type Specimen description: Access a to specified previous version of a single resource of type Specimen get: summary: Fast Healthcare Interoperability Resources Read a past state of the resource operationId: vreadSpecimen 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/Specimen application/fhir+xml: schema: "$ref": https://hl7.org/fhir/R4/Specimen.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: - Specimen "/Specimen/_history": summary: Read past versions of resources of type Specimen description: Access to previous versions of resourcez of type Specimen get: summary: Fast Healthcare Interoperability Resources Read the past states of the resource operationId: histtypeSpecimen 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: - Specimen "/_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' "/": summary: System level operations description: System level operations get: summary: Fast Healthcare Interoperability Resources Search all resources of all types based on a set of criteria operationId: searchAll 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" put: summary: Fast Healthcare Interoperability Resources Batch or Transaction operationId: transaction requestBody: description: The batch or transaction required: true 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 responses: '200': description: Batch or Transaction response 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" components: parameters: rid: name: rid in: path description: id of the resource (=Resource.id) required: true allowEmptyValue: false style: simple schema: type: string hid: name: hid in: path description: id of the history entry (=Resource.meta.versionId) required: true allowEmptyValue: false style: simple schema: type: string 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' 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 pretty: name: _pretty in: query description: Ask for a pretty printed response for human convenience allowEmptyValue: true style: form schema: type: boolean 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 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 tags: - name: ' History' - name: AllergyIntolerance - name: CarePlan - name: CareTeam - name: Condition - name: Coverage - name: Device - name: DiagnosticReport - name: DocumentReference - name: Encounter - name: Endpoint - name: Goal - name: HealthcareService - name: Immunization - name: Location - name: Media - name: Medication - name: MedicationDispense - name: MedicationRequest - name: Metadata - name: Observation - name: Organization - name: Patient - name: Practitioner - name: PractitionerRole - name: Procedure - name: Provenance - name: Questionnaire - name: QuestionnaireResponse - name: RelatedPerson - name: ServiceRequest - name: Specimen