US Core: Improve Consistency Across Quick Start Sections

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive
    • Priority: Medium
    • US Core (FHIR)
    • STU3
    • Structured Documents
    • Profiles and Extensions
    • Hide

      Make quick start sections consistent across profiles and remove the Response Class statement from Location ( is covered in the CapabilityStatement )

      Show
      Make quick start sections consistent across profiles and remove the Response Class statement from Location ( is covered in the CapabilityStatement )
    • Brett Marquard/Lisa Nelson: 20-0-2
    • Correction
    • Non-substantive

      The Quick Start section is on every profile page, but there are some needless inconsistencies across some pages. While it's not strictly required that these sections be consistent, a consistent approach would make the IG easier to consume and more professional looking.

      I think most pages are consistent, but all pages should probably be reviewed for consistency.

      One example of inconsistencies is found in the Quick Start section of Location (http://hl7.org/fhir/us/core/2019Jan/StructureDefinition-us-core-location.html#quick-start).

      While most Quick Starts have full phrases for the "Supports" data (e.g., "Support: Mandatory to support search by patient."), the Location Quick Start just says: "Support: Mandatory"

      In addition, the Location Quick Start also contains "Response Class" sections for each search parameter, with descriptions of HTTP 200, 400, 401, 4xx, and 403 responses. No other Quick Start sections (so far) go into this detail – and I don't think there is anything special about Location that would require it.

            Assignee:
            Unassigned
            Reporter:
            cmoesel
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: