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

Consider adding an optional name element to DataRequirement

    XMLWordPrintableJSON

    Details

    • Type: Change Request
    • Status: Applied (View Workflow)
    • Priority: Medium
    • Resolution: Persuasive with Modification
    • Specification:
      FHIR Core (FHIR)
    • Raised in Version:
      R5
    • Work Group:
      Clinical Decision Support
    • Related Page(s):
      Metadata Types
    • Resolution Description:
      Hide

      Don't want name on DataRequirement.  Instead, we want to make PlanDefinition.action.input and PlanDefinition.action.output into complex structures.  Each should have the following:

      title 0..1 string: A human-readable label for the data requirement - used to label data flows in BPMN or similar diagrams.  Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers

      requirement 0..1 DataRequirement: Defines the data to be provided as input/output

      relatedRequirementId 0.. id*: Points to an existing data requirement (PlanDefinition.action.[input/output].requirement.id) that is shared by this input or output.
      Usage notes: relatedRequirementId allows indicating that an input to a parent activity is an input to specific child activities.  It also allows the output of one sub-activity to be identified as the input to a different activity

      Add an invariant requiring that input and output have either requirement or relatedRequirementId (must have one or at least one of the other, can't have both).

      Show
      Don't want name on DataRequirement.  Instead, we want to make PlanDefinition.action.input and PlanDefinition.action.output into complex structures.  Each should have the following: title 0..1 string : A human-readable label for the data requirement - used to label data flows in BPMN or similar diagrams.  Also provides a human readable label when rendering the data requirement that conveys its purpose to human readers requirement 0..1 DataRequirement : Defines the data to be provided as input/output relatedRequirementId 0.. id*: Points to an existing data requirement (PlanDefinition.action. [input/output] .requirement.id) that is shared by this input or output. Usage notes: relatedRequirementId allows indicating that an input to a parent activity is an input to specific child activities.  It also allows the output of one sub-activity to be identified as the input to a different activity Add an invariant requiring that input and output have either requirement or relatedRequirementId (must have one or at least one of the other, can't have both).
    • Resolution Vote:
      Ben Hamlin/Rob Samples: 29-0-3
    • Change Category:
      Enhancement
    • Change Impact:
      Non-compatible

      Description

      Consider adding a name element to DataRequirement to enable specific reference to data requirements. This comes up often in the context of defining input and output data associated with data flow in a PlanDefinition:

      https://confluence.hl7.org/display/FHIRI/FHIR+Workflow+Minutes+CC+20200518

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              bryn.rhodes Bryn Rhodes
              Reporter:
              bryn.rhodes Bryn Rhodes
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:
                Vote Date: