WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-anc/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.org/guides/who/core/StructureDefinition/who-careplan | Version: 0.3.0 | |||
Draft as of 2024-09-10 | Computable Name: WHOCarePlan |
WHO CarePlan
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CPGCarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | Healthcare plan for patient or group | |
identifier | S | 1..* | Identifier | External Ids for this plan |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | order | option |
category | S | 1..* | CodeableConcept | Type of plan |
title | S | 1..1 | string | Human-friendly name for the care plan |
description | S | 0..1 | string | Summary of nature of plan |
subject | S | 1..1 | Reference(WHO Patient) | Who the care plan is for |
encounter | S | 0..1 | Reference(WHO Encounter) | Encounter created as part of |
period | S | 0..1 | Period | Time period plan covers |
careTeam | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? |
addresses | S | 0..* | Reference(WHO Condition) | Health issues this plan addresses |
activity | S | 0..* | BackboneElement | Action to occur as part of plan |
outcomeReference | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. |
reference | S | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource |
detail | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
planFor | S | 0..* | Reference(CPGCase) | Which case URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Ids for this plan |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
instantiatesCanonical | SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition |
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 1..* | 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 | SΣ | 1..1 | string | Human-friendly name for the care plan |
description | SΣ | 0..1 | string | Summary of nature of plan |
subject | SΣ | 1..1 | Reference(WHO Patient) | Who the care plan is for |
encounter | SΣ | 0..1 | Reference(WHO Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Time period plan covers |
created | SΣ | 0..1 | dateTime | Date record was first recorded |
careTeam | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? |
addresses | SΣ | 0..* | Reference(WHO Condition) | Health issues this plan addresses |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | SC | 0..* | 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 |
outcomeReference | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. |
reference | SC | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category 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 |
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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
planFor | S | 0..* | Reference(CPGCase) | Which case URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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 | ?!SΣ | 1..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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | SΣ | 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 | 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | SΣ | 1..* | 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 | SΣ | 1..1 | string | Human-friendly name for the care plan | ||||
description | SΣ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(WHO Patient) | Who the care plan is for | ||||
encounter | SΣ | 0..1 | Reference(WHO Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
created | SΣ | 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 | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? | ||||
addresses | SΣ | 0..* | Reference(WHO Condition) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | S | 0..* | Reference(Goal) | Desired outcome of plan | ||||
activity | SC | 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 | |||||
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 | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. | ||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | SC | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource | ||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CarePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
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() |
This structure is derived from CPGCarePlan
Summary
Mandatory: 6 elements
Must-Support: 17 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from CPGCarePlan
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | Healthcare plan for patient or group | |
identifier | S | 1..* | Identifier | External Ids for this plan |
use | S | 1..1 | code | usual | official | temp | secondary | old (If known) |
system | S | 1..1 | uri | The namespace for the identifier value |
value | S | 1..1 | string | The value that is unique |
status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
intent | S | 1..1 | code | proposal | plan | order | option |
category | S | 1..* | CodeableConcept | Type of plan |
title | S | 1..1 | string | Human-friendly name for the care plan |
description | S | 0..1 | string | Summary of nature of plan |
subject | S | 1..1 | Reference(WHO Patient) | Who the care plan is for |
encounter | S | 0..1 | Reference(WHO Encounter) | Encounter created as part of |
period | S | 0..1 | Period | Time period plan covers |
careTeam | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? |
addresses | S | 0..* | Reference(WHO Condition) | Health issues this plan addresses |
activity | S | 0..* | BackboneElement | Action to occur as part of plan |
outcomeReference | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. |
reference | S | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource |
detail | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | Healthcare plan for patient or group | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | Content/Rules for all slices | |||
planFor | S | 0..* | Reference(CPGCase) | Which case URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | External Ids for this plan |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
instantiatesCanonical | SΣ | 0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition |
status | ?!SΣ | 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 | ?!SΣ | 1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. |
category | SΣ | 1..* | 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 | SΣ | 1..1 | string | Human-friendly name for the care plan |
description | SΣ | 0..1 | string | Summary of nature of plan |
subject | SΣ | 1..1 | Reference(WHO Patient) | Who the care plan is for |
encounter | SΣ | 0..1 | Reference(WHO Encounter) | Encounter created as part of |
period | SΣ | 0..1 | Period | Time period plan covers |
created | SΣ | 0..1 | dateTime | Date record was first recorded |
careTeam | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? |
addresses | SΣ | 0..* | Reference(WHO Condition) | Health issues this plan addresses |
goal | S | 0..* | Reference(Goal) | Desired outcome of plan |
activity | SC | 0..* | 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 |
outcomeReference | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. |
reference | SC | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource |
Documentation for this format |
Path | Conformance | ValueSet | URI |
CarePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | |
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | |
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category 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 |
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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
CarePlan | 0..* | CPGCarePlan | 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
planFor | S | 0..* | Reference(CPGCase) | Which case URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-planFor | ||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 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 | ?!SΣ | 1..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 Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 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 | SΣ | 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 | 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 | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | ||||
category | SΣ | 1..* | 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 | SΣ | 1..1 | string | Human-friendly name for the care plan | ||||
description | SΣ | 0..1 | string | Summary of nature of plan | ||||
subject | SΣ | 1..1 | Reference(WHO Patient) | Who the care plan is for | ||||
encounter | SΣ | 0..1 | Reference(WHO Encounter) | Encounter created as part of | ||||
period | SΣ | 0..1 | Period | Time period plan covers | ||||
created | SΣ | 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 | S | 1..1 | Reference(WHO CareTeam) | Who's involved in plan? | ||||
addresses | SΣ | 0..* | Reference(WHO Condition) | Health issues this plan addresses | ||||
supportingInfo | 0..* | Reference(Resource) | Information considered as part of plan | |||||
goal | S | 0..* | Reference(Goal) | Desired outcome of plan | ||||
activity | SC | 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 | |||||
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 | S | 0..* | Reference(WHO AllergyIntolerance | WHO Appointment | WHO Condition | WHO Encounter | WHO EpisodeOfCare | WHO Immunization | WHO Immunization Not Done | WHO Observation | WHO Observation Not Done | WHO Procedure | WHO Procedure Not Done) | Appointment, Encounter, Procedure, etc. | ||||
progress | 0..* | Annotation | Comments about the activity status/progress | |||||
reference | SC | 0..1 | Reference(WHO Medication Not Requested | WHO MedicationRequest | WHO Service Not Requested | WHO ServiceRequest) | Activity details defined in specific resource | ||||
note | 0..* | Annotation | Comments about the plan | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
CarePlan.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
CarePlan.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
CarePlan.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
CarePlan.status | required | RequestStatushttp://hl7.org/fhir/ValueSet/request-status|4.0.1 from the FHIR Standard | ||||
CarePlan.intent | required | CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1 from the FHIR Standard | ||||
CarePlan.category | example | CarePlanCategoryhttp://hl7.org/fhir/ValueSet/care-plan-category from the FHIR Standard | ||||
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() |
This structure is derived from CPGCarePlan
Summary
Mandatory: 6 elements
Must-Support: 17 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron