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

Use the same font of the s in " hub.channel.types"

    XMLWordPrintableJSON

    Details

    • Type: Technical Correction
    • Status: Applied (View Workflow)
    • Priority: Highest
    • Resolution: Persuasive
    • Specification:
      FHIRCast (FHIR)
    • Raised in Version:
      0.1
    • Work Group:
      Imaging Integration
    • Related Page(s):
      (NA)
    • Related Section(s):
      Subscription Denial Example
    • Grouping:
    • Resolution Description:
      Hide

      Throughout the FHIRcast spec, we use markdown to denote specific terms that exist within the exchanged messages. For example: "hub.channel.type" is a specific json element and specific formatting is applied to this term. 

      This specific term is used in the plural, here: https://fhircast.hl7.org/specification/Feb2020Ballot/#subscription-confirmation

      To clearly indicate the the json element does not include a trailing 's', the formatting is awkward. 

      Clearly communicating the correct json element name is more important than nice formatting. A middle ground of rewording the sentence to avoid the awkward formatting, while also continuing to clearly communication the appropriate json element name is to update the language from:

      >For hub.channel.type}}s of both {{webhook and websocket, this subscription confirmation step informs the subscriber of the details of Hub's recently created subscription.

      to:

      >For `hub.channel.type` values of `webhook` and `websocket`, this subscription confirmation step informs the subscriber of the details of Hub's recently created subscription.

      Will update the spec as described, above.

       

      Show
      Throughout the FHIRcast spec, we use markdown to denote specific terms that exist within the exchanged messages. For example: "hub.channel.type" is a specific json element and specific formatting is applied to this term.  This specific term is used in the plural, here:  https://fhircast.hl7.org/specification/Feb2020Ballot/#subscription-confirmation To clearly indicate the the json element does not include a trailing 's', the formatting is awkward.  Clearly communicating the correct json element name is more important than nice formatting. A middle ground of rewording the sentence to avoid the awkward formatting, while also continuing to clearly communication the appropriate json element name is to update the language from: >For  hub.channel.type}}s of both {{webhook  and  websocket , this subscription confirmation step informs the subscriber of the details of Hub's recently created subscription. to: >For ` hub.channel.type`   values  of `webhook` and `websocket`, this subscription confirmation step informs the subscriber of the details of Hub's recently created subscription. Will update the spec as described, above.  
    • Change Category:
      Correction

      Description

      Use the same font of the s in " hub.channel.types"

      Existing Wording:

      For hub.channel.types of both webhook and websocket, this subscription confirmation step informs the subscriber of the details of Hub's recently created subscription.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              Isaac.Vetter Isaac Vetter
              Reporter:
              bvdh Bas van den Heuvel
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: