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

contextDirection in Example 1 is wrong

    XMLWordPrintableJSON

Details

    • Change Request
    • Status: Published (View Workflow)
    • Highest
    • Resolution: Persuasive
    • US Core (FHIR)
    • 4.1.0
    • Cross-Group Projects
    • STU
    • Clinical Notes Guidance
    • 2.3.3.1
    • Hide

      Background:

      The Commenter is referring to following documentation:

      Discovering Note and Report Types

      The note and report types for a particular server are discovered by invoking the #expand operation as follows:

      GET [base]/ValueSet/$expand?context=[context]&contextDirection=[contextDirection]

      where:

      • [contextDirection]incoming for write operations and outgoing for read operations.
      • [context]DiagnosticReport.category for DiagnosticReport report category discovery, DiagnosticReport.code for DiagnosticReport report type discovery, DocumentReference.category for DocumentReference note category discovery, DocumentReference.type for DocumentReference note type discovery.

      Examples

      Click on Here To See Scenario 1 Example
      A client determines the types of reports they can access through DiagnosticReport. The server responds with ‘foo’,’bar’ ,and ‘baz’ report types:

      Request for DiagnosticReport report type
       GET [base]/ValueSet/$expand?context=DiagnosticReport.codes&contextDirection=incoming
      Response ...

       

      Reasoning:

      We agree with commenter. This an editorial error.
       

      Proposed Changes:

       

      Change:

      GET [base]/ValueSet/$expand?context=DiagnosticReport.codes&contextDirection=incoming

      To:

      GET [base]/ValueSet/$expand?context=DiagnosticReport.codes&contextDirection=outgoing

      Show
      Background: The Commenter is referring to following documentation: Discovering Note and Report Types The note and report types for a particular server are discovered by invoking the #expand operation as follows: GET [base] /ValueSet/$expand?context= [context] &contextDirection= [contextDirection] where: [contextDirection] =  incoming  for write operations and  outgoing  for read operations. [context] =  DiagnosticReport.category  for DiagnosticReport report category discovery,  DiagnosticReport.code  for DiagnosticReport report type discovery,  DocumentReference.category  for DocumentReference note category discovery,  DocumentReference.type  for DocumentReference note type discovery. Examples Click on Here To See Scenario 1 Example A client determines the types of reports they can access through DiagnosticReport. The server responds with ‘foo’,’bar’ ,and ‘baz’ report types: Request for DiagnosticReport report type   GET [base] /ValueSet/$expand?context=DiagnosticReport.codes& contextDirection=incoming Response ...   Reasoning: We agree with commenter. This an editorial error.   Proposed Changes:   Change: GET [base] /ValueSet/$expand?context=DiagnosticReport.codes&c ontextDirection=incoming To: GET [base] /ValueSet/$expand?context=DiagnosticReport.codes&context Direction=outgoing
    • Floyd Eisenberg/Eric Haas: 12-0-2
    • Correction
    • Non-substantive

    Description

      Example 1 says: "A client determines the types of reports they can access through DiagnosticReport. The server responds with 'foo','bar' ,and 'baz' report types:"

      The query example shows

      GET [base]/ValueSet/$expand?context=DiagnosticReport.codes&contextDirection=incoming
      

      According to $expand operation (http://build.fhir.org/valueset-operation-expand.html)

      'incoming': the codes a client can use for PUT/POST operations, and
      'outgoing', the codes a client might receive from the server.

      Since the example is what client can access, the value of contextDirection should be *outgoin*g

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              yunwwang Yunwei Wang
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: