FHIR © HL7.org  |  FHIRsmith 0.14.2  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagenl.generiekefuncties.csd
Resource TypeCapabilityStatement
IdCapabilityStatement-nl-gf-localization-repository-patient.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/minvws/generiekefuncties-docs/CapabilityStatement-nl-gf-localization-repository-patient.html
URLhttp://fhir.generiekefuncties.nl/csd/CapabilityStatement/nl-gf-localization-repository-patient
Version1.0.0
Statusactive
Date2026-10-08
TitleLocalization Service (Patient)
Realmnl
DescriptionDutch requirements for a Localization Service that registers and searches localization records as Patient resources.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
nl.generiekefuncties.csd#currentnl-gf-localization-patientNL Generic Functions Localization Patient Profile

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement nl-gf-localization-repository-patient

Localization Service (Patient)

  • Implementation Guide Version: 1.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Published on: 2026-10-08
  • Published by: Ministerie van Volksgezondheid, Welzijn en Sport

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCDSearches_include_revincludeOperations
PatientSupported Profiles
  NL Generic Functions Localization Patient Profile
YYYidentifier, organization, _source

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support delete
    create

    SHALL support conditional create with If-None-Exist: identifier=[custodian-assigned identifier]&_source=[client URI], so a registering client cannot create duplicate registrations.

    search-type

    SHALL support data-user search using POST [base]/Patient/_search (application/x-www-form-urlencoded). This search SHALL include the NVI patient identifier and MAY combine it with managing-organization filters. SHALL support the standard chained searches organization:identifier, organization.type, organization.endpoint.payload-type, and organization._has:HealthcareService:organization:service-type; the NVI resolves managing-organization identifiers against its LRZa replica. SHALL return only matching Patient projections for which the Authorization Decision is allow, marked with the SUBSETTED tag and omitting all Patient.identifier values and meta.source. These projections SHALL NOT be used to update registrations. An authorized registering client MAY search its registrations by _source for maintenance; those results are distinct from data-user search results.

Documentation

A Patient resource represents one patient at one custodian. Registration and maintenance use direct Patient REST interactions; transaction Bundles SHALL NOT be used.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

The NVI patient pseudonym. SHALL support the NVI identifier system. A registering client MAY also search by the custodian-assigned identifier, combined with _source, for record maintenance and conditional create.

SHALLorganizationreference

SHALL support filtering on the managing Organization using its :identifier modifier and chained type, endpoint.payload-type, and _has:HealthcareService:organization:service-type parameters. SHALL also accept the equivalent type-qualified form organization.endpoint:Endpoint.payload-type. The Organization identifier is resolved against the LRZa replica.

SHALL_sourceuri

Search by the registering OAuth client URI in meta.source for record maintenance.

 

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "nl-gf-localization-repository-patient",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.generiekefuncties.nl/csd/CapabilityStatement/nl-gf-localization-repository-patient",
  "version": "1.0.0",
  "title": "Localization Service (Patient)",
  "status": "active",
  "experimental": false,
  "date": "2026-10-08",
  "publisher": "Ministerie van Volksgezondheid, Welzijn en Sport",
  "contact": [
    {
      "name": "Ministerie van Volksgezondheid, Welzijn en Sport",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.minvws.nl"
        }
      ]
    }
  ],
  "description": "Dutch requirements for a Localization Service that registers and searches localization records as Patient resources.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "NL",
          "display": "Netherlands"
        }
      ]
    }
  ],
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "supportedProfile": [
            "http://fhir.generiekefuncties.nl/csd/StructureDefinition/nl-gf-localization-patient"
          ],
          "documentation": "A Patient resource represents one patient at one custodian. Registration and maintenance use direct Patient REST interactions; transaction Bundles SHALL NOT be used.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "SHALL support conditional create with `If-None-Exist: identifier=[custodian-assigned identifier]&_source=[client URI]`, so a registering client cannot create duplicate registrations."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "delete"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "SHALL support data-user search using `POST [base]/Patient/_search` (`application/x-www-form-urlencoded`). This search SHALL include the NVI patient identifier and MAY combine it with managing-organization filters. SHALL support the standard chained searches `organization:identifier`, `organization.type`, `organization.endpoint.payload-type`, and `organization._has:HealthcareService:organization:service-type`; the NVI resolves managing-organization identifiers against its LRZa replica. SHALL return only matching Patient projections for which the Authorization Decision is allow, marked with the `SUBSETTED` tag and omitting all Patient.identifier values and meta.source. These projections SHALL NOT be used to update registrations. An authorized registering client MAY search its registrations by `_source` for maintenance; those results are distinct from data-user search results."
            }
          ],
          "conditionalCreate": true,
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "The NVI patient pseudonym. SHALL support the NVI identifier system. A registering client MAY also search by the custodian-assigned identifier, combined with `_source`, for record maintenance and conditional create."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "organization",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-organization",
              "type": "reference",
              "documentation": "SHALL support filtering on the managing Organization using its `:identifier` modifier and chained `type`, `endpoint.payload-type`, and `_has:HealthcareService:organization:service-type` parameters. SHALL also accept the equivalent type-qualified form `organization.endpoint:Endpoint.payload-type`. The Organization identifier is resolved against the LRZa replica."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_source",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-source",
              "type": "uri",
              "documentation": "Search by the registering OAuth client URI in meta.source for record maintenance."
            }
          ]
        }
      ]
    }
  ]
}