eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.4.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/fut-infrastructure/implementation-guide/ and changes regularly. See the Directory of published versions
Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/plan | Version: 3.4.0 | |||
Active as of 2025-02-06 | Computable Name: plan |
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement plan
application/fhir+xml
, xml
, application/fhir+json
, json
, application/x-turtle
, ttl
, html/json
, html/xml
, html/turtle
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.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|
ActivityDefinition | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-activitydefinition | y | y | y | y | y | _content, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, context-type-value, 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 | ActivityDefinition:composed-of , ActivityDefinition:depends-on , ActivityDefinition:derived-from , ActivityDefinition:predecessor , ActivityDefinition:successor | 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 | $validate , $create-clone |
DocumentReference | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-documentreference | y | y | y | y | y | _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, use-context-context, use-context-context-type, use-context-context-type-value | * , DocumentReference:authenticator , DocumentReference:author , DocumentReference:custodian , DocumentReference:encounter , DocumentReference:patient , DocumentReference:related , DocumentReference:relatesto , DocumentReference:subject | 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 | $validate |
OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y | * | 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 | ||||||
PlanDefinition | http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-plandefinition | y | y | y | y | y | _content, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, base, baseEnvironment, composed-of, context, context-quantity, context-type, context-type-value, 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 | * , PlanDefinition:composed-of , PlanDefinition:definition , PlanDefinition:depends-on , PlanDefinition:derived-from , PlanDefinition:documentation , PlanDefinition:predecessor , PlanDefinition:successor | 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 | $validate , $import , $export , $create-clone , $apply |
update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _id | token | The ID of the resource |
SHALL | _language | string | The language of the resource |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search |
SHALL | base | token | Base of resource |
SHALL | baseEnvironment | token | Base Environment of resource |
SHALL | composed-of | reference | What resource is being referenced |
SHALL | context | token | A use context assigned to the activity definition |
SHALL | context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
SHALL | context-type | token | A type of use context assigned to the activity definition |
SHALL | context-type-value | composite | A use context type and value assigned to the activity definition |
SHALL | date | date | The activity definition publication date |
SHALL | depends-on | reference | What resource is being referenced |
SHALL | derived-from | reference | What resource is being referenced |
SHALL | description | string | The description of the activity definition |
SHALL | effective | date | The time during which the activity definition is intended to be in use |
SHALL | ehealthPredecessor | token | Predecessor of resource |
SHALL | employeeTitle | string | Title intented for clinicians |
SHALL | identifier | token | External identifier for the activity definition |
SHALL | intendedAudience | reference | The intended audience of the plan definition |
SHALL | jurisdiction | token | Intended jurisdiction for the activity definition |
SHALL | modifier_role_reference | reference | Reference to either Organization, CareTeam, Practitioner |
SHALL | modifier_role_role | token | Role of Organization, CareTeam, Practitioner |
SHALL | name | string | Computationally friendly name of the activity definition |
SHALL | predecessor | reference | What resource is being referenced |
SHALL | publisher | string | Name of the publisher of the activity definition |
SHALL | recommendation | token | Recommendation for the plan definition |
SHALL | status | token | The current status of the activity definition |
SHALL | successor | reference | What resource is being referenced |
SHALL | title | string | The human-friendly name of the activity definition |
SHALL | topic | token | Topics associated with the module |
SHALL | url | uri | The uri that identifies the activity definition |
SHALL | version | token | The business version of the activity definition |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $create-clone | Input
OutputBundle containing all resources that were created during the operation. Validation
|
update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | _filter | string | Search the contents of the resource's data using a filter |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _id | token | The ID of the resource |
SHALL | _language | string | The language of the resource |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search |
SHALL | authenticator | reference | Who/what authenticated the document |
SHALL | author | reference | Who and/or what authored the document |
SHALL | category | token | Categorization of document |
SHALL | contenttype | token | Mime type of the content, with charset etc. |
SHALL | custodian | reference | Organization which maintains the document |
SHALL | date | date | When this document reference was created |
SHALL | description | string | Human-readable description |
SHALL | encounter | reference | Context of the document content |
SHALL | event | token | Main clinical acts documented |
SHALL | facility | token | Kind of facility where patient was seen |
SHALL | format | token | Format/content rules for the document |
SHALL | identifier | token | Master Version Specific Identifier |
SHALL | language | token | Human language of the content (BCP-47) |
SHALL | location | uri | Uri where the data can be found |
SHALL | patient | reference | Who/what is the subject of the document |
SHALL | period | date | Time of service that is being documented |
SHALL | related | reference | Related identifiers or resources |
SHALL | relatesto | reference | Target of the relationship |
SHALL | relation | token | replaces | transforms | signs | appends |
SHALL | relationship | composite | Combination of relation and relatesTo |
SHALL | security-label | token | Document security-tags |
SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
SHALL | status | token | current | superseded | entered-in-error |
SHALL | subject | reference | Who/what is the subject of the document |
SHALL | type | token | Kind of document (LOINC if possible) |
SHALL | use-context-context | token | A use context assigned to the DocumentReference |
SHALL | use-context-context-type | token | A type of use context assigned to the DocumentReference |
SHALL | use-context-context-type-value | composite | A use context type and value assigned to the DocumentReference |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate |
read
.update
, search-type
, vread
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _content | string | Search the contents of the resource's data using a fulltext search |
SHALL | _has | string | Return resources linked to by the given target |
SHALL | _id | token | The ID of the resource |
SHALL | _language | string | The language of the resource |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | _profile | uri | Search for resources which have the given profile |
SHALL | _security | token | Search for resources which have the given security labels |
SHALL | _source | uri | Search for resources which have the given source value (Resource.meta.source) |
SHALL | _tag | token | Search for resources which have the given tag |
SHALL | _text | string | Search the contents of the resource's narrative using a fulltext search |
SHALL | base | token | Base of resource |
SHALL | baseEnvironment | token | Base Environment of resource |
SHALL | composed-of | reference | What resource is being referenced |
SHALL | context | token | A use context assigned to the plan definition |
SHALL | context-quantity | quantity | A quantity- or range-valued use context assigned to the plan definition |
SHALL | context-type | token | A type of use context assigned to the plan definition |
SHALL | context-type-value | composite | A use context type and value assigned to the plan definition |
SHALL | date | date | The plan definition publication date |
SHALL | definition | reference | Activity or plan definitions used by plan definition |
SHALL | depends-on | reference | What resource is being referenced |
SHALL | derived-from | reference | What resource is being referenced |
SHALL | description | string | The description of the plan definition |
SHALL | documentation | reference | What resource is being referenced |
SHALL | effective | date | The time during which the plan definition is intended to be in use |
SHALL | ehealthPredecessor | token | Predecessor of resource |
SHALL | employeeTitle | string | Title intented for clinicians |
SHALL | identifier | token | External identifier for the plan definition |
SHALL | intendedAudience | reference | The intended audience of the plan definition |
SHALL | jurisdiction | token | Intended jurisdiction for the plan definition |
SHALL | modifier_role_reference | reference | Reference to either Organization, CareTeam, Practitioner |
SHALL | modifier_role_role | token | Role of Organization, CareTeam, Practitioner |
SHALL | name | string | Computationally friendly name of the plan definition |
SHALL | predecessor | reference | What resource is being referenced |
SHALL | publisher | string | Name of the publisher of the plan definition |
SHALL | recommendation | token | Recommendation for the plan definition |
SHALL | status | token | The current status of the plan definition |
SHALL | successor | reference | What resource is being referenced |
SHALL | title | string | The human-friendly name of the plan definition |
SHALL | topic | token | Topics associated with the module |
SHALL | type | token | The type of artifact the plan (e.g. order-set, eca-rule, protocol) |
SHALL | url | uri | The uri that identifies the plan definition |
SHALL | version | token | The business version of the plan definition |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $validate | |
SHALL | $import | Import a Plandefinition Parameters
OutputBundle 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 ContentsThe export contains the PlanDefinition including referenced resources:- PlanDefinitions
Each resource is returned in a separate JSon file. Parameters
OutputOutput 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
OutputBundle containing all resources that were created during the operation. Validation
|
SHALL | $apply | Create a careplan for a specific episodeOfCare using this PlanDefinition as a template. |