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 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, _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, 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 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 *, 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 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, _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: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 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 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 _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 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 Extended Operations Conformance Operation Documentation 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 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) Extended Operations Conformance Operation Documentation 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 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 _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 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 url uri The uri that identifies the plan definition SHALL version token The business version of the plan definition Extended Operations Conformance Operation Documentation 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.
Den telemedicinske infrastruktur (eHealth Infrastructure)
Search the contents of the resource's data using a fulltext search
Return resources linked to by the given target
Only return resources which were last updated as specified by the given range
Search for resources which have the given profile
Search for resources which have the given security labels
Search for resources which have the given tag
Search the contents of the resource's narrative using a fulltext search
The activity definition publication date
The description of the activity definition
The time during which the activity definition is intended to be in use
External identifier for the activity definition
The intended audience of the plan definition
Intended jurisdiction for the activity definition
Reference to either Organization, CareTeam, Practitioner
Role of Organization, CareTeam, Practitioner
Computationally friendly name of the activity definition
Name of the publisher of the activity definition
The current status of the activity definition
The human-friendly name of the activity definition
The uri that identifies the activity definition
The business version of the activity definition
### 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
Search the contents of the resource's data using a filter
Search for resources which have the given source value (Resource.meta.source)
Mime type of the content, with charset etc.
Organization which maintains the document
When this document reference was created
Time of service that is being documented
Additional details about where the content was created (e.g. clinical specialty)
Activity or plan definitions used by plan definition
The time during which the plan definition is intended to be in use
External identifier for the plan definition
Intended jurisdiction for the plan definition
Computationally friendly name of the plan definition
Name of the publisher of the plan definition
The current status of the plan definition
The human-friendly name of the plan definition
The uri that identifies the plan definition
The business version of the plan definition
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.
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
### 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
Create a careplan for a specific episodeOfCare using this PlanDefinition as a template.
Accept a FHIR Message Bundle for processing
Forces a single pass of the resource reindexing processor
Provides the number of resources currently stored on the server, broken down by resource type