Documentation Pasientens Rekvisisjoner (Parek) API

Here you can find documentation on how to get started using the Pasientens Rekvisisjoner API.

Intro to the API

The API uses FHIR and supports CRUD operations on FHIR resources in use for Pasientens Rekvisisjoner. PaRek will be able to receive information from both the requester and the laboratory, and distribute information to the requester, laboratory and citizens.

Getting Started

Authentication and authorization with HelseID - see HelseID authorization.

For test-environments see environments.

🎛️ 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

External consumers can subscribe to pushed specimen update notifications via AMQPS. The service publishes events to a broker hosted on the health network, in addition to over the internet in the test environment.

Connection Details

* See environments and base URLs for host value.

** Queue name is requested and received via a support ticket.

*** Username is requested and received via a support ticket.

**** Password is requested through a support ticket and received via a text message.

Note: The host is publicly accessible for the test environment. Ensure your firewall allows outbound TCP traffic on port 5671. If additional information is required to accept traffic through the firewall, contact the team on slack using the channel documented in the contact information section.

Protocol Requirements

• AMQP Version: 🚨 1.0 is enforced; clients using 0.9.1 may experience silent message drops or UUID parsing errors.
• Message Format: Events are published as JSON payloads with EventId and EventType attached.

API Examples

For examples of API use see API examples.

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.