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

Explanations are too technical and duplicate what the spec already says.

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Highest Highest

    Description

      A profile should never have a description that says "x was sliced". Most implementers will not know (or care) what 'slicing' means. Just explain what the rules are (and why they're there) in business-friendly terms. Also, the description of the profile shouldn't just repeat what the profile already says. It should provide additional information not already present in the spec. Just repeating things in text does two things: it creates more text for the developer to read (without adding value); and it creates a risk of the text saying something different than what the formal spec says. (holds for all profiles)

      Existing Wording:

      E.g. To facilitate searching for SDOH screening response observations, Observation.category is sliced. The required slices are bound to the "social-history" and "survey" codes from the FHIR "Observation Category Codes" value set.

      Additionally, an optional Observation.category slice bound to the "SDOHCC ValueSet SDOHDomain 1" value set allows the categorization of an Observation into one or more of the SDOH domains (e.g., food-insecurity-domain, inadequate-housing-domain, etc.). It is recommended that this optional slice be used in order to facilitate searching for SDOH observations.

      (Comment 117 - imported by: Robert Dieterle)

      Attachments

        Activity

          People

            Unassigned Unassigned
            lloyd Lloyd McKenzie
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: