The sub-sections structure is to be improved

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive with Modification
    • Priority: Highest
    • SMART Web Messaging (FHIR)
    • 0.1.0
    • FHIR Infrastructure
    • Home
    • 1.3.2
    • Hide

      The sections describing the contents of the request and response payloads were confusingly separated from the text describing how they were used and showing examples.  I've moved the payload descriptions to be more contextually relevant to the examples and the property descriptions.

      Show
      The sections describing the contents of the request and response payloads were confusingly separated from the text describing how they were used and showing examples.  I've moved the payload descriptions to be more contextually relevant to the examples and the property descriptions.
    • Ivan Zapreev / Dennis Patterson: 8-0-1
    • Clarification
    • Non-substantive

      The sub-division does not seem to be well formed. The section 1.3.1 contains only the table with the parameters and is then directly followed by seciton 1.3.2 with its own set of parameters. However, after that second table the parameters of the first table are being explained in two paragraphs. This is not very logical the description of the parameters from section 1.3.1 (activityType, activityParameters) should be inside section 1.3.1 and not in 1.3.2. The subsequent two code examples also seem to be missplaced.

      Alternatively remove sub-section 1.3.1 and 1.3.2 and move the table of section 1.3.2 after the examples, where the corresponding parameters (success, details) are being explained.

            Assignee:
            Unassigned
            Reporter:
            ivan_zapreev
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: