FHIR Restful Interactions
activeContentcompleteURL
http://hl7.org/fhir/restful-interactionCopied!
Version5.0.0Copied!
PublisherFHIR ProjectDescriptionThe set of interactions defined by the RESTful part of the FHIR specification.
Concepts
Select a concept to view details
This code system
http://hl7.org/fhir/restful-interaction defines the following codes:
{
"description" : "The set of interactions defined by the RESTful part of the FHIR specification.",
"meta" : {
"lastUpdated" : "2023-03-26T15:21:02.749+11:00"
},
"publisher" : "FHIR Project",
"jurisdiction" : [ {
"coding" : [ {
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
} ]
} ],
"content" : "complete",
"property" : [ {
"description" : "The concept identified is a child of the concept",
"type" : "code",
"code" : "child",
"uri" : "http://hl7.org/fhir/concept-properties#child"
}, {
"description" : "The concept identified is a parent of the concept",
"type" : "code",
"code" : "parent",
"uri" : "http://hl7.org/fhir/concept-properties#parent"
} ],
"name" : "FHIRRestfulInteractions",
"experimental" : false,
"resourceType" : "CodeSystem",
"title" : "FHIR Restful Interactions",
"extension" : [ {
"valueCode" : "fhir",
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg"
}, {
"valueCode" : "normative",
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"
}, {
"valueCode" : "4.0.0",
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"
}, {
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 5
}, {
"extension" : [ {
"valueString" : "concept",
"url" : "path"
}, {
"url" : "count",
"valueInteger" : 12
} ],
"url" : "http://health-samurai.io/extensions/excised-data"
}, {
"url" : "http://health-samurai.io/extensions/source",
"valueCode" : "db"
} ],
"status" : "active",
"hierarchyMeaning" : "is-a",
"id" : "be35dafd-3b2d-4573-aafe-125c69923a9f",
"valueSet" : "http://hl7.org/fhir/ValueSet/restful-interaction",
"url" : "http://hl7.org/fhir/restful-interaction",
"identifier" : [ {
"system" : "urn:ietf:rfc:3986",
"value" : "urn:oid:2.16.840.1.113883.4.642.4.1823"
} ],
"caseSensitive" : true,
"version" : "5.0.0",
"text" : {
"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\"> history-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\"> history-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\"> history-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\"> search-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\"> search-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\"> search-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>",
"status" : "generated"
}
}