FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.uv.xver-r4.r4b
Resource TypeCodeSystem
IdCodeSystem-restful-interaction.json
FHIR VersionR4B
Sourcehttp://hl7.org/fhir/uv/xver-r4.r4b/0.0.1-snapshot-2/CodeSystem-restful-interaction.html
URLhttp://hl7.org/fhir/restful-interaction
Version4.0.1
Statusactive
Date2025-09-13T16:11:23-04:00
NameFHIR Restful Interactions
Realmuv
Authorityhl7
DescriptionThe set of interactions defined by the RESTful part of the FHIR specification.
Contentcomplete

Resources that use this resource

CodeSystem
http-interaction-csHTTP interaction translations
ValueSet
testscript-operation-codesTest Script Operation Code Value Set
AllReadVSall Reads
AllSearchVSall Searches
AllUpdateVSall Updates
eagreementmessageValueSet message
audit-event-subtype-vsAudit event subtype
cardActionsCDS Hooks Card Suggestion Action Types Value Set
ehmi-delivery-status-rest-all-read-valuesetEHMI Delivery Status (EDS) - restful-interaction Reads
ehmi-delivery-status-types-valuesetEHMI Delivery Status (EDS) - Types Valueset
R4-audit-event-sub-type-for-R4BCross-version VS for R4.AuditEventSub-Type for use in FHIR R4B
R4-system-restful-interaction-for-R4BCross-version VS for R4.SystemRestfulInteraction for use in FHIR R4B
R4-type-restful-interaction-for-R4BCross-version VS for R4.TypeRestfulInteraction for use in FHIR R4B
R5-audit-event-sub-type-for-R4BCross-version VS for R5.AuditEventSubType for use in FHIR R4B
R5-testscript-operation-codes-for-R4BCross-version VS for R5.TestScriptOperationCode for use in FHIR R4B
R2-audit-event-sub-type-for-R4BCross-version VS for R2.Audit Event Sub-Type for use in FHIR R4B
R2-restful-interaction-for-R4BCross-version VS for R2.FHIR Restful Interactions for use in FHIR R4B
R2-system-restful-interaction-for-R4BCross-version VS for R2.SystemRestfulInteraction for use in FHIR R4B
R2-type-restful-interaction-for-R4BCross-version VS for R2.TypeRestfulInteraction for use in FHIR R4B
capability-feature-vsCapability Feature VS
R2-audit-event-sub-type-for-R4Cross-version VS for R2.Audit Event Sub-Type for use in FHIR R4
R2-restful-interaction-for-R4Cross-version VS for R2.FHIR Restful Interactions for use in FHIR R4
R2-type-restful-interaction-for-R4Cross-version VS for R2.TypeRestfulInteraction for use in FHIR R4
R3-audit-event-sub-type-for-R4BCross-version VS for R3.Audit Event Sub-Type for use in FHIR R4B
R3-system-restful-interaction-for-R4BCross-version VS for R3.SystemRestfulInteraction for use in FHIR R4B
R3-type-restful-interaction-for-R4BCross-version VS for R3.TypeRestfulInteraction for use in FHIR R4B
R4-audit-event-sub-type-for-R5Cross-version VS for R4.AuditEventSub-Type for use in FHIR R5
R4-system-restful-interaction-for-R5Cross-version VS for R4.SystemRestfulInteraction for use in FHIR R5
R4-type-restful-interaction-for-R5Cross-version VS for R4.TypeRestfulInteraction for use in FHIR R5
dipag-audit-event-sub-type-vsDigitale Patientenrechnung Audit Event Sub-Type
R5-audit-event-sub-type-for-R4Cross-version VS for R5.AuditEventSubType for use in FHIR R4
R5-interaction-trigger-for-R4Cross-version VS for R5.InteractionTrigger for use in FHIR R4
R5-testscript-operation-codes-for-R4Cross-version VS for R5.TestScriptOperationCode for use in FHIR R4
R2-audit-event-sub-type-for-R5Cross-version VS for R2.Audit Event Sub-Type for use in FHIR R5
R2-restful-interaction-for-R5Cross-version VS for R2.FHIR Restful Interactions for use in FHIR R5
R2-system-restful-interaction-for-R5Cross-version VS for R2.SystemRestfulInteraction for use in FHIR R5
R2-type-restful-interaction-for-R5Cross-version VS for R2.TypeRestfulInteraction for use in FHIR R5
R4B-audit-event-sub-type-for-R5Cross-version VS for R4B.AuditEventSub-Type for use in FHIR R5
R4B-audit-event-sub-type-for-R4Cross-version VS for R4B.AuditEventSub-Type for use in FHIR R4
R4B-interaction-trigger-for-R4Cross-version VS for R4B.InteractionTrigger for use in FHIR R4
R3-audit-event-sub-type-for-R5Cross-version VS for R3.Audit Event Sub-Type for use in FHIR R5
R3-system-restful-interaction-for-R5Cross-version VS for R3.SystemRestfulInteraction for use in FHIR R5
R3-type-restful-interaction-for-R5Cross-version VS for R3.TypeRestfulInteraction for use in FHIR R5

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CodeSystem restful-interaction

This case-sensitive code system http://hl7.org/fhir/restful-interaction defines the following codes in a Is-A hierarchy:

LvlCodeDefinition
1read Read the current state of the resource.
1vread Read the state of a specific version of the resource.
1update Update an existing resource by its id (or create it if it is new).
1patch Update an existing resource by posting a set of changes to it.
1delete Delete a resource.
1history Retrieve the change history for a particular resource, type of resource, or the entire system.
2  history-instance Retrieve the change history for a particular resource.
2  history-type Retrieve the change history for all resources of a particular type.
2  history-system Retrieve the change history for all resources on a system.
1create Create a new resource with a server assigned id.
1search Search a resource type or all resources based on some filter criteria.
2  search-type Search all resources of the specified type based on some filter criteria.
2  search-system Search all resources based on some filter criteria.
1capabilities Get a Capability Statement for the system.
1transaction Update, create or delete a set of resources as a single transaction.
1batch perform a set of a separate interactions in a single http operation
1operation Perform an operation as defined by an OperationDefinition.

Source1

{
  "resourceType": "CodeSystem",
  "id": "restful-interaction",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "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-r4.r4b"
        },
        {
          "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": "4.0.1",
  "name": "FHIR Restful Interactions",
  "status": "active",
  "experimental": false,
  "date": "2025-09-13T16:11:23-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": "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."
    }
  ]
}