PanCareSurPass Project HL7 FHIR Implementation Guide
0.2.0 - CI Build 150

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

Logical Model: PlanOfCare - Detailed Descriptions

Draft as of 2024-09-11

Definitions for the PlanOfCare logical model.

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

0. PlanOfCare
Definition

Care Plan Maturity Level: 0 - Draft

ShortCare Plan
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PlanOfCare.identifier
Definition

Care plan business identifier

ShortCare plan Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. PlanOfCare.addressedProblem
Definition

Problems (e.g. primary cancer) addressed by this plan

ShortProblems addressed by this plan
Control0..*
TypeIdentifier
6. PlanOfCare.author
Definition

Author

ShortAuthor
Control0..1
TypeBackboneElement
8. PlanOfCare.creationTime
Definition

Date the plan was created

ShortDate the plan was created
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PlanOfCare.note
Definition

Plan note

ShortPlan note
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PlanOfCare.chronicConditions
Definition

Chronic condition

ShortChronic condition
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PlanOfCare.reccomandation
Definition

Reccomandation

ShortReccomandation
Control1..*
TypeBackboneElement
16. PlanOfCare.reccomandation.riskFactor
Definition

Risk factors considered for generating this care plan

ShortRisk factors
Control0..*
TypeCodeableConcept
18. PlanOfCare.reccomandation.conditionAtRisk
Definition

Conditions at risk

ShortConditions at risk
Control0..*
TypeCodeableConcept
20. PlanOfCare.reccomandation.reccomandation
Definition

Reccomandation suggested by the algorithm

ShortSuggested reccomandation
Control0..1
TypeCodeableConcept
22. PlanOfCare.reccomandation.note
Definition

Note

ShortNote
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. PlanOfCare
Definition

Care Plan Maturity Level: 0 - Draft

ShortCare Plan
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PlanOfCare.identifier
Definition

Care plan business identifier

ShortCare plan Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. PlanOfCare.addressedProblem
Definition

Problems (e.g. primary cancer) addressed by this plan

ShortProblems addressed by this plan
Control0..*
TypeIdentifier
6. PlanOfCare.author
Definition

Author

ShortAuthor
Control0..1
TypeBackboneElement
8. PlanOfCare.creationTime
Definition

Date the plan was created

ShortDate the plan was created
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PlanOfCare.note
Definition

Plan note

ShortPlan note
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PlanOfCare.chronicConditions
Definition

Chronic condition

ShortChronic condition
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PlanOfCare.reccomandation
Definition

Reccomandation

ShortReccomandation
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PlanOfCare.reccomandation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
18. PlanOfCare.reccomandation.riskFactor
Definition

Risk factors considered for generating this care plan

ShortRisk factors
Control0..*
TypeCodeableConcept
20. PlanOfCare.reccomandation.conditionAtRisk
Definition

Conditions at risk

ShortConditions at risk
Control0..*
TypeCodeableConcept
22. PlanOfCare.reccomandation.reccomandation
Definition

Reccomandation suggested by the algorithm

ShortSuggested reccomandation
Control0..1
TypeCodeableConcept
24. PlanOfCare.reccomandation.note
Definition

Note

ShortNote
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

0. PlanOfCare
Definition

Care Plan Maturity Level: 0 - Draft

ShortCare Plan
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. PlanOfCare.identifier
Definition

Care plan business identifier

ShortCare plan Identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..*
TypeIdentifier
4. PlanOfCare.addressedProblem
Definition

Problems (e.g. primary cancer) addressed by this plan

ShortProblems addressed by this plan
Control0..*
TypeIdentifier
6. PlanOfCare.author
Definition

Author

ShortAuthor
Control0..1
TypeBackboneElement
8. PlanOfCare.creationTime
Definition

Date the plan was created

ShortDate the plan was created
Control0..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. PlanOfCare.note
Definition

Plan note

ShortPlan note
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. PlanOfCare.chronicConditions
Definition

Chronic condition

ShortChronic condition
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. PlanOfCare.reccomandation
Definition

Reccomandation

ShortReccomandation
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. PlanOfCare.reccomandation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
18. PlanOfCare.reccomandation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on PlanOfCare.reccomandation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 20. PlanOfCare.reccomandation.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    22. PlanOfCare.reccomandation.riskFactor
    Definition

    Risk factors considered for generating this care plan

    ShortRisk factors
    Control0..*
    TypeCodeableConcept
    24. PlanOfCare.reccomandation.conditionAtRisk
    Definition

    Conditions at risk

    ShortConditions at risk
    Control0..*
    TypeCodeableConcept
    26. PlanOfCare.reccomandation.reccomandation
    Definition

    Reccomandation suggested by the algorithm

    ShortSuggested reccomandation
    Control0..1
    TypeCodeableConcept
    28. PlanOfCare.reccomandation.note
    Definition

    Note

    ShortNote
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension