eHealth Infrastructure
2.6.0 - Release 13
eHealth Infrastructure
2.6.0 - Release 13
eHealth Infrastructure - Local Development build (v2.6.0). See the Directory of published versions
| Active as of 2023-01-07 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="careplan"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><h2>careplan</h2><table><tr><td>Mode</td><td>SERVER</td></tr><tr><td>Description</td><td/></tr><tr><td>Transaction</td><td>y</td></tr><tr><td>System History</td><td>y</td></tr><tr><td>System Search</td><td></td></tr></table><table><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th><b title="GET a resource (read interaction)">Read</b></th><th><b title="GET past versions of resources (vread interaction)">V-Read</b></th><th><b title="GET all set of resources of the type (search interaction)">Search</b></th><th><b title="PUT a new resource version (update interaction)">Update</b></th><th><b title="PATCH a new resource version (patch interaction)">Patch</b></th><th><b title="POST a new resource (create interaction)">Create</b></th><th><b title="DELETE a resource (delete interaction)">Delete</b></th></tr><tr><td>CarePlan</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td></td><td></td></tr><tr><td>CommunicationRequest</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td>y</td></tr><tr><td>Condition</td><td><a href="http://hl7.org/fhir/StructureDefinition/Condition">http://hl7.org/fhir/StructureDefinition/Condition</a></td><td>y</td><td>y</td><td></td><td></td><td>y</td><td>y</td><td></td></tr><tr><td>Consent</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consent">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consent</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td></td></tr><tr><td>EpisodeOfCare</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare</a></td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td></td><td></td></tr><tr><td>Goal</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-goal">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-goal</a></td><td>y</td><td>y</td><td>y</td><td>y</td><td></td><td>y</td><td></td></tr><tr><td>OperationDefinition</td><td><a href="http://hl7.org/fhir/StructureDefinition/OperationDefinition">http://hl7.org/fhir/StructureDefinition/OperationDefinition</a></td><td>y</td><td></td><td></td><td></td><td></td><td></td><td></td></tr><tr><td>Provenance</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance</a></td><td>y</td><td>y</td><td>y</td><td></td><td></td><td></td><td></td></tr><tr><td>ServiceRequest</td><td><a href="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest">http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest</a></td><td>y</td><td>y</td><td></td><td>y</td><td></td><td></td><td></td></tr></table></div>
</text>
<url value="http://ehealth.sundhed.dk/fhir/CapabilityStatement/careplan"/>
<version value="2.6.0"/>
<name value="careplan"/>
<status value="active"/>
<date value="2023-01-07T02:02:35.982+00:00"/>
<publisher value="Systematic | Trifork"/>
<contact>
<name value="Systematic | Trifork"/>
<telecom>
<system value="url"/>
<value value="http://ehealth.sundhed.dk"/>
</telecom>
</contact>
<kind value="instance"/>
<software>
<name value="careplan"/>
<version value="1.15.1"/>
</software>
<implementation>
<description value="eHealth careplan service"/>
<url value="https://careplan.devtest.systematic-ehealth.com/fhir"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+xml"/>
<format value="xml"/>
<format value="application/fhir+json"/>
<format value="json"/>
<format value="application/x-turtle"/>
<format value="ttl"/>
<format value="html/json"/>
<format value="html/xml"/>
<format value="html/turtle"/>
<rest>
<mode value="server"/>
<resource>
<type value="CarePlan"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<conditionalUpdate value="true"/>
<searchInclude value="CarePlan:activity-reference"/>
<searchInclude value="CarePlan:episodeOfCare"/>
<searchInclude value="CarePlan:goal"/>
<searchInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<name value="_id"/>
<type value="token"/>
<documentation value="The ID of the resource"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="activity-reference"/>
<type value="reference"/>
<documentation value="Activity details defined in specific resource"/>
</searchParam>
<searchParam>
<name value="care-team"/>
<type value="reference"/>
<documentation value="Who's involved in plan?"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation value="Type of plan"/>
</searchParam>
<searchParam>
<name value="date"/>
<type value="date"/>
<documentation value="Time period plan covers"/>
</searchParam>
<searchParam>
<name value="episodeOfCare"/>
<type value="reference"/>
<documentation value="EpisodeOfCare"/>
</searchParam>
<searchParam>
<name value="goal"/>
<type value="reference"/>
<documentation value="Goal of the care plan"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation value="External Ids for this plan"/>
</searchParam>
<searchParam>
<name value="part-of"/>
<type value="reference"/>
<documentation value="Part of referenced CarePlan"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who care plan is for"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="draft | active | suspended | completed | entered-in-error | cancelled | unknown"/>
</searchParam>
<searchParam>
<name value="status-scheduled-time"/>
<type value="date"/>
<documentation value="Scheduled time for status change"/>
</searchParam>
<searchParam>
<name value="team-scheduled-time"/>
<type value="date"/>
<documentation value="Scheduled time for team change"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
<operation>
<name value="update-care-teams"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/CarePlanEpisodeOfCare-i-update-care-teams"/>
<documentation
value="The operation modifies the care team assignment of the care plan and all of its sub plans."/>
</operation>
<operation>
<name value="suggest-care-teams"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/CarePlan-i-suggest-care-teams"/>
<documentation
value="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."/>
</operation>
</resource>
<resource>
<type value="CommunicationRequest"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="delete"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<searchInclude value="CommunicationRequest:based-on"/>
<searchInclude value="CommunicationRequest:context"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<name value="_content"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a fulltext search"/>
</searchParam>
<searchParam>
<name value="_has"/>
<type value="string"/>
<documentation
value="Return resources linked to by the given target"/>
</searchParam>
<searchParam>
<name value="_id"/>
<type value="token"/>
<documentation value="The ID of the resource"/>
</searchParam>
<searchParam>
<name value="_language"/>
<type value="string"/>
<documentation value="The language of the resource"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<type value="date"/>
<documentation
value="Only return resources which were last updated as specified by the given range"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given profile"/>
</searchParam>
<searchParam>
<name value="_security"/>
<type value="token"/>
<documentation
value="Search for resources which have the given security labels"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="_text"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's narrative using a fulltext search"/>
</searchParam>
<searchParam>
<name value="authored"/>
<type value="date"/>
<documentation value="When request transitioned to being actionable"/>
</searchParam>
<searchParam>
<name value="based-on"/>
<type value="reference"/>
<documentation value="Fulfills plan or proposal"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation value="Message category"/>
</searchParam>
<searchParam>
<name value="encounter"/>
<type value="reference"/>
<documentation value="Encounter leading to message"/>
</searchParam>
<searchParam>
<name value="episodeOfCare"/>
<type value="reference"/>
<documentation value="Episode leading to message"/>
</searchParam>
<searchParam>
<name value="group-identifier"/>
<type value="token"/>
<documentation value="Composite request this is part of"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation value="Unique identifier"/>
</searchParam>
<searchParam>
<name value="medium"/>
<type value="token"/>
<documentation value="A channel of communication"/>
</searchParam>
<searchParam>
<name value="occurrence"/>
<type value="date"/>
<documentation value="When scheduled"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Focus of message"/>
</searchParam>
<searchParam>
<name value="priority"/>
<type value="token"/>
<documentation value="Message urgency"/>
</searchParam>
<searchParam>
<name value="reasonCode"/>
<type value="token"/>
<documentation value="ReasonCode"/>
</searchParam>
<searchParam>
<name value="recipient"/>
<type value="reference"/>
<documentation value="Message recipient"/>
</searchParam>
<searchParam>
<name value="replaces"/>
<type value="reference"/>
<documentation value="Request(s) replaced by this request"/>
</searchParam>
<searchParam>
<name value="requester"/>
<type value="reference"/>
<documentation value="Individual making the request"/>
</searchParam>
<searchParam>
<name value="sender"/>
<type value="reference"/>
<documentation value="Message sender"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="draft | active | suspended | cancelled | completed | entered-in-error | unknown"/>
</searchParam>
<searchParam>
<name value="subject"/>
<type value="reference"/>
<documentation value="Focus of message"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
</resource>
<resource>
<type value="Condition"/>
<profile value="http://hl7.org/fhir/StructureDefinition/Condition"/>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="patch"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<conditionalCreate value="true"/>
<searchInclude value="*"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
</resource>
<resource>
<type value="Consent"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consent"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<name value="data"/>
<type value="reference"/>
<documentation value="The actual data reference"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="actor"/>
<type value="reference"/>
<documentation value="Resource for the actor (or group, by role)"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation
value="Classification of the consent statement - for indexing/retrieval"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="Identifier for this record (external references)"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who the consent applies to"/>
</searchParam>
<searchParam>
<name value="period"/>
<type value="date"/>
<documentation value="Period that this consent applies"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="draft | proposed | active | rejected | inactive | entered-in-error"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
</resource>
<resource>
<type value="EpisodeOfCare"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare"/>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="patch"/>
</interaction>
<searchInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="condition"/>
<type value="reference"/>
<documentation
value="Conditions/problems/diagnoses this episode of care is for"/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation
value="Business Identifier(s) relevant for this EpisodeOfCare"/>
</searchParam>
<searchParam>
<name value="organization"/>
<type value="reference"/>
<documentation
value="The organization that has assumed the specific responsibilities of this EpisodeOfCare"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation
value="The patient who is the focus of this episode of care"/>
</searchParam>
<searchParam>
<name value="status"/>
<type value="token"/>
<documentation
value="The current status of the Episode of Care as provided (does not check the status history collection)"/>
</searchParam>
<searchParam>
<name value="status-scheduled-time"/>
<type value="date"/>
<documentation value="Scheduled time for status change"/>
</searchParam>
<searchParam>
<name value="team"/>
<type value="reference"/>
<documentation
value="The list of practitioners that may be facilitating this episode of care for specific purposes."/>
</searchParam>
<searchParam>
<name value="team-scheduled-time"/>
<type value="date"/>
<documentation value="Scheduled time for team change"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
<operation>
<name value="update-care-teams"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/CarePlanEpisodeOfCare-i-update-care-teams"/>
<documentation
value="Modify the care team assignment of the episode of care and all care plans that has the episode of care as context."/>
</operation>
<operation>
<name value="is-context-allowed"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/EpisodeOfCare-i-is-context-allowed"/>
<documentation
value="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"/>
</operation>
</resource>
<resource>
<type value="Goal"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-goal"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="create"/>
</interaction>
<conditionalCreate value="true"/>
<conditionalUpdate value="true"/>
<searchInclude value="*"/>
<searchInclude value="Goal:patient"/>
<searchInclude value="Goal:subject"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<name value="_content"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a fulltext search"/>
</searchParam>
<searchParam>
<name value="_filter"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's data using a filter"/>
</searchParam>
<searchParam>
<name value="_has"/>
<type value="string"/>
<documentation
value="Return resources linked to by the given target"/>
</searchParam>
<searchParam>
<name value="_id"/>
<type value="token"/>
<documentation value="The ID of the resource"/>
</searchParam>
<searchParam>
<name value="_language"/>
<type value="string"/>
<documentation value="The language of the resource"/>
</searchParam>
<searchParam>
<name value="_lastUpdated"/>
<type value="date"/>
<documentation
value="Only return resources which were last updated as specified by the given range"/>
</searchParam>
<searchParam>
<name value="_profile"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given profile"/>
</searchParam>
<searchParam>
<name value="_security"/>
<type value="token"/>
<documentation
value="Search for resources which have the given security labels"/>
</searchParam>
<searchParam>
<name value="_source"/>
<type value="uri"/>
<documentation
value="Search for resources which have the given source value (Resource.meta.source)"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<searchParam>
<name value="_text"/>
<type value="string"/>
<documentation
value="Search the contents of the resource's narrative using a fulltext search"/>
</searchParam>
<searchParam>
<name value="addresses"/>
<type value="reference"/>
<documentation value="What the goal addresses"/>
</searchParam>
<searchParam>
<name value="category"/>
<type value="token"/>
<documentation value="E.g. Treatment, dietary, behavioral, etc."/>
</searchParam>
<searchParam>
<name value="identifier"/>
<type value="token"/>
<documentation value="External Ids for this goal"/>
</searchParam>
<searchParam>
<name value="lifecycle-status"/>
<type value="token"/>
<documentation
value="proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected"/>
</searchParam>
<searchParam>
<name value="patient"/>
<type value="reference"/>
<documentation value="Who this goal is intended for"/>
</searchParam>
<searchParam>
<name value="start-date"/>
<type value="date"/>
<documentation value="When goal pursuit begins"/>
</searchParam>
<searchParam>
<name value="subject"/>
<type value="reference"/>
<documentation value="Who this goal is intended for"/>
</searchParam>
<searchParam>
<name value="target-date"/>
<type value="date"/>
<documentation value="Reach goal on or before"/>
</searchParam>
</resource>
<resource>
<type value="OperationDefinition"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/OperationDefinition"/>
<interaction>
<code value="read"/>
</interaction>
<searchInclude value="*"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
</resource>
<resource>
<type value="Provenance"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance"/>
<interaction>
<code value="search-type"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<name value="target"/>
<type value="reference"/>
<documentation
value="Target Reference(s) (usually version specific)"/>
</searchParam>
<searchParam>
<name value="_tag"/>
<type value="token"/>
<documentation value="Search for resources which have the given tag"/>
</searchParam>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
</resource>
<resource>
<type value="ServiceRequest"/>
<profile
value="http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest"/>
<interaction>
<code value="update"/>
</interaction>
<interaction>
<code value="vread"/>
</interaction>
<interaction>
<code value="read"/>
</interaction>
<conditionalUpdate value="true"/>
<searchInclude value="*"/>
<searchRevInclude value="CarePlan:activity-reference"/>
<searchRevInclude value="CarePlan:care-team"/>
<searchRevInclude value="CarePlan:episodeOfCare"/>
<searchRevInclude value="CarePlan:goal"/>
<searchRevInclude value="CarePlan:part-of"/>
<searchRevInclude value="CarePlan:patient"/>
<searchRevInclude value="CommunicationRequest:based-on"/>
<searchRevInclude value="CommunicationRequest:encounter"/>
<searchRevInclude value="CommunicationRequest:episodeOfCare"/>
<searchRevInclude value="CommunicationRequest:patient"/>
<searchRevInclude value="CommunicationRequest:recipient"/>
<searchRevInclude value="CommunicationRequest:replaces"/>
<searchRevInclude value="CommunicationRequest:requester"/>
<searchRevInclude value="CommunicationRequest:sender"/>
<searchRevInclude value="CommunicationRequest:subject"/>
<searchRevInclude value="Consent:actor"/>
<searchRevInclude value="Consent:data"/>
<searchRevInclude value="Consent:patient"/>
<searchRevInclude value="EpisodeOfCare:condition"/>
<searchRevInclude value="EpisodeOfCare:organization"/>
<searchRevInclude value="EpisodeOfCare:patient"/>
<searchRevInclude value="EpisodeOfCare:team"/>
<searchRevInclude value="Goal:addresses"/>
<searchRevInclude value="Goal:patient"/>
<searchRevInclude value="Goal:subject"/>
<searchRevInclude value="Provenance:target"/>
<operation>
<name value="validate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/Multi-it-validate"/>
</operation>
</resource>
<interaction>
<code value="transaction"/>
</interaction>
<interaction>
<code value="history-system"/>
</interaction>
<operation>
<name value="migrate"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-migrate"/>
<documentation value="Data migration"/>
</operation>
<operation>
<name value="get-patient-procedures"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-patient-procedures"/>
<documentation
value="This operation returns an overview of patient activities within a time period and filtered by either EpisodeOfCare or Condition code(s). On success, the returned Bundle contains a Parameters structure detailing the count of measurements received and expected. This is done per ServiceRequest with status active for those part of a CarePlan with status active related to eligible EpisodeOfCare resources. Eligible EpisodeOfCare are those with status active that refer to the given Patient and are either given as EpisodeOfCare reference in input or are referencing a Condition with a condition code that matches at least one of the Condition codes possibly given as input. The measurement regime expressed in ServiceRequest.occurrence[x] is, when possible, resolved to time slot(s) corresponding to datetime/period where an action is supposed to take place, typically performed by the Patient. When the occurrenceTiming variant is used, resolved time slots overlapping with the input time periode are considered. For occurrenceTiming expression which are either adhoc or unresolved, the effective datetime/period of a measurement is considered when checked for overlap with input time period.
## Input
The operation has three mandatory inputs, a Patient reference, a start date and an end date. Additionally the operation has three optional inputs: a list of reference(s) to EpisodeOfCare, a list of Codings for Condition and a list of Codings for tags.
### Patient reference
Mandatory reference for the Patient which the procedure overview is computed for.
### Start and end datetimes
Start and end datetime are both mandatory, and together specify the period of interest in the patient procedure overview. As stated above, for resolvable past and future time slots as well as adhoc and unresolved timings there must overlap with this period.
### EpisodeOfCare list
The list of EpisodeOfCare references is optional. If EpisodeOfCare are provided, these will be used to further filter which active EpisodeOfCare, CarePlan and ServiceRequest are considered for the patient procedure overview.
### Condition Coding list
The list of Coding for Condition is optional. If Condition Coding are provided, the EpisodeOfCare considered are those referring to a Condition matching at least one of the codes in the list. As above, the EpisodeOfCare (one or more) considered further determines which active EpisodeOfCare, CarePlan and ServiceRequest are considered.
### Tag Coding list
The list of Coding for tags is optional. If tag Coding are provided, the EpisodeOfCare considered are those including a tag matching at least one of the codes in the list. As above, both the Condition (one or more) and EpisodeOfCare (one or more) considered further determines which active EpisodeOfCare, CarePlan and ServiceRequest are considered.
### Extra boolean
This is an optional parameter that can be set to true if activities allowing 'Extra' submissions should be included in the response.
## Output
For valid inputs, the server will compute and return a Bundle. The Bundle contains a Parameters resource with resolved measurement regimes and associated counts of measurement submitted and counts expected. Such counts are also included in the Parameters structure when the measurement regime is either adhoc or unresolved. In addition, the Bundle contains CarePlan and ServiceRequest referenced in the Parameters. The Bundle can contain an OperationOutcome describing any encountered warnings.
### Output Parameters
The output contains rows (encoded in parameters) for each matching and active ServiceRequest with resolved timings overlapping with the requested period.
Rows are represented as Parameters.parameter with names: item_1, item_2, etc. Columns are represented as Parameters.parameter.part with name and value
```
Example:
'resource': {
'resourceType': 'Parameters',
'parameter': [{
'name': 'item_1',
'part': [{
'name': 'CarePlan',
'valueReference': {
'reference': 'https://careplan.devtest.systematic-ehealth.com/fhir/CarePlan/164581'
}
}]
}]
}
```
### Columns
- CarePlan: Reference to the CarePlan that the ServiceRequest belongs to.
- ServiceRequest: Reference to the ServiceRequest.
- ServiceRequestVersionId: The version of the ServiceRequest (version specified at time of submit-measurement or the current version (for expected activities)).
- Activity: Description of the planned activity.
- ResolvedTimingStart: A planned start time for the activity in the requested period.
- ResolvedTimingEnd: A planned end time for the activity in the requested period. May be identical to start if no duration is specified in the measurement regime.
- TotalSubmitted: The number of measurements already submitted for this ServiceRequest and resolved timing.
- SubmittedTimely: The number of measurements where the measurement time matches the resolved timing.
- TimingType:
* Resolved: a measurement regime that is supported by the infrastructure and where resolved timing and requested number of measurements can be calculated.
* Unresolved: a measurement regime that is not supported by the infrastructure. Resolved Timing Start, end, submitted timely and Occurrences requested will be empty.
* Adhoc: A ServiceRequest without a measurement regime or a measurement regime stating ad-hoc.
- OccurencesRequested: Expected number of measurements."/>
</operation>
<operation>
<name value="create-episode-of-care"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-create-episode-of-care"/>
<documentation
value="This operation persists an EpisodeOfCare based on the transient value of an EpisodeOfCare provided in the input.
## Input
The input is a Bundle which must contain exactly one EpisodeOfCare, conditions referenced in diagnosis list and at least one Provenance resource. All Provenances in the input must have the EpisodeOfCare as target. At least one Provenance must be interpreted into a 'Privacy-provenance' (see below).
### The EpisodeOfCare resource
The EpisodeOfCare has to have `PLANNED` status
The 'id' property of the EpisodeOfCare will be reassigned by the server, but can be referenced by other resources in the same bundle.
The 'managingOrganization' property of the EpisodeOfCare references the GDPR Data Controller (Danish: 'Dataansvarlig').
### The privacy-Provenance resource
A privacy-Provenance is a Provenance resource characterized by having at least one entry in Provenance.policy which data are transported, stored, or processed in the system. Possible values are:
- 'http://ehealth.sundhed.dk/policy/dk/sundhedsloven'
- 'http://ehealth.sundhed.dk/policy/dk/serviceloven'
### Diagnosis referenced Condition resource
For any diagnosis listed, the referenced Condition must be concerning the same Patient as the EpisodeOfCare.
## Output
For valid inputs, the server will create, persist and return a new EpisodeOfCare, client-supplied provenances, conditions and origin-provenance carrying a server-assigned ids.
To get resources bodies in the output the request header has to contain parameter ```Prefer: return=representation```.
### The origin-Provenance resource
Whenever an EpisodeOfCare is created, the server automatically creates an 'origin' Provenance resource point to it (in addition to the client-supplied Privacy-Provenance). This Origin-Provenance resource is filled with data from the JWT access token in order to record the origin of the EpisodeOfCare resource. For instance agent.whoReference points to a resource which is created as a shadow identity from the JWT token."/>
</operation>
<operation>
<name value="apply"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-apply"/>
<documentation
value="This operation creates a careplan for a specific episodeOfCare using this PlanDefinition as a template."/>
</operation>
<operation>
<name value="process-message"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-process-message"/>
<documentation value="Accept a FHIR Message Bundle for processing"/>
</operation>
<operation>
<name value="perform-reindexing-pass"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-perform-reindexing-pass"/>
<documentation
value="Forces a single pass of the resource reindexing processor"/>
</operation>
<operation>
<name value="meta"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-meta"/>
</operation>
<operation>
<name value="get-resource-counts"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-get-resource-counts"/>
<documentation
value="Provides the number of resources currently stored on the server, broken down by resource type"/>
</operation>
<operation>
<name value="reindex-terminology"/>
<definition
value="https://careplan.devtest.systematic-ehealth.com/fhir/OperationDefinition/-s-reindex-terminology"/>
</operation>
</rest>
</CapabilityStatement>
IG © 2021+ Systematic | Trifork. Package dk.ehealth.sundhed.fhir.ig.core#2.6.0 based on FHIR 4.0.1. Generated 2023-01-12
