LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
| Official URL: http://linuxforhealth.org/fhir/cdm/StructureDefinition/cdm-careplan | Version: 8.0.0 | |||
| Active as of 2022-11-10 | Computable Name: CDMCarePlan | |||
LinuxForHealth Common Data Model definition of what fields we currently define for a care plan
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 | 0..* | CarePlan | Healthcare plan for patient or group | |
  meta | 0..1 | ProcessMeta | Metadata about a resource | |
 contained | 0..0 | |||
 identifier | 1..* | Identifier | External Ids for this plan | |
 type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
| system | 1..1 | uri | The namespace for the identifier value | |
 value | 1..1 | string | The value that is unique | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier | Σ | 1..* | Identifier | External Ids for this plan |
 use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
 subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.identifier.use | required | IdentifierUse |
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet |
| CarePlan.status | required | RequestStatus |
| CarePlan.intent | required | CarePlanIntent |
| 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 | ProcessMeta | Metadata about a 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..* | Identifier | External Ids for this plan | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..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(Organization) | Organization that issued id (may be just text) | ||||
| 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 | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option 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 | Group) | 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 | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
| contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
| careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
| addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
| 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 | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error 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 | ||||
 scheduled[x] | 0..1 | When activity is to occur | ||||||
| scheduledTiming | Timing | |||||||
| scheduledPeriod | Period | |||||||
| scheduledString | string | |||||||
| 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 | Extra info describing activity to perform | |||||
| note | 0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CarePlan.language | preferred | CommonLanguages
| ||||
| CarePlan.identifier.use | required | IdentifierUse | ||||
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet | ||||
| CarePlan.status | required | RequestStatus | ||||
| CarePlan.intent | required | CarePlanIntent | ||||
| CarePlan.category | example | CarePlanCategory | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
This structure is derived from CarePlan
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| contained | 0..0 | |||
| identifier | 1..* | Identifier | External Ids for this plan | |
| type | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | |
| system | 1..1 | uri | The namespace for the identifier value | |
| value | 1..1 | string | The value that is unique | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
| meta | 0..1 | ProcessMeta | Metadata about a resource | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..* | Identifier | External Ids for this plan |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) |
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
| status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
| subject | Σ | 1..1 | Reference(Patient | Group) | Who the care plan is for |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| CarePlan.identifier.use | required | IdentifierUse |
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet |
| CarePlan.status | required | RequestStatus |
| CarePlan.intent | required | CarePlanIntent |
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 | ProcessMeta | Metadata about a 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..* | Identifier | External Ids for this plan | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Value Set (extensible) | ||||
| system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | Σ | 1..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(Organization) | Organization that issued id (may be just text) | ||||
| 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 | draft | active | on-hold | revoked | completed | entered-in-error | unknown 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 | proposal | plan | order | option 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 | Group) | 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 | Σ | 0..1 | dateTime | Date record was first recorded | ||||
| author | Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
| contributor | 0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
| careTeam | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||
| addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | ||||
| supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
| goal | 0..* | Reference(Goal) | Desired outcome of plan | |||||
| activity | C | 0..* | BackboneElement | Action to occur as part of plan | ||||
| 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 | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
| instantiatesUri | 0..* | uri | Instantiates external protocol or definition | |||||
| code | 0..1 | CodeableConcept | Detail type of activity Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | |||||
| reasonCode | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
| reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
| goal | 0..* | Reference(Goal) | Goals this activity relates to | |||||
| status | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error 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 | ||||
| scheduled[x] | 0..1 | When activity is to occur | ||||||
| scheduledTiming | Timing | |||||||
| scheduledPeriod | Period | |||||||
| scheduledString | string | |||||||
| 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 | Extra info describing activity to perform | |||||
| note | 0..* | Annotation | Comments about the plan | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| CarePlan.language | preferred | CommonLanguages
| ||||
| CarePlan.identifier.use | required | IdentifierUse | ||||
| CarePlan.identifier.type | extensible | IdentifierTypeValueSet | ||||
| CarePlan.status | required | RequestStatus | ||||
| CarePlan.intent | required | CarePlanIntent | ||||
| CarePlan.category | example | CarePlanCategory | ||||
| CarePlan.activity.outcomeCodeableConcept | example | CarePlanActivityOutcome | ||||
| CarePlan.activity.detail.kind | required | CarePlanActivityKind | ||||
| CarePlan.activity.detail.code | example | ProcedureCodes(SNOMEDCT) | ||||
| CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindings | ||||
| CarePlan.activity.detail.status | required | CarePlanActivityStatus | ||||
| CarePlan.activity.detail.product[x] | example | SNOMEDCTMedicationCodes |
This structure is derived from CarePlan
Other representations of profile: CSV, Excel, Schematron