FHIR OperationDefinition

Pathling provides a FHIR® REST interface, and the $import operation is an extended operation defined on that interface.

This operation allows FHIR R4 data to be imported into the server, making it available for query via other operations such as search and aggregate. This operation accepts the NDJSON format, and links to retrieve that data are provided rather that sending the data inline within the request itself. This is to allow for large data sets to be imported efficiently.

Currently Pathling supports retrieval of NDJSON files from Amazon S3 (s3://), HDFS (hdfs://) and filesystem (file://) URLs. Authentication is supported for S3, see Configuration and deployment for details.

POST [FHIR endpoint]/$import

Import operation


The request for the $import operation is a Parameters resource containing the following parameters:

  • source [1..*] - A source FHIR NDJSON file containing resources to be included within this import operation. Each file must contain only one type of resource.
    • resourceType [1..1] (code) - The base FHIR resource type contained within this source file. Code must be a member of
    • url [1..1] (uri) - A URL that can be used to retrieve this source file.


The response from the $import operation is an OperationOutcome resource, which will indicate success or a description of any errors that occurred.


Check out example import requests in the Postman collection:

Run in Postman

Next: Search