Ministerie van Volksgezondheid,Welzijn en Sport
Generic Functions for data exchange - Implementation Guide
26.0.0 - trial-use
Ministerie van Volksgezondheid,Generic Functions for data exchange - Implementation Guide
26.0.0 - trial-use
Generic Functions for data exchange - Implementation Guide - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-10-08 |
{
"resourceType" : "CapabilityStatement",
"id" : "nl-gf-localization-repository-patient",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement nl-gf-localization-repository-patient</b></p><a name=\"nl-gf-localization-repository-patient\"> </a><a name=\"hcnl-gf-localization-repository-patient\"> </a><h2 id=\"title\">Localization Service (Patient)</h2><ul><li>Implementation Guide Version: 26.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Published on: 2026-10-08 </li><li>Published by: Ministerie van Volksgezondheid, Welzijn en Sport </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"/></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-nl-gf-localization-patient.html\">NL Generic Functions Localization Patient Profile</a></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td>identifier, organization, _source</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-4\"><span class=\"lead\">Reference Policy</span><br/></div><div class=\"col-lg-4\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>delete</code><br/><code>create</code><div><p>SHALL support conditional create with <code>If-None-Exist: identifier=[custodian-assigned identifier]&_source=[client URI]</code>, so a registering client cannot create duplicate registrations.</p>\n</div><code>search-type</code><div><p>SHALL support data-user search using <code>POST [base]/Patient/_search</code> (<code>application/x-www-form-urlencoded</code>). This search SHALL include the NVI patient identifier and MAY combine it with managing-organization filters. SHALL support the standard chained searches <code>organization:identifier</code>, <code>organization.type</code>, <code>organization.endpoint.payload-type</code>, and <code>organization._has:HealthcareService:organization:service-type</code>; 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 <code>SUBSETTED</code> 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 <code>_source</code> for maintenance; those results are distinct from data-user search results.</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-nl-gf-localization-patient.html\">NL Generic Functions Localization Patient Profile</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>A Patient resource represents one patient at one custodian, registered by one client. Registration and maintenance use direct Patient REST interactions; transaction Bundles SHALL NOT be used.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>The NVI patient pseudonym. SHALL support the NVI identifier system. A registering client MAY also search by the custodian-assigned identifier, combined with <code>_source</code>, for record maintenance and conditional create.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">organization</a></td><td><code>reference</code></td><td><div><p>SHALL support filtering on the managing Organization using its <code>:identifier</code> modifier and chained <code>type</code>, <code>endpoint.payload-type</code>, and <code>_has:HealthcareService:organization:service-type</code> parameters. SHALL also accept the equivalent type-qualified form <code>organization.endpoint:Endpoint.payload-type</code>. The Organization identifier is resolved against the LRZa replica.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_source</a></td><td><code>uri</code></td><td><div><p>Search by the registering OAuth client URI in meta.source for record maintenance.</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://fhir.generiekefuncties.nl/CapabilityStatement/nl-gf-localization-repository-patient",
"version" : "26.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/StructureDefinition/nl-gf-localization-patient"
],
"documentation" : "A Patient resource represents one patient at one custodian, registered by one client. 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."
}
]
}
]
}
]
}