Documentation Pasientens Rekvisisjoner (Parek) APIs

Here you can find the technical documentation on how to get started using the Pasientens Rekvisisjoner API. The technical documentation is in English.

Note: Looking for a broader overview of the Pasientens Rekvisisjoner service as a whole? See the top level page or Pasientens Rekvisisjoner on nhn.no (both are in Norwegian).

Intro to the APIs

In a broad sense, Pasientens Rekvisisjoner has two APIs:

HTTP/REST API (or just API)

The API uses the FHIR standard. The requester (rekvirent) and collector (prøvetaker) may write to and read from the API. Citizens can also read their data from the API via Helsenorge.

AMQP messaging API (or just AMQP/AMQPS)

Important events are published to an AMQP queue. The requester can subscribe to this queue in order to be informed that requested specimens have been collected.

Getting Started

Authentication and authorization with HelseID - see HelseID authorization.

For our test environment, see environments. You should also create your own synthetic patients with SyntPop that you will be able to use in our test environment.

🎛️ API version

The API version is directly reflected in the endpoint URLs, being prefixed to the route of the request like so: <base-url>/<api-version>/....

Resource URLs

The API follows FHIR conventions and accesses resources by appending the resource name to the base URL. The full set available is documented in Swagger.

AMQPS Connection

Check out the AMQPS page if you need to subscribe to Specimen updated events.

API Usage

For details on how to use the API, see the API usage page.

Try it out with OpenAPI with Swagger.

Fhir resources - Implementation guide

The FHIR resources used in Pasientens Rekvisisjoner API are specified in the implementation guide (hl7norway.github.io).