Left: | PA Care Plan (http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan) |
Right: | PA Care Plan (http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan) |
Error | StructureDefinition.version | Values for version differ: '1.0.0-ballot' vs '1.0.0' |
Information | StructureDefinition.date | Values for date differ: '2023-03-28T18:30:00+00:00' vs '2023-08-25T16:04:38+00:00' |
Information | StructureDefinition.comment | Values for comment differ: 'The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan. This element is labeled as a modifier because the status contains the code entered-in-error that marks the plan as not currently valid. The only status source systems are expected to support are 'active' and 'completed'. Receiving systems must handle the others if present, though they do not need to differentiate additional statues other than 'entered-in-error'.' vs 'In most instances, the 'status' of the CarePlan is expected to be 'active'. However, when the goals of the CarePlan are either achieved or no longer applicable, the status should be updated to 'completed' or 'revoked' respectively. While there are additional statuses available, they might not be universally used across all systems. Even though source systems are only expected to support 'active' and 'completed', receiving systems must handle the others if present, though they do not need to differentiate additional statues other than 'entered-in-error'.' |
Information | StructureDefinition.short | Values for short differ: 'A reference from one resource to another' vs 'Individual responsible for the annotation' |
Information | StructureDefinition.definition | Values for definition differ: 'A reference from one resource to another.' vs 'The individual responsible for making the annotation.' |
Information | StructureDefinition.comment | Values for comment differ: 'References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.' vs 'Organization is used when there's no need for specific attribution as to who made the comment.' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan | ||
copyright | |||
date | 2023-03-28T18:30:00+00:00 | 2023-08-25T16:04:38+00:00 |
|
description | A plan describing the plan to improve or maintain a patient's level of physical activity | ||
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | PACarePlan | ||
publisher | HL7 International - Patient Care WG | ||
purpose | |||
status | active | ||
title | PA Care Plan | ||
type | CarePlan | ||
url | http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-careplan | ||
version | 1.0.0-ballot | 1.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group | 0..* | USCoreCarePlanProfile | Healthcare plan for patient or group | |||||||||||
id | Σ | 0..1 | id | 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..0 | ?!Σ | 0..0 | |||||||||||||
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 | 1..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 | extensions | additional | empty Binding: ?? (required): Constrained value set of narrative statuses. | |||||||||
div | SC | 1..1 | xhtml | Limited xhtml content | SC | 1..1 | xhtml | Limited xhtml 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..0 | ?! | 0..0 | |||||||||||||
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 | Plan Binding: ?? (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: plan | ?!SΣ | 1..1 | code | Plan Binding: ?? (required): Codes indicating the degree of authority/intentionality associated with a care plan Required Pattern: plan | |||||||||
Slices for category | SΣ | 2..* | 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Σ | 2..* | 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) | 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 | SΣ | 0..1 | Period | Time period plan covers | SΣ | 0..1 | Period | Time period plan covers | |||||||||
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 | |||||||||||
start | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | SΣC | 0..1 | dateTime | Starting time with inclusive boundary | |||||||||
end | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | SΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | |||||||||
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 | C | 0..* | BackboneElement | Action to occur as part of plan | |||||||||
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 | S | 0..* | Annotation | Comments about the plan | S | 0..* | Annotation | Comments about the plan | |||||||||
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 | |||||||||||
author[x] | SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Patient Profile S | PA Related Person) | A reference from one resource to another | SΣ | 1..1 | Reference(US Core Practitioner Profile S | US Core Organization Profile S | US Core Patient Profile S | PA Related Person) | Individual responsible for the annotation | |||||||||
time | SΣ | 1..1 | dateTime | When the annotation was made | SΣ | 1..1 | dateTime | When the annotation was made | |||||||||
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | |||||||||
Documentation for this format |