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

Better define the output of the $extract operation

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • Structured Data Capture (SDC) (FHIR)
    • 2.7.0 [deprecated]
    • FHIR Infrastructure
    • Form Data Extraction
    • Hide

      Will add some documentation about the output expectations of $extract.

      • Observation-based will always produce a 'transaction' Bundle, even if it's only creating or updating a single Observation
      • Definition-based will always produce a 'transaction' Bundle that indicates what resources are to be created or updated.  The resources within the transaction can be anything (including Bundle resources such as FHIR documents)
      • StructureMap-based may produce either a 'transaction' Bundle or a single resource instance (though the instance might itself be a different type of Bundle, such as a document or collection).  It is possible for StructureMaps to map to non-FHIR data structures, however there's no "built-in" mechanism to serialize such models, so additional information would need to be passed into the $extract process to guide such serialization.  Support for non-FHIR extracts is outside the scope of this specification.
      Show
      Will add some documentation about the output expectations of $extract. Observation-based will always produce a 'transaction' Bundle, even if it's only creating or updating a single Observation Definition-based will always produce a 'transaction' Bundle that indicates what resources are to be created or updated.  The resources within the transaction can be anything (including Bundle resources such as FHIR documents) StructureMap-based may produce either a 'transaction' Bundle or a single resource instance (though the instance might itself be a different type of Bundle, such as a document or collection).  It is possible for StructureMaps to map to non-FHIR data structures, however there's no "built-in" mechanism to serialize such models, so additional information would need to be passed into the $extract process to guide such serialization.  Support for non-FHIR extracts is outside the scope of this specification.
    • Paul Lynch/Stoyan Halkaliev: 8-0-0
    • Clarification
    • Non-substantive

    Description

      If there are any constraints or best practices concerning the output of the $extract operation, it should be better documented. 

      For example, assuming it is a Bundle, it can be a Document or a Transaction. Would this be parametrized? Would there be any option or guidance on when to use either?

      Attachments

        Activity

          People

            Unassigned Unassigned
            costateixeira Jose Costa-Teixeira
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: