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

Corrections to ND-JSON page

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R4
    • FHIR Infrastructure
    • Resource Definitions
    • Hide

      Will make the changes as proposed
      For #3, will change "each NDJSON document contains only resources of a single type" to "each NDJSON document SHALL only contain resources of a single type"

      For #4, will label the example as "NDJSON example"

      Show
      Will make the changes as proposed For #3, will change "each NDJSON document contains only resources of a single type" to "each NDJSON document SHALL only contain resources of a single type" For #4, will label the example as "NDJSON example"
    • Grahame Grieve/Rob Hausam: 4-0-0
    • Clarification
    • Non-substantive
    • R5

    Description

      There are a number of corrections necessary on the page "ND-JSON Representation of Resources": http://build.fhir.org/nd-json.html

      1. We should reference the specification for this format at: https://github.com/ndjson/ndjson-spec
      2. It should consistently be referred to as "NDJSON", not "ND-JSON", "nd-json" or "ns-json".
      3. "In order to simplify nd-json processing, each nd-json document contains only resources of a single type - every line contains a resource of a particular type. (though note that resources may still contain contained resources of various types). " - this sentence should include an RFC 2119 key word so that it is clear whether this is a hard requirement or not.
      4. The example should have some sort of caption to describe what it is, and should be amended to the following:
      { "resourceType" : "[type]", .... }
      { "resourceType" : "[type]", .... }
      

      Attachments

        Activity

          People

            GrahameGrieve Grahame Grieve
            johngrimes John Grimes (Inactive)
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: