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

provide clearer guidance for $docref operation when no date range is specified

    XMLWordPrintableJSON

Details

    • Change Request
    • Status: Published (View Workflow)
    • Medium
    • Resolution: Persuasive
    • US Core (FHIR)
    • 4.1.0
    • Cross-Group Projects
    • US Core DocumentReference Profile
    • Search Parameters and Operations
    • Hide

      Background:

      see commenter's description

      The commenter is referring to the following section in the US Core Server Capability Statement:

      DocumentReference

      Conformance Expectation: SHALL

      ...

      Operation Summary:

      • SHALL support the $docref operation
        A server SHALL be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available. MAY provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server SHALL provide references to last or current encounter. SHOULD document what resources, if any, are returned as included resources

      GET [base]/DocumentReference/$docref?patient=[id]
      {{}}

      more background on this operation is provided in the OperationDefinition here:

      https://build.fhir.org/ig/HL7/US-Core/OperationDefinition-docref.html

      and spefically relates to these parameters ( highlighted for emphaisis):

      IN start 0..1 dateTime   The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.
      IN end 0..1 dateTime   The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client SHOULD provide values precise to the second + time offset.

      Reasoning:

      We agree with commenter to fix the grammar

      We agree with the commenter that not all documents are encounter focused.  

      Proposed Changes:

      Update the text as proposed

      Show
      Background: see commenter's description The commenter is referring to the following section in the US Core Server Capability Statement: DocumentReference Conformance Expectation:  SHALL ... Operation Summary: SHALL  support the  $docref  operation A server  SHALL  be capable of responding to a $docref operation and capable of returning at least a reference to a generated CCD document, if available.  MAY  provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range I f no date range is supplied, then the server  SHALL  provide references to last or current encounter.   SHOULD  document what resources, if any, are returned as included resources GET [base] /DocumentReference/$docref?patient= [id] {{}} more background on this operation is provided in the OperationDefinition here: https://build.fhir.org/ig/HL7/US-Core/OperationDefinition-docref.html and spefically relates to these parameters ( highlighted for emphaisis): IN start 0..1 dateTime   The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no start date is provided, all documents prior to the end date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client  SHOULD  provide values precise to the second + time offset. IN end 0..1 dateTime   The date range relates to care dates, not record currency dates - e.g. all records relating to care provided in a certain date range. If no end date is provided, all documents subsequent to the start date are in scope. If neither a start date nor an end date is provided, the most recent or current document is in scope. The client  SHOULD  provide values precise to the second + time offset. Reasoning: We agree with commenter to fix the grammar We agree with the commenter that not all documents are encounter focused.   Proposed Changes: Update the text as proposed
    • Eric Haas / Emma Jones: 14-0-0
    • Correction
    • Non-substantive

    Description

      "If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range If no date range is supplied, then the server SHALL provide references to last or current encounter. "

      1. Please add a period between range and If - to make the sentence clearer
      2. Please remove change encounter to document (use of encounter assumes all documents are associated with encounters which is not always the case)

      Suggested change

      "If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range.  If no date range is supplied, then the server SHALL provide references to last or current document(s). "

      Attachments

        Activity

          People

            Unassigned Unassigned
            emmanurse Emma Jones
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: