{ "openapi": "3.0.2", "info": { "title": "patient", "license": { "name": "Creative Commons Zero v1.0 Universal", "url": "http://spdx.org/licenses/CC0-1.0.html" }, "version": "8.0.2-SNAPSHOT", "contact": { "name": "Den telemedicinske infrastruktur (eHealth Infrastructure)", "url": "http://ehealth.sundhed.dk" } }, "servers": [ { "url": "https://patient.ehealth.sundhed.dk/fhir/", "description": "eHealth Patient service" } ], "externalDocs": { "url": "http://ehealth.sundhed.dk/fhir/CapabilityStatement/patient", "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" } ] } }, "/Appointment": { "summary": "Manager for resources of type Appointment", "description": "The Manager for resources of type Appointment: provides services to manage the collection of all the Appointment instances", "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": "Appointment date/time.", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "specialty", "in": "query", "description": "The specialty of a practitioner that would be required to perform the service requested in this appointment", "schema": { "type": "string" } }, { "name": "service-category", "in": "query", "description": "A broad categorization of the service that is to be performed during this appointment", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "slot", "in": "query", "description": "The slots that this appointment is filling", "schema": { "type": "string" } }, { "name": "reason-code", "in": "query", "description": "Coded reason this appointment is scheduled", "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "The service request this appointment is allocated to assess", "schema": { "type": "string" } }, { "name": "appointmentGroupId", "in": "query", "description": "Search parameter for finding resources based on group id", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "One of the individuals of the appointment is this patient", "schema": { "type": "string" } }, { "name": "responsible", "in": "query", "description": "Search parameter for finding responsible entity on Appointment", "schema": { "type": "string" } }, { "name": "supporting-info", "in": "query", "description": "Additional information to support the appointment", "schema": { "type": "string" } }, { "name": "careteamParticipant", "in": "query", "description": "Search parameter for finding appointments based on careteam participants", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An Identifier of the Appointment", "schema": { "type": "string" } }, { "name": "practitioner", "in": "query", "description": "One of the individuals of the appointment is this practitioner", "schema": { "type": "string" } }, { "name": "appointment-type", "in": "query", "description": "The style of appointment or patient that has been booked in the slot (not service type)", "schema": { "type": "string" } }, { "name": "part-status", "in": "query", "description": "The Participation status of the subject, or other participant on the appointment. Can be used to locate participants that have not responded to meeting requests.", "schema": { "type": "string" } }, { "name": "service-type", "in": "query", "description": "The specific service that is to be performed during this appointment", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "actor", "in": "query", "description": "Any one of the individuals participating in the appointment", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "intended-audience", "in": "query", "description": "Search parameter for finding intended audience on Appointment", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "reason-reference", "in": "query", "description": "Reason the appointment is to take place (resource)", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "This location is listed in the participants of the appointment", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The overall status of the appointment", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createAppointment", "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/Appointment" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Appointment.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/Appointment" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Appointment.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateAppointment", "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/Appointment" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Appointment.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/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchAppointment", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Appointment" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Appointment.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/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" } ] } }, "/Appointment/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Appointment", "description": "Access a to specified previous version of a single resource of type Appointment", "get": { "summary": "Read a past state of the resource", "operationId": "vreadAppointment", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Binary": { "summary": "Manager for resources of type Binary", "description": "The Manager for resources of type Binary: provides services to manage the collection of all the Binary instances", "get": { "summary": "Search all resources of type Binary based on a set of criteria", "operationId": "searchBinary", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource\u0027s data using a list", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createBinary", "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/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.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/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.xsd" } } } } }, "parameters": [ { "$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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateBinary", "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/Binary" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.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/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchBinary", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Binary" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Binary.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/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" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteBinary", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/Binary/{rid}/_history": { "summary": "Read past versions of resource instance of type Binary", "description": "Access to previous versions of a single resource of type Binary", "get": { "summary": "Read the past states of the resource", "operationId": "histinstBinary", "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 resources being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" }, { "$ref": "#/components/parameters/count" }, { "name": "_since", "in": "query", "description": "Only include resource versions that were created at or after the given instant in time", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "_at", "in": "query", "description": "Only include resource versions that were current at some point during the time period specified in the date time value (see Search notes on date searching)", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "_list", "in": "query", "description": "Only include resource versions that are referenced in the specified list (current list references are allowed)", "schema": { "type": "string" } } ] } }, "/Binary/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Binary", "description": "Access a to specified previous version of a single resource of type Binary", "get": { "summary": "Read a past state of the resource", "operationId": "vreadBinary", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Binary/_history": { "summary": "Read past versions of resources of type Binary", "description": "Access to previous versions of resourcez of type Binary", "get": { "summary": "Read the past states of the resource", "operationId": "histtypeBinary", "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 resources being returned", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Bundle" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Bundle.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" }, { "$ref": "#/components/parameters/count" }, { "name": "_since", "in": "query", "description": "Only include resource versions that were created at or after the given instant in time", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "_at", "in": "query", "description": "Only include resource versions that were current at some point during the time period specified in the date time value (see Search notes on date searching)", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "_list", "in": "query", "description": "Only include resource versions that are referenced in the specified list (current list references are allowed)", "schema": { "type": "string" } } ] } }, "/CodeSystem": { "summary": "manage the collection of resources of type CodeSystem", "description": "Access to services to manage the collection of all resources of type CodeSystem", "get": { "summary": "Search all resources of type CodeSystem based on a set of criteria", "operationId": "searchCodeSystem", "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": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "A code defined in the code system", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n", "schema": {} }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "jurisdiction", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "A language in which a designation is provided", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n", "schema": {} }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n", "schema": { "type": "string" } }, { "name": "content-mode", "in": "query", "description": "not-present | example | fragment | complete | supplement", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "supplements", "in": "query", "description": "Find code system supplements for the referenced code system", "schema": { "type": "string" } }, { "name": "system", "in": "query", "description": "The system for any codes defined by this code system (same as \u0027url\u0027)", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n", "schema": { "type": "string" } } ] } }, "/CodeSystem/{rid}": { "summary": "Read/Write/etc resource instance of type CodeSystem", "description": "Access to services to manage the state of a single resource of type CodeSystem", "get": { "summary": "Read the current state of the resource", "operationId": "readCodeSystem", "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/CodeSystem" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/CodeSystem.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/CodeSystem/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type CodeSystem", "description": "Access a to specified previous version of a single resource of type CodeSystem", "get": { "summary": "Read a past state of the resource", "operationId": "vreadCodeSystem", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/CodeSystem" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/CodeSystem.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "administrativeStatus", "in": "query", "description": "Search parameter for finding communication based on administrative status", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Focus of message", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "part-of", "in": "query", "description": "Part of this action", "schema": { "type": "string" } }, { "name": "medium", "in": "query", "description": "A channel of communication", "schema": { "type": "string" } }, { "name": "on-behalf-of", "in": "query", "description": "Search parameter for finding communication based on on-behalf-of", "schema": { "type": "string" } }, { "name": "threadId", "in": "query", "description": "Search parameter for finding communication based on thread id", "schema": { "type": "string" } }, { "name": "topic", "in": "query", "description": "Search parameter to enable filtering ehealth-message Communications by topic", "schema": { "type": "string" } }, { "name": "communicationRelatesTo", "in": "query", "description": "Search parameter for finding communication based on either participant or episode of care", "schema": { "type": "string" } }, { "name": "based-on", "in": "query", "description": "Request fulfilled by this communication", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Focus of message", "schema": { "type": "string" } }, { "name": "instantiates-uri", "in": "query", "description": "Instantiates external protocol or definition", "schema": { "type": "string" } }, { "name": "communicationAbout", "in": "query", "description": "Search parameter for finding communication based on about", "schema": { "type": "string" } }, { "name": "episodeOfCare", "in": "query", "description": "Search parameter for finding communication based on episodeOfCare", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Unique identifier", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Search parameter for finding communication based on period", "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": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "communicationParticipant", "in": "query", "description": "Search parameter for finding communication based on participant", "schema": { "type": "string" } }, { "name": "instantiates-canonical", "in": "query", "description": "Instantiates FHIR protocol or definition", "schema": { "type": "string" } }, { "name": "communicationCategory", "in": "query", "description": "Search parameter for finding communication based on the category code", "schema": { "type": "string" } }, { "name": "received", "in": "query", "description": "When received", "schema": { "type": "string", "pattern": "([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-9]000)(-(0[1-9]|1[0-2])(-(0[1-9]|[1-2][0-9]|3[0-1])(T([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)(\\.[0-9]+)?(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00)))?)?)?" } }, { "name": "encounter", "in": "query", "description": "Encounter created as part of", "schema": { "type": "string" } }, { "name": "careTeamRecipient", "in": "query", "description": "Search parameter for finding communication based on CareTeam recipient", "schema": { "type": "string" } }, { "name": "communicationGroupId", "in": "query", "description": "Search parameter for finding resources based on group id", "schema": { "type": "string" } }, { "name": "sent", "in": "query", "description": "When sent", "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": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "careTeamSender", "in": "query", "description": "Search parameter for finding communication based on CareTeam sender", "schema": { "type": "string" } }, { "name": "sender", "in": "query", "description": "Message sender", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "recipient", "in": "query", "description": "Message recipient", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Message category", "schema": { "type": "string" } }, { "name": "restrictionCategory", "in": "query", "description": "Search parameter for finding communication based on restriction category", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown", "schema": { "type": "string" } } ] }, "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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchCommunication", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Communication" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Communication.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/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" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteCommunication", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/Communication/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Communication", "description": "Access a to specified previous version of a single resource of type Communication", "get": { "summary": "Read a past state of the resource", "operationId": "vreadCommunication", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Consent": { "summary": "Manager for resources of type Consent", "description": "The Manager for resources of type Consent: provides services to manage the collection of all the Consent instances", "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": "date", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded\r\n* [CarePlan](careplan.html): Time period plan covers\r\n* [CareTeam](careteam.html): Time period team covers\r\n* [ClinicalImpression](clinicalimpression.html): When the assessment was documented\r\n* [Composition](composition.html): Composition editing time\r\n* [Consent](consent.html): When this Consent was created or indexed\r\n* [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report\r\n* [Encounter](encounter.html): A date within the period the Encounter lasted\r\n* [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care\u0027s period\r\n* [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated\r\n* [Flag](flag.html): Time period when flag is active\r\n* [Immunization](immunization.html): Vaccination (non)-Administration Date\r\n* [List](list.html): When the list was prepared\r\n* [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period\r\n* [Procedure](procedure.html): When the procedure was performed\r\n* [RiskAssessment](riskassessment.html): When was assessment made?\r\n* [SupplyRequest](supplyrequest.html): When the request was made\r\n", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "data", "in": "query", "description": "The actual data reference", "schema": { "type": "string" } }, { "name": "purpose", "in": "query", "description": "Context of activities covered by this rule", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "source-reference", "in": "query", "description": "Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse", "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource\u0027s data using a list", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for\r\n* [CarePlan](careplan.html): Who the care plan is for\r\n* [CareTeam](careteam.html): Who care team is for\r\n* [ClinicalImpression](clinicalimpression.html): Patient or group assessed\r\n* [Composition](composition.html): Who and/or what the composition is about\r\n* [Condition](condition.html): Who has the condition?\r\n* [Consent](consent.html): Who the consent applies to\r\n* [DetectedIssue](detectedissue.html): Associated patient\r\n* [DeviceRequest](devicerequest.html): Individual the service is ordered for\r\n* [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient\r\n* [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient\r\n* [DocumentManifest](documentmanifest.html): The subject of the set of documents\r\n* [DocumentReference](documentreference.html): Who/what is the subject of the document\r\n* [Encounter](encounter.html): The patient or group present at the encounter\r\n* [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care\r\n* [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for\r\n* [Flag](flag.html): The identity of a subject to list flags for\r\n* [Goal](goal.html): Who this goal is intended for\r\n* [ImagingStudy](imagingstudy.html): Who the study is about\r\n* [Immunization](immunization.html): The patient for the vaccination record\r\n* [List](list.html): If all resources have the same subject\r\n* [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for\r\n* [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for\r\n* [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient\r\n* [MedicationStatement](medicationstatement.html): Returns statements for a specific patient.\r\n* [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement\r\n* [Observation](observation.html): The subject that the observation is about (if patient)\r\n* [Procedure](procedure.html): Search by subject - a patient\r\n* [RiskAssessment](riskassessment.html): Who/what does assessment apply to?\r\n* [ServiceRequest](servicerequest.html): Search by subject - a patient\r\n* [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied\r\n* [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for\r\n", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "Which of the four areas this resource covers (extensible)", "schema": { "type": "string" } }, { "name": "action", "in": "query", "description": "Actions controlled by this rule", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [AllergyIntolerance](allergyintolerance.html): External ids for this item\r\n* [CarePlan](careplan.html): External Ids for this plan\r\n* [CareTeam](careteam.html): External Ids for this team\r\n* [Composition](composition.html): Version-independent identifier for the Composition\r\n* [Condition](condition.html): A unique identifier of the condition record\r\n* [Consent](consent.html): Identifier for this record (external references)\r\n* [DetectedIssue](detectedissue.html): Unique id for the detected issue\r\n* [DeviceRequest](devicerequest.html): Business identifier for request/order\r\n* [DiagnosticReport](diagnosticreport.html): An identifier for the report\r\n* [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents\r\n* [DocumentReference](documentreference.html): Master Version Specific Identifier\r\n* [Encounter](encounter.html): Identifier(s) by which this encounter is known\r\n* [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare\r\n* [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier\r\n* [Goal](goal.html): External Ids for this goal\r\n* [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID and Accession number\r\n* [Immunization](immunization.html): Business identifier\r\n* [List](list.html): Business identifier\r\n* [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier\r\n* [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier\r\n* [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier\r\n* [MedicationStatement](medicationstatement.html): Return statements with this external identifier\r\n* [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier\r\n* [Observation](observation.html): The unique id for a particular observation\r\n* [Procedure](procedure.html): A unique identifier for a procedure\r\n* [RiskAssessment](riskassessment.html): Unique identifier for the assessment\r\n* [ServiceRequest](servicerequest.html): Identifiers assigned to this order\r\n* [SupplyDelivery](supplydelivery.html): External identifier\r\n* [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest\r\n* [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier\r\n", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Timeframe for this rule", "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": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "actor", "in": "query", "description": "Resource for the actor (or group, by role)", "schema": { "type": "string" } }, { "name": "security-label", "in": "query", "description": "Security Labels that define affected resources", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "Custodian of the consent", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "consentor", "in": "query", "description": "Who is agreeing to the policy and rules", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Classification of the consent statement - for indexing/retrieval", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "draft | proposed | active | rejected | inactive | entered-in-error", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createConsent", "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/Consent" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Consent.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/Consent" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Consent.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateConsent", "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/Consent" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Consent.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/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchConsent", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Consent" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Consent.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/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" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteConsent", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/Consent/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Consent", "description": "Access a to specified previous version of a single resource of type Consent", "get": { "summary": "Read a past state of the resource", "operationId": "vreadConsent", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/OperationDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type OperationDefinition", "description": "Access to services to manage the state of a single resource of type OperationDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readOperationDefinition", "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/OperationDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/OperationDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Patient": { "summary": "manage the collection of resources of type Patient", "description": "Access to services to manage the collection of all resources of type Patient", "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": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient\u0027s date of birth\r\n* [Person](person.html): The person\u0027s date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person\u0027s date of birth\r\n", "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": "deceased", "in": "query", "description": "This patient has been marked as deceased, or as a death date entered", "schema": { "type": "string" } }, { "name": "address-state", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "link", "in": "query", "description": "All patients linked to the given patient", "schema": { "type": "string" } }, { "name": "patientCPRIdentifier", "in": "query", "description": "Search parameter for Patient DK-Core CPR identifier", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language code (irrespective of use value)", "schema": { "type": "string" } }, { "name": "address-country", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n", "schema": { "type": "string" } }, { "name": "death-date", "in": "query", "description": "The date of death has been provided and satisfies this search value", "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": "phonetic", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n", "schema": { "type": "string" } }, { "name": "telecom", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n", "schema": { "type": "string" } }, { "name": "given", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the given name of the patient\r\n* [Practitioner](practitioner.html): A portion of the given name\r\n", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "A patient identifier", "schema": { "type": "string" } }, { "name": "patientCPRIdentifierUnique", "in": "query", "description": "Uniqueness constraint on search parameter patientCPRIdentifier", "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n", "schema": { "type": "string" } }, { "name": "general-practitioner", "in": "query", "description": "Patient\u0027s nominated general practitioner, not the organization that manages the record", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Whether the patient record is active", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "organization", "in": "query", "description": "The organization that is the custodian of the patient record", "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of the family name of the patient\r\n* [Practitioner](practitioner.html): A portion of the family name\r\n", "schema": { "type": "string" } } ] } }, "/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchPatient", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Patient" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Patient.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Patient.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Patient/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Patient", "description": "Access a to specified previous version of a single resource of type Patient", "get": { "summary": "Read a past state of the resource", "operationId": "vreadPatient", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Patient" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Patient.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Provenance": { "summary": "Manager for resources of type Provenance", "description": "The Manager for resources of type Provenance: provides services to manage the collection of all the Provenance instances", "get": { "summary": "Search all resources of type Provenance based on a set of criteria", "operationId": "searchProvenance", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "agent-type", "in": "query", "description": "How the agent participated", "schema": { "type": "string" } }, { "name": "agent", "in": "query", "description": "Who participated", "schema": { "type": "string" } }, { "name": "signature-type", "in": "query", "description": "Indication of the reason the entity signed the object(s)", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "recorded", "in": "query", "description": "When the activity was recorded / updated", "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": "when", "in": "query", "description": "When the activity occurred", "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": "target", "in": "query", "description": "Target Reference(s) (usually version specific)", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "_list", "in": "query", "description": "Search the contents of the resource\u0027s data using a list", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "Target Reference(s) (usually version specific)", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Where the activity occurred, if relevant", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "agent-role", "in": "query", "description": "What the agents role was", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "Identity of entity", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createProvenance", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } } } } }, "parameters": [ { "$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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateProvenance", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchProvenance", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Provenance" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteProvenance", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/Provenance/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type Provenance", "description": "Access a to specified previous version of a single resource of type Provenance", "get": { "summary": "Read a past state of the resource", "operationId": "vreadProvenance", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Provenance" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Provenance.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/RelatedPerson": { "summary": "Manager for resources of type RelatedPerson", "description": "The Manager for resources of type RelatedPerson: provides services to manage the collection of all the RelatedPerson instances", "get": { "summary": "Search all resources of type RelatedPerson based on a set of criteria", "operationId": "searchRelatedPerson", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "birthdate", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The patient\u0027s date of birth\r\n* [Person](person.html): The person\u0027s date of birth\r\n* [RelatedPerson](relatedperson.html): The Related Person\u0027s date of birth\r\n", "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": "address-state", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A state specified in an address\r\n* [Person](person.html): A state specified in an address\r\n* [Practitioner](practitioner.html): A state specified in an address\r\n* [RelatedPerson](relatedperson.html): A state specified in an address\r\n", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): Gender of the patient\r\n* [Person](person.html): The gender of the person\r\n* [Practitioner](practitioner.html): Gender of the practitioner\r\n* [RelatedPerson](relatedperson.html): Gender of the related person\r\n", "schema": { "type": "string" } }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "address-country", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A country specified in an address\r\n* [Person](person.html): A country specified in an address\r\n* [Practitioner](practitioner.html): A country specified in an address\r\n* [RelatedPerson](relatedperson.html): A country specified in an address\r\n", "schema": { "type": "string" } }, { "name": "phonetic", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [Person](person.html): A portion of name using some kind of phonetic matching algorithm\r\n* [Practitioner](practitioner.html): A portion of either family or given name using some kind of phonetic matching algorithm\r\n* [RelatedPerson](relatedperson.html): A portion of name using some kind of phonetic matching algorithm\r\n", "schema": { "type": "string" } }, { "name": "patient", "in": "query", "description": "The patient this related person is related to", "schema": { "type": "string" } }, { "name": "telecom", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): The value in any kind of telecom details of the patient\r\n* [Person](person.html): The value in any kind of contact\r\n* [Practitioner](practitioner.html): The value in any kind of contact\r\n* [PractitionerRole](practitionerrole.html): The value in any kind of contact\r\n* [RelatedPerson](relatedperson.html): The value in any kind of contact\r\n", "schema": { "type": "string" } }, { "name": "address-city", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A city specified in an address\r\n* [Person](person.html): A city specified in an address\r\n* [Practitioner](practitioner.html): A city specified in an address\r\n* [RelatedPerson](relatedperson.html): A city specified in an address\r\n", "schema": { "type": "string" } }, { "name": "relationship", "in": "query", "description": "The relationship between the patient and the relatedperson", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in an email contact\r\n* [Person](person.html): A value in an email contact\r\n* [Practitioner](practitioner.html): A value in an email contact\r\n* [PractitionerRole](practitionerrole.html): A value in an email contact\r\n* [RelatedPerson](relatedperson.html): A value in an email contact\r\n", "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "An Identifier of the RelatedPerson", "schema": { "type": "string" } }, { "name": "address", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Person](person.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [Practitioner](practitioner.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n* [RelatedPerson](relatedperson.html): A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text\r\n", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Indicates if the related person record is active", "schema": { "type": "string" } }, { "name": "address-postalcode", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A postalCode specified in an address\r\n* [Person](person.html): A postal code specified in an address\r\n* [Practitioner](practitioner.html): A postalCode specified in an address\r\n* [RelatedPerson](relatedperson.html): A postal code specified in an address\r\n", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A value in a phone contact\r\n* [Person](person.html): A value in a phone contact\r\n* [Practitioner](practitioner.html): A value in a phone contact\r\n* [PractitionerRole](practitionerrole.html): A value in a phone contact\r\n* [RelatedPerson](relatedperson.html): A value in a phone contact\r\n", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "address-use", "in": "query", "description": "Multiple Resources: \r\n\r\n* [Patient](patient.html): A use code specified in an address\r\n* [Person](person.html): A use code specified in an address\r\n* [Practitioner](practitioner.html): A use code specified in an address\r\n* [RelatedPerson](relatedperson.html): A use code specified in an address\r\n", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createRelatedPerson", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } } } } }, "parameters": [ { "$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" } ] }, "put": { "summary": "Update the current state of the resource", "operationId": "updateRelatedPerson", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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/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" } ] }, "patch": { "summary": "Change the current state of the resource by providing a patch - a series of change commands", "operationId": "patchRelatedPerson", "requestBody": { "description": "The new state of the resource", "required": true, "content": { "application/json-patch+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/RelatedPerson" } }, "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/xml-patch+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } }, "responses": { "default": { "description": "Error, with details", "content": { "application/fhir+json": { "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 patched", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] }, "delete": { "summary": "Delete the resource so that it no exists (no read, search etc)", "operationId": "deleteRelatedPerson", "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" } } } }, "204": { "description": "If the resource is deleted - no content is returned", "headers": { "ETag": { "description": "Version from Resource.meta.version as a weak ETag", "schema": { "type": "string" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" } ] } }, "/RelatedPerson/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type RelatedPerson", "description": "Access a to specified previous version of a single resource of type RelatedPerson", "get": { "summary": "Read a past state of the resource", "operationId": "vreadRelatedPerson", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/RelatedPerson" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/RelatedPerson.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/SearchParameter": { "summary": "manage the collection of resources of type SearchParameter", "description": "Access to services to manage the collection of all resources of type SearchParameter", "get": { "summary": "Search all resources of type SearchParameter based on a set of criteria", "operationId": "searchSearchParameter", "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": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "Code used in URL", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n", "schema": {} }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "jurisdiction", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n", "schema": { "type": "string" } }, { "name": "derived-from", "in": "query", "description": "Original definition for the search parameter", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "number | date | string | token | reference | composite | quantity | uri | special", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n", "schema": {} }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "sp-unique-url", "in": "query", "description": "Search parameter for making a SearchParameter unique by URL", "schema": {} }, { "name": "version", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Search parameter for finding a searchparameter by URL", "schema": { "type": "string" } }, { "name": "target", "in": "query", "description": "Types of resource (if a resource reference)", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "component", "in": "query", "description": "Defines how the part works", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n", "schema": { "type": "string" } }, { "name": "base", "in": "query", "description": "The resource type(s) this search parameter applies to", "schema": { "type": "string" } } ] } }, "/SearchParameter/{rid}": { "summary": "Read/Write/etc resource instance of type SearchParameter", "description": "Access to services to manage the state of a single resource of type SearchParameter", "get": { "summary": "Read the current state of the resource", "operationId": "readSearchParameter", "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/SearchParameter" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/SearchParameter.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/SearchParameter/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type SearchParameter", "description": "Access a to specified previous version of a single resource of type SearchParameter", "get": { "summary": "Read a past state of the resource", "operationId": "vreadSearchParameter", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/SearchParameter" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/SearchParameter.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/StructureDefinition": { "summary": "Manager for resources of type StructureDefinition", "description": "The Manager for resources of type StructureDefinition: provides services to manage the collection of all the StructureDefinition instances", "get": { "summary": "Search all resources of type StructureDefinition based on a set of criteria", "operationId": "searchStructureDefinition", "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": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n", "schema": {} }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "jurisdiction", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "experimental", "in": "query", "description": "For testing purposes, not real usage", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type defined or constrained by this structure", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "path", "in": "query", "description": "A path that is constrained in the StructureDefinition", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "base-path", "in": "query", "description": "Path that identifies the base element", "schema": { "type": "string" } }, { "name": "sd-unique-url", "in": "query", "description": "Search parameter for making a structureDefinition unique by URL", "schema": {} }, { "name": "keyword", "in": "query", "description": "A code for the StructureDefinition", "schema": { "type": "string" } }, { "name": "context-type-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n", "schema": {} }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n", "schema": { "type": "string" } }, { "name": "valueset", "in": "query", "description": "A vocabulary binding reference", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "primitive-type | complex-type | resource | logical", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "abstract", "in": "query", "description": "Whether the structure is abstract", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Search parameter for finding a structureDefinition by URL", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "ext-context", "in": "query", "description": "The system is the URL for the context-type: e.g. http://hl7.org/fhir/extension-context-type#element|CodeableConcept.text", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "derivation", "in": "query", "description": "specialization | constraint - How relates to base definition", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n", "schema": { "type": "string" } }, { "name": "base", "in": "query", "description": "Definition that this type is constrained/specialized from", "schema": { "type": "string" } } ] }, "post": { "summary": "Create a new resource", "operationId": "createStructureDefinition", "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/StructureDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/StructureDefinition.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/StructureDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/StructureDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/StructureDefinition/{rid}": { "summary": "Read/Write/etc resource instance of type StructureDefinition", "description": "Access to services to manage the state of a single resource of type StructureDefinition", "get": { "summary": "Read the current state of the resource", "operationId": "readStructureDefinition", "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/StructureDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/StructureDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/StructureDefinition/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type StructureDefinition", "description": "Access a to specified previous version of a single resource of type StructureDefinition", "get": { "summary": "Read a past state of the resource", "operationId": "vreadStructureDefinition", "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 for that version", "schema": { "type": "string" } } }, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/StructureDefinition" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/StructureDefinition.xsd" } } } } }, "parameters": [ { "$ref": "#/components/parameters/rid" }, { "$ref": "#/components/parameters/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/ValueSet": { "summary": "manage the collection of resources of type ValueSet", "description": "Access to services to manage the collection of all resources of type ValueSet", "get": { "summary": "Search all resources of type ValueSet based on a set of criteria", "operationId": "searchValueSet", "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": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The capability statement publication date\r\n* [CodeSystem](codesystem.html): The code system publication date\r\n* [CompartmentDefinition](compartmentdefinition.html): The compartment definition publication date\r\n* [ConceptMap](conceptmap.html): The concept map publication date\r\n* [GraphDefinition](graphdefinition.html): The graph definition publication date\r\n* [ImplementationGuide](implementationguide.html): The implementation guide publication date\r\n* [MessageDefinition](messagedefinition.html): The message definition publication date\r\n* [NamingSystem](namingsystem.html): The naming system publication date\r\n* [OperationDefinition](operationdefinition.html): The operation definition publication date\r\n* [SearchParameter](searchparameter.html): The search parameter publication date\r\n* [StructureDefinition](structuredefinition.html): The structure definition publication date\r\n* [StructureMap](structuremap.html): The structure map publication date\r\n* [TerminologyCapabilities](terminologycapabilities.html): The terminology capabilities publication date\r\n* [ValueSet](valueset.html): The value set publication date\r\n", "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": "_language", "in": "query", "description": "The language of the resource", "schema": { "type": "string" } }, { "name": "code", "in": "query", "description": "This special parameter searches for codes in the value set. See additional notes on the ValueSet resource", "schema": { "type": "string" } }, { "name": "context-type-value", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and value assigned to the value set\r\n", "schema": {} }, { "name": "_lastUpdated", "in": "query", "description": "When the resource version last changed", "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": "jurisdiction", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Intended jurisdiction for the capability statement\r\n* [CodeSystem](codesystem.html): Intended jurisdiction for the code system\r\n* [ConceptMap](conceptmap.html): Intended jurisdiction for the concept map\r\n* [GraphDefinition](graphdefinition.html): Intended jurisdiction for the graph definition\r\n* [ImplementationGuide](implementationguide.html): Intended jurisdiction for the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Intended jurisdiction for the message definition\r\n* [NamingSystem](namingsystem.html): Intended jurisdiction for the naming system\r\n* [OperationDefinition](operationdefinition.html): Intended jurisdiction for the operation definition\r\n* [SearchParameter](searchparameter.html): Intended jurisdiction for the search parameter\r\n* [StructureDefinition](structuredefinition.html): Intended jurisdiction for the structure definition\r\n* [StructureMap](structuremap.html): Intended jurisdiction for the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Intended jurisdiction for the terminology capabilities\r\n* [ValueSet](valueset.html): Intended jurisdiction for the value set\r\n", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The description of the capability statement\r\n* [CodeSystem](codesystem.html): The description of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The description of the compartment definition\r\n* [ConceptMap](conceptmap.html): The description of the concept map\r\n* [GraphDefinition](graphdefinition.html): The description of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The description of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The description of the message definition\r\n* [NamingSystem](namingsystem.html): The description of the naming system\r\n* [OperationDefinition](operationdefinition.html): The description of the operation definition\r\n* [SearchParameter](searchparameter.html): The description of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The description of the structure definition\r\n* [StructureMap](structuremap.html): The description of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The description of the terminology capabilities\r\n* [ValueSet](valueset.html): The description of the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A type of use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A type of use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A type of use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A type of use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A type of use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A type of use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A type of use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A type of use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A type of use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A type of use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A type of use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A type of use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A type of use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A type of use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "title", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The human-friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): The human-friendly name of the code system\r\n* [ConceptMap](conceptmap.html): The human-friendly name of the concept map\r\n* [ImplementationGuide](implementationguide.html): The human-friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The human-friendly name of the message definition\r\n* [OperationDefinition](operationdefinition.html): The human-friendly name of the operation definition\r\n* [StructureDefinition](structuredefinition.html): The human-friendly name of the structure definition\r\n* [StructureMap](structuremap.html): The human-friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The human-friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): The human-friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "reference", "in": "query", "description": "A code system included or excluded in the value set or an imported value set", "schema": { "type": "string" } }, { "name": "context-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A quantity- or range-valued use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A quantity- or range-valued use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A quantity- or range-valued use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A quantity- or range-valued use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A quantity- or range-valued use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A quantity- or range-valued use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A quantity- or range-valued use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A quantity- or range-valued use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A quantity- or range-valued use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A quantity- or range-valued use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A quantity- or range-valued use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A quantity- or range-valued use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A quantity- or range-valued use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A quantity- or range-valued use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context assigned to the value set\r\n", "schema": { "type": "string" } }, { "name": "context-type-quantity", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): A use context type and quantity- or range-based value assigned to the capability statement\r\n* [CodeSystem](codesystem.html): A use context type and quantity- or range-based value assigned to the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): A use context type and quantity- or range-based value assigned to the compartment definition\r\n* [ConceptMap](conceptmap.html): A use context type and quantity- or range-based value assigned to the concept map\r\n* [GraphDefinition](graphdefinition.html): A use context type and quantity- or range-based value assigned to the graph definition\r\n* [ImplementationGuide](implementationguide.html): A use context type and quantity- or range-based value assigned to the implementation guide\r\n* [MessageDefinition](messagedefinition.html): A use context type and quantity- or range-based value assigned to the message definition\r\n* [NamingSystem](namingsystem.html): A use context type and quantity- or range-based value assigned to the naming system\r\n* [OperationDefinition](operationdefinition.html): A use context type and quantity- or range-based value assigned to the operation definition\r\n* [SearchParameter](searchparameter.html): A use context type and quantity- or range-based value assigned to the search parameter\r\n* [StructureDefinition](structuredefinition.html): A use context type and quantity- or range-based value assigned to the structure definition\r\n* [StructureMap](structuremap.html): A use context type and quantity- or range-based value assigned to the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): A use context type and quantity- or range-based value assigned to the terminology capabilities\r\n* [ValueSet](valueset.html): A use context type and quantity- or range-based value assigned to the value set\r\n", "schema": {} }, { "name": "identifier", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CodeSystem](codesystem.html): External identifier for the code system\r\n* [ConceptMap](conceptmap.html): External identifier for the concept map\r\n* [MessageDefinition](messagedefinition.html): External identifier for the message definition\r\n* [StructureDefinition](structuredefinition.html): External identifier for the structure definition\r\n* [StructureMap](structuremap.html): External identifier for the structure map\r\n* [ValueSet](valueset.html): External identifier for the value set\r\n", "schema": { "type": "string" } }, { "name": "_security", "in": "query", "description": "Security Labels applied to this resource", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The business version of the capability statement\r\n* [CodeSystem](codesystem.html): The business version of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The business version of the compartment definition\r\n* [ConceptMap](conceptmap.html): The business version of the concept map\r\n* [GraphDefinition](graphdefinition.html): The business version of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The business version of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The business version of the message definition\r\n* [OperationDefinition](operationdefinition.html): The business version of the operation definition\r\n* [SearchParameter](searchparameter.html): The business version of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The business version of the structure definition\r\n* [StructureMap](structuremap.html): The business version of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The business version of the terminology capabilities\r\n* [ValueSet](valueset.html): The business version of the value set\r\n", "schema": { "type": "string" } }, { "name": "url", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The uri that identifies the capability statement\r\n* [CodeSystem](codesystem.html): The uri that identifies the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The uri that identifies the compartment definition\r\n* [ConceptMap](conceptmap.html): The uri that identifies the concept map\r\n* [GraphDefinition](graphdefinition.html): The uri that identifies the graph definition\r\n* [ImplementationGuide](implementationguide.html): The uri that identifies the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The uri that identifies the message definition\r\n* [OperationDefinition](operationdefinition.html): The uri that identifies the operation definition\r\n* [SearchParameter](searchparameter.html): The uri that identifies the search parameter\r\n* [StructureDefinition](structuredefinition.html): The uri that identifies the structure definition\r\n* [StructureMap](structuremap.html): The uri that identifies the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The uri that identifies the terminology capabilities\r\n* [ValueSet](valueset.html): The uri that identifies the value set\r\n", "schema": { "type": "string" } }, { "name": "expansion", "in": "query", "description": "Identifies the value set expansion (business identifier)", "schema": { "type": "string" } }, { "name": "_filter", "in": "query", "description": "Search the contents of the resource\u0027s data using a filter", "schema": { "type": "string" } }, { "name": "_profile", "in": "query", "description": "Profiles this resource claims to conform to", "schema": { "type": "string" } }, { "name": "_tag", "in": "query", "description": "Tags applied to this resource", "schema": { "type": "string" } }, { "name": "_has", "in": "query", "description": "Return resources linked to by the given target", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Computationally friendly name of the capability statement\r\n* [CodeSystem](codesystem.html): Computationally friendly name of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Computationally friendly name of the compartment definition\r\n* [ConceptMap](conceptmap.html): Computationally friendly name of the concept map\r\n* [GraphDefinition](graphdefinition.html): Computationally friendly name of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Computationally friendly name of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Computationally friendly name of the message definition\r\n* [NamingSystem](namingsystem.html): Computationally friendly name of the naming system\r\n* [OperationDefinition](operationdefinition.html): Computationally friendly name of the operation definition\r\n* [SearchParameter](searchparameter.html): Computationally friendly name of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Computationally friendly name of the structure definition\r\n* [StructureMap](structuremap.html): Computationally friendly name of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Computationally friendly name of the terminology capabilities\r\n* [ValueSet](valueset.html): Computationally friendly name of the value set\r\n", "schema": { "type": "string" } }, { "name": "publisher", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): Name of the publisher of the capability statement\r\n* [CodeSystem](codesystem.html): Name of the publisher of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): Name of the publisher of the compartment definition\r\n* [ConceptMap](conceptmap.html): Name of the publisher of the concept map\r\n* [GraphDefinition](graphdefinition.html): Name of the publisher of the graph definition\r\n* [ImplementationGuide](implementationguide.html): Name of the publisher of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): Name of the publisher of the message definition\r\n* [NamingSystem](namingsystem.html): Name of the publisher of the naming system\r\n* [OperationDefinition](operationdefinition.html): Name of the publisher of the operation definition\r\n* [SearchParameter](searchparameter.html): Name of the publisher of the search parameter\r\n* [StructureDefinition](structuredefinition.html): Name of the publisher of the structure definition\r\n* [StructureMap](structuremap.html): Name of the publisher of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): Name of the publisher of the terminology capabilities\r\n* [ValueSet](valueset.html): Name of the publisher of the value set\r\n", "schema": { "type": "string" } }, { "name": "_source", "in": "query", "description": "Identifies where the resource comes from", "schema": { "type": "string" } }, { "name": "_id", "in": "query", "description": "Logical id of this artifact", "schema": { "type": "string" } }, { "name": "_content", "in": "query", "description": "Search the contents of the resource\u0027s data using a fulltext search", "schema": { "type": "string" } }, { "name": "_text", "in": "query", "description": "Search the contents of the resource\u0027s narrative using a fulltext search", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Multiple Resources: \r\n\r\n* [CapabilityStatement](capabilitystatement.html): The current status of the capability statement\r\n* [CodeSystem](codesystem.html): The current status of the code system\r\n* [CompartmentDefinition](compartmentdefinition.html): The current status of the compartment definition\r\n* [ConceptMap](conceptmap.html): The current status of the concept map\r\n* [GraphDefinition](graphdefinition.html): The current status of the graph definition\r\n* [ImplementationGuide](implementationguide.html): The current status of the implementation guide\r\n* [MessageDefinition](messagedefinition.html): The current status of the message definition\r\n* [NamingSystem](namingsystem.html): The current status of the naming system\r\n* [OperationDefinition](operationdefinition.html): The current status of the operation definition\r\n* [SearchParameter](searchparameter.html): The current status of the search parameter\r\n* [StructureDefinition](structuredefinition.html): The current status of the structure definition\r\n* [StructureMap](structuremap.html): The current status of the structure map\r\n* [TerminologyCapabilities](terminologycapabilities.html): The current status of the terminology capabilities\r\n* [ValueSet](valueset.html): The current status of the value set\r\n", "schema": { "type": "string" } } ] } }, "/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" } ] } }, "/ValueSet/{rid}/_history/{hid}": { "summary": "Read a past version of resource instance of type ValueSet", "description": "Access a to specified previous version of a single resource of type ValueSet", "get": { "summary": "Read a past state of the resource", "operationId": "vreadValueSet", "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 for that version", "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/hid" }, { "$ref": "#/components/parameters/summary" }, { "$ref": "#/components/parameters/format" }, { "$ref": "#/components/parameters/pretty" }, { "$ref": "#/components/parameters/elements" } ] } }, "/Appointment/$validate": { "summary": "Operation $validate on type Appointment", "description": "Operation $validate on type Appointment", "post": { "summary": "$validate on type Appointment", "operationId": "op-validate-Appointment", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Appointment/$exportAsiCal": { "summary": "Operation $exportAsiCal on type Appointment", "description": "Operation $exportAsiCal on type Appointment", "post": { "summary": "$exportAsiCal on type Appointment", "operationId": "op-exportAsiCal-Appointment", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Appointment/$meta-delete": { "summary": "Operation $meta-delete on type Appointment", "description": "Operation $meta-delete on type Appointment", "post": { "summary": "$meta-delete on type Appointment", "operationId": "op-meta-delete-Appointment", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Appointment/$meta-add": { "summary": "Operation $meta-add on type Appointment", "description": "Operation $meta-add on type Appointment", "post": { "summary": "$meta-add on type Appointment", "operationId": "op-meta-add-Appointment", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Appointment/$meta": { "summary": "Operation $meta on type Appointment", "description": "Operation $meta on type Appointment", "post": { "summary": "$meta on type Appointment", "operationId": "op-meta-Appointment", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$validate": { "summary": "Operation $validate on type Binary", "description": "Operation $validate on type Binary", "post": { "summary": "$validate on type Binary", "operationId": "op-validate-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$meta-delete": { "summary": "Operation $meta-delete on type Binary", "description": "Operation $meta-delete on type Binary", "post": { "summary": "$meta-delete on type Binary", "description": "Delete tags, profiles, and/or security labels from a resource", "operationId": "op-meta-delete-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$meta-add": { "summary": "Operation $meta-add on type Binary", "description": "Operation $meta-add on type Binary", "post": { "summary": "$meta-add on type Binary", "description": "Add tags, profiles, and/or security labels to a resource", "operationId": "op-meta-add-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$meta": { "summary": "Operation $meta on type Binary", "description": "Operation $meta on type Binary", "post": { "summary": "$meta on type Binary", "description": "Request a list of tags, profiles, and security labels for a specfic resource instance", "operationId": "op-meta-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Binary/$expunge": { "summary": "Operation $expunge on type Binary", "description": "Operation $expunge on type Binary", "post": { "summary": "$expunge on type Binary", "operationId": "op-expunge-Binary", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/CodeSystem/$validate": { "summary": "Operation $validate on type CodeSystem", "description": "Operation $validate on type CodeSystem", "post": { "summary": "$validate on type CodeSystem", "operationId": "op-validate-CodeSystem", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/CodeSystem/$subsumes": { "summary": "Operation $subsumes on type CodeSystem", "description": "Operation $subsumes on type CodeSystem", "post": { "summary": "$subsumes on type CodeSystem", "operationId": "op-subsumes-CodeSystem", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/CodeSystem/$lookup": { "summary": "Operation $lookup on type CodeSystem", "description": "Operation $lookup on type CodeSystem", "post": { "summary": "$lookup on type CodeSystem", "operationId": "op-lookup-CodeSystem", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Communication/$validate": { "summary": "Operation $validate on type Communication", "description": "Operation $validate on type Communication", "post": { "summary": "$validate on type Communication", "operationId": "op-validate-Communication", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Consent/$validate": { "summary": "Operation $validate on type Consent", "description": "Operation $validate on type Consent", "post": { "summary": "$validate on type Consent", "operationId": "op-validate-Consent", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Group/$export": { "summary": "Operation $export on type Group", "description": "Operation $export on type Group", "post": { "summary": "$export on type Group", "operationId": "op-export-Group", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Patient/$export": { "summary": "Operation $export on type Patient", "description": "Operation $export on type Patient", "post": { "summary": "$export on type Patient", "operationId": "op-export-Patient", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Patient/$validate": { "summary": "Operation $validate on type Patient", "description": "Operation $validate on type Patient", "post": { "summary": "$validate on type Patient", "operationId": "op-validate-Patient", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Patient/$updatePatientWithSKRSData": { "summary": "Operation $updatePatientWithSKRSData on type Patient", "description": "Operation $updatePatientWithSKRSData on type Patient", "post": { "summary": "$updatePatientWithSKRSData on type Patient", "operationId": "op-updatePatientWithSKRSData-Patient", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Patient/$createPatient": { "summary": "Operation $createPatient on type Patient", "description": "Operation $createPatient on type Patient", "post": { "summary": "$createPatient on type Patient", "operationId": "op-createPatient-Patient", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Person/$match": { "summary": "Operation $match on type Person", "description": "Operation $match on type Person", "post": { "summary": "$match on type Person", "operationId": "op-match-Person", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/Provenance/$validate": { "summary": "Operation $validate on type Provenance", "description": "Operation $validate on type Provenance", "post": { "summary": "$validate on type Provenance", "operationId": "op-validate-Provenance", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/RelatedPerson/$validate": { "summary": "Operation $validate on type RelatedPerson", "description": "Operation $validate on type RelatedPerson", "post": { "summary": "$validate on type RelatedPerson", "operationId": "op-validate-RelatedPerson", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/RelatedPerson/$updateRelatedPersonWithSKRSData": { "summary": "Operation $updateRelatedPersonWithSKRSData on type RelatedPerson", "description": "Operation $updateRelatedPersonWithSKRSData on type RelatedPerson", "post": { "summary": "$updateRelatedPersonWithSKRSData on type RelatedPerson", "operationId": "op-updateRelatedPersonWithSKRSData-RelatedPerson", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/SearchParameter/$validate": { "summary": "Operation $validate on type SearchParameter", "description": "Operation $validate on type SearchParameter", "post": { "summary": "$validate on type SearchParameter", "operationId": "op-validate-SearchParameter", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/StructureDefinition/$validate": { "summary": "Operation $validate on type StructureDefinition", "description": "Operation $validate on type StructureDefinition", "post": { "summary": "$validate on type StructureDefinition", "operationId": "op-validate-StructureDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/StructureDefinition/$snapshot": { "summary": "Operation $snapshot on type StructureDefinition", "description": "Operation $snapshot on type StructureDefinition", "post": { "summary": "$snapshot on type StructureDefinition", "operationId": "op-snapshot-StructureDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/StructureDefinition/$generateSnapshot": { "summary": "Operation $generateSnapshot on type StructureDefinition", "description": "Operation $generateSnapshot on type StructureDefinition", "post": { "summary": "$generateSnapshot on type StructureDefinition", "operationId": "op-generateSnapshot-StructureDefinition", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/ValueSet/$validate-code": { "summary": "Operation $validate-code on type ValueSet", "description": "Operation $validate-code on type ValueSet", "post": { "summary": "$validate-code on type ValueSet", "operationId": "op-validate-code-ValueSet", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/ValueSet/$invalidate-expansion": { "summary": "Operation $invalidate-expansion on type ValueSet", "description": "Operation $invalidate-expansion on type ValueSet", "post": { "summary": "$invalidate-expansion on type ValueSet", "operationId": "op-invalidate-expansion-ValueSet", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/ValueSet/$expand": { "summary": "Operation $expand on type ValueSet", "description": "Operation $expand on type ValueSet", "post": { "summary": "$expand on type ValueSet", "operationId": "op-expand-ValueSet", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/ValueSet/$validate": { "summary": "Operation $validate on type ValueSet", "description": "Operation $validate on type ValueSet", "post": { "summary": "$validate on type ValueSet", "operationId": "op-validate-ValueSet", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$export-poll-status": { "summary": "System level operation $export-poll-status", "description": "Operation $export-poll-status invoked at the system level", "post": { "summary": "$export-poll-status (system)", "operationId": "op-export-poll-status-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$export": { "summary": "System level operation $export", "description": "Operation $export invoked at the system level", "post": { "summary": "$export (system)", "operationId": "op-export-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$migrate": { "summary": "System level operation $migrate", "description": "Operation $migrate invoked at the system level", "post": { "summary": "$migrate (system)", "operationId": "op-migrate-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$reindex": { "summary": "System level operation $reindex", "description": "Operation $reindex invoked at the system level", "post": { "summary": "$reindex (system)", "operationId": "op-reindex-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$process-message": { "summary": "System level operation $process-message", "description": "Operation $process-message invoked at the system level", "post": { "summary": "$process-message (system)", "operationId": "op-process-message-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$meta": { "summary": "System level operation $meta", "description": "Operation $meta invoked at the system level", "post": { "summary": "$meta (system)", "operationId": "op-meta-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$get-resource-counts": { "summary": "System level operation $get-resource-counts", "description": "Operation $get-resource-counts invoked at the system level", "post": { "summary": "$get-resource-counts (system)", "description": "Provides the number of resources currently stored on the server, broken down by resource type", "operationId": "op-get-resource-counts-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } }, "/$expunge": { "summary": "System level operation $expunge", "description": "Operation $expunge invoked at the system level", "post": { "summary": "$expunge (system)", "operationId": "op-expunge-system", "requestBody": { "description": "Operation parameters", "required": false, "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.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": "Operation response", "content": { "application/fhir+json": { "schema": { "$ref": "https://hl7.org/fhir/R4/fhir.schema.json#/definitions/Parameters" } }, "application/fhir+xml": { "schema": { "$ref": "https://hl7.org/fhir/R4/Parameters.xsd" } } } } } } } }, "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" } } } } }