FHIR Cross-Version Extensions package for FHIR R4 from FHIR R5 - Version 0.0.1-snapshot-2. See the Directory of published versions
| Page standards status: Normative | Maturity Level: 5 |
{
"resourceType" : "CodeSystem",
"id" : "restful-interaction",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>This code system \n <code>http://hl7.org/fhir/restful-interaction</code> defines the following codes:\n </p>\n <table class=\"codes\">\n <tr>\n <td>\n <b>Lvl</b>\n </td>\n <td style=\"white-space:nowrap\">\n <b>Code</b>\n </td>\n <td>\n <b>Definition</b>\n </td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">read\n <a name=\"restful-interaction-read\"> </a>\n </td>\n <td>Read the current state of the resource.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">vread\n <a name=\"restful-interaction-vread\"> </a>\n </td>\n <td>Read the state of a specific version of the resource.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">update\n <a name=\"restful-interaction-update\"> </a>\n </td>\n <td>Update an existing resource by its id (or create it if it is new).</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">patch\n <a name=\"restful-interaction-patch\"> </a>\n </td>\n <td>Update an existing resource by posting a set of changes to it.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">delete\n <a name=\"restful-interaction-delete\"> </a>\n </td>\n <td>Delete a resource.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">history\n <a name=\"restful-interaction-history\"> </a>\n </td>\n <td>Retrieve the change history for a particular resource, type of resource, or the entire system.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0history-instance\n <a name=\"restful-interaction-history-instance\"> </a>\n </td>\n <td>Retrieve the change history for a particular resource.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0history-type\n <a name=\"restful-interaction-history-type\"> </a>\n </td>\n <td>Retrieve the change history for all resources of a particular type.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0history-system\n <a name=\"restful-interaction-history-system\"> </a>\n </td>\n <td>Retrieve the change history for all resources on a system.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">create\n <a name=\"restful-interaction-create\"> </a>\n </td>\n <td>Create a new resource with a server assigned id.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">search\n <a name=\"restful-interaction-search\"> </a>\n </td>\n <td>Search a resource type or all resources based on some filter criteria.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0search-type\n <a name=\"restful-interaction-search-type\"> </a>\n </td>\n <td>Search all resources of the specified type based on some filter criteria.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0search-system\n <a name=\"restful-interaction-search-system\"> </a>\n </td>\n <td>Search all resources based on some filter criteria.</td>\n </tr>\n <tr>\n <td>2</td>\n <td style=\"white-space:nowrap\">\u00a0\u00a0search-compartment\n <a name=\"restful-interaction-search-compartment\"> </a>\n </td>\n <td>Search resources in a compartment based on some filter criteria.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">capabilities\n <a name=\"restful-interaction-capabilities\"> </a>\n </td>\n <td>Get a Capability Statement for the system.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">transaction\n <a name=\"restful-interaction-transaction\"> </a>\n </td>\n <td>Update, create or delete a set of resources as a single transaction.</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">batch\n <a name=\"restful-interaction-batch\"> </a>\n </td>\n <td>perform a set of a separate interactions in a single http operation</td>\n </tr>\n <tr>\n <td>1</td>\n <td style=\"white-space:nowrap\">operation\n <a name=\"restful-interaction-operation\"> </a>\n </td>\n <td>Perform an operation as defined by an OperationDefinition.</td>\n </tr>\n </table>\n </div>"
},
"extension" : [
{
"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
},
{
"extension" : [
{
"url" : "packageId",
"valueId" : "hl7.fhir.uv.xver-r5.r4"
},
{
"url" : "version",
"valueString" : "0.0.1-snapshot-2"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}
],
"url" : "http://hl7.org/fhir/restful-interaction",
"version" : "5.0.0",
"name" : "FHIRRestfulInteractions",
"title" : "FHIR Restful Interactions",
"status" : "active",
"experimental" : false,
"date" : "2025-09-13T16:55:28-04:00",
"publisher" : "FHIR Infrastructure",
"contact" : [
{
"name" : "FHIR Infrastructure",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "The set of interactions defined by the RESTful part of the FHIR specification.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"caseSensitive" : true,
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-interaction",
"hierarchyMeaning" : "is-a",
"content" : "complete",
"concept" : [
{
"code" : "read",
"display" : "read",
"definition" : "Read the current state of the resource."
},
{
"code" : "vread",
"display" : "vread",
"definition" : "Read the state of a specific version of the resource."
},
{
"code" : "update",
"display" : "update",
"definition" : "Update an existing resource by its id (or create it if it is new)."
},
{
"code" : "patch",
"display" : "patch",
"definition" : "Update an existing resource by posting a set of changes to it."
},
{
"code" : "delete",
"display" : "delete",
"definition" : "Delete a resource."
},
{
"code" : "history",
"display" : "history",
"definition" : "Retrieve the change history for a particular resource, type of resource, or the entire system.",
"concept" : [
{
"code" : "history-instance",
"display" : "history-instance",
"definition" : "Retrieve the change history for a particular resource."
},
{
"code" : "history-type",
"display" : "history-type",
"definition" : "Retrieve the change history for all resources of a particular type."
},
{
"code" : "history-system",
"display" : "history-system",
"definition" : "Retrieve the change history for all resources on a system."
}
]
},
{
"code" : "create",
"display" : "create",
"definition" : "Create a new resource with a server assigned id."
},
{
"code" : "search",
"display" : "search",
"definition" : "Search a resource type or all resources based on some filter criteria.",
"concept" : [
{
"code" : "search-type",
"display" : "search-type",
"definition" : "Search all resources of the specified type based on some filter criteria."
},
{
"code" : "search-system",
"display" : "search-system",
"definition" : "Search all resources based on some filter criteria."
},
{
"code" : "search-compartment",
"display" : "search-compartment",
"definition" : "Search resources in a compartment based on some filter criteria."
}
]
},
{
"code" : "capabilities",
"display" : "capabilities",
"definition" : "Get a Capability Statement for the system."
},
{
"code" : "transaction",
"display" : "transaction",
"definition" : "Update, create or delete a set of resources as a single transaction."
},
{
"code" : "batch",
"display" : "batch",
"definition" : "perform a set of a separate interactions in a single http operation"
},
{
"code" : "operation",
"display" : "operation",
"definition" : "Perform an operation as defined by an OperationDefinition."
}
]
}