This page is part of the FHIR Specification v6.0.0-ballot1: Release 6 Ballot (1st Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions 
| Terminology Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative |
Raw JSON (canonical form + also see JSON Format Specification)
Definition for Value SetType Restful Interaction
{
"resourceType" : "ValueSet",
"id" : "type-restful-interaction",
"meta" : {
"lastUpdated" : "2023-12-18T15:12:07.602+11:00",
"profile" : ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
},
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <ul>\n <li>Include these codes as defined in \n <a href=\"codesystem-restful-interaction.html\">\n <code>http://hl7.org/fhir/restful-interaction</code>\n </a>\n <table class=\"none\">\n <tr>\n <td style=\"white-space:nowrap\">\n <b>Code</b>\n </td>\n <td>\n <b>Display</b>\n </td>\n <td>\n <b>Definition</b>\n </td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-read\">read</a>\n </td>\n <td>read</td>\n <td>Read the current state of the resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-vread\">vread</a>\n </td>\n <td>vread</td>\n <td>Read the state of a specific version of the resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-update\">update</a>\n </td>\n <td>update</td>\n <td>Update an existing resource by its id (or create it if it is new).</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-update-conditional\">update-conditional</a>\n </td>\n <td>update-conditional</td>\n <td>Update an existing resource based on some identification criteria (or create it if it is new).</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-patch\">patch</a>\n </td>\n <td>patch</td>\n <td>Update an existing resource by posting a set of changes to it.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-patch\">patch-conditional</a>\n </td>\n <td>patch-conditional</td>\n <td>Update an existing resource, based on some identification criteria, by posting a set of changes to it.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-delete\">delete</a>\n </td>\n <td>delete</td>\n <td>Delete a resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-delete-conditional-single\">delete-conditional-single</a>\n </td>\n <td>delete-conditional-single</td>\n <td>Delete a single resource based on some identification criteria.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-delete-conditional-multiple\">delete-conditional-multiple</a>\n </td>\n <td>delete-conditional-multiple</td>\n <td>Delete one or more resources based on some identification criteria.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-delete-history\">delete-history</a>\n </td>\n <td>delete-history</td>\n <td>Delete all historical versions of a resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-delete-history-version\">delete-history-version</a>\n </td>\n <td>delete-history-version</td>\n <td>Delete a specific version of a resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-history-instance\">history-instance</a>\n </td>\n <td>history-instance</td>\n <td>Retrieve the change history for a particular resource.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-history-type\">history-type</a>\n </td>\n <td>history-type</td>\n <td>Retrieve the change history for all resources of a particular type.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-create\">create</a>\n </td>\n <td>create</td>\n <td>Create a new resource with a server assigned id.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-create-conditional\">create-conditional</a>\n </td>\n <td>create-conditional</td>\n <td>Create a new resource with a server assigned id if an equivalent resource does not already exist.</td>\n </tr>\n <tr>\n <td>\n <a href=\"codesystem-restful-interaction.html#restful-interaction-search-type\">search-type</a>\n </td>\n <td>search-type</td>\n <td>Search all resources of the specified type based on some filter criteria.</td>\n </tr>\n </table>\n </li>\n </ul>\n </div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "normative"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version",
"valueCode" : "4.0.0"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
}],
"url" : "http://hl7.org/fhir/ValueSet/type-restful-interaction",
"identifier" : [{
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.3.180"
},
{
"use" : "old",
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.3.170"
},
{
"use" : "old",
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.2.83"
}],
"version" : "6.0.0-ballot1",
"name" : "TypeRestfulInteraction",
"title" : "Type Restful Interaction",
"status" : "active",
"experimental" : false,
"date" : "2020-12-28T16:55:11+11:00",
"publisher" : "HL7 (FHIR Project)",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://hl7.org/fhir"
},
{
"system" : "email",
"value" : "fhir@lists.hl7.org"
}]
}],
"description" : "Operations supported by REST at the type or instance level.",
"jurisdiction" : [{
"coding" : [{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}]
}],
"compose" : {
"include" : [{
"system" : "http://hl7.org/fhir/restful-interaction",
"concept" : [{
"code" : "read"
},
{
"code" : "vread"
},
{
"code" : "update"
},
{
"code" : "update-conditional"
},
{
"code" : "patch"
},
{
"code" : "patch-conditional"
},
{
"code" : "delete"
},
{
"code" : "delete-conditional-single"
},
{
"code" : "delete-conditional-multiple"
},
{
"code" : "delete-history"
},
{
"code" : "delete-history-version"
},
{
"code" : "history-instance"
},
{
"code" : "history-type"
},
{
"code" : "create"
},
{
"code" : "create-conditional"
},
{
"code" : "search-type"
}]
}]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot1 generated on Mon, Dec 18, 2023 15:15+1100.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change