FHIR ValueSet endpoint

The ValueSet endpoint is a RESTful facade to the ITI48 and ITI60 SOAP-transactions. It provides two main functionalities: retrieving all available Value Sets and retrieving a specific Value Set by its identifier.

Security

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

Endpoints

Note: The methods RetrieveMultipleValueSets and RetrieveValueSet 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.

Method Route Description Parameters Returns Status Codes
RetrieveValueSet "$baseurl/fhir/ValueSet/" 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
RetrieveMultipleValueSets "$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

Example request

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

Response

{
    "resourceType": "ValueSet",
    "id": "2.16.578.1.12.4.1.7.1.2.12.1.1.1.9.15",
    "language": "en-US",
    "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"
                    }
                ]
            }
        ]
    }
}