FHIR ValueSet endpoint

Background

Current implementation is based on IHE SVCM v1.5.1 (trial implementation of IHE SVCM) which is based in FHIR R4. This is an initial implementation of API-service providing option to search withing all registered ValueSets in NHN's SVS and option to retrieve set of all available ValueSets.

Security

This endpoint is a part of the Patient Health Records REST-api, but does not require any authentication.

Endpoints

Note: Methods are implemented as HTTP GET routes and return JSON-formatted responses containing the requested Value Sets. These methods handle various status codes and error scenarios to provide appropriate feedback to the client.
Language of the valueset is specified using the Accept-Language-header in the HTTP-request.

IHE ITI-95 Query Value Set

Route Description Parameters Returns Status Codes
"$baseurl/fhir/ValueSet/{identifier}" Retrieves a speficic Value Set by its identifier - identifier (string) Existing OID of the value set
- version(string) Version number of the Value Set (optional)
- language set using Accept-Language		 JSON FHIR ValueSet object - 200
- 400
- 404
"$baseurl/fhir/ValueSet/" Retrieves all available Value Sets from the Value Set Repository none JSON FHIR bundle of type searchset with all value sets - 200
- 400

ValueSets versioning

All ValueSets are versioned. There is a difference between versions in test and production environment.

These differences will be eliminated as all new ValueSets with language support are going to be established as version "2024".

Language support

When retrieving specific ValueSet than header "Accept-Language" MUST be specifed.

Supported languages:

Code Language Comments
en-US English default fallback language if header is not specified
nb-NO Norwegian (bokmål)
nn-NO Norwegian (nynorsk)
sme-NO Sami (Northern Sami)
smj-NO Sami (Lule Sami)
sma-NO Sami (Southern Sami)
no-NO Norsk Deprecated (historical)

Example request

GET https://api.pjd.test.nhn.no/R4/fhir/ValueSet/2.16.578.1.12.4.1.7.1.2.12.1.1.1.9.15&version=2024

Accept-Language: "nb-NO"

Response

{
    "resourceType": "ValueSet",
    "id": "2.16.578.1.12.4.1.7.1.2.12.1.1.1.9.15",
    "language": "nb-NO",
    "version": "1",
    "name": "institutions",
    "status": "active",
    "publisher": "Norsk helsenet SF, Pasientens journaldokumenter",
    "compose": {
        "include": [
            {
                "concept": [
                    {
                        "code": "depart2",
                        "display": "Hospital in Innsbruck - Innere Medizin"
                    },
                    {
                        "code": "2.16.578.1.12.4.4.3.1",
                        "display": "Region Helse Nord (XDS-domain)"
                    },
                    {
                        "code": "depart10",
                        "display": "Bezirkskrankenhaus Hall - Pädiatrie"
                    }
                ]
            }
        ]
    }
}