R6 Ballot (3rd Draft)

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes). The current version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.1.6.5 NDJSON Representation of Resources

Implementable Technology Specifications icon Work GroupMaturity Level: 4Standards Status: Draft

NDJSON (New line delimited JSON icon) is a variant of the NDJSON format that is supported for bulk data transfer. In principle, NDJSON is a simple variation on the JSON format, but where resources are serialized with no whitespace, and separated by a newline pair (characters 13 and 10).

Example: 

{ "resourceType" : "[type]", .... }
{ "resourceType" : "[type]", .... }

The MIME-type for this format is application/fhir+ndjson.

In order to simplify NDJSON processing, each NDJSON document SHALL only contain 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).

On the RESTful API, the NDJSON format can only be retrieved using the Asynchronous Pattern.