Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-28142

Clarify meaning of side effects in REST operations

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • FHIR Infrastructure
    • operations
    • 3.2.0
    • Hide

      Will change "the intended purpose is to cause side effects such as the modification of existing resources or creation of new resources, or other changes out of scope of the RESTful interface (e.g. merging patient records)"

      to

      "the intended purpose is to cause [side effects](https://en.wikipedia.org/wiki/Side_effect_(computer_science)) such as the modification or creation of resources not transmitted as part of the RESTful call (e.g. triggering the generation of an invoice), or other changes out of scope of the RESTful interface (e.g. merging patient records)"

      Show
      Will change "the intended purpose is to cause side effects such as the modification of existing resources or creation of new resources, or other changes out of scope of the RESTful interface (e.g. merging patient records)" to "the intended purpose is to cause [side effects] ( https://en.wikipedia.org/wiki/Side_effect_(computer_science )) such as the modification or creation of resources not transmitted as part of the RESTful call (e.g. triggering the generation of an invoice), or other changes out of scope of the RESTful interface (e.g. merging patient records)"
    • Rick Geimer / Gino Canessa: 13-0-2
    • Clarification
    • Non-substantive
    • R5

    Description

      The list of criteria for where operations are appropriate used contains this bullet point.

      • the intended purpose is to cause side effects such as the modification of existing resources or creation of new resources, or other changes out of scope of the RESTful interface (e.g. merging patient records)

      Based on work group discussions I think many clinicians aren't familiar with the technical meaning of "side effects" from a computer science perspective. Recommend we add a note to clarify that merely creating a new Bundle resource and returning that to the client doesn't qualify as a side effect if that new Bundle isn't persisted on the server (server state hasn't changed).

      Attachments

        Activity

          People

            GrahameGrieve Grahame Grieve
            nradov Nick Radov
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: