eHealth Infrastructure
3.3.0 - ci-build Denmark flag

eHealth Infrastructure, published by Den telemedicinske infrastruktur (eHealth Infrastructure). This guide is not an authorized publication; it is the continuous build for version 3.3.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

CapabilityStatement: careplan

Official URL: http://ehealth.sundhed.dk/fhir/CapabilityStatement/careplan Version: 3.3.0
Active as of 2024-10-28 Computable Name: careplan

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement careplan

  • Implementation Guide Version: 3.3.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: 2024-10-28 02:03:02+0000
  • 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 transactioninteraction.
  • Supports the history-systeminteraction.

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-RSUPCDSearches_include_revincludeOperations
CarePlanhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplanyyyy_id, _lastUpdated, _tag, activity-reference, care-team, category, condition, date, episodeOfCare, goal, identifier, instantiates-canonical, part-of, participant-actor, participant-function, participant-function-actor, patient, status, status-history-end-time, status-history-start-time, status-history-status, status-scheduled-status, status-scheduled-time, team-scheduled-timeCarePlan:activity-reference, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:part-ofCarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate, $update-care-teams, $suggest-care-teams
CommunicationRequesthttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-requestyyyyyy_content, _has, _id, _language, _lastUpdated, _profile, _security, _tag, _text, authored, based-on, category, encounter, episodeOfCare, group-identifier, identifier, medium, occurrence, patient, priority, reasonCode, recipient, replaces, requester, sender, status, subjectCommunicationRequest:based-on, CommunicationRequest:contextCarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate
Conditionhttp://hl7.org/fhir/StructureDefinition/Conditionyyyy*CarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate
Consenthttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consentyyyyydata, _tag, actor, category, identifier, patient, period, statusCarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate
EpisodeOfCarehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcareyyyy_tag, condition, identifier, organization, participant-actor, participant-function, participant-function-actor, patient, status, status-scheduled-time, team, team-scheduled-timeEpisodeOfCare:conditionCarePlan:episodeOfCare$validate, $update-care-teams, $is-context-allowed
Goalhttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-goalyyyyy_content, _filter, _has, _id, _language, _lastUpdated, _profile, _security, _source, _tag, _text, addresses, category, identifier, lifecycle-status, patient, start-date, subject, target-date*, Goal:patient, Goal:subjectCarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*CarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target
Provenancehttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenanceyyytarget, _tagCarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate
ServiceRequesthttp://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequestyyy*CarePlan:activity-reference, CarePlan:care-team, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:instantiates-canonical, CarePlan:part-of, CarePlan:participant-actor, CarePlan:patient, CommunicationRequest:based-on, CommunicationRequest:encounter, CommunicationRequest:episodeOfCare, CommunicationRequest:patient, CommunicationRequest:recipient, CommunicationRequest:replaces, CommunicationRequest:requester, CommunicationRequest:sender, CommunicationRequest:subject, Consent:actor, Consent:data, Consent:patient, EpisodeOfCare:condition, EpisodeOfCare:organization, EpisodeOfCare:participant-actor, EpisodeOfCare:patient, EpisodeOfCare:team, Goal:addresses, Goal:patient, Goal:subject, Provenance:target$validate

Resource Conformance: supported CarePlan

Base System Profile
ehealth-careplan
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

The ID of the resource

SHALL_lastUpdateddate

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

SHALL_tagtoken

Search for resources which have the given tag

SHALLactivity-referencereference

Activity details defined in specific resource

SHALLcare-teamreference

Who's involved in plan?

SHALLcategorytoken

Type of plan

SHALLconditionreference

Health issues this plan addresses

SHALLdatedate

Time period plan covers

SHALLepisodeOfCarereference

EpisodeOfCare

SHALLgoalreference

Goal of the care plan

SHALLidentifiertoken

External Ids for this plan

SHALLinstantiates-canonicalreference

Instantiates FHIR protocol or definition

SHALLpart-ofreference

Part of referenced CarePlan

SHALLparticipant-actorreference

Reference to the participant

SHALLparticipant-functiontoken

The role of the participant

SHALLparticipant-function-actorcomposite

A Participant with a specific function and actor

SHALLpatientreference

Who care plan is for

SHALLstatustoken

draft | active | suspended | completed | entered-in-error | cancelled | unknown

SHALLstatus-history-end-timedate

end time of historic status change

SHALLstatus-history-start-timedate

start time of historic status change

SHALLstatus-history-statustoken

status of historic status change

SHALLstatus-scheduled-statustoken

Scheduled status for status change

SHALLstatus-scheduled-timedate

Scheduled time for status change

SHALLteam-scheduled-timedate

Scheduled time for team change

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$update-care-teams

The operation modifies the care team assignment of the care plan and all of its sub plans.

SHALL$suggest-care-teams

Suggest care teams matching the conditions required by the care plan on either a regional or a municipality level. The suggested care teams has reason codes matching all the conditions addressed by the care plan and has a managing organization matching the input region code or municipality code. One of region code or municipality code must be input. If both region code and municipality code is input, then the municipality code is ignored. Return a bundle with matching care teams and their managing organizations.

Resource Conformance: supported CommunicationRequest

Base System Profile
ehealth-communication-request
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, search-type, vread, read, delete, 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

SHALLauthoreddate

When request transitioned to being actionable

SHALLbased-onreference

Fulfills plan or proposal

SHALLcategorytoken

Message category

SHALLencounterreference

Encounter leading to message

SHALLepisodeOfCarereference

Episode leading to message

SHALLgroup-identifiertoken

Composite request this is part of

SHALLidentifiertoken

Unique identifier

SHALLmediumtoken

A channel of communication

SHALLoccurrencedate

When scheduled

SHALLpatientreference

Focus of message

SHALLprioritytoken

Message urgency

SHALLreasonCodetoken

ReasonCode

SHALLrecipientreference

Message recipient

SHALLreplacesreference

Request(s) replaced by this request

SHALLrequesterreference

Individual making the request

SHALLsenderreference

Message sender

SHALLstatustoken

draft | active | suspended | cancelled | completed | entered-in-error | unknown

SHALLsubjectreference

Focus of message

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported Condition

Base System Profile
Condition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports vread, read, patch, create.

Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported Consent

Base System Profile
ehealth-consent
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLdatareference

The actual data reference

SHALL_tagtoken

Search for resources which have the given tag

SHALLactorreference

Resource for the actor (or group, by role)

SHALLcategorytoken

Classification of the consent statement - for indexing/retrieval

SHALLidentifiertoken

Identifier for this record (external references)

SHALLpatientreference

Who the consent applies to

SHALLperioddate

Period that this consent applies

SHALLstatustoken

draft | proposed | active | rejected | inactive | entered-in-error

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported EpisodeOfCare

Base System Profile
ehealth-episodeofcare
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, vread, read, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_tagtoken

Search for resources which have the given tag

SHALLconditionreference

Conditions/problems/diagnoses this episode of care is for

SHALLidentifiertoken

Business Identifier(s) relevant for this EpisodeOfCare

SHALLorganizationreference

The organization that has assumed the specific responsibilities of this EpisodeOfCare

SHALLparticipant-actorreference

The reference to the actor

SHALLparticipant-functiontoken

The role of the participant

SHALLparticipant-function-actorcomposite

A Participant with a specific function and actor

SHALLpatientreference

The patient who is the focus of this episode of care

SHALLstatustoken

The current status of the Episode of Care as provided (does not check the status history collection)

SHALLstatus-scheduled-timedate

Scheduled time for status change

SHALLteamreference

The list of practitioners that may be facilitating this episode of care for specific purposes.

SHALLteam-scheduled-timedate

Scheduled time for team change

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate
SHALL$update-care-teams

Modify the care team assignment of the episode of care and all care plans that has the episode of care as context.

SHALL$is-context-allowed

Checks that it is allowed to set an EpisodeOfCare as context. If the user requesting context is a patient, then the patient input parameter should be specified. If the user requesting context is a practitioner, then the careTeam input parameter should be specified. Throws an exception if it is not allowed to select the Episode Of Care context.

Output

For valid Episode of Care is returned references that cause the Episode of Care to be valid context. For a practitioner, two output parameters will be returned on success:

  • CareTeam: The Careteam that gave access
  • EpisodeOfCare/CarePlan: The EpisodeOfCare or CarePlan that referenced the CareTeam

Resource Conformance: supported Goal

Base System Profile
ehealth-goal
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

SHALLaddressesreference

What the goal addresses

SHALLcategorytoken

E.g. Treatment, dietary, behavioral, etc.

SHALLidentifiertoken

External Ids for this goal

SHALLlifecycle-statustoken

proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected

SHALLpatientreference

Who this goal is intended for

SHALLstart-datedate

When goal pursuit begins

SHALLsubjectreference

Who this goal is intended for

SHALLtarget-datedate

Reach goal on or before

 

Resource Conformance: supported OperationDefinition

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Provenance

Base System Profile
ehealth-provenance
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtargetreference

Target Reference(s) (usually version specific)

SHALL_tagtoken

Search for resources which have the given tag

 
Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Resource Conformance: supported ServiceRequest

Base System Profile
ehealth-servicerequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports update, vread, read.

Extended Operations
ConformanceOperationDocumentation
SHALL$validate

Operations

Use