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

Define best practices for narrative for a resource

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • STU3
    • FHIR Infrastructure
    • Narrative
    • Grahame Grieve / Lloyd McKenzie: 2-0-0
    • Enhancement
    • Non-substantive

    Description

      1. Make it quality criteria for committee to comment on best practice for representing a resource in narrative. Relevant from Maturity level 3

      2. define a template for committees to work from when making these comments - see below

      3. make a way for committees to define, when it's appropriate, a liquid template to (a) represent their best practices (in English) and (b) used by the build when rendering the resources (rather than the auto-generated form now used). Note caveats on the use of liquid templates in committee guidance (around multiple contexts of use)

      4. allow for langauge variants as well

      5. Once the infrastructure exists, create a task for each resource for the committee to actually create the comments

      6. Allow for IGs to define liquid templates (in languages of choice) and use for rendering there too. Make it quality criteria for HL7 IGs to include rendering guidance


      Typical Template:
      In general, the narrative for this resource should include all the elements that are present in the resource, except for the following:

      • X, Y, Z - included for indexing/context purposes, and left to the infrastructure
      • A : background provenance that may be in a footnote

      It would generally be inappropriate to not display fields I, J, and K, though this depends on the context of use. Implementers should consult relevant implementation guides for additional guidance.

      Attachments

        Activity

          People

            Unassigned Unassigned
            GrahameGrieve Grahame Grieve
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: