{ "openapi": "3.0.2", "info": { "title": "CapabilityStatementExampleApotti", "license": { "name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html" }, "version": "2.0.0-rc3", "contact": { "name": "HL7 Finland ry", "email": "mikael@sensotrend.com", "url": "https://www.hl7.fi/" } }, "servers": [ { "url": "https://gw.apottiekosysteemi.fi/Interconnect-FHIR-EKO01/api/FHIR/R4", "description": "Apotti EKO01 FHIR Server" } ], "externalDocs": { "url": "https://hl7.fi/fhir/finnish-smart/CapabilityStatement/apotti-eko01", "description": "FHIR CapabilityStatement" }, "paths": { "/metadata": { "summary": "Access to the Server\u0027s Capability Statement", "description": "All FHIR Servers return a CapabilityStatement that describes what services they perform", "get": { "summary": "Return the server\u0027s capability statement", "operationId": "metadata", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" } ] } }, "/AdverseEvent": { "summary": "manage the collection of resources of type AdverseEvent", "description": "Access to services to manage the collection of all resources of type AdverseEvent", "get": { "summary": "Search all resources of type AdverseEvent based on a set of criteria", "operationId": "searchAdverseEvent", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "seriousness", "in": "query", "description": "Refine a search for AdverseEvent resources by seriousness of the event. Serious and Non-serious are the only supported values.", "schema": { "type": "string" } }, { "name": "study", "in": "query", "description": "Search for AdverseEvent resources for a specified study ID.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for AdverseEvent resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/AdverseEvent/{rid}": { "summary": "Read/Write/etc resource instance of type AdverseEvent", "description": "Access to services to manage the state of a single resource of type AdverseEvent", "get": { "summary": "Read the current state of the resource", "operationId": "readAdverseEvent", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/AdverseEvent" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/AdverseEvent.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type AllergyIntolerance based on a set of criteria", "operationId": "searchAllergyIntolerance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "clinical-status", "in": "query", "description": "Refine a search for AllergyIntolerance resources by clinicalStatus. Active is the only supported clinical status to search by.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for AllergyIntolerance resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readAllergyIntolerance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Appointment": { "summary": "manage the collection of resources of type Appointment", "description": "Access to services to manage the collection of all resources of type Appointment", "get": { "summary": "Search all resources of type Appointment based on a set of criteria", "operationId": "searchAppointment", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "date", "in": "query", "description": "Refine a search for Appointment resources by date. By default, all Appointments are returned. Not supported for scheduled surgeries.", "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": "identifier", "in": "query", "description": "Refine a search for Appointment resources by identifier. Not supported for scheduled surgeries.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Appointment resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "service-category", "in": "query", "description": "Search on the type of appointment. Enter \u0027surgery\u0027 for scheduled surgery appointments, and \u0027appointment\u0027 for all other types of appointments.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for Appointment resources by status. By default, all Appointments are returned. Not supported for scheduled surgeries.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Appointment/{rid}": { "summary": "Read/Write/etc resource instance of type Appointment", "description": "Access to services to manage the state of a single resource of type Appointment", "get": { "summary": "Read the current state of the resource", "operationId": "readAppointment", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Appointment" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Appointment.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Binary/{rid}": { "summary": "Read/Write/etc resource instance of type Binary", "description": "Access to services to manage the state of a single resource of type Binary", "get": { "summary": "Read the current state of the resource", "operationId": "readBinary", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/BodyStructure": { "summary": "manage the collection of resources of type BodyStructure", "description": "Access to services to manage the collection of all resources of type BodyStructure", "get": { "summary": "Search all resources of type BodyStructure based on a set of criteria", "operationId": "searchBodyStructure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "location", "in": "query", "description": "Refine a search for BodyStructure resources by identifier. Enter using the structure \"[system]|[search string]\".", "schema": { "type": "string" } }, { "name": "morphology", "in": "query", "description": "Refine a search for BodyStructure resources by morphology.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for BodyStructure resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for BodyStructure resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/BodyStructure/{rid}": { "summary": "Read/Write/etc resource instance of type BodyStructure", "description": "Access to services to manage the state of a single resource of type BodyStructure", "get": { "summary": "Read the current state of the resource", "operationId": "readBodyStructure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/BodyStructure" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/BodyStructure.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/CarePlan": { "summary": "manage the collection of resources of type CarePlan", "description": "Access to services to manage the collection of all resources of type CarePlan", "get": { "summary": "Search all resources of type CarePlan based on a set of criteria", "operationId": "searchCarePlan", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "activity-date", "in": "query", "description": "Search for CarePlan resources with questionaires due before the provided date.", "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": "Search for CarePlans of the given type. This is a required search parameter.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Refine a search for Encounter CarePlans to search only the encounters provided. Ignored if not searching for Encounter CarePlans.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for CarePlan resources using a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Refine a search for Education CarePlans to include only Education CarePlans that are part of the given Education CarePlans. Ignored if not searching for Education CarePlans.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for Encounter, Education, and Care Path CarePlans to search only for encounters, education, or Care Paths with the provided status. Ignored if not searching for Encounter, Education, or Care Path CarePlans.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for CarePlan resources using a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readCarePlan", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/CareTeam": { "summary": "manage the collection of resources of type CareTeam", "description": "Access to services to manage the collection of all resources of type CareTeam", "get": { "summary": "Search all resources of type CareTeam based on a set of criteria", "operationId": "searchCareTeam", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for CareTeam resources using a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search based on the CareTeam\u0027s status. Currently only active is supported.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for CareTeam resources using a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readCareTeam", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Communication": { "summary": "Manager for resources of type Communication", "description": "The Manager for resources of type Communication: provides services to manage the collection of all the Communication instances", "get": { "summary": "Search all resources of type Communication based on a set of criteria", "operationId": "searchCommunication", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "based-on", "in": "query", "description": "Refine a search for Education Communication resources to include only Education Communication resources that are documentation for the given Education CarePlans. These should be CarePlans with an education-subcategory of point. Ignored if not searching for Education Communication resources.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Refine a search to include only Communication resources with the given categories.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Refine a search to include Communication resources from only the encounters provided.", "schema": { "type": "string" } }, { "name": "part-of", "in": "query", "description": "Refine a search for Communication resources \"part of\" a specified Task ID. If not provided, all Communications are returned.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Communication resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Communication resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createCommunication", "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/Communication" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Communication.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Communication" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Communication.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Communication/{rid}": { "summary": "Read/Write/etc resource instance of type Communication", "description": "Access to services to manage the state of a single resource of type Communication", "get": { "summary": "Read the current state of the resource", "operationId": "readCommunication", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Communication" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Communication.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ConceptMap/{rid}": { "summary": "Read/Write/etc resource instance of type ConceptMap", "description": "Access to services to manage the state of a single resource of type ConceptMap", "get": { "summary": "Read the current state of the resource", "operationId": "readConceptMap", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ConceptMap" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ConceptMap.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ConceptMap": { "summary": "Manager for resources of type ConceptMap", "description": "The Manager for resources of type ConceptMap: provides services to manage the collection of all the ConceptMap instances", "post": { "summary": "Create a new resource", "operationId": "createConceptMap", "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/ConceptMap" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ConceptMap.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ConceptMap" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ConceptMap.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type Condition based on a set of criteria", "operationId": "searchCondition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "abatement-date", "in": "query", "description": "Search for Conditions with a specified abatement date. This is only used when searching for infections.", "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": "Search for Condition resources by category.", "schema": { "type": "string" } }, { "name": "clinical-status", "in": "query", "description": "Refine a search for Condition resources by clinicalStatus. Only clinical statuses of \u0027inactive\u0027, \u0027resolved\u0027 and \u0027active\u0027 are supported for health concerns and problem list items. Only clinical statuses of \u0027inactive\u0027 and \u0027active\u0027 are supported for infections.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Search for Conditions with a specified code. This is only used when searching for infections.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Search for Condition resources for specific encounters.", "schema": { "type": "string" } }, { "name": "onset-date", "in": "query", "description": "Search for Conditions with a specified onset date. This is only used when searching for infections.", "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 for Condition resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "recorded-date", "in": "query", "description": "Search for Conditions with a specified recorded date. This is only used when searching for infections.", "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": "subject", "in": "query", "description": "Search for Condition resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readCondition", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Consent": { "summary": "manage the collection of resources of type Consent", "description": "Access to services to manage the collection of all resources of type Consent", "get": { "summary": "Search all resources of type Consent based on a set of criteria", "operationId": "searchConsent", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Search for Consent resources by category.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Consent resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Search for Consent resources by status.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Consent resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Consent/{rid}": { "summary": "Read/Write/etc resource instance of type Consent", "description": "Access to services to manage the state of a single resource of type Consent", "get": { "summary": "Read the current state of the resource", "operationId": "readConsent", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Consent" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Consent.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Coverage": { "summary": "manage the collection of resources of type Coverage", "description": "Access to services to manage the collection of all resources of type Coverage", "get": { "summary": "Search all resources of type Coverage based on a set of criteria", "operationId": "searchCoverage", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "beneficiary", "in": "query", "description": "Search for Coverage resource for a specific patient ID. You can use \"patient\" or \"beneficiary\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Coverage resource for a specific patient ID. You can use \"patient\" or \"beneficiary\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readCoverage", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Device": { "summary": "manage the collection of resources of type Device", "description": "Access to services to manage the collection of all resources of type Device", "get": { "summary": "Search all resources of type Device based on a set of criteria", "operationId": "searchDevice", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "device-name", "in": "query", "description": "A string that will match the Device.deviceName.name field. Not case sensitive.", "schema": { "type": "string" } }, { "name": "manufacturer", "in": "query", "description": "Manufacturer of the device.", "schema": { "type": "string" } }, { "name": "model", "in": "query", "description": "Model number of the device.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient in whom this device is implanted. This is a required parameter.", "schema": { "type": "string" } }, { "name": "udi-carrier", "in": "query", "description": "The UDI barcode string - matches static UDI.", "schema": { "type": "string" } }, { "name": "udi-di", "in": "query", "description": "The UDI device identifier (DI).", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readDevice", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/DeviceRequest": { "summary": "manage the collection of resources of type DeviceRequest", "description": "Access to services to manage the collection of all resources of type DeviceRequest", "get": { "summary": "Search all resources of type DeviceRequest based on a set of criteria", "operationId": "searchDeviceRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for DeviceRequest resource for a specified patient ID.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Search for a DeviceRequest based on a device request status", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/DeviceRequest/{rid}": { "summary": "Read/Write/etc resource instance of type DeviceRequest", "description": "Access to services to manage the state of a single resource of type DeviceRequest", "get": { "summary": "Read the current state of the resource", "operationId": "readDeviceRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/DeviceRequest" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DeviceRequest.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/DeviceUseStatement": { "summary": "manage the collection of resources of type DeviceUseStatement", "description": "Access to services to manage the collection of all resources of type DeviceUseStatement", "get": { "summary": "Search all resources of type DeviceUseStatement based on a set of criteria", "operationId": "searchDeviceUseStatement", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for DeviceUseStatement resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for DeviceUseStatement resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/DeviceUseStatement/{rid}": { "summary": "Read/Write/etc resource instance of type DeviceUseStatement", "description": "Access to services to manage the state of a single resource of type DeviceUseStatement", "get": { "summary": "Read the current state of the resource", "operationId": "readDeviceUseStatement", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/DeviceUseStatement" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/DeviceUseStatement.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/DiagnosticReport": { "summary": "manage the collection of resources of type DiagnosticReport", "description": "Access to services to manage the collection of all resources of type DiagnosticReport", "get": { "summary": "Search all resources of type DiagnosticReport based on a set of criteria", "operationId": "searchDiagnosticReport", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Refine a search for DiagnosticReport resources by category.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Refine a search for DiagnosticReport resources by code.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Refine a search for DiagnosticReport resources by specifying a date or date range that a DiagnosticReport was resulted or recorded. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included. Not supported by Care Plan Goal.", "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": "identifier", "in": "query", "description": "Refine search by specifying an identifier, such as the internal order ID or the accession number. Not supported by Care Plan Goal.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for DiagnosticReport resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for DiagnosticReport resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readDiagnosticReport", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "put": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type DocumentReference based on a set of criteria", "operationId": "searchDocumentReference", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "author", "in": "query", "description": "Further refine a search for a given set of DocumentReferences on a patient by specifying a Practitioner ID that corresponds to the author of the document. Currently only supported for correspondence and imaging-result search.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Refine a search for DocumentReference resources by category.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]) that corresponds to the document creation time. Local server time is assumed if time zone information is not included.", "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": "docstatus", "in": "query", "description": "Further refine a search for a given set of DocumentReferences on a patient by specifying a docStatus. By default, all docStatuses are returned. Not supported for correspondence, imaging-result, or questionnaire-response search.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Search for DocumentReference resources for a specified encounter ID. Not supported for correspondence, imaging-result, or questionnaire-response search.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for DocumentReference resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Further refine a search for a given set of DocumentReferences on a patient by specifying a date or date range in ISO format (YYYY[-MM[-DD]]) that corresponds to the time of the service that is being documented. Not supported for questionnaire-response search.", "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": "Further refine a search for a given set of DocumentReferences on a patient by specifying a status of the document. Currently only supported for questionnaire-response with a status of current.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for DocumentReference resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Further refine a search for a given set of DocumentReferences on a patient by specifying a type code to return only documents of that type. Use the format: type\u003d\u003ccode\u003e to search all supported systems with that code or type\u003d\u003csystem\u003e|\u003ccode\u003e to further refine the search to one code system. Not supported for questionnaire-response search.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readDocumentReference", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "put": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Encounter": { "summary": "manage the collection of resources of type Encounter", "description": "Access to services to manage the collection of all resources of type Encounter", "get": { "summary": "Search all resources of type Encounter based on a set of criteria", "operationId": "searchEncounter", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "class", "in": "query", "description": "Refine a search for Encounter resources by class. By default, all classes are returned.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Refine a search for Encounter resources by date. By default, all Encounters are returned. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]]). Local server time is assumed if time zone information is not included.", "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": "identifier", "in": "query", "description": "Search for Encounter resources by encounter identifier in the format \u003ccode system\u003e|\u003ccode\u003e", "schema": { "type": "string" } }, { "name": "onlyscannable", "in": "query", "description": "Refine a search for Encounter resources to scannable encounters only. By default, all Encounters are returned. Use a value of \"true\" to only return scannable encounters. Can only be used when the application is launched from Hyperspace.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Encounter resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for difference references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Encounter resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for difference references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readEncounter", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readEndpoint", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/EpisodeOfCare": { "summary": "manage the collection of resources of type EpisodeOfCare", "description": "Access to services to manage the collection of all resources of type EpisodeOfCare", "get": { "summary": "Search all resources of type EpisodeOfCare based on a set of criteria", "operationId": "searchEpisodeOfCare", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for EpisodeOfCare resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for EpisodeOfCare resources by status. Active, finished, and cancelled are the only supported statuses.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Refine a search for EpisodeOfCare resources by type.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/EpisodeOfCare/{rid}": { "summary": "Read/Write/etc resource instance of type EpisodeOfCare", "description": "Access to services to manage the state of a single resource of type EpisodeOfCare", "get": { "summary": "Read the current state of the resource", "operationId": "readEpisodeOfCare", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/EpisodeOfCare" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/EpisodeOfCare.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ExplanationOfBenefit": { "summary": "manage the collection of resources of type ExplanationOfBenefit", "description": "Access to services to manage the collection of all resources of type ExplanationOfBenefit", "get": { "summary": "Search all resources of type ExplanationOfBenefit based on a set of criteria", "operationId": "searchExplanationOfBenefit", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "created", "in": "query", "description": "Refine a search for ExplanationOfBenefit resources by creation date for the claim. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.", "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 for ExplanationOfBenefit resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/ExplanationOfBenefit/{rid}": { "summary": "Read/Write/etc resource instance of type ExplanationOfBenefit", "description": "Access to services to manage the state of a single resource of type ExplanationOfBenefit", "get": { "summary": "Read the current state of the resource", "operationId": "readExplanationOfBenefit", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ExplanationOfBenefit" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ExplanationOfBenefit.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/FamilyMemberHistory": { "summary": "manage the collection of resources of type FamilyMemberHistory", "description": "Access to services to manage the collection of all resources of type FamilyMemberHistory", "get": { "summary": "Search all resources of type FamilyMemberHistory based on a set of criteria", "operationId": "searchFamilyMemberHistory", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Required: the patient whose family history you\u0027d like to search.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/FamilyMemberHistory/{rid}": { "summary": "Read/Write/etc resource instance of type FamilyMemberHistory", "description": "Access to services to manage the state of a single resource of type FamilyMemberHistory", "get": { "summary": "Read the current state of the resource", "operationId": "readFamilyMemberHistory", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/FamilyMemberHistory" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/FamilyMemberHistory.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Flag": { "summary": "manage the collection of resources of type Flag", "description": "Access to services to manage the collection of all resources of type Flag", "get": { "summary": "Search all resources of type Flag based on a set of criteria", "operationId": "searchFlag", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Refine a search for Flag resources by category.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Refine a search for Flag resources by encounter. This is currently only supported for the isolation category.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Flag resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for Flag resources by status.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Flag resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Flag/{rid}": { "summary": "Read/Write/etc resource instance of type Flag", "description": "Access to services to manage the state of a single resource of type Flag", "get": { "summary": "Read the current state of the resource", "operationId": "readFlag", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Flag" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Flag.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Goal": { "summary": "manage the collection of resources of type Goal", "description": "Access to services to manage the collection of all resources of type Goal", "get": { "summary": "Search all resources of type Goal based on a set of criteria", "operationId": "searchGoal", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Refines a search by Goal category.", "schema": { "type": "string" } }, { "name": "lifecycle-status", "in": "query", "description": "Refines a search based on Goal lifecycle status.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Patient resources for a specific patient ID. You can use \"patient\" or \"subject\" equivalently but they can\u0027t be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Patient resources for a specific patient ID. You can use \"patient\" or \"subject\" equivalently but they can\u0027t be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readGoal", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Group": { "summary": "manage the collection of resources of type Group", "description": "Access to services to manage the collection of all resources of type Group", "get": { "summary": "Search all resources of type Group based on a set of criteria", "operationId": "searchGroup", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Group/{rid}": { "summary": "Read/Write/etc resource instance of type Group", "description": "Access to services to manage the state of a single resource of type Group", "get": { "summary": "Read the current state of the resource", "operationId": "readGroup", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Group" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Group.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ImagingStudy": { "summary": "manage the collection of resources of type ImagingStudy", "description": "Access to services to manage the collection of all resources of type ImagingStudy", "get": { "summary": "Search all resources of type ImagingStudy based on a set of criteria", "operationId": "searchImagingStudy", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "identifier", "in": "query", "description": "Search for ImagingStudy resources by a study\u0027s identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. An ImagingStudy\u0027s identifier must be in the format \u003ccode system\u003e|\u003ccode\u003e or \u003cID Type\u003e|\u003cID\u003e.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for ImagingStudy resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for ImagingStudy resources for a specified patient ID. You can use \"patient\" and \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/ImagingStudy/{rid}": { "summary": "Read/Write/etc resource instance of type ImagingStudy", "description": "Access to services to manage the state of a single resource of type ImagingStudy", "get": { "summary": "Read the current state of the resource", "operationId": "readImagingStudy", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ImagingStudy" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ImagingStudy.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Immunization": { "summary": "manage the collection of resources of type Immunization", "description": "Access to services to manage the collection of all resources of type Immunization", "get": { "summary": "Search all resources of type Immunization based on a set of criteria", "operationId": "searchImmunization", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "date", "in": "query", "description": "Refine a search for Immunization resources by vaccine administration date. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.", "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 for Immunization resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for Immunization resources by status.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readImmunization", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ImmunizationRecommendation": { "summary": "manage the collection of resources of type ImmunizationRecommendation", "description": "Access to services to manage the collection of all resources of type ImmunizationRecommendation", "get": { "summary": "Search all resources of type ImmunizationRecommendation based on a set of criteria", "operationId": "searchImmunizationRecommendation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "The FHIR id of a patient whose immunization recommendations you\u0027d like to obtain. Only one of either patient or subject needs to be specified.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/ImmunizationRecommendation/{rid}": { "summary": "Read/Write/etc resource instance of type ImmunizationRecommendation", "description": "Access to services to manage the state of a single resource of type ImmunizationRecommendation", "get": { "summary": "Read the current state of the resource", "operationId": "readImmunizationRecommendation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ImmunizationRecommendation" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ImmunizationRecommendation.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/List": { "summary": "manage the collection of resources of type List", "description": "Access to services to manage the collection of all resources of type List", "get": { "summary": "Search all resources of type List based on a set of criteria", "operationId": "searchList", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "code", "in": "query", "description": "Refine a search for List resources by list type. Accepted values include \"medications,\" \"allergies,\" \"immunizations,\" \"problems,\" \"pedigree-list,\" and \"hospital-problems.\"", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Refine a search for List resources by encounter.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Refine a search for List resources by patient. You can use \"patient\" or \"subject\" equivalently, but not at the same time with different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Refine a search for List resources by patient. You can use \"patient\" or \"subject\" equivalently, but not at the same time with different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/List/{rid}": { "summary": "Read/Write/etc resource instance of type List", "description": "Access to services to manage the state of a single resource of type List", "get": { "summary": "Read the current state of the resource", "operationId": "readList", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/List" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/List.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Location": { "summary": "manage the collection of resources of type Location", "description": "Access to services to manage the collection of all resources of type Location", "get": { "summary": "Search all resources of type Location based on a set of criteria", "operationId": "searchLocation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readLocation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Measure": { "summary": "manage the collection of resources of type Measure", "description": "Access to services to manage the collection of all resources of type Measure", "get": { "summary": "Search all resources of type Measure based on a set of criteria", "operationId": "searchMeasure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Measure/{rid}": { "summary": "Read/Write/etc resource instance of type Measure", "description": "Access to services to manage the state of a single resource of type Measure", "get": { "summary": "Read the current state of the resource", "operationId": "readMeasure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Measure" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Measure.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/MeasureReport": { "summary": "manage the collection of resources of type MeasureReport", "description": "Access to services to manage the collection of all resources of type MeasureReport", "get": { "summary": "Search all resources of type MeasureReport based on a set of criteria", "operationId": "searchMeasureReport", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/MeasureReport/{rid}": { "summary": "Read/Write/etc resource instance of type MeasureReport", "description": "Access to services to manage the state of a single resource of type MeasureReport", "get": { "summary": "Read the current state of the resource", "operationId": "readMeasureReport", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/MeasureReport" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/MeasureReport.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Medication": { "summary": "manage the collection of resources of type Medication", "description": "Access to services to manage the collection of all resources of type Medication", "get": { "summary": "Search all resources of type Medication based on a set of criteria", "operationId": "searchMedication", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readMedication", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/MedicationAdministration": { "summary": "manage the collection of resources of type MedicationAdministration", "description": "Access to services to manage the collection of all resources of type MedicationAdministration", "get": { "summary": "Search all resources of type MedicationAdministration based on a set of criteria", "operationId": "searchMedicationAdministration", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "context", "in": "query", "description": "Refine a search for MedicationAdministration resources with one or more linked encounters.", "schema": { "type": "string" } }, { "name": "effective-time", "in": "query", "description": "Refine a search for MedicationAdministration resources for a given patient by specifying a date or a range of dates for the administration.", "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 for MedicationAdministration resources for a specified patient ID. You can use \"patient\" and \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "performer", "in": "query", "description": "Refine a search for MedicationAdministration resources by one or more associated Practitioners.", "schema": { "type": "string" } }, { "name": "request", "in": "query", "description": "Refine a search for MedicationAdministration resources by associated MedicationRequests.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for MedicationAdministration resources with one or more statuses.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for MedicationAdministration resources for a specified patient ID. You can use \"patient\" and \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/MedicationAdministration/{rid}": { "summary": "Read/Write/etc resource instance of type MedicationAdministration", "description": "Access to services to manage the state of a single resource of type MedicationAdministration", "get": { "summary": "Read the current state of the resource", "operationId": "readMedicationAdministration", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/MedicationAdministration" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/MedicationAdministration.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/MedicationDispense": { "summary": "manage the collection of resources of type MedicationDispense", "description": "Access to services to manage the collection of all resources of type MedicationDispense", "get": { "summary": "Search all resources of type MedicationDispense based on a set of criteria", "operationId": "searchMedicationDispense", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for MedicationDispense resources for a specified patient ID.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for MedicationDispense resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for difference references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readMedicationDispense", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/MedicationRequest": { "summary": "manage the collection of resources of type MedicationRequest", "description": "Access to services to manage the collection of all resources of type MedicationRequest", "get": { "summary": "Search all resources of type MedicationRequest based on a set of criteria", "operationId": "searchMedicationRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "authoredon", "in": "query", "description": "Further refine a search for MedicationRequest resources for a given patient by specifying a date or range of dates for when the medication was ordered. Note: all medications will be returned regardless of date range provided on the search.", "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": "Refine a search for MedicationRequest resources by category. By default, the search returns all categories. Categories of inpatient, outpatient, community, and discharge are supported.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Refine a search for MedicationRequest resources for a given patient by specifying a date or a range of dates for when the medication was active.", "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": "intent", "in": "query", "description": "Refine a search for MedicationRequest resources by one or more intents.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for MedicationRequest resources for a specified patient ID. You can use \"patient\" and \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for MedicationRequest resources by one or more statuses.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for MedicationRequest resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readMedicationRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/NutritionOrder": { "summary": "manage the collection of resources of type NutritionOrder", "description": "Access to services to manage the collection of all resources of type NutritionOrder", "get": { "summary": "Search all resources of type NutritionOrder based on a set of criteria", "operationId": "searchNutritionOrder", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for NutritionOrder resources for the specified patient ID.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/NutritionOrder/{rid}": { "summary": "Read/Write/etc resource instance of type NutritionOrder", "description": "Access to services to manage the state of a single resource of type NutritionOrder", "get": { "summary": "Read the current state of the resource", "operationId": "readNutritionOrder", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/NutritionOrder" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/NutritionOrder.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type Observation based on a set of criteria", "operationId": "searchObservation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "based-on", "in": "query", "description": "Refine a search for Observation resources by specifying a ServiceRequest associated with the Observation. (currently Genomics-only)", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Refine a search for Observation resources by category or SNOMED code. Epic categories are laboratory, vital-signs, social-history, core-characteristics, LDA, LDA-property, LDA-assessment, functional-mental-status, periodontal, labor-delivery, newborn-delivery, and obstetrics-gynecology. Supported SNOMED codes include 384821006, 118228005, 252275004, 275711006, 68793005, 395124008, 314076009, 19851009, and 405825005.", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Refine a search for Observation resources by code, including but not limited to LOINC code, SNOMED code, flowsheet row IDs, or SmartData Identifiers. Codes associated with the labor-delivery and newborn-delivery categories require that the category be specified.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Refine a search for Observation resources by specifying a date or date range that a result- or vital sign-based Observation was resulted or recorded. This can also be used to refine the search results for labor-delivery, obstetrics-gynecology, and LDA based Observation searches. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.", "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": "focus", "in": "query", "description": "Refine a search for Observation resources by specifying a Reference associated with the Observation. (currently only SmartData and obstetrics-gynecology)", "schema": { "type": "string" } }, { "name": "issued", "in": "query", "description": "Refine a search for Observation resources by specifying a date or date range that a social-history-based Observation was made available. Enter dates in ISO format (YYYY[-MM[-DD[THH:MM[:SS][TZ]]]]). Local server time is assumed if time zone information is not included.", "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 for Observation resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Observation resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readObservation", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "put": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Organization": { "summary": "manage the collection of resources of type Organization", "description": "Access to services to manage the collection of all resources of type Organization", "get": { "summary": "Search all resources of type Organization based on a set of criteria", "operationId": "searchOrganization", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readOrganization", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type Patient based on a set of criteria", "operationId": "searchPatient", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "address", "in": "query", "description": "Search for Patient resources using an address string.", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "Search for Patient resources using the city for a patient\u0027s home address. You can use this parameter along with other address parameters.", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "Search for Patient resources using the postal code for a patient\u0027s home address. You can use this parameter along with other address parameters.", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "Search for Patient resources using the state for a patient\u0027s home address. You can use this parameter along with other address parameters.", "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Search for Patient resources using a date of birth in ISO format (YYYY-MM-DD).", "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": "Search for Patient resources by family (last) name. You can use the family parameter along with other name parameters to search by a patient\u0027s name. Family name searching supports exact matching, \"sounds like\" matching, and patient aliases.", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Search for Patient resources using the following gender codes: female, male, other, or unknown.", "schema": { "type": "string" } }, { "name": "given", "in": "query", "description": "Search for Patient resources by given (first) name. You can use the given parameter along with other name parameters to search by a patient\u0027s name. Given name searching supports both exact and \"sounds like\" matches. Patient aliases and dominant name aliases (ex. Bob for Robert) are also supported.", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Search for Patient resources by a patient\u0027s identifier. You can use the identifier parameter as the only parameter in a search or in conjunction with other parameters. A patient\u0027s identifier must be in the format {\u003ccode system\u003e|}\u003ccode\u003e or {\u003cID Type\u003e|}\u003cID\u003e.", "schema": { "type": "string" } }, { "name": "legal-sex", "in": "query", "description": "Search for Patient resources using the following gender codes: female, male, nonbinary, x, other, or unknown.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Search for Patient resources by a patient\u0027s name. To search on specific name parts use the name part parameters, such as family or given. This parameter is ignored if any name part parameters are used.", "schema": { "type": "string" } }, { "name": "own-name", "in": "query", "description": "Search for Patient resources by patient\u0027s own last name, usually used in non-US names. You can use the own-name parameter along with other name parameters to search by a patient\u0027s name.", "schema": { "type": "string" } }, { "name": "own-prefix", "in": "query", "description": "Search for Patient resources by patient\u0027s own last name prefix, usually used in non-US names. You can use the own-prefix parameter along with other name parameters to search by a patient\u0027s name, but own-name must also be included.", "schema": { "type": "string" } }, { "name": "partner-name", "in": "query", "description": "Search for Patient resources by patient\u0027s spouse\u0027s last name, usually used in non-US names. You can use the partner-name parameter along with other name parameters to search by a patient\u0027s name, but own-name must also be included.", "schema": { "type": "string" } }, { "name": "partner-prefix", "in": "query", "description": "Search for Patient resources by patient\u0027s spouse\u0027s last name prefix, usually used in non-US names. You can use the partner-prefix parameter along with other name parameters to search by a patient\u0027s name, but own-name must also be included.", "schema": { "type": "string" } }, { "name": "telecom", "in": "query", "description": "Search for Patient resources using a patient\u0027s home phone number, cell phone number, or email address.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readPatient", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Practitioner": { "summary": "manage the collection of resources of type Practitioner", "description": "Access to services to manage the collection of all resources of type Practitioner", "get": { "summary": "Search all resources of type Practitioner based on a set of criteria", "operationId": "searchPractitioner", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "address", "in": "query", "description": "Any part of an address (street, city, etc.) where a practitioner can be visited. When used, family is also required. Only respected if no other address parameters are populated. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "The city where a practitioner can be visited. When used, address-state is also required. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "The zip code where a practitioner can be found. When used, family is also required.", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "The state where a practitioner can be found. When used, family is also required. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "A practitioner\u0027s family (last) name. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "given", "in": "query", "description": "A practitioner\u0027s given (first) name. When used, family is also required. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A practitioner\u0027s identifier in the format \u003ccode system\u003e|\u003ccode\u003e. When this parameter is provided, all others (except _id) are ignored.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Any part of a practitioner\u0027s name. For full names, format should be first last. When specified, family and given are ignored. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readPractitioner", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/PractitionerRole": { "summary": "manage the collection of resources of type PractitionerRole", "description": "Access to services to manage the collection of all resources of type PractitionerRole", "get": { "summary": "Search all resources of type PractitionerRole based on a set of criteria", "operationId": "searchPractitionerRole", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "email", "in": "query", "description": "Refine a search for a PractitionerRole by entering a valid email address. Code system is ignored.", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Search for PractitionerRoles using identifiers. A code system is required. The code must be prepended with URN:OID. Some codes may need to be URL encoded prior to query.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Search for PractitionerRoles using a Location ID. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Search for PractitionerRoles using an Organization ID. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Refine a search for a PractitionerRole by entering a valid phone number. Code system is ignored.", "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "Search for PractitionerRoles for a specified Practitioner ID. Only the first instance of this parameter is respected.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Refine a search for a PractitionerRole by entering a valid role. System must be included.", "schema": { "type": "string" } }, { "name": "specialty", "in": "query", "description": "Search for PractitionerRoles for a given specialty. A code system is required. Depending on the organization, NUCC may be supported.", "schema": { "type": "string" } }, { "name": "telecom", "in": "query", "description": "Refine a search for a PractitionerRole for a specific telecom. System must be specified as either \u0027phone\u0027 or \u0027email\u0027", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readPractitionerRole", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Procedure": { "summary": "manage the collection of resources of type Procedure", "description": "Access to services to manage the collection of all resources of type Procedure", "get": { "summary": "Search all resources of type Procedure based on a set of criteria", "operationId": "searchProcedure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Refine a search for Procedure resources by category. Only the following values are supported: 103693007 (diagnostic procedures), 387713003 (surgical procedures), 9632001 (nursing procedures, Netherlands only), and 225317005 or freedom-restricting-intervention (restricting intervention, Netherlands only) are supported.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Refine a search for Procedure resources by specifying a date or date range that a Procedure was resulted. Enter dates in ISO format (YYYY[-MM[-DD]]). Not supported by nursing procedures or restricting interventions.", "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 for Procedure resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Procedure resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readProcedure", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readProvenance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Questionnaire": { "summary": "manage the collection of resources of type Questionnaire", "description": "Access to services to manage the collection of all resources of type Questionnaire", "get": { "summary": "Search all resources of type Questionnaire based on a set of criteria", "operationId": "searchQuestionnaire", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readQuestionnaire", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Search all resources of type QuestionnaireResponse based on a set of criteria", "operationId": "searchQuestionnaireResponse", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "encounter", "in": "query", "description": "Search for QuestionnaireResponses by encounter", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for QuestionnaireResponses for a specified patient. You can also use \"subject\" equivalently", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for QuestionnaireResponses for a specified patient. You can also use \"patient\" equivalently", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] }, "post": { "summary": "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": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readQuestionnaireResponse", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "Read the current state of the resource", "operationId": "readRelatedPerson", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/RequestGroup": { "summary": "manage the collection of resources of type RequestGroup", "description": "Access to services to manage the collection of all resources of type RequestGroup", "get": { "summary": "Search all resources of type RequestGroup based on a set of criteria", "operationId": "searchRequestGroup", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/RequestGroup/{rid}": { "summary": "Read/Write/etc resource instance of type RequestGroup", "description": "Access to services to manage the state of a single resource of type RequestGroup", "get": { "summary": "Read the current state of the resource", "operationId": "readRequestGroup", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/RequestGroup" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RequestGroup.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ResearchStudy": { "summary": "manage the collection of resources of type ResearchStudy", "description": "Access to services to manage the collection of all resources of type ResearchStudy", "get": { "summary": "Search all resources of type ResearchStudy based on a set of criteria", "operationId": "searchResearchStudy", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "identifier", "in": "query", "description": "Search for the ResearchStudy resource for a specified study code.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Search for the ResearchStudy resource for a specified status", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/ResearchStudy/{rid}": { "summary": "Read/Write/etc resource instance of type ResearchStudy", "description": "Access to services to manage the state of a single resource of type ResearchStudy", "get": { "summary": "Read the current state of the resource", "operationId": "readResearchStudy", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ResearchStudy" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ResearchStudy.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ResearchSubject": { "summary": "manage the collection of resources of type ResearchSubject", "description": "Access to services to manage the collection of all resources of type ResearchSubject", "get": { "summary": "Search all resources of type ResearchSubject based on a set of criteria", "operationId": "searchResearchSubject", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "patient", "in": "query", "description": "Search for the ResearchSubject resources related to a specified patient", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Search for the ResearchSubject resources for a specified status.", "schema": { "type": "string" } }, { "name": "study", "in": "query", "description": "Search for the ResearchSubject resources related to a specified study", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/ResearchSubject/{rid}": { "summary": "Read/Write/etc resource instance of type ResearchSubject", "description": "Access to services to manage the state of a single resource of type ResearchSubject", "get": { "summary": "Read the current state of the resource", "operationId": "readResearchSubject", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ResearchSubject" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ResearchSubject.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ServiceRequest": { "summary": "manage the collection of resources of type ServiceRequest", "description": "Access to services to manage the collection of all resources of type ServiceRequest", "get": { "summary": "Search all resources of type ServiceRequest based on a set of criteria", "operationId": "searchServiceRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "category", "in": "query", "description": "Refine a search for ServiceRequests of a particular category. By default, all ServiceRequests are returned.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Search for ServiceRequest resources for specific encounters. If not provided, all ServiceRequest results are returned.", "schema": { "type": "string" } }, { "name": "onlyscannable", "in": "query", "description": "Refine a search for ServiceRequest resources to scannable only. By default, all ServiceRequests are returned. Use a value of \"true\" to only return scannable ServiceRequests. Can only be used when the application is launched from Hyperspace.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search ServiceRequest resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "requester", "in": "query", "description": "Refine a search for ServiceRequest resources by individual making the request. By default, all ServiceRequests are returned.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Refine a search for ServiceRequest resources by status. By default, all ServiceRequests are returned. Statuses of draft, active, completed, revoked, and unknown are supported.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search ServiceRequest resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readServiceRequest", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Specimen": { "summary": "manage the collection of resources of type Specimen", "description": "Access to services to manage the collection of all resources of type Specimen", "get": { "summary": "Search all resources of type Specimen based on a set of criteria", "operationId": "searchSpecimen", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/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": "Read the current state of the resource", "operationId": "readSpecimen", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Substance": { "summary": "manage the collection of resources of type Substance", "description": "Access to services to manage the collection of all resources of type Substance", "get": { "summary": "Search all resources of type Substance based on a set of criteria", "operationId": "searchSubstance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Substance/{rid}": { "summary": "Read/Write/etc resource instance of type Substance", "description": "Access to services to manage the state of a single resource of type Substance", "get": { "summary": "Read the current state of the resource", "operationId": "readSubstance", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Substance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Substance.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Task": { "summary": "manage the collection of resources of type Task", "description": "Access to services to manage the collection of all resources of type Task", "get": { "summary": "Search all resources of type Task based on a set of criteria", "operationId": "searchTask", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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" } } } } }, "parameters": [ { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/elements" }, { "name": "code", "in": "query", "description": "Specify community-resource for CRRN tasks, episode-checklist for Episode Checklist tasks. When nothing is specified, all valid tasks are returned.", "schema": { "type": "string" } }, { "name": "encounter", "in": "query", "description": "Further refine the search for a task by specifying the encounter associated with the task. For Episode Checklist tasks, only tasks created in this encounter will be returned.", "schema": { "type": "string" } }, { "name": "focus", "in": "query", "description": "Specify the EpisodeOfCare FHIR ID to search for Episode Checklist tasks.", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Search for Task resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Restrict the search for tasks based on task status. Only respected by Episode Checklist tasks.", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Search for Task resources for a specified patient ID. You can use \"patient\" or \"subject\" equivalently, but they cannot be used at the same time for different references.", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "FHIR resource IDs for the desired resources. If _id is used in a search, all other parameters will be ignored.", "schema": { "type": "string" } }, { "name": "_count", "in": "query", "description": "Number of results per page.", "schema": { "type": "number" } } ] } }, "/Task/{rid}": { "summary": "Read/Write/etc resource instance of type Task", "description": "Access to services to manage the state of a single resource of type Task", "get": { "summary": "Read the current state of the resource", "operationId": "readTask", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateTask", "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/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/Task" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Task.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ValueSet/{rid}": { "summary": "Read/Write/etc resource instance of type ValueSet", "description": "Access to services to manage the state of a single resource of type ValueSet", "get": { "summary": "Read the current state of the resource", "operationId": "readValueSet", "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/OperationOutcome" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationOutcome.xsd" } } } }, "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/ValueSet" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/ValueSet.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } } }, "components": { "parameters": { "rid": { "name": "rid", "in": "path", "description": "id of the resource (\u003dResource.id)", "required": true, "allowEmptyValue": false, "style": "simple", "schema": { "type": "string" } }, "hid": { "name": "hid", "in": "path", "description": "id of the history entry (\u003dResource.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" } } } } }