INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions
StructureDefinition: CareConnect-CarePlan-1
Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
The official URL for this profile is:
https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CarePlan-1
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CarePlan-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CareTeam-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..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 | External Ids for this plan |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(CareConnect-CarePlan-1) | Fulfills care plan |
| replaces | Σ | 0..* | Reference(CareConnect-CarePlan-1) | CarePlan replaced by this CarePlan |
| partOf | Σ | 0..* | Reference(CareConnect-CarePlan-1) | Part of referenced CarePlan |
| status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
| category | Σ | 0..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Patient-1) | Who care plan is for |
| context | Σ | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Created in context of |
| period | Σ | 0..1 | Period | Time period plan covers |
| author | Σ | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1 | CareConnect-RelatedPerson-1) | Who is responsible for contents of the plan |
| careTeam | 0..* | Reference(CareConnect-CareTeam-1) | Who's involved in plan? | |
| addresses | Σ | 0..* | Reference(CareConnect-Condition-1) | Health issues this plan addresses |
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |
| activity | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example) | |
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
 author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorString | string | |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | NutritionOrder | Task | ReferralRequest | VisionPrescription | RequestGroup | CareConnect-ProcedureRequest-1 | CareConnect-MedicationRequest-1) | Activity details defined in specific resource |
 detail | I | 0..1 | BackboneElement | In-line definition of activity |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
| definition | 0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example) | |
| reasonReference | 0..* | Reference(CareConnect-Condition-1) | Condition triggering need for activity | |
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..1 | boolean | Do NOT do |
| scheduled[x] | 0..1 | When activity is to occur | ||
| scheduledTiming | Timing | |||
| scheduledPeriod | Period | |||
| scheduledString | string | |||
| location | 0..1 | Reference(CareConnect-Location-1) | Where it should happen | |
| performer | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1 | CareConnect-RelatedPerson-1) | Who will be responsible? | |
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | ||
| productCodeableConcept | CodeableConcept | |||
| productReference | Reference(Substance | CareConnect-Medication-1) | |||
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
| description | 0..1 | string | Extra info describing activity to perform | |
| note | 0..* | Annotation | Comments about the plan | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorString | string | |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
This structure is derived from CarePlan
Summary
Structures
This structure refers to these other structures:
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CarePlan-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-EpisodeOfCare-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-CareTeam-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Condition-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1
- https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1
Differential View
This structure is derived from CarePlan
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | I | 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: Common Languages (extensible) Max Binding: All Languages | |
| text | I | 0..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 | External Ids for this plan |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(CareConnect-Organization-1) | Organization that issued id (may be just text) |
| definition | Σ | 0..* | Reference(PlanDefinition | Questionnaire) | Protocol or definition |
| basedOn | Σ | 0..* | Reference(CareConnect-CarePlan-1) | Fulfills care plan |
| replaces | Σ | 0..* | Reference(CareConnect-CarePlan-1) | CarePlan replaced by this CarePlan |
| partOf | Σ | 0..* | Reference(CareConnect-CarePlan-1) | Part of referenced CarePlan |
| status | ?!Σ | 1..1 | code | draft | active | suspended | completed | entered-in-error | cancelled | unknown Binding: CarePlanStatus (required) |
| intent | ?!Σ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required) |
| category | Σ | 0..* | CodeableConcept | Type of plan Binding: Care Plan Category (example) |
| title | Σ | 0..1 | string | Human-friendly name for the CarePlan |
| description | Σ | 0..1 | string | Summary of nature of plan |
| subject | Σ | 1..1 | Reference(Group | CareConnect-Patient-1) | Who care plan is for |
| context | Σ | 0..1 | Reference(CareConnect-EpisodeOfCare-1 | CareConnect-Encounter-1) | Created in context of |
| period | Σ | 0..1 | Period | Time period plan covers |
| author | Σ | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1 | CareConnect-RelatedPerson-1) | Who is responsible for contents of the plan |
| careTeam | 0..* | Reference(CareConnect-CareTeam-1) | Who's involved in plan? | |
| addresses | Σ | 0..* | Reference(CareConnect-Condition-1) | Health issues this plan addresses |
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |
| activity | I | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: Care Plan Activity Outcome (example) | |
| outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |
| progress | 0..* | Annotation | Comments about the activity status/progress | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorString | string | |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| reference | I | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | NutritionOrder | Task | ReferralRequest | VisionPrescription | RequestGroup | CareConnect-ProcedureRequest-1 | CareConnect-MedicationRequest-1) | Activity details defined in specific resource |
| detail | I | 0..1 | BackboneElement | In-line definition of activity |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| category | 0..1 | CodeableConcept | diet | drug | encounter | observation | procedure | supply | other Binding: CarePlanActivityCategory (example) | |
| definition | 0..1 | Reference(PlanDefinition | ActivityDefinition | Questionnaire) | Protocol or definition | |
| code | 0..1 | CodeableConcept | Detail type of activity Binding: Care Plan Activity (example) | |
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: Activity Reason (example) | |
| reasonReference | 0..* | Reference(CareConnect-Condition-1) | Condition triggering need for activity | |
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown Binding: CarePlanActivityStatus (required) |
| statusReason | 0..1 | string | Reason for current status | |
| prohibited | ?! | 0..1 | boolean | Do NOT do |
| scheduled[x] | 0..1 | When activity is to occur | ||
| scheduledTiming | Timing | |||
| scheduledPeriod | Period | |||
| scheduledString | string | |||
| location | 0..1 | Reference(CareConnect-Location-1) | Where it should happen | |
| performer | 0..* | Reference(CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-CareTeam-1 | CareConnect-RelatedPerson-1) | Who will be responsible? | |
| product[x] | 0..1 | What is to be administered/supplied Binding: SNOMED CT Medication Codes (example) | ||
| productCodeableConcept | CodeableConcept | |||
| productReference | Reference(Substance | CareConnect-Medication-1) | |||
| dailyAmount | 0..1 | SimpleQuantity | How to consume/day? | |
| quantity | 0..1 | SimpleQuantity | How much to administer/supply/consume | |
| description | 0..1 | string | Extra info describing activity to perform | |
| note | 0..* | Annotation | Comments about the plan | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |
| authorString | string | |||
| authorReference | Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1) | |||
| time | Σ | 0..1 | dateTime | When the annotation was made |
| text | 1..1 | string | The annotation - text content | |
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| CarePlan.language | extensible | Common Languages Max Binding: All Languages |
| CarePlan.identifier.use | required | IdentifierUse |
| CarePlan.identifier.type | extensible | Identifier Type Codes |
| CarePlan.status | required | CarePlanStatus |
| CarePlan.intent | required | CarePlanIntent |
| CarePlan.category | example | Care Plan Category |
| CarePlan.activity.outcomeCodeableConcept | example | Care Plan Activity Outcome |
| CarePlan.activity.detail.category | example | CarePlanActivityCategory |
| CarePlan.activity.detail.code | example | Care Plan Activity |
| CarePlan.activity.detail.reasonCode | example | Activity Reason |
| CarePlan.activity.detail.status | required | CarePlanActivityStatus |
| CarePlan.activity.detail.product[x] | example | SNOMED CT Medication Codes |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | CarePlan | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | CarePlan | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | CarePlan | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | CarePlan.activity | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| cpl-3 | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
| ele-1 | CarePlan.activity.detail | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |