Generated Narrative: Kapabilitetserklæring careplan Implementation Guide Version: 3.6.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 Published on: 2025-04-25 02:02:42+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 Operations Conformance Operation Documentation SHALL $migrate Data migration SHALL $get-patient-procedures 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. Whether the ServiceRequest is included when Extra paremeter is set to true, is based on the ServiceRequest.includeAsExtra field. 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. Extra: The service request may be performed outside the resolved timing. OccurencesRequested: Expected number of measurements. TotalInvalidated: Number of measurements which are invalidated. SHALL $create-episode-of-care 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. Validation Patient.deceased must be false to create episode of care 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. SHALL $apply This operation creates a careplan for a specific episodeOfCare using this PlanDefinition as a template. SHALL $reindex-terminology SHALL $meta SHALL $get-resource-counts Provides the number of resources currently stored on the server, broken down by resource type 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 P C D Searches _include _revinclude Operations CarePlan http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-careplan y y y y _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-time CarePlan:activity-reference, CarePlan:condition, CarePlan:episodeOfCare, CarePlan:goal, CarePlan:part-of 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, $update-care-teams, $suggest-care-teams CommunicationRequest http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-communication-request y y y y y y _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, subject CommunicationRequest:based-on, CommunicationRequest:context 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 Condition http://hl7.org/fhir/StructureDefinition/Condition y y y y * 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 Consent http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-consent y y y y y data, _tag, actor, category, identifier, patient, period, status 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 EpisodeOfCare http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-episodeofcare y y y y _tag, condition, identifier, organization, participant-actor, participant-function, participant-function-actor, patient, status, status-scheduled-time, team, team-scheduled-time EpisodeOfCare:condition CarePlan:episodeOfCare $validate, $update-care-teams, $is-context-allowed Goal http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-goal y y y y y _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:subject 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 OperationDefinition http://hl7.org/fhir/StructureDefinition/OperationDefinition y * 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 Provenance http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-provenance y y y target, _tag 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 ServiceRequest http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-servicerequest y y y * 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 Conformance Parameter Type Documentation SHALL _id token The ID of the resource SHALL _lastUpdated date Only return resources which were last updated as specified by the given range SHALL _tag token Search for resources which have the given tag SHALL activity-reference reference Activity details defined in specific resource SHALL care-team reference Who's involved in plan? SHALL category token Type of plan SHALL condition reference Health issues this plan addresses SHALL date date Time period plan covers SHALL episodeOfCare reference EpisodeOfCare SHALL goal reference Goal of the care plan SHALL identifier token External Ids for this plan SHALL instantiates-canonical reference Instantiates FHIR protocol or definition SHALL part-of reference Part of referenced CarePlan SHALL participant-actor reference Reference to the participant SHALL participant-function token The role of the participant SHALL participant-function-actor composite A Participant with a specific function and actor SHALL patient reference Who care plan is for SHALL status token draft | active | suspended | completed | entered-in-error | cancelled | unknown SHALL status-history-end-time date end time of historic status change SHALL status-history-start-time date start time of historic status change SHALL status-history-status token status of historic status change SHALL status-scheduled-status token Scheduled status for status change SHALL status-scheduled-time date Scheduled time for status change SHALL team-scheduled-time date Scheduled time for team change Extended Operations Conformance Operation Documentation 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 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 authored date When request transitioned to being actionable SHALL based-on reference Fulfills plan or proposal SHALL category token Message category SHALL encounter reference Encounter leading to message SHALL episodeOfCare reference Episode leading to message SHALL group-identifier token Composite request this is part of SHALL identifier token Unique identifier SHALL medium token A channel of communication SHALL occurrence date When scheduled SHALL patient reference Focus of message SHALL priority token Message urgency SHALL reasonCode token ReasonCode SHALL recipient reference Message recipient SHALL replaces reference Request(s) replaced by this request SHALL requester reference Individual making the request SHALL sender reference Message sender SHALL status token draft | active | suspended | cancelled | completed | entered-in-error | unknown SHALL subject reference Focus of message Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported Condition Base System Profile Condition Profile Conformance SHALL Reference Policy Interaction summary Supports vread, read, patch, create. Extended Operations Conformance Operation Documentation 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 Conformance Parameter Type Documentation SHALL data reference The actual data reference SHALL _tag token Search for resources which have the given tag SHALL actor reference Resource for the actor (or group, by role) SHALL category token Classification of the consent statement - for indexing/retrieval SHALL identifier token Identifier for this record (external references) SHALL patient reference Who the consent applies to SHALL period date Period that this consent applies SHALL status token draft | proposed | active | rejected | inactive | entered-in-error Extended Operations Conformance Operation Documentation 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 Conformance Parameter Type Documentation SHALL _tag token Search for resources which have the given tag SHALL condition reference Conditions/problems/diagnoses this episode of care is for SHALL identifier token Business Identifier(s) relevant for this EpisodeOfCare SHALL organization reference The organization that has assumed the specific responsibilities of this EpisodeOfCare SHALL participant-actor reference The reference to the actor SHALL participant-function token The role of the participant SHALL participant-function-actor composite A Participant with a specific function and actor SHALL patient reference The patient who is the focus of this episode of care SHALL status token The current status of the Episode of Care as provided (does not check the status history collection) SHALL status-scheduled-time date Scheduled time for status change SHALL team reference The list of practitioners that may be facilitating this episode of care for specific purposes. SHALL team-scheduled-time date Scheduled time for team change Extended Operations Conformance Operation Documentation 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 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 addresses reference What the goal addresses SHALL category token E.g. Treatment, dietary, behavioral, etc. SHALL identifier token External Ids for this goal SHALL lifecycle-status token proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected SHALL patient reference Who this goal is intended for SHALL start-date date When goal pursuit begins SHALL subject reference Who this goal is intended for SHALL target-date date 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 Conformance Parameter Type Documentation SHALL target reference Target Reference(s) (usually version specific) SHALL _tag token Search for resources which have the given tag Extended Operations Conformance Operation Documentation SHALL $validate Resource Conformance: supported ServiceRequest Base System Profile ehealth-servicerequest Profile Conformance SHALL Reference Policy Interaction summary Supports update, vread, read. Extended Operations Conformance Operation Documentation SHALL $validate
Den telemedicinske infrastruktur (eHealth Infrastructure)
Only return resources which were last updated as specified by the given range
Search for resources which have the given tag
Activity details defined in specific resource
Instantiates FHIR protocol or definition
A Participant with a specific function and actor
draft | active | suspended | completed | entered-in-error | cancelled | unknown
The operation modifies the care team assignment of the care plan and all of its sub plans.
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.
Search the contents of the resource's data using a fulltext search
Return resources linked to by the given target
Search for resources which have the given profile
Search for resources which have the given security labels
Search the contents of the resource's narrative using a fulltext search
When request transitioned to being actionable
draft | active | suspended | cancelled | completed | entered-in-error | unknown
Resource for the actor (or group, by role)
Classification of the consent statement - for indexing/retrieval
Identifier for this record (external references)
draft | proposed | active | rejected | inactive | entered-in-error
Conditions/problems/diagnoses this episode of care is for
Business Identifier(s) relevant for this EpisodeOfCare
The organization that has assumed the specific responsibilities of this EpisodeOfCare
The patient who is the focus of this episode of care
The current status of the Episode of Care as provided (does not check the status history collection)
The list of practitioners that may be facilitating this episode of care for specific purposes.
Modify the care team assignment of the episode of care and all care plans that has the episode of care as context.
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
Search the contents of the resource's data using a filter
Search for resources which have the given source value (Resource.meta.source)
E.g. Treatment, dietary, behavioral, etc.
proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected
Target Reference(s) (usually version specific)
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. Whether the ServiceRequest is included when Extra paremeter is set to true, is based on the ServiceRequest.includeAsExtra field. ## 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. * Extra: The service request may be performed outside the resolved timing. - OccurencesRequested: Expected number of measurements. - TotalInvalidated: Number of measurements which are invalidated.
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```. ## Validation - Patient.deceased must be false to create episode of care ### 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.
This operation creates a careplan for a specific episodeOfCare using this PlanDefinition as a template.
Provides the number of resources currently stored on the server, broken down by resource type