xShare Project CarePlan
1.0.0-ci - ci-build 150

xShare Project CarePlan, published by xShare Project. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xshare-careplan/ and changes regularly. See the Directory of published versions

Logical Model: CarePlanXShareModel - Detailed Descriptions

Draft as of 2026-06-05

Definitions for the CarePlanXShare logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. CarePlanXShare
Definition

Logical model representing a Care Plan structure with metadata, care team participation, subject and clinical context, goals, supporting information, planned or performed activities, and activity outcomes. This model extends the EHDSCarePlan model with additional elements to capture care team participation, clinical context, and activity and goal details, while maintaining logical compatibility with the original EHDSCarePlan structure.

ShortCare Plan (Logical Model)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CarePlanXShare.header
Definition

Basic metadata for this information

ShortBasic metadata for this information
Control1..1
TypeBase
4. CarePlanXShare.header.subject
Definition

The patient whose intended care is described in the plan.

ShortThe patient whose intended care is described in the plan.
Control1..1
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. CarePlanXShare.header.identifier
Definition

Identifier for the care plan

ShortIdentifier for the care plan
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
8. CarePlanXShare.header.author[x]
Definition

The responsible party (custodian) for the care plan.

ShortThe responsible party (custodian) for the care plan.
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. CarePlanXShare.header.date
Definition

Date and optionally time of authoring/issuing

ShortDate and optionally time of authoring/issuing
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CarePlanXShare.header.status
Definition

Indicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.

ShortIndicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.
Control1..1
Binding

HL7 Request status

TypeCodeableConcept
14. CarePlanXShare.header.source
Definition

Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.

ShortSource of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
Control0..1
TypeCodeableConcept
16. CarePlanXShare.header.language
Definition

Language in which the resource is written. Language is expressed by the IETF language tag.

ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
Control0..1
Binding

BCP 47

TypeCodeableConcept
18. CarePlanXShare.title
Definition

Human-friendly name for the care plan

ShortHuman-friendly name for the care plan
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CarePlanXShare.description
Definition

A description of the scope and nature of the plan.

ShortA description of the scope and nature of the plan.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. CarePlanXShare.period
Definition

Indicates when the plan did (or is intended to) come into effect and end.

ShortIndicates when the plan did (or is intended to) come into effect and end.
Control0..1
TypePeriod
24. CarePlanXShare.realize[x]
Definition

Identifier or reference to the guidelines that this care plan realizes.

ShortInstantiated Guideline
Control0..*
TypeChoice of: uri, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. CarePlanXShare.category
Definition

Categorization of the care plan (e.g., rehab, chronic care, oncology).

ShortCategory
Control0..*
TypeCodeableConcept
28. CarePlanXShare.careTeam
Definition

Care team or responsible organization in charge of the plan.

ShortCare team / organization in charge
Control0..*
TypeBase
30. CarePlanXShare.careTeam.member[x]
Definition

References to practitioners, organizations, or related persons involved in the care plan.

ShortCare team member
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
32. CarePlanXShare.addresses[x]
Definition

Conditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.

ShortConditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.
Control0..*
Binding

ICD-10, SNOMED CT, Orphacode

TypeChoice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCondition
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
34. CarePlanXShare.activity
Definition

Planned or performed activities as part of the care plan.

ShortActivity
Control0..*
TypeBase
36. CarePlanXShare.activity.activityCodeableConcept
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeCodeableConcept
38. CarePlanXShare.activity.activityReference
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeReference
40. CarePlanXShare.activity.workflowStatus
Definition

Workflow status of the activity (e.g., planned, in-progress, completed, stopped).

ShortWorkflow status
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. CarePlanXShare.activity.description
Definition

Human-readable description of the activity.

ShortDescription
Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. CarePlanXShare.activity.progress
Definition

Outcome(s) or progresses captured for the activity.

ShortOutcome, Progresses
Control0..*
TypeAnnotation
46. CarePlanXShare.activity.performed
Definition

References to the performed activities.

ShortPerformed activity
Control0..*
TypeReference
48. CarePlanXShare.goal
Definition

Goals defined for the care plan, including treatment goals defined by the care team and patient goals expressed by the patient.

ShortGoal
Control0..*
TypeBase
50. CarePlanXShare.goal.description
Definition

Describes the intended objective(s) of carrying out the care plan.

ShortDescribes the intended objective(s) of carrying out the care plan.
Control0..*
TypeCodeableConcept
52. CarePlanXShare.goal.category
Definition

Categorization of the goal (e.g., treatment goal, patient goal).

ShortCategory (e.g., treatment, patient goal)
Control0..1
TypeCodeableConcept
54. CarePlanXShare.goal.target
Definition

Target of the goal.

ShortGoal target
Control0..*
TypeBase
56. CarePlanXShare.goal.due
Definition

Date by which the goal should be met or reviewed.

ShortGoal due date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. CarePlanXShare.goal.outcome
Definition

Outcome of the goal, which can be represented as a codeable concept or a reference to an observation or other resource capturing the outcome.

ShortGoal outcome
Control0..*
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSObservation
60. CarePlanXShare.supportingInfo
Definition

Evidence or other supporting information used as the basis for this care plan.

ShortEvidence / supporting information
Control0..*
TypeReference

Guidance on how to interpret the contents of this table can be foundhere

0. CarePlanXShare
Definition

Logical model representing a Care Plan structure with metadata, care team participation, subject and clinical context, goals, supporting information, planned or performed activities, and activity outcomes. This model extends the EHDSCarePlan model with additional elements to capture care team participation, clinical context, and activity and goal details, while maintaining logical compatibility with the original EHDSCarePlan structure.

ShortCare Plan (Logical Model)
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CarePlanXShare.header
4. CarePlanXShare.header.subject
Definition

The patient whose intended care is described in the plan.

ShortThe patient whose intended care is described in the plan.
6. CarePlanXShare.header.identifier
Definition

Identifier for the care plan

ShortIdentifier for the care plan
NoteThis is a business identifier, not a resource identifier (see discussion)
8. CarePlanXShare.header.author[x]
Definition

The responsible party (custodian) for the care plan.

ShortThe responsible party (custodian) for the care plan.
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. CarePlanXShare.header.status
Definition

Indicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.

ShortIndicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.
Binding

HL7 Request status

12. CarePlanXShare.title
Definition

Human-friendly name for the care plan

ShortHuman-friendly name for the care plan
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. CarePlanXShare.description
Definition

A description of the scope and nature of the plan.

ShortA description of the scope and nature of the plan.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. CarePlanXShare.period
Definition

Indicates when the plan did (or is intended to) come into effect and end.

ShortIndicates when the plan did (or is intended to) come into effect and end.
Control0..1
TypePeriod
18. CarePlanXShare.realize[x]
Definition

Identifier or reference to the guidelines that this care plan realizes.

ShortInstantiated Guideline
Control0..*
TypeChoice of: uri, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CarePlanXShare.category
Definition

Categorization of the care plan (e.g., rehab, chronic care, oncology).

ShortCategory
Control0..*
TypeCodeableConcept
22. CarePlanXShare.careTeam
Definition

Care team or responsible organization in charge of the plan.

ShortCare team / organization in charge
Control0..*
TypeBase
24. CarePlanXShare.careTeam.member[x]
Definition

References to practitioners, organizations, or related persons involved in the care plan.

ShortCare team member
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
26. CarePlanXShare.addresses[x]
Definition

Conditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.

ShortConditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.
Control0..*
Binding

ICD-10, SNOMED CT, Orphacode

TypeChoice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCondition
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
28. CarePlanXShare.activity
Definition

Planned or performed activities as part of the care plan.

ShortActivity
Control0..*
TypeBase
30. CarePlanXShare.activity.activityCodeableConcept
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeCodeableConcept
32. CarePlanXShare.activity.activityReference
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeReference
34. CarePlanXShare.activity.workflowStatus
Definition

Workflow status of the activity (e.g., planned, in-progress, completed, stopped).

ShortWorkflow status
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. CarePlanXShare.activity.description
Definition

Human-readable description of the activity.

ShortDescription
Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. CarePlanXShare.activity.progress
Definition

Outcome(s) or progresses captured for the activity.

ShortOutcome, Progresses
Control0..*
TypeAnnotation
40. CarePlanXShare.activity.performed
Definition

References to the performed activities.

ShortPerformed activity
Control0..*
TypeReference
42. CarePlanXShare.goal
Definition

Goals defined for the care plan, including treatment goals defined by the care team and patient goals expressed by the patient.

ShortGoal
Control0..*
TypeBase
44. CarePlanXShare.goal.description
Definition

Describes the intended objective(s) of carrying out the care plan.

ShortDescribes the intended objective(s) of carrying out the care plan.
Control0..*
TypeCodeableConcept
46. CarePlanXShare.goal.category
Definition

Categorization of the goal (e.g., treatment goal, patient goal).

ShortCategory (e.g., treatment, patient goal)
Control0..1
TypeCodeableConcept
48. CarePlanXShare.goal.target
Definition

Target of the goal.

ShortGoal target
Control0..*
TypeBase
50. CarePlanXShare.goal.due
Definition

Date by which the goal should be met or reviewed.

ShortGoal due date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
52. CarePlanXShare.goal.outcome
Definition

Outcome of the goal, which can be represented as a codeable concept or a reference to an observation or other resource capturing the outcome.

ShortGoal outcome
Control0..*
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSObservation
54. CarePlanXShare.supportingInfo
Definition

Evidence or other supporting information used as the basis for this care plan.

ShortEvidence / supporting information
Control0..*
TypeReference

Guidance on how to interpret the contents of this table can be foundhere

0. CarePlanXShare
Definition

Logical model representing a Care Plan structure with metadata, care team participation, subject and clinical context, goals, supporting information, planned or performed activities, and activity outcomes. This model extends the EHDSCarePlan model with additional elements to capture care team participation, clinical context, and activity and goal details, while maintaining logical compatibility with the original EHDSCarePlan structure.

ShortCare Plan (Logical Model)
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. CarePlanXShare.header
Definition

Basic metadata for this information

ShortBasic metadata for this information
Control1..1
TypeBase
4. CarePlanXShare.header.subject
Definition

The patient whose intended care is described in the plan.

ShortThe patient whose intended care is described in the plan.
Control1..1
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSPatient
6. CarePlanXShare.header.identifier
Definition

Identifier for the care plan

ShortIdentifier for the care plan
NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
8. CarePlanXShare.header.author[x]
Definition

The responsible party (custodian) for the care plan.

ShortThe responsible party (custodian) for the care plan.
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSDevice
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
10. CarePlanXShare.header.date
Definition

Date and optionally time of authoring/issuing

ShortDate and optionally time of authoring/issuing
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. CarePlanXShare.header.status
Definition

Indicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.

ShortIndicates whether the plan is currently being acted upon, represents future intentions, or is now a historical record.
Control1..1
Binding

HL7 Request status

TypeCodeableConcept
14. CarePlanXShare.header.source
Definition

Source of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.

ShortSource of information (e.g. patient, patient's proxy). Used in case the patient has authored the information or the author has submitted patient-stated information.
Control0..1
TypeCodeableConcept
16. CarePlanXShare.header.language
Definition

Language in which the resource is written. Language is expressed by the IETF language tag.

ShortLanguage in which the resource is written. Language is expressed by the IETF language tag.
Control0..1
Binding

BCP 47

TypeCodeableConcept
18. CarePlanXShare.title
Definition

Human-friendly name for the care plan

ShortHuman-friendly name for the care plan
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. CarePlanXShare.description
Definition

A description of the scope and nature of the plan.

ShortA description of the scope and nature of the plan.
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. CarePlanXShare.period
Definition

Indicates when the plan did (or is intended to) come into effect and end.

ShortIndicates when the plan did (or is intended to) come into effect and end.
Control0..1
TypePeriod
24. CarePlanXShare.realize[x]
Definition

Identifier or reference to the guidelines that this care plan realizes.

ShortInstantiated Guideline
Control0..*
TypeChoice of: uri, Reference
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. CarePlanXShare.category
Definition

Categorization of the care plan (e.g., rehab, chronic care, oncology).

ShortCategory
Control0..*
TypeCodeableConcept
28. CarePlanXShare.careTeam
Definition

Care team or responsible organization in charge of the plan.

ShortCare team / organization in charge
Control0..*
TypeBase
30. CarePlanXShare.careTeam.member[x]
Definition

References to practitioners, organizations, or related persons involved in the care plan.

ShortCare team member
Control0..*
TypeChoice of: http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSHealthProfessional, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSOrganisation
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
32. CarePlanXShare.addresses[x]
Definition

Conditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.

ShortConditions/problems/concerns/diagnoses/etc whose management and/or mitigation are handled by this plan.
Control0..*
Binding

ICD-10, SNOMED CT, Orphacode

TypeChoice of: CodeableConcept, http://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSCondition
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
34. CarePlanXShare.activity
Definition

Planned or performed activities as part of the care plan.

ShortActivity
Control0..*
TypeBase
36. CarePlanXShare.activity.activityCodeableConcept
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeCodeableConcept
38. CarePlanXShare.activity.activityReference
Definition

The details of the proposed activity represented in a specific resource.

ShortThe details of the proposed activity represented in a specific resource.
Control0..*
TypeReference
40. CarePlanXShare.activity.workflowStatus
Definition

Workflow status of the activity (e.g., planned, in-progress, completed, stopped).

ShortWorkflow status
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
42. CarePlanXShare.activity.description
Definition

Human-readable description of the activity.

ShortDescription
Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
44. CarePlanXShare.activity.progress
Definition

Outcome(s) or progresses captured for the activity.

ShortOutcome, Progresses
Control0..*
TypeAnnotation
46. CarePlanXShare.activity.performed
Definition

References to the performed activities.

ShortPerformed activity
Control0..*
TypeReference
48. CarePlanXShare.goal
Definition

Goals defined for the care plan, including treatment goals defined by the care team and patient goals expressed by the patient.

ShortGoal
Control0..*
TypeBase
50. CarePlanXShare.goal.description
Definition

Describes the intended objective(s) of carrying out the care plan.

ShortDescribes the intended objective(s) of carrying out the care plan.
Control0..*
TypeCodeableConcept
52. CarePlanXShare.goal.category
Definition

Categorization of the goal (e.g., treatment goal, patient goal).

ShortCategory (e.g., treatment, patient goal)
Control0..1
TypeCodeableConcept
54. CarePlanXShare.goal.target
Definition

Target of the goal.

ShortGoal target
Control0..*
TypeBase
56. CarePlanXShare.goal.due
Definition

Date by which the goal should be met or reviewed.

ShortGoal due date
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
58. CarePlanXShare.goal.outcome
Definition

Outcome of the goal, which can be represented as a codeable concept or a reference to an observation or other resource capturing the outcome.

ShortGoal outcome
Control0..*
Typehttp://www.xt-ehr.eu/fhir/models/StructureDefinition/EHDSObservation
60. CarePlanXShare.supportingInfo
Definition

Evidence or other supporting information used as the basis for this care plan.

ShortEvidence / supporting information
Control0..*
TypeReference