eHealth Infrastructure
3.2.0 - release
eHealth Infrastructure
3.2.0 - release
This page is part of the FUT Infrastructure (v3.2.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Active as of 2024-08-06 |
{
"resourceType" : "CapabilityStatement",
"id" : "library",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement library</b></p><a name=\"library\"> </a><a name=\"hclibrary\"> </a><a name=\"library-en-US\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 3.2.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>xml</code>, <code>application/fhir+json</code>, <code>json</code>, <code>application/x-turtle</code>, <code>ttl</code>, <code>html/json</code>, <code>html/xml</code>, <code>html/turtle</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-08-06 02:22:43+0000 </li><li>Published by: Den telemedicinske infrastruktur (eHealth Infrastructure) </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 class=\"lead\"><em>Summary of System-wide Interactions</em></div><ul><li>Supports the <code>transaction</code>interaction.</li><li>Supports the <code>history-system</code>interaction.</li></ul></div></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 past versions of resources (vread interaction)\">V-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><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=\"#Library1-1\">Library</a></td><td><a href=\"StructureDefinition-ehealth-library.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td>_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, composed-of, date, depends-on, derived-from, description, effective, identifier, jurisdiction, name, predecessor, publisher, status, successor, title, topic, url, version</td><td><code>*</code>, <code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td><code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td><code>$validate</code>, <code>$evaluate</code></td></tr><tr><td><a href=\"#OperationDefinition1-2\">OperationDefinition</a></td><td><a href=\"http://hl7.org/fhir/R4/operationdefinition.html\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td class=\"text-center\"></td><td></td><td><code>*</code></td><td><code>Library:composed-of</code>, <code>Library:depends-on</code>, <code>Library:derived-from</code>, <code>Library:predecessor</code>, <code>Library:successor</code></td><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Library1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>Library</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-ehealth-library.html\">ehealth-library</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>update</code>, <code>search-type</code>, <code>vread</code>, <code>read</code>, <code>create</code>.</li></ul></div></div><p/><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>_content</td><td><code>string</code></td><td><div><p>Search the contents of the resource's data using a fulltext search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_has</td><td><code>string</code></td><td><div><p>Return resources linked to by the given target</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div><p>The ID of the resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_language</td><td><code>string</code></td><td><div><p>The language of the resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_lastUpdated</td><td><code>date</code></td><td><div><p>Only return resources which were last updated as specified by the given range</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_profile</td><td><code>uri</code></td><td><div><p>Search for resources which have the given profile</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_security</td><td><code>token</code></td><td><div><p>Search for resources which have the given security labels</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_tag</td><td><code>token</code></td><td><div><p>Search for resources which have the given tag</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>_text</td><td><code>string</code></td><td><div><p>Search the contents of the resource's narrative using a fulltext search</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>composed-of</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>The library publication date</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>depends-on</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>derived-from</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div><p>The description of the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>effective</td><td><code>date</code></td><td><div><p>The time during which the library is intended to be in use</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>External identifier for the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>jurisdiction</td><td><code>token</code></td><td><div><p>Intended jurisdiction for the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>Computationally friendly name of the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>predecessor</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>publisher</td><td><code>string</code></td><td><div><p>Name of the publisher of the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>The current status of the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>successor</td><td><code>reference</code></td><td><div><p>What resource is being referenced</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>title</td><td><code>string</code></td><td><div><p>The human-friendly name of the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>topic</td><td><code>token</code></td><td><div><p>Topics associated with the module</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>url</td><td><code>uri</code></td><td><div><p>The uri that identifies the library</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>version</td><td><code>token</code></td><td><div><p>The business version of the library</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Extended Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>$validate</td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-Library-it-evaluate.html\">$evaluate</a></td><td><div><p>This operation evaluates parameters passed as input against the decision support rule identified by the Library resource. It returns the computed clinical decision support result and/or errors. The Library resource identifies the clinical decision rule and define its parameters.</p>\n<p>The operation is idempotent.</p>\n<h3>Input</h3>\n<ul>\n<li>1..1 Parameters: HL7 FHIR <a href=\"https://www.hl7.org/fhir/stu3/parameters.html\">Parameters</a> resource containing input parameters for the clinical decision support computation.This should either be a QuestionnaireResponse or an Observation for evaluation.</li>\n</ul>\n<h3>Output</h3>\n<p>Upon success this operation returns an GuidanceResponse resource containing the decision support result.</p>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"OperationDefinition1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>OperationDefinition</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/operationdefinition.html\">OperationDefinition</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/></div></div></div><h3 id=\"operationsCap1\">Operations</h3><h4 id=\"operationsSummary1\">Use</h4></div>"
},
"url" : "http://ehealth.sundhed.dk/fhir/CapabilityStatement/library",
"version" : "3.2.0",
"name" : "library",
"status" : "active",
"date" : "2024-08-06T02:22:43.738+00:00",
"publisher" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"contact" : [
{
"name" : "Den telemedicinske infrastruktur (eHealth Infrastructure)",
"telecom" : [
{
"system" : "url",
"value" : "http://ehealth.sundhed.dk"
}
]
}
],
"kind" : "instance",
"software" : {
"name" : "library",
"version" : "1.9.10"
},
"implementation" : {
"description" : "eHealth library service",
"url" : "https://library.devtest.systematic-ehealth.com/fhir"
},
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"xml",
"application/fhir+json",
"json",
"application/x-turtle",
"ttl",
"html/json",
"html/xml",
"html/turtle"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Library",
"profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "vread"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"searchInclude" : [
"*",
"Library:composed-of",
"Library:depends-on",
"Library:derived-from",
"Library:predecessor",
"Library:successor"
],
"searchRevInclude" : [
"Library:composed-of",
"Library:depends-on",
"Library:derived-from",
"Library:predecessor",
"Library:successor"
],
"searchParam" : [
{
"name" : "_content",
"type" : "string",
"documentation" : "Search the contents of the resource's data using a fulltext search"
},
{
"name" : "_has",
"type" : "string",
"documentation" : "Return resources linked to by the given target"
},
{
"name" : "_id",
"type" : "token",
"documentation" : "The ID of the resource"
},
{
"name" : "_language",
"type" : "string",
"documentation" : "The language of the resource"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Only return resources which were last updated as specified by the given range"
},
{
"name" : "_profile",
"type" : "uri",
"documentation" : "Search for resources which have the given profile"
},
{
"name" : "_security",
"type" : "token",
"documentation" : "Search for resources which have the given security labels"
},
{
"name" : "_tag",
"type" : "token",
"documentation" : "Search for resources which have the given tag"
},
{
"name" : "_text",
"type" : "string",
"documentation" : "Search the contents of the resource's narrative using a fulltext search"
},
{
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "date",
"type" : "date",
"documentation" : "The library publication date"
},
{
"name" : "depends-on",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "derived-from",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "description",
"type" : "string",
"documentation" : "The description of the library"
},
{
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the library is intended to be in use"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the library"
},
{
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the library"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the library"
},
{
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the library"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The current status of the library"
},
{
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the library"
},
{
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the library"
},
{
"name" : "version",
"type" : "token",
"documentation" : "The business version of the library"
}
],
"operation" : [
{
"name" : "validate",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/Library-it-validate"
},
{
"name" : "evaluate",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/Library-it-evaluate",
"documentation" : "This operation evaluates parameters passed as input against the decision support rule identified by the Library resource. It returns the computed clinical decision support result and/or errors. The Library resource identifies the clinical decision rule and define its parameters.\n\nThe operation is idempotent.\n### Input\n- 1..1 Parameters: HL7 FHIR [Parameters](https://www.hl7.org/fhir/stu3/parameters.html) resource containing input parameters for the clinical decision support computation.This should either be a QuestionnaireResponse or an Observation for evaluation.\n\n### Output\nUpon success this operation returns an GuidanceResponse resource containing the decision support result."
}
]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"Library:composed-of",
"Library:depends-on",
"Library:derived-from",
"Library:predecessor",
"Library:successor"
]
}
],
"interaction" : [
{
"code" : "transaction"
},
{
"code" : "history-system"
}
],
"operation" : [
{
"name" : "perform-reindexing-pass",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass",
"documentation" : "Forces a single pass of the resource reindexing processor"
},
{
"name" : "meta",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"
},
{
"name" : "get-resource-counts",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-resource-counts",
"documentation" : "Provides the number of resources currently stored on the server, broken down by resource type"
},
{
"name" : "reindex-terminology",
"definition" : "https://library.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"
}
]
}
]
}
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#3.2.0 based on FHIR 4.0.1. Generated 2024-09-02
