Left: | US Core CarePlan Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan) |
Right: | US Core CarePlan Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan) |
Error | StructureDefinition.version | Values for version differ: '3.1.1' vs '7.0.0' |
Information | StructureDefinition.date | Values for date differ: '2019-08-29' vs '2023-10-17' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 US Realm Steering Committee' vs 'HL7 International / Cross-Group Projects' |
Information | StructureDefinition.definition | Values for definition differ: 'The US Core CarePlan Profile is based upon the core FHIR CarePlan Resource and created to meet the 2015 Edition Common Clinical Data Set 'Assessment and Plan of Treatment requirements.' vs '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.' |
Information | CarePlan.text | Element minimum cardinalities differ: '1' vs '0' |
Information | StructureDefinition.short | Values for short differ: 'generated | extensions | additional | empty' vs 'generated | additional' |
Information | StructureDefinition.definition | Values for definition differ: 'generated | additional.' vs 'The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.' |
Warning | CarePlan.text.div | Elements differ in definition for mustSupport: 'false' vs 'true' |
Information | StructureDefinition.requirements | Values for requirements differ: 'Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g. 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc.' vs 'Identifies what 'kind' of plan this is to support differentiation between multiple co-existing plans; e.g., 'Home health', 'psychiatric', 'asthma', 'disease management', 'wellness plan', etc.' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/CarePlan | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
date | 2019-08-29 | 2023-10-17 |
|
description | Defines constraints and extensions on the CarePlan resource for the minimal set of data to query and retrieve a patient's Care Plan. | The US Core CarePlan Profile inherits from the FHIR [CarePlan](https://hl7.org/fhir/R4/careplan.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient. It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. |
|
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USCoreCarePlanProfile | ||
publisher | HL7 US Realm Steering Committee | HL7 International / Cross-Group Projects |
|
purpose | |||
status | active | ||
title | US Core CarePlan Profile | ||
type | CarePlan | ||
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan | ||
version | 3.1.1 | 7.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | 0..* | CarePlan | Healthcare plan for patient or group | |||||||||||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | S | 1..1 | Narrative | Text summary of the resource, for human interpretation | S | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| ||||||||
id | 0..1 | string | Unique id for inter-element referencing | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
status | S | 1..1 | code | generated | extensions | additional | empty Binding: ?? (required): Constrained value set of narrative statuses. | S | 1..1 | code | generated | additional Binding: ?? (required): Constrained value set of narrative statuses. | |||||||||
div | C | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content | SC | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content |
| ||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | Σ | 0..* | Identifier | External Ids for this plan | Σ | 0..* | Identifier | External Ids for this plan | |||||||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | Σ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |||||||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | Σ | 0..* | uri | Instantiates external protocol or definition | |||||||||
basedOn | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | Σ | 0..* | Reference(CarePlan) | Fulfills CarePlan | |||||||||
replaces | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | |||||||||
partOf | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | |||||||||
status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: ?? (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: ?? (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. | |||||||||
intent | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: ?? (required): Codes indicating the degree of authority/intentionality associated with a care plan | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: ?? (required): Codes indicating the degree of authority/intentionality associated with a care plan | |||||||||
Slices for category | SΣ | 1..* | CodeableConcept | Type of plan Slice: Unordered, Open by pattern:$this Binding: ?? (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. | SΣ | 1..* | CodeableConcept | Type of plan Slice: Unordered, Open by pattern:$this Binding: ?? (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 | Σ | 0..1 | string | Human-friendly name for the care plan | |||||||||
description | Σ | 0..1 | string | Summary of nature of plan | Σ | 0..1 | string | Summary of nature of plan | |||||||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Who the care plan is for | SΣ | 1..1 | Reference(US Core Patient Profile S | Group) | Who the care plan is for | |||||||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | |||||||||
period | Σ | 0..1 | Period | Time period plan covers | Σ | 0..1 | Period | Time period plan covers | |||||||||
created | Σ | 0..1 | dateTime | Date record was first recorded | Σ | 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 | Σ | 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 | 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? | 0..* | Reference(CareTeam) | Who's involved in plan? | |||||||||||
addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | Σ | 0..* | Reference(Condition) | Health issues this plan addresses | |||||||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | 0..* | Reference(Resource) | Information considered as part of plan | |||||||||||
goal | 0..* | Reference(Goal) | Desired outcome of plan | 0..* | Reference(Goal) | Desired outcome of plan | |||||||||||
activity | C | 0..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both | C | 0..* | 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 | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
outcomeCodeableConcept | 0..* | CodeableConcept | Results of the activity Binding: ?? (example): Identifies the results of the activity. | 0..* | CodeableConcept | Results of the activity Binding: ?? (example): Identifies the results of the activity. | |||||||||||
outcomeReference | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | 0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||||||||
progress | 0..* | Annotation | Comments about the activity status/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 | 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 | C | 0..1 | BackboneElement | In-line definition of activity | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
kind | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: ?? (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | 0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: ?? (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 | 0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||||||||
instantiatesUri | 0..* | uri | Instantiates external protocol or definition | 0..* | uri | Instantiates external protocol or definition | |||||||||||
code | 0..1 | CodeableConcept | Detail type of activity Binding: ?? (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter. | 0..1 | CodeableConcept | Detail type of activity Binding: ?? (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: ?? (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. | 0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: ?? (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 | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||||||||
goal | 0..* | Reference(Goal) | Goals this activity relates to | 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: ?? (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | ?! | 1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: ?? (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 | 0..1 | CodeableConcept | Reason for current status | |||||||||||
doNotPerform | ?! | 0..1 | boolean | If true, activity is prohibiting action | ?! | 0..1 | boolean | If true, activity is prohibiting action | |||||||||
scheduled[x] | 0..1 | Timing, Period, string | When activity is to occur | 0..1 | Timing, Period, string | When activity is to occur | |||||||||||
location | 0..1 | Reference(Location) | Where it should happen | 0..1 | Reference(Location) | Where it should happen | |||||||||||
performer | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | 0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||||||||
product[x] | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Binding: ?? (example): A product supplied or administered as part of a care plan activity. | 0..1 | CodeableConcept, Reference(Medication | Substance) | What is to be administered/supplied Binding: ?? (example): A product supplied or administered as part of a care plan activity. | |||||||||||
dailyAmount | 0..1 | ?? | How to consume/day? | 0..1 | ?? | How to consume/day? | |||||||||||
quantity | 0..1 | ?? | How much to administer/supply/consume | 0..1 | ?? | How much to administer/supply/consume | |||||||||||
description | 0..1 | string | Extra info describing activity to perform | 0..1 | string | Extra info describing activity to perform | |||||||||||
note | 0..* | Annotation | Comments about the plan | 0..* | Annotation | Comments about the plan | |||||||||||
Documentation for this format |