This page is part of the FUT Infrastructure (v3.1.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-04-29 |
{
"resourceType" : "CapabilityStatement",
"id" : "plan",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement plan</b></p><a name=\"plan\"> </a><a name=\"hcplan\"> </a><a name=\"hcplan-en-US\"> </a><h2 id=\"title\"/><ul><li>Implementation Guide Version: 3.1.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-04-29 02:42:23+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=\"#ActivityDefinition1-1\">ActivityDefinition</a></td><td><a href=\"StructureDefinition-ehealth-activitydefinition.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition</a></td><td>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, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, date, depends-on, derived-from, description, effective, ehealthPredecessor, employeeTitle, identifier, intendedAudience, jurisdiction, modifier_role_reference, modifier_role_role, name, predecessor, publisher, recommendation, status, successor, title, topic, url, version</td><td><code>ActivityDefinition:composed-of</code>, <code>ActivityDefinition:depends-on</code>, <code>ActivityDefinition:derived-from</code>, <code>ActivityDefinition:predecessor</code>, <code>ActivityDefinition:successor</code></td><td><code>ActivityDefinition:composed-of</code>, <code>ActivityDefinition:depends-on</code>, <code>ActivityDefinition:derived-from</code>, <code>ActivityDefinition:intendedAudience</code>, <code>ActivityDefinition:modifier_role_reference</code>, <code>ActivityDefinition:predecessor</code>, <code>ActivityDefinition:successor</code>, <code>DocumentReference:authenticator</code>, <code>DocumentReference:author</code>, <code>DocumentReference:custodian</code>, <code>DocumentReference:encounter</code>, <code>DocumentReference:patient</code>, <code>DocumentReference:related</code>, <code>DocumentReference:relatesto</code>, <code>DocumentReference:subject</code>, <code>PlanDefinition:composed-of</code>, <code>PlanDefinition:definition</code>, <code>PlanDefinition:depends-on</code>, <code>PlanDefinition:derived-from</code>, <code>PlanDefinition:documentation</code>, <code>PlanDefinition:intendedAudience</code>, <code>PlanDefinition:modifier_role_reference</code>, <code>PlanDefinition:predecessor</code>, <code>PlanDefinition:successor</code></td><td/></tr><tr><td><a href=\"#DocumentReference1-2\">DocumentReference</a></td><td><a href=\"StructureDefinition-ehealth-documentreference.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference</a></td><td>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, _filter, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, authenticator, author, category, contenttype, custodian, date, description, encounter, event, facility, format, identifier, language, location, patient, period, related, relatesto, relation, relationship, security-label, setting, status, subject, type</td><td><code>*</code>, <code>DocumentReference:authenticator</code>, <code>DocumentReference:author</code>, <code>DocumentReference:custodian</code>, <code>DocumentReference:encounter</code>, <code>DocumentReference:patient</code>, <code>DocumentReference:related</code>, <code>DocumentReference:relatesto</code>, <code>DocumentReference:subject</code></td><td><code>ActivityDefinition:composed-of</code>, <code>ActivityDefinition:depends-on</code>, <code>ActivityDefinition:derived-from</code>, <code>ActivityDefinition:intendedAudience</code>, <code>ActivityDefinition:modifier_role_reference</code>, <code>ActivityDefinition:predecessor</code>, <code>ActivityDefinition:successor</code>, <code>DocumentReference:authenticator</code>, <code>DocumentReference:author</code>, <code>DocumentReference:custodian</code>, <code>DocumentReference:encounter</code>, <code>DocumentReference:patient</code>, <code>DocumentReference:related</code>, <code>DocumentReference:relatesto</code>, <code>DocumentReference:subject</code>, <code>PlanDefinition:composed-of</code>, <code>PlanDefinition:definition</code>, <code>PlanDefinition:depends-on</code>, <code>PlanDefinition:derived-from</code>, <code>PlanDefinition:documentation</code>, <code>PlanDefinition:intendedAudience</code>, <code>PlanDefinition:modifier_role_reference</code>, <code>PlanDefinition:predecessor</code>, <code>PlanDefinition:successor</code></td><td/></tr><tr><td><a href=\"#OperationDefinition1-3\">OperationDefinition</a></td><td><a href=\"http://hl7.org/fhir/R4/operationdefinition.html\">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>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>ActivityDefinition:composed-of</code>, <code>ActivityDefinition:depends-on</code>, <code>ActivityDefinition:derived-from</code>, <code>ActivityDefinition:intendedAudience</code>, <code>ActivityDefinition:modifier_role_reference</code>, <code>ActivityDefinition:predecessor</code>, <code>ActivityDefinition:successor</code>, <code>DocumentReference:authenticator</code>, <code>DocumentReference:author</code>, <code>DocumentReference:custodian</code>, <code>DocumentReference:encounter</code>, <code>DocumentReference:patient</code>, <code>DocumentReference:related</code>, <code>DocumentReference:relatesto</code>, <code>DocumentReference:subject</code>, <code>PlanDefinition:composed-of</code>, <code>PlanDefinition:definition</code>, <code>PlanDefinition:depends-on</code>, <code>PlanDefinition:derived-from</code>, <code>PlanDefinition:documentation</code>, <code>PlanDefinition:intendedAudience</code>, <code>PlanDefinition:modifier_role_reference</code>, <code>PlanDefinition:predecessor</code>, <code>PlanDefinition:successor</code></td><td/></tr><tr><td><a href=\"#PlanDefinition1-4\">PlanDefinition</a></td><td><a href=\"StructureDefinition-ehealth-plandefinition.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition</a></td><td>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, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, date, definition, depends-on, derived-from, description, documentation, effective, ehealthPredecessor, employeeTitle, identifier, intendedAudience, jurisdiction, modifier_role_reference, modifier_role_role, name, predecessor, publisher, recommendation, status, successor, title, topic, type, url, version</td><td><code>*</code>, <code>PlanDefinition:composed-of</code>, <code>PlanDefinition:definition</code>, <code>PlanDefinition:depends-on</code>, <code>PlanDefinition:derived-from</code>, <code>PlanDefinition:documentation</code>, <code>PlanDefinition:predecessor</code>, <code>PlanDefinition:successor</code></td><td><code>ActivityDefinition:composed-of</code>, <code>ActivityDefinition:depends-on</code>, <code>ActivityDefinition:derived-from</code>, <code>ActivityDefinition:intendedAudience</code>, <code>ActivityDefinition:modifier_role_reference</code>, <code>ActivityDefinition:predecessor</code>, <code>ActivityDefinition:successor</code>, <code>DocumentReference:authenticator</code>, <code>DocumentReference:author</code>, <code>DocumentReference:custodian</code>, <code>DocumentReference:encounter</code>, <code>DocumentReference:patient</code>, <code>DocumentReference:related</code>, <code>DocumentReference:relatesto</code>, <code>DocumentReference:subject</code>, <code>PlanDefinition:composed-of</code>, <code>PlanDefinition:definition</code>, <code>PlanDefinition:depends-on</code>, <code>PlanDefinition:derived-from</code>, <code>PlanDefinition:documentation</code>, <code>PlanDefinition:intendedAudience</code>, <code>PlanDefinition:modifier_role_reference</code>, <code>PlanDefinition:predecessor</code>, <code>PlanDefinition:successor</code></td><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ActivityDefinition1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>ActivityDefinition</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-activitydefinition.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition</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>_source</td><td><code>uri</code></td><td><div><p>Search for resources which have the given source value (Resource.meta.source)</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>base</td><td><code>token</code></td><td><div><p>Base of resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>baseEnvironment</td><td><code>token</code></td><td><div><p>Base Environment of resource</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>context</td><td><code>token</code></td><td><div><p>A use context assigned to the activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>context-quantity</td><td><code>quantity</code></td><td><div><p>A quantity- or range-valued use context assigned to the activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>context-type</td><td><code>token</code></td><td><div><p>A type of use context assigned to the activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>The activity definition 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 activity definition</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 activity definition is intended to be in use</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>ehealthPredecessor</td><td><code>token</code></td><td><div><p>Predecessor of resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>employeeTitle</td><td><code>string</code></td><td><div><p>Title intented for clinicians</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 activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>intendedAudience</td><td><code>reference</code></td><td><div><p>The intended audience of the plan definition</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 activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>modifier_role_reference</td><td><code>reference</code></td><td><div><p>Reference to either Organization, CareTeam, Practitioner</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>modifier_role_role</td><td><code>token</code></td><td><div><p>Role of Organization, CareTeam, Practitioner</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 activity definition</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 activity definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>recommendation</td><td><code>token</code></td><td><div><p>Recommendation for the plan definition</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 activity definition</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 activity definition</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 activity definition</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 activity definition</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-ActivityDefinitionPlanDefinition-i-create-clone.html\">$create-clone</a></td><td><div><h3>Input</h3>\n<ul>\n<li>resourceId: reference to the ActivityDefinition resource that should be cloned</li>\n<li>clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation</li>\n<li>default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned</li>\n<li>deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.</li>\n</ul>\n<h3>Output</h3>\n<p>Bundle containing all resources that were created during the operation.</p>\n<h3>Validation</h3>\n<ul>\n<li>New business versions require that the user has modifier-role: owner or co-author for the resource</li>\n<li>New copy does not require that the user has a modifier-role.</li>\n<li>New business version can be made only when no draft resource exists (having identical base identifier).</li>\n<li>Read/search/create privileges are required for the resource types affected by $create-clone</li>\n</ul>\n</div></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</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-documentreference.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference</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>_filter</td><td><code>string</code></td><td><div><p>Search the contents of the resource's data using a filter</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>_source</td><td><code>uri</code></td><td><div><p>Search for resources which have the given source value (Resource.meta.source)</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>authenticator</td><td><code>reference</code></td><td><div><p>Who/what authenticated the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>author</td><td><code>reference</code></td><td><div><p>Who and/or what authored the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>category</td><td><code>token</code></td><td><div><p>Categorization of document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>contenttype</td><td><code>token</code></td><td><div><p>Mime type of the content, with charset etc.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>custodian</td><td><code>reference</code></td><td><div><p>Organization which maintains the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>When this document reference was created</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>description</td><td><code>string</code></td><td><div><p>Human-readable description</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>encounter</td><td><code>reference</code></td><td><div><p>Context of the document content</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>event</td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>facility</td><td><code>token</code></td><td><div><p>Kind of facility where patient was seen</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>format</td><td><code>token</code></td><td><div><p>Format/content rules for the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>Master Version Specific Identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>language</td><td><code>token</code></td><td><div><p>Human language of the content (BCP-47)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>location</td><td><code>uri</code></td><td><div><p>Uri where the data can be found</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>period</td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>related</td><td><code>reference</code></td><td><div><p>Related identifiers or resources</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relatesto</td><td><code>reference</code></td><td><div><p>Target of the relationship</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relation</td><td><code>token</code></td><td><div><p>replaces | transforms | signs | appends</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>relationship</td><td><code>composite</code></td><td><div><p>Combination of relation and relatesTo</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>security-label</td><td><code>token</code></td><td><div><p>Document security-tags</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>setting</td><td><code>token</code></td><td><div><p>Additional details about where the content was created (e.g. clinical specialty)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>subject</td><td><code>reference</code></td><td><div><p>Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div><p>Kind of document (LOINC if possible)</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></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"OperationDefinition1-3\" 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\">http://hl7.org/fhir/StructureDefinition/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><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"PlanDefinition1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>PlanDefinition</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-plandefinition.html\">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition</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>_source</td><td><code>uri</code></td><td><div><p>Search for resources which have the given source value (Resource.meta.source)</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>base</td><td><code>token</code></td><td><div><p>Base of resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>baseEnvironment</td><td><code>token</code></td><td><div><p>Base Environment of resource</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>context</td><td><code>token</code></td><td><div><p>A use context assigned to the plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>context-quantity</td><td><code>quantity</code></td><td><div><p>A quantity- or range-valued use context assigned to the plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>context-type</td><td><code>token</code></td><td><div><p>A type of use context assigned to the plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div><p>The plan definition publication date</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>definition</td><td><code>reference</code></td><td><div><p>Activity or plan definitions used by plan definition</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 plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>documentation</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>effective</td><td><code>date</code></td><td><div><p>The time during which the plan definition is intended to be in use</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>ehealthPredecessor</td><td><code>token</code></td><td><div><p>Predecessor of resource</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>employeeTitle</td><td><code>string</code></td><td><div><p>Title intented for clinicians</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 plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>intendedAudience</td><td><code>reference</code></td><td><div><p>The intended audience of the plan definition</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 plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>modifier_role_reference</td><td><code>reference</code></td><td><div><p>Reference to either Organization, CareTeam, Practitioner</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>modifier_role_role</td><td><code>token</code></td><td><div><p>Role of Organization, CareTeam, Practitioner</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 plan definition</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 plan definition</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>recommendation</td><td><code>token</code></td><td><div><p>Recommendation for the plan definition</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 plan definition</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 plan definition</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>type</td><td><code>token</code></td><td><div><p>The type of artifact the plan (e.g. order-set, eca-rule, protocol)</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 plan definition</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 plan definition</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-PlanDefinition-t-import.html\">$import</a></td><td><div><p>Import a Plandefinition</p>\n<h3>Parameters</h3>\n<ul>\n<li>planDefinitionPackage: Binary package produced by the export operation</li>\n</ul>\n<h3>Output</h3>\n<p>Bundle containing the created resources. PlanDefinitions, ActivityDefinitions, and Questionnaires will be created. Imports QFFD DocumentReference into Document-Transformation service.Libraries and Organizations are used to find the corresponding resources on the target system.</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-PlanDefinition-i-export.html\">$export</a></td><td><div><p>Export a PlanDefinition.</p>\n<h3>Export Contents</h3>\n<p>The export contains the PlanDefinition including referenced resources:- PlanDefinitions</p>\n<ul>\n<li>ActivityDefinitions</li>\n<li>Questionnaires</li>\n<li>Libraries</li>\n<li>Organizations</li>\n<li>DocumentReference + QFDD</li>\n</ul>\n<p>Each resource is returned in a separate JSon file.</p>\n<h3>Parameters</h3>\n<ul>\n<li>exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.</li>\n</ul>\n<h3>Output</h3>\n<p>Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.\nAll returned objects are Fhir resources. See the implementation guide for details</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-ActivityDefinitionPlanDefinition-i-create-clone.html\">$create-clone</a></td><td><div><h3>Input</h3>\n<ul>\n<li>resourceId: reference to the PlanDefinition resource that should be cloned</li>\n<li>clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation</li>\n<li>default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned</li>\n<li>deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.</li>\n</ul>\n<h3>Output</h3>\n<p>Bundle containing all resources that were created during the operation.</p>\n<h3>Validation</h3>\n<ul>\n<li>New business versions require that the user has modifier-role: owner or co-author for the resource</li>\n<li>New copy does not require that the user has a modifier-role.</li>\n<li>New business version can be made only when no draft resource exists (having identical base identifier).</li>\n<li>Read/search/create privileges are required for the resource types affected by $create-clone</li>\n</ul>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"OperationDefinition-PlanDefinition-i-apply.html\">$apply</a></td><td><div><p>Create a careplan for a specific episodeOfCare using this PlanDefinition as a template.</p>\n</div></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "http://ehealth.sundhed.dk/fhir/CapabilityStatement/plan",
"version" : "3.1.0",
"name" : "plan",
"status" : "active",
"date" : "2024-04-29T02:42:23.634+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" : "plan",
"version" : "2.2.0"
},
"implementation" : {
"description" : "eHealth plan service",
"url" : "https://plan.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" : "ActivityDefinition",
"profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "vread"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"searchInclude" : [
"ActivityDefinition:composed-of",
"ActivityDefinition:depends-on",
"ActivityDefinition:derived-from",
"ActivityDefinition:predecessor",
"ActivityDefinition:successor"
],
"searchRevInclude" : [
"ActivityDefinition:composed-of",
"ActivityDefinition:depends-on",
"ActivityDefinition:derived-from",
"ActivityDefinition:intendedAudience",
"ActivityDefinition:modifier_role_reference",
"ActivityDefinition:predecessor",
"ActivityDefinition:successor",
"DocumentReference:authenticator",
"DocumentReference:author",
"DocumentReference:custodian",
"DocumentReference:encounter",
"DocumentReference:patient",
"DocumentReference:related",
"DocumentReference:relatesto",
"DocumentReference:subject",
"PlanDefinition:composed-of",
"PlanDefinition:definition",
"PlanDefinition:depends-on",
"PlanDefinition:derived-from",
"PlanDefinition:documentation",
"PlanDefinition:intendedAudience",
"PlanDefinition:modifier_role_reference",
"PlanDefinition:predecessor",
"PlanDefinition: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" : "_source",
"type" : "uri",
"documentation" : "Search for resources which have the given source value (Resource.meta.source)"
},
{
"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" : "base",
"type" : "token",
"documentation" : "Base of resource"
},
{
"name" : "baseEnvironment",
"type" : "token",
"documentation" : "Base Environment of resource"
},
{
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the activity definition"
},
{
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the activity definition"
},
{
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the activity definition"
},
{
"name" : "date",
"type" : "date",
"documentation" : "The activity definition 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 activity definition"
},
{
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the activity definition is intended to be in use"
},
{
"name" : "ehealthPredecessor",
"type" : "token",
"documentation" : "Predecessor of resource"
},
{
"name" : "employeeTitle",
"type" : "string",
"documentation" : "Title intented for clinicians"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the activity definition"
},
{
"name" : "intendedAudience",
"type" : "reference",
"documentation" : "The intended audience of the plan definition"
},
{
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the activity definition"
},
{
"name" : "modifier_role_reference",
"type" : "reference",
"documentation" : "Reference to either Organization, CareTeam, Practitioner"
},
{
"name" : "modifier_role_role",
"type" : "token",
"documentation" : "Role of Organization, CareTeam, Practitioner"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the activity definition"
},
{
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the activity definition"
},
{
"name" : "recommendation",
"type" : "token",
"documentation" : "Recommendation for the plan definition"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The current status of the activity definition"
},
{
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the activity definition"
},
{
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the activity definition"
},
{
"name" : "version",
"type" : "token",
"documentation" : "The business version of the activity definition"
}
],
"operation" : [
{
"name" : "validate",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
},
{
"name" : "create-clone",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/ActivityDefinitionPlanDefinition-i-create-clone",
"documentation" : "### Input\n- resourceId: reference to the ActivityDefinition resource that should be cloned\n- clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation \n- default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned \n- deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.\n\n### Output\nBundle containing all resources that were created during the operation.\n\n### Validation\n- New business versions require that the user has modifier-role: owner or co-author for the resource\n- New copy does not require that the user has a modifier-role.\n- New business version can be made only when no draft resource exists (having identical base identifier).\n- Read/search/create privileges are required for the resource types affected by $create-clone"
}
]
},
{
"type" : "DocumentReference",
"profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "vread"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"searchInclude" : [
"*",
"DocumentReference:authenticator",
"DocumentReference:author",
"DocumentReference:custodian",
"DocumentReference:encounter",
"DocumentReference:patient",
"DocumentReference:related",
"DocumentReference:relatesto",
"DocumentReference:subject"
],
"searchRevInclude" : [
"ActivityDefinition:composed-of",
"ActivityDefinition:depends-on",
"ActivityDefinition:derived-from",
"ActivityDefinition:intendedAudience",
"ActivityDefinition:modifier_role_reference",
"ActivityDefinition:predecessor",
"ActivityDefinition:successor",
"DocumentReference:authenticator",
"DocumentReference:author",
"DocumentReference:custodian",
"DocumentReference:encounter",
"DocumentReference:patient",
"DocumentReference:related",
"DocumentReference:relatesto",
"DocumentReference:subject",
"PlanDefinition:composed-of",
"PlanDefinition:definition",
"PlanDefinition:depends-on",
"PlanDefinition:derived-from",
"PlanDefinition:documentation",
"PlanDefinition:intendedAudience",
"PlanDefinition:modifier_role_reference",
"PlanDefinition:predecessor",
"PlanDefinition:successor"
],
"searchParam" : [
{
"name" : "_content",
"type" : "string",
"documentation" : "Search the contents of the resource's data using a fulltext search"
},
{
"name" : "_filter",
"type" : "string",
"documentation" : "Search the contents of the resource's data using a filter"
},
{
"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" : "_source",
"type" : "uri",
"documentation" : "Search for resources which have the given source value (Resource.meta.source)"
},
{
"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" : "authenticator",
"type" : "reference",
"documentation" : "Who/what authenticated the document"
},
{
"name" : "author",
"type" : "reference",
"documentation" : "Who and/or what authored the document"
},
{
"name" : "category",
"type" : "token",
"documentation" : "Categorization of document"
},
{
"name" : "contenttype",
"type" : "token",
"documentation" : "Mime type of the content, with charset etc."
},
{
"name" : "custodian",
"type" : "reference",
"documentation" : "Organization which maintains the document"
},
{
"name" : "date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"name" : "description",
"type" : "string",
"documentation" : "Human-readable description"
},
{
"name" : "encounter",
"type" : "reference",
"documentation" : "Context of the document content"
},
{
"name" : "event",
"type" : "token",
"documentation" : "Main clinical acts documented"
},
{
"name" : "facility",
"type" : "token",
"documentation" : "Kind of facility where patient was seen"
},
{
"name" : "format",
"type" : "token",
"documentation" : "Format/content rules for the document"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "Master Version Specific Identifier"
},
{
"name" : "language",
"type" : "token",
"documentation" : "Human language of the content (BCP-47)"
},
{
"name" : "location",
"type" : "uri",
"documentation" : "Uri where the data can be found"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"name" : "related",
"type" : "reference",
"documentation" : "Related identifiers or resources"
},
{
"name" : "relatesto",
"type" : "reference",
"documentation" : "Target of the relationship"
},
{
"name" : "relation",
"type" : "token",
"documentation" : "replaces | transforms | signs | appends"
},
{
"name" : "relationship",
"type" : "composite",
"documentation" : "Combination of relation and relatesTo"
},
{
"name" : "security-label",
"type" : "token",
"documentation" : "Document security-tags"
},
{
"name" : "setting",
"type" : "token",
"documentation" : "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"name" : "status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
},
{
"name" : "subject",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"name" : "type",
"type" : "token",
"documentation" : "Kind of document (LOINC if possible)"
}
],
"operation" : [
{
"name" : "validate",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
}
]
},
{
"type" : "OperationDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/OperationDefinition",
"interaction" : [
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"ActivityDefinition:composed-of",
"ActivityDefinition:depends-on",
"ActivityDefinition:derived-from",
"ActivityDefinition:intendedAudience",
"ActivityDefinition:modifier_role_reference",
"ActivityDefinition:predecessor",
"ActivityDefinition:successor",
"DocumentReference:authenticator",
"DocumentReference:author",
"DocumentReference:custodian",
"DocumentReference:encounter",
"DocumentReference:patient",
"DocumentReference:related",
"DocumentReference:relatesto",
"DocumentReference:subject",
"PlanDefinition:composed-of",
"PlanDefinition:definition",
"PlanDefinition:depends-on",
"PlanDefinition:derived-from",
"PlanDefinition:documentation",
"PlanDefinition:intendedAudience",
"PlanDefinition:modifier_role_reference",
"PlanDefinition:predecessor",
"PlanDefinition:successor"
]
},
{
"type" : "PlanDefinition",
"profile" : "http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition",
"interaction" : [
{
"code" : "update"
},
{
"code" : "search-type"
},
{
"code" : "vread"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"conditionalCreate" : true,
"conditionalUpdate" : true,
"searchInclude" : [
"*",
"PlanDefinition:composed-of",
"PlanDefinition:definition",
"PlanDefinition:depends-on",
"PlanDefinition:derived-from",
"PlanDefinition:documentation",
"PlanDefinition:predecessor",
"PlanDefinition:successor"
],
"searchRevInclude" : [
"ActivityDefinition:composed-of",
"ActivityDefinition:depends-on",
"ActivityDefinition:derived-from",
"ActivityDefinition:intendedAudience",
"ActivityDefinition:modifier_role_reference",
"ActivityDefinition:predecessor",
"ActivityDefinition:successor",
"DocumentReference:authenticator",
"DocumentReference:author",
"DocumentReference:custodian",
"DocumentReference:encounter",
"DocumentReference:patient",
"DocumentReference:related",
"DocumentReference:relatesto",
"DocumentReference:subject",
"PlanDefinition:composed-of",
"PlanDefinition:definition",
"PlanDefinition:depends-on",
"PlanDefinition:derived-from",
"PlanDefinition:documentation",
"PlanDefinition:intendedAudience",
"PlanDefinition:modifier_role_reference",
"PlanDefinition:predecessor",
"PlanDefinition: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" : "_source",
"type" : "uri",
"documentation" : "Search for resources which have the given source value (Resource.meta.source)"
},
{
"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" : "base",
"type" : "token",
"documentation" : "Base of resource"
},
{
"name" : "baseEnvironment",
"type" : "token",
"documentation" : "Base Environment of resource"
},
{
"name" : "composed-of",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "context",
"type" : "token",
"documentation" : "A use context assigned to the plan definition"
},
{
"name" : "context-quantity",
"type" : "quantity",
"documentation" : "A quantity- or range-valued use context assigned to the plan definition"
},
{
"name" : "context-type",
"type" : "token",
"documentation" : "A type of use context assigned to the plan definition"
},
{
"name" : "date",
"type" : "date",
"documentation" : "The plan definition publication date"
},
{
"name" : "definition",
"type" : "reference",
"documentation" : "Activity or plan definitions used by plan definition"
},
{
"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 plan definition"
},
{
"name" : "documentation",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "effective",
"type" : "date",
"documentation" : "The time during which the plan definition is intended to be in use"
},
{
"name" : "ehealthPredecessor",
"type" : "token",
"documentation" : "Predecessor of resource"
},
{
"name" : "employeeTitle",
"type" : "string",
"documentation" : "Title intented for clinicians"
},
{
"name" : "identifier",
"type" : "token",
"documentation" : "External identifier for the plan definition"
},
{
"name" : "intendedAudience",
"type" : "reference",
"documentation" : "The intended audience of the plan definition"
},
{
"name" : "jurisdiction",
"type" : "token",
"documentation" : "Intended jurisdiction for the plan definition"
},
{
"name" : "modifier_role_reference",
"type" : "reference",
"documentation" : "Reference to either Organization, CareTeam, Practitioner"
},
{
"name" : "modifier_role_role",
"type" : "token",
"documentation" : "Role of Organization, CareTeam, Practitioner"
},
{
"name" : "name",
"type" : "string",
"documentation" : "Computationally friendly name of the plan definition"
},
{
"name" : "predecessor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "publisher",
"type" : "string",
"documentation" : "Name of the publisher of the plan definition"
},
{
"name" : "recommendation",
"type" : "token",
"documentation" : "Recommendation for the plan definition"
},
{
"name" : "status",
"type" : "token",
"documentation" : "The current status of the plan definition"
},
{
"name" : "successor",
"type" : "reference",
"documentation" : "What resource is being referenced"
},
{
"name" : "title",
"type" : "string",
"documentation" : "The human-friendly name of the plan definition"
},
{
"name" : "topic",
"type" : "token",
"documentation" : "Topics associated with the module"
},
{
"name" : "type",
"type" : "token",
"documentation" : "The type of artifact the plan (e.g. order-set, eca-rule, protocol)"
},
{
"name" : "url",
"type" : "uri",
"documentation" : "The uri that identifies the plan definition"
},
{
"name" : "version",
"type" : "token",
"documentation" : "The business version of the plan definition"
}
],
"operation" : [
{
"name" : "validate",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"
},
{
"name" : "import",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-t-import",
"documentation" : "Import a Plandefinition\n### Parameters\n- planDefinitionPackage: Binary package produced by the export operation\n### Output\nBundle containing the created resources. PlanDefinitions, ActivityDefinitions, and Questionnaires will be created. Imports QFFD DocumentReference into Document-Transformation service.Libraries and Organizations are used to find the corresponding resources on the target system."
},
{
"name" : "export",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-i-export",
"documentation" : "Export a PlanDefinition.\n### Export Contents\nThe export contains the PlanDefinition including referenced resources:- PlanDefinitions\n- ActivityDefinitions\n- Questionnaires\n- Libraries\n- Organizations\n- DocumentReference + QFDD\n\nEach resource is returned in a separate JSon file.\n### Parameters\n- exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.\n### Output\nOutput can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files.\nAll returned objects are Fhir resources. See the implementation guide for details"
},
{
"name" : "create-clone",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/ActivityDefinitionPlanDefinition-i-create-clone",
"documentation" : "### Input\n- resourceId: reference to the PlanDefinition resource that should be cloned\n- clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation \n- default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned \n- deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.\n\n### Output\nBundle containing all resources that were created during the operation.\n\n### Validation\n- New business versions require that the user has modifier-role: owner or co-author for the resource\n- New copy does not require that the user has a modifier-role.\n- New business version can be made only when no draft resource exists (having identical base identifier).\n- Read/search/create privileges are required for the resource types affected by $create-clone"
},
{
"name" : "apply",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/PlanDefinition-i-apply",
"documentation" : "Create a careplan for a specific episodeOfCare using this PlanDefinition as a template."
}
]
}
],
"interaction" : [
{
"code" : "transaction"
},
{
"code" : "history-system"
}
],
"operation" : [
{
"name" : "migrate-list",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-migrate-list",
"documentation" : "Data migration"
},
{
"name" : "migrate",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-migrate",
"documentation" : "Data migration"
},
{
"name" : "process-message",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-process-message",
"documentation" : "Accept a FHIR Message Bundle for processing"
},
{
"name" : "perform-reindexing-pass",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass",
"documentation" : "Forces a single pass of the resource reindexing processor"
},
{
"name" : "meta",
"definition" : "https://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"
},
{
"name" : "get-resource-counts",
"definition" : "https://plan.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://plan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"
}
]
}
]
}