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

Please clarify how connectionType, payloadType, and payloadMimeType interact for various Endpoint types

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • Patient Administration
    • EndPoint
    • Hide

      Based on the proposed resolution for FHIR-39616, the new profile property in payload appears to satisfy the questions here.

       

      PA Conf Call - Nov 8 2023

      Current thoughts:

      • Draft a narrative section in the main endpoint page saying something like this:

      Endpoint.payload.type is meant to be a description of the semantic content, for example, does this endpoint support exchanging care plans, discharge summaries, referrals, appointment bookings, etc.  The "how" that content is exchanged is described elsewhere, via the mimeType (what format) and connectionType (what exchange method).

      • Create several very specific, real-worldish examples, and refer to those examples in the new narrative section.

       

      Here are some initial examples, but we want more:

       

      Example #1:  US Core FHIR REST endpoint

      Endpoint.connectionType = restful-fhir

      Endpoint.payload.profiles[0] = us-core-condition

      Endpoint.payload.profiles[1] = us-core-observation

      Endpoint.payload.type =  clinical-data

      Endpoint.payload.mimeType = json, xml

       

      Example #2:  XCA CCDA Referral Exchange

      Endpoint.connectionType = ihe-xca, XCA-RespGateway-Query, XCA-RespGateway-Retrieve

      Endpoint.payload.profiles = ihe-cda-referral-request-profile, ihe-cde-discharge-summary-profile

      Endpoint.payload.type =  discharge-summaries, referral-requests  || ccda-2.1-structured

      Open Question: ** Is Endpoint.payload.type the formatCode or classCode for CDA?  To align with other examples, it seems like classCode is the best mapping.

      Endpoint.payload.mimeType = application/pdf, application/xml, application/jpg

       

      Example #3:  AU HL7v2 Referral Exchange

      Endpoint.connectionType = sealed-message-delivery

      Endpoint.payload.profiles[0] = http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706

      Endpoint.payload.profiles[1] = http://ns.electronichealth.net.au/ds/sc/deliver/hl7Mdm/2012

      Endpoint.payload.profiles[2] = http://ns.electronichealth.net.au/ack/sc/deliver/hl7Ack/2012

      Endpoint.payload.type =  referral-request

      Endpoint.payload.mimeType = application/hl7-v2

       

      Show
      Based on the proposed resolution for FHIR-39616 , the new profile property in payload appears to satisfy the questions here.   PA Conf Call - Nov 8 2023 Current thoughts: Draft a narrative section in the main endpoint page saying something like this: Endpoint.payload.type is meant to be a description of the semantic content, for example, does this endpoint support exchanging care plans, discharge summaries, referrals, appointment bookings, etc.  The "how" that content is exchanged is described elsewhere, via the mimeType (what format) and connectionType (what exchange method). Create several very specific, real-worldish examples, and refer to those examples in the new narrative section.   Here are some initial examples, but we want more:   Example #1:  US Core FHIR REST endpoint Endpoint.connectionType = restful-fhir Endpoint.payload.profiles [0] = us-core-condition Endpoint.payload.profiles [1] = us-core-observation Endpoint.payload.type =  clinical-data Endpoint.payload.mimeType = json, xml   Example #2:  XCA CCDA Referral Exchange Endpoint.connectionType = ihe-xca, XCA-RespGateway-Query, XCA-RespGateway-Retrieve Endpoint.payload.profiles = ihe-cda-referral-request-profile, ihe-cde-discharge-summary-profile Endpoint.payload.type =  discharge-summaries, referral-requests  || ccda-2.1-structured Open Question: ** Is Endpoint.payload.type the formatCode or classCode for CDA?  To align with other examples, it seems like classCode is the best mapping. Endpoint.payload.mimeType = application/pdf, application/xml, application/jpg   Example #3:  AU HL7v2 Referral Exchange Endpoint.connectionType = sealed-message-delivery Endpoint.payload.profiles [0] = http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706 Endpoint.payload.profiles [1] = http://ns.electronichealth.net.au/ds/sc/deliver/hl7Mdm/2012 Endpoint.payload.profiles [2] = http://ns.electronichealth.net.au/ack/sc/deliver/hl7Ack/2012 Endpoint.payload.type =  referral-request Endpoint.payload.mimeType = application/hl7-v2  

    Description

      The two fields, payloadType and payloadMimeType, are pretty clear when an endpoint supports IHE SOAP-based document sharing (XCA): these map to the XDS attributes formatCode and mimeType.

      But what is a "payload" when the Endpoint is to a FHIR server (Endpoint.connectionType is hl7-fhir-rest)?

      • Does "payload" just not apply? In other words, you should omit these two fields? FHIR-25393 seems to imply this.
      • Should "payload" refer to the format and profiles of the FHIR resources supported? FHIR-39616 suggests StructDef URLs for payloadType, and current discussions in National Directory are considering documenting supported FHIR formats (e.g. xml | json | ttl) in payloadMimeType.
      • Should "payload" refer to the format and profiles of files available via DocumentReference? For example, using the IHE MHD profile to do document sharing over FHIR. This would map nicely to the XDS usage.

      I don't think these interpretations play well together, so it would be helpful to capture any guidance that hasn't made it into the core spec.

      Attachments

        Activity

          People

            Unassigned Unassigned
            jlamy Joseph M. Lamy
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: