eHealth Infrastructure
3.0.0 - release

eHealth Infrastructure - Local Development build (v3.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: plan

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/plan Version: 3.0.0
Active as of 2024-02-04 Computable Name: plan

Raw OpenAPI-Swagger Definition file | Download

  • Implementation Guide Version: 3.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, xml, application/fhir+json, json, application/x-turtle, ttl, html/json, html/xml, html/turtle
  • Supported Patch Formats:
  • Published on: Sun Feb 04 02:42:24 UTC 2024
  • Published by: Den telemedicinske infrastruktur (eHealth Infrastructure)

Note to Implementers: FHIR Capabilities

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

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions
  • Supports the transaction interaction.
  • Supports the history-system interaction.

Capabilities by Resource/Profile

Summary

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

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUCSearches_include_revincludeOperations
ActivityDefinitionhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinitionyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, base, baseEnvironment, composed-of, 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, versionActivityDefinition:composed-of, ActivityDefinition:depends-on, ActivityDefinition:derived-from, ActivityDefinition:predecessor, ActivityDefinition:successorActivityDefinition: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
DocumentReferencehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreferenceyyyyy_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*, DocumentReference:authenticator, DocumentReference:author, DocumentReference:custodian, DocumentReference:encounter, DocumentReference:patient, DocumentReference:related, DocumentReference:relatesto, DocumentReference:subjectActivityDefinition: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
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*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
PlanDefinitionhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinitionyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, base, baseEnvironment, composed-of, 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, url, version*, PlanDefinition:composed-of, PlanDefinition:definition, PlanDefinition:depends-on, PlanDefinition:derived-from, PlanDefinition:documentation, PlanDefinition:predecessor, PlanDefinition:successorActivityDefinition: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

Resource Conformance: supportedActivityDefinition

Base System Profile
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLbasetoken

Base of resource

SHALLbaseEnvironmenttoken

Base Environment of resource

SHALLcomposed-ofreference

What resource is being referenced

SHALLdatedate

The activity definition publication date

SHALLdepends-onreference

What resource is being referenced

SHALLderived-fromreference

What resource is being referenced

SHALLdescriptionstring

The description of the activity definition

SHALLeffectivedate

The time during which the activity definition is intended to be in use

SHALLehealthPredecessortoken

Predecessor of resource

SHALLemployeeTitlestring

Title intented for clinicians

SHALLidentifiertoken

External identifier for the activity definition

SHALLintendedAudiencereference

The intended audience of the plan definition

SHALLjurisdictiontoken

Intended jurisdiction for the activity definition

SHALLmodifier_role_referencereference

Reference to either Organization, CareTeam, Practitioner

SHALLmodifier_role_roletoken

Role of Organization, CareTeam, Practitioner

SHALLnamestring

Computationally friendly name of the activity definition

SHALLpredecessorreference

What resource is being referenced

SHALLpublisherstring

Name of the publisher of the activity definition

SHALLrecommendationtoken

Recommendation for the plan definition

SHALLstatustoken

The current status of the activity definition

SHALLsuccessorreference

What resource is being referenced

SHALLtitlestring

The human-friendly name of the activity definition

SHALLtopictoken

Topics associated with the module

SHALLurluri

The uri that identifies the activity definition

SHALLversiontoken

The business version of the activity definition

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$create-clone

Input

  • resourceId: reference to the ActivityDefinition resource that should be cloned
  • clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation
  • default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned
  • deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.

Output

Bundle containing all resources that were created during the operation.

Validation

  • New business versions require that the user has modifier-role: owner or co-author for the resource
  • New copy does not require that the user has a modifier-role.
  • New business version can be made only when no draft resource exists (having identical base identifier).
  • Read/search/create privileges are required for the resource types affected by $create-clone

Resource Conformance: supportedDocumentReference

Base System Profile
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_filterstring

Search the contents of the resource's data using a filter

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_sourceuri

Search for resources which have the given source value (Resource.meta.source)

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLauthenticatorreference

Who/what authenticated the document

SHALLauthorreference

Who and/or what authored the document

SHALLcategorytoken

Categorization of document

SHALLcontenttypetoken

Mime type of the content, with charset etc.

SHALLcustodianreference

Organization which maintains the document

SHALLdatedate

When this document reference was created

SHALLdescriptionstring

Human-readable description

SHALLencounterreference

Context of the document content

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

Master Version Specific Identifier

SHALLlanguagetoken

Human language of the content (BCP-47)

SHALLlocationuri

Uri where the data can be found

SHALLpatientreference

Who/what is the subject of the document

SHALLperioddate

Time of service that is being documented

SHALLrelatedreference

Related identifiers or resources

SHALLrelatestoreference

Target of the relationship

SHALLrelationtoken

replaces | transforms | signs | appends

SHALLrelationshipcomposite

Combination of relation and relatesTo

SHALLsecurity-labeltoken

Document security-tags

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLsubjectreference

Who/what is the subject of the document

SHALLtypetoken

Kind of document (LOINC if possible)

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supportedOperationDefinition

Base System Profile
http://hl7.org/fhir/StructureDefinition/OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supportedPlanDefinition

Base System Profile
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_contentstring

Search the contents of the resource's data using a fulltext search

SHALL_hasstring

Return resources linked to by the given target

SHALL_idtoken

The ID of the resource

SHALL_languagestring

The language of the resource

SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALL_profileuri

Search for resources which have the given profile

SHALL_securitytoken

Search for resources which have the given security labels

SHALL_tagtoken

Search for resources which have the given tag

SHALL_textstring

Search the contents of the resource's narrative using a fulltext search

SHALLbasetoken

Base of resource

SHALLbaseEnvironmenttoken

Base Environment of resource

SHALLcomposed-ofreference

What resource is being referenced

SHALLdatedate

The plan definition publication date

SHALLdefinitionreference

Activity or plan definitions used by plan definition

SHALLdepends-onreference

What resource is being referenced

SHALLderived-fromreference

What resource is being referenced

SHALLdescriptionstring

The description of the plan definition

SHALLdocumentationreference

What resource is being referenced

SHALLeffectivedate

The time during which the plan definition is intended to be in use

SHALLehealthPredecessortoken

Predecessor of resource

SHALLemployeeTitlestring

Title intented for clinicians

SHALLidentifiertoken

External identifier for the plan definition

SHALLintendedAudiencereference

The intended audience of the plan definition

SHALLjurisdictiontoken

Intended jurisdiction for the plan definition

SHALLmodifier_role_referencereference

Reference to either Organization, CareTeam, Practitioner

SHALLmodifier_role_roletoken

Role of Organization, CareTeam, Practitioner

SHALLnamestring

Computationally friendly name of the plan definition

SHALLpredecessorreference

What resource is being referenced

SHALLpublisherstring

Name of the publisher of the plan definition

SHALLrecommendationtoken

Recommendation for the plan definition

SHALLstatustoken

The current status of the plan definition

SHALLsuccessorreference

What resource is being referenced

SHALLtitlestring

The human-friendly name of the plan definition

SHALLtopictoken

Topics associated with the module

SHALLurluri

The uri that identifies the plan definition

SHALLversiontoken

The business version of the plan definition

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$import

Import a Plandefinition

Parameters

  • planDefinitionPackage: Binary package produced by the export operation

Output

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.

SHALL$export

Export a PlanDefinition.

Export Contents

The export contains the PlanDefinition including referenced resources:- PlanDefinitions

  • ActivityDefinitions
  • Questionnaires
  • Libraries
  • Organizations
  • DocumentReference + QFDD

Each resource is returned in a separate JSon file.

Parameters

  • exclude: references to ActivityDefinitions or PlanDefinitions to exclude from the export.

Output

Output can be found in Binary.content. This is a Base64 encoded .zip file containing JSon files. All returned objects are Fhir resources. See the implementation guide for details

SHALL$create-clone

Input

  • resourceId: reference to the PlanDefinition resource that should be cloned
  • clone_operation: minor-version/major-version/copy Coding from codesystem: http://ehealth.sundhed.dk/cs/ehealth-clone-operation
  • default-clone-behavior: true/false. False signifies deep-clone mode where the list of deep-clone-references determine which resources should be cloned
  • deep-clone-references: References to resources to create as new resources rather than referencing the existing ones.

Output

Bundle containing all resources that were created during the operation.

Validation

  • New business versions require that the user has modifier-role: owner or co-author for the resource
  • New copy does not require that the user has a modifier-role.
  • New business version can be made only when no draft resource exists (having identical base identifier).
  • Read/search/create privileges are required for the resource types affected by $create-clone
SHALL$apply

Create a careplan for a specific episodeOfCare using this PlanDefinition as a template.