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
Official URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/CarePlan-eu-pcsp | Version: 0.2.0 | |||
Draft as of 2024-12-11 | Computable Name: CarePlanPcsp |
This profile defines how to represent the Care Plan proposed by the PCSP platoform in HL7 FHIR. This profile can be used for both the version generated by the platoform and that curated and validated by Clinicians.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | CarePlan | |||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
identifier | 0..* | Identifier | Business Identifier of this Care Plan | |
status | 1..1 | code | Status (draft when automatically generated) | |
intent | 1..1 | code | Intent (proposal when automatically generated) | |
subject | 1..1 | Reference(Patient: PCSP) | Who the care plan is for | |
created | 1..1 | dateTime | Date record was first recorded | |
author | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) | |
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. | |
addresses | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses | |
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors | |
activity | 1..* | BackboneElement | Action to occur as part of plan | |
detail | ||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition) | Instantiates FHIR protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: Recommendations (extensible) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Conditions at risk (extensible) | |
reasonReference | 0..* | Reference(Observation: Risk Factor) | Why activity is needed | |
status | 1..1 | code | Progress being made | |
Slices for scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur Slice: Unordered, Open by type:$this | |
scheduled[x]:scheduledString | 0..1 | string | Planned for | |
description | 0..1 | string | Activity to perform | |
note | 0..2 | Annotation | Comments about the plan | |
Slices for extension | Content/Rules for all slices | |||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.activity.detail.code | extensible | Recommendation (a valid code from PCSP Recommendations)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-recommendation-eu-pcsp from this IG | |
CarePlan.activity.detail.reasonCode | extensible | RiskCondition (a valid code from PCSP Conditions at risk)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-riskcondition-eu-pcsp from this IG | |
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
identifier | Σ | 0..* | Identifier | Business Identifier of this Care Plan ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | Status (draft when automatically generated) Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | Intent (proposal when automatically generated) Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(Patient: PCSP) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
created | Σ | 1..1 | dateTime | Date record was first recorded ele-1: All FHIR elements must have a @value or children |
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) ele-1: All FHIR elements must have a @value or children |
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. ele-1: All FHIR elements must have a @value or children | |
addresses | Σ | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses ele-1: All FHIR elements must have a @value or children |
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors ele-1: All FHIR elements must have a @value or children | |
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
note | 0..2 | Annotation | Comments about the plan ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) ele-1: All FHIR elements must have a @value or children | |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier of this Care Plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!Σ | 1..1 | code | Status (draft when automatically generated) Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | Intent (proposal when automatically generated) Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | Σ | 1..1 | Reference(Patient: PCSP) | Who the care plan is for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | Σ | 0..1 | Period | Time period plan covers | ||||
created | Σ | 1..1 | dateTime | Date record was first recorded | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) | ||||
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | Σ | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition) | Instantiates FHIR protocol or definition | |||||
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail type of activity Binding: Recommendations (extensible) | |||||
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Conditions at risk (extensible) | |||||
reasonReference | 0..* | Reference(Observation: Risk Factor) | Why activity is needed | |||||
goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
status | ?! | 1..1 | code | Progress being made Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
scheduled[x]:scheduledString | 0..1 | string | Planned for | |||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Activity to perform | |||||
note | 0..2 | Annotation | Comments about the plan | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type" | |||||
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.code | extensible | Recommendation (a valid code from PCSP Recommendations)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-recommendation-eu-pcsp from this IG | ||||
CarePlan.activity.detail.reasonCode | extensible | RiskCondition (a valid code from PCSP Conditions at risk)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-riskcondition-eu-pcsp from this IG | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
This structure is derived from CarePlan
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | CarePlan | |||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |
identifier | 0..* | Identifier | Business Identifier of this Care Plan | |
status | 1..1 | code | Status (draft when automatically generated) | |
intent | 1..1 | code | Intent (proposal when automatically generated) | |
subject | 1..1 | Reference(Patient: PCSP) | Who the care plan is for | |
created | 1..1 | dateTime | Date record was first recorded | |
author | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) | |
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. | |
addresses | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses | |
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors | |
activity | 1..* | BackboneElement | Action to occur as part of plan | |
detail | ||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition) | Instantiates FHIR protocol or definition | |
code | 0..1 | CodeableConcept | Detail type of activity Binding: Recommendations (extensible) | |
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Conditions at risk (extensible) | |
reasonReference | 0..* | Reference(Observation: Risk Factor) | Why activity is needed | |
status | 1..1 | code | Progress being made | |
Slices for scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur Slice: Unordered, Open by type:$this | |
scheduled[x]:scheduledString | 0..1 | string | Planned for | |
description | 0..1 | string | Activity to perform | |
note | 0..2 | Annotation | Comments about the plan | |
Slices for extension | Content/Rules for all slices | |||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.activity.detail.code | extensible | Recommendation (a valid code from PCSP Recommendations)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-recommendation-eu-pcsp from this IG | |
CarePlan.activity.detail.reasonCode | extensible | RiskCondition (a valid code from PCSP Conditions at risk)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-riskcondition-eu-pcsp from this IG | |
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
text | 1..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
identifier | Σ | 0..* | Identifier | Business Identifier of this Care Plan ele-1: All FHIR elements must have a @value or children |
status | ?!Σ | 1..1 | code | Status (draft when automatically generated) Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. ele-1: All FHIR elements must have a @value or children |
intent | ?!Σ | 1..1 | code | Intent (proposal when automatically generated) Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. ele-1: All FHIR elements must have a @value or children |
subject | Σ | 1..1 | Reference(Patient: PCSP) | Who the care plan is for ele-1: All FHIR elements must have a @value or children |
created | Σ | 1..1 | dateTime | Date record was first recorded ele-1: All FHIR elements must have a @value or children |
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) ele-1: All FHIR elements must have a @value or children |
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. ele-1: All FHIR elements must have a @value or children | |
addresses | Σ | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses ele-1: All FHIR elements must have a @value or children |
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors ele-1: All FHIR elements must have a @value or children | |
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
note | 0..2 | Annotation | Comments about the plan ele-1: All FHIR elements must have a @value or children | |
Slices for extension | Content/Rules for all slices | |||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type" | |
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) ele-1: All FHIR elements must have a @value or children | |
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 1..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | Business Identifier of this Care Plan | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | ||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
status | ?!Σ | 1..1 | code | Status (draft when automatically generated) Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ||||
intent | ?!Σ | 1..1 | code | Intent (proposal when automatically generated) Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | Σ | 0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | Σ | 1..1 | Reference(Patient: PCSP) | Who the care plan is for | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
period | Σ | 0..1 | Period | Time period plan covers | ||||
created | Σ | 1..1 | dateTime | Date record was first recorded | ||||
author | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who it is attributed to (a Device when automatically generated) | ||||
contributor | 0..* | Reference(Practitioner | PractitionerRole | Device | Organization | CareTeam) | Who provided the contents of the care plan. | |||||
careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
addresses | Σ | 0..* | Reference(Condition: Primary Cancer) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Observation: Risk Factor | Resource) | Supporting infos, including risk factors | |||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
detail | C | 0..1 | BackboneElement | In-line definition of activity | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
instantiatesCanonical | 0..* | canonical(PlanDefinition | ActivityDefinition) | Instantiates FHIR protocol or definition | |||||
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
code | 0..1 | CodeableConcept | Detail type of activity Binding: Recommendations (extensible) | |||||
reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Conditions at risk (extensible) | |||||
reasonReference | 0..* | Reference(Observation: Risk Factor) | Why activity is needed | |||||
goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
status | ?! | 1..1 | code | Progress being made Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ||||
statusReason | 0..1 | CodeableConcept | Reason for current status | |||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ||||
Slices for scheduled[x] | 0..1 | When activity is to occur Slice: Unordered, Open by type:$this | ||||||
scheduledTiming | Timing | |||||||
scheduledPeriod | Period | |||||||
scheduledString | string | |||||||
scheduled[x]:scheduledString | 0..1 | string | Planned for | |||||
location | 0..1 | Reference(Location) | Where it should happen | |||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
product[x] | 0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
productCodeableConcept | CodeableConcept | |||||||
productReference | Reference(Medication | Substance) | |||||||
dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |||||
quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |||||
description | 0..1 | string | Activity to perform | |||||
note | 0..2 | Annotation | Comments about the plan | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
annotationType | 0..1 | (Complex) | Annotation Type URL: http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.eu/fhir/ig/pcsp/StructureDefinition/annotation-type" | |||||
value[x] | 0..1 | CodeableConcept | Value of extension Binding: Annotation type (preferred) | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcomehttp://hl7.org/fhir/ValueSet/care-plan-activity-outcome from the FHIR Standard | ||||
CarePlan.activity.detail.kind | required | CarePlanActivityKindhttp://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.code | extensible | Recommendation (a valid code from PCSP Recommendations)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-recommendation-eu-pcsp from this IG | ||||
CarePlan.activity.detail.reasonCode | extensible | RiskCondition (a valid code from PCSP Conditions at risk)http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-riskcondition-eu-pcsp from this IG | ||||
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard | ||||
CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codes from the FHIR Standard | ||||
CarePlan.note.extension:annotationType.value[x] | preferred | AnnotationTypeVShttp://hl7.eu/fhir/ig/pcsp/ValueSet/annotation-type-vs from this IG |
This structure is derived from CarePlan
Summary
Mandatory: 3 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron