Person-Centered Outcomes
0.2.0 - ci-build
Person-Centered Outcomes, published by Mountain Lotus WellBeing LLC. 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/mtnlotus/pco-ig/ and changes regularly. See the Directory of published versions
Official URL: http://mtnlotus.com/uv/pco/StructureDefinition/pco-care-plan | Version: 0.2.0 | |||
Draft as of 2024-10-25 | Computable Name: PCOCarePlan |
A person-centered care plan SHALL reference a person-centered goal and SHALL include action steps that support progress toward achievement of the plan’s goals and desired outcomes. A plan SHOULD address the person’s stated priorities for what matters most to them. Action steps may include both treatment procedures and self-care steps identified by the person.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreCarePlanProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | Healthcare plan for patient or group | |
Slices for category | Content/Rules for all slices | |||
category:pcoCategory | S | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
goal | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this plan |
activity | 1..* | BackboneElement | Action to occur as part of plan | |
reference | S | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals |
detail | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation |
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
div | SC | 1..1 | xhtml | (USCDI) 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (USCDI) 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 | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan |
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this 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. |
category:AssessPlan | SΣ | 1..1 | CodeableConcept | (USCDI) 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
category:pcoCategory | SΣ | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who the care plan is for |
goal | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this plan |
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | SC | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.category:AssessPlan | example | Pattern: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG | |
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | 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 : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | 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 | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
div | SC | 1..1 | xhtml | (USCDI) 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this 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 | ?!SΣ | 1..1 | code | (USCDI) 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 | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this 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. | ||||
category:AssessPlan | SΣ | 1..1 | CodeableConcept | (USCDI) 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:pcoCategory | SΣ | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) 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 | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this 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 | SC | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals | ||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.category:AssessPlan | example | Pattern: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG | ||||
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 | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | 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 : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from USCoreCarePlanProfile
Differential View
This structure is derived from USCoreCarePlanProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | Healthcare plan for patient or group | |
Slices for category | Content/Rules for all slices | |||
category:pcoCategory | S | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
goal | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this plan |
activity | 1..* | BackboneElement | Action to occur as part of plan | |
reference | S | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals |
detail | 0..0 | |||
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
text | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation |
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. |
div | SC | 1..1 | xhtml | (USCDI) 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 |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!SΣ | 1..1 | code | (USCDI) 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 | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan |
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this 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. |
category:AssessPlan | SΣ | 1..1 | CodeableConcept | (USCDI) 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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |
category:pcoCategory | SΣ | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets |
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) Who the care plan is for |
goal | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this plan |
activity | C | 1..* | BackboneElement | Action to occur as part of plan cpl-3: Provide a reference or detail, not both |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
reference | SC | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.category:AssessPlan | example | Pattern: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | |
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG | |
CarePlan.activity.detail.status | required | CarePlanActivityStatushttp://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | 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 : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | USCoreCarePlanProfile(6.1.0) | 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 | S | 0..1 | Narrative | (USCDI) Text summary of the resource, for human interpretation | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
status | S | 1..1 | code | (USCDI) generated | extensions | additional | empty Binding: US Core Narrative Status (required): Constrained value set of narrative statuses. | ||||
div | SC | 1..1 | xhtml | (USCDI) 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Ids for this 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 | ?!SΣ | 1..1 | code | (USCDI) 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 | ?!SΣ | 1..1 | code | (USCDI) proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan | ||||
Slices for category | SΣ | 1..* | CodeableConcept | (USCDI) Type of plan Slice: Unordered, Open by pattern:$this 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. | ||||
category:AssessPlan | SΣ | 1..1 | CodeableConcept | (USCDI) 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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/core/CodeSystem/careplan-category | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: assess-plan | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:pcoCategory | SΣ | 0..* | CodeableConcept | Person-Centered Outcome category Binding: PCO Categories (required): Note that other codes are permitted, see Required Bindings When Slicing by Value Sets | ||||
title | Σ | 0..1 | string | Human-friendly name for the care plan | ||||
description | Σ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(US Core Patient Profile(6.1.0)) | (USCDI) 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 | S | 1..* | Reference(Person-Centered Goal) | Person-centered goals supported by this 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 | SC | 1..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Action steps for person-centered goals | ||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.text.status | required | NarrativeStatushttp://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.category:AssessPlan | example | Pattern: assess-planhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
CarePlan.category:pcoCategory | required | PCOCategoryValueSethttp://mtnlotus.com/uv/pco/ValueSet/pco-category-valueset from this IG | ||||
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 | example | ProcedureCodes(SNOMEDCT)http://hl7.org/fhir/ValueSet/procedure-code from the FHIR Standard | ||||
CarePlan.activity.detail.reasonCode | example | SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings from the FHIR Standard | ||||
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 |
Id | Grade | Path(s) | Details | Requirements |
cpl-3 | error | CarePlan.activity | Provide a reference or detail, not both : detail.empty() or reference.empty() | |
dom-2 | error | CarePlan | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | CarePlan | 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 : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | 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-5 | error | CarePlan | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | CarePlan | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
txt-1 | error | CarePlan.text.div | 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 : htmlChecks() | |
txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from USCoreCarePlanProfile
Other representations of profile: CSV, Excel, Schematron