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

Clarify purpose of "Representation in Narrative" section

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • Using CQL With FHIR (FHIR)
    • 1.0.0-ballot
    • Clinical Decision Support
    • Using CQL
    • 2.4.3, 2.5.1
    • Hide

      Agreed, add clarifying language to make clear that there is a conformance requirement, but it is about what content must be presented, rather than specifically how it must be presented:

      When value sets are used within knowledge artifacts, if the artifact includes narrative (Human-readable), it SHALL include a representation of at least the following information for each value set:

      The local identifier for the value set
      The external identifier for the value set
      The version of the value set, if specified

      For example:

      "Encounter Inpatient": "Encounter Inpatient SNOMEDCT Value Set" (http://example.org/fhir/ValueSet/encounter-inpatient, version 20160929)

      Show
      Agreed, add clarifying language to make clear that there is a conformance requirement, but it is about what content must be presented, rather than specifically how it must be presented: When value sets are used within knowledge artifacts, if the artifact includes narrative (Human-readable), it SHALL include a representation of at least the following information for each value set: The local identifier for the value set The external identifier for the value set The version of the value set, if specified For example: "Encounter Inpatient": "Encounter Inpatient SNOMEDCT Value Set" ( http://example.org/fhir/ValueSet/encounter-inpatient , version 20160929)
    • Chris Moesel / Juliet Rubini : 23-0-0
    • Clarification
    • Non-substantive

    Description

      In Using CQL, the Value Set Expansion and Codes sections include sub-sections named "Representation in Narrative" that contain text like:

      When value sets are used within knowledge artifacts, they will be represented in the narrative (Human-readable) as:

      It's not clear if this is describing something that MUST happen (e.g., rendering software MUST do this), something that SHOULD happen, or simply an observation of what current rendering software does (which may be subject to change).

      If this is intended to specify requirements, use the appropriate formal language (MUST or SHOULD). If this is merely an observation of current behavior in prevalent tools, indicate it as such.

      Attachments

        Activity

          People

            jen_seeman Jennifer Seeman
            cmoesel Chris Moesel
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: