Documentation of Examples is incomplete/not useful enough for Implementers to follow

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Not Persuasive
    • Priority: Medium
    • US Da Vinci CDex (FHIR)
    • STU3
    • Patient Care
    • STU
    • Profiles [deprecated]
    • Hide

      A full page write-up is not necessary or appropriate.  Documentation is done in the profiles, not the examples.  As indicated in the resolution to 22963, examples will be updated to have embedded comments to provide guidance/clarification where the content is not self-explanatory.  As well, the examples will be explicitly tied to particular points in the formal specification to highlight what point in the workflow they're demonstrating.  Examples will also have short descriptions that explain their purpose and provide a short overview of what they're conveying.

      Show
      A full page write-up is not necessary or appropriate.  Documentation is done in the profiles, not the examples.  As indicated in the resolution to 22963, examples will be updated to have embedded comments to provide guidance/clarification where the content is not self-explanatory.  As well, the examples will be explicitly tied to particular points in the formal specification to highlight what point in the workflow they're demonstrating.  Examples will also have short descriptions that explain their purpose and provide a short overview of what they're conveying.
    • Bob Dieterle / Laura Herrman : 13-0-2

      Each example should have a full page writeup to explain each element of the resource that gets used and how it is supposed to be used.

            Assignee:
            Unassigned
            Reporter:
            Lisa R. Nelson
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: