WHO Family Planning Implementation Guide
0.2.0 - CI Build
WHO Family Planning Implementation Guide, published by World Health Organization (WHO). 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/WorldHealthOrganization/smart-fp/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.org/guides/who/fp-cds/StructureDefinition/who-fp-careplan-requested-contraceptive-method | Version: 0.2.0 | |||
| Draft as of 2026-11-19 | Computable Name: WHO-FP CarePlan (Requested Contraceptive Method) | |||
The first pick of method desired by the client, prior to medical eligibility tests. This may be the method in mind or the method selected after discussing the full range of methods.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
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. | |
![]() ![]() |
1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |
![]() ![]() ![]() ![]() |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If true, activity is prohibiting action | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Ids for this plan | |||||
![]() ![]() |
0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() |
0..* | Reference(CarePlan) | Fulfills CarePlan | |||||
![]() ![]() |
0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | |||||
![]() ![]() |
0..* | Reference(CarePlan) | Part of referenced CarePlan | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | |||||
![]() ![]() |
0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | |||||
![]() ![]() |
0..1 | string | Human-friendly name for the care plan | |||||
![]() ![]() |
0..1 | string | Summary of nature of plan | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Who the care plan is for | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
![]() ![]() |
0..1 | Period | Time period plan covers | |||||
![]() ![]() |
0..1 | dateTime | Date record was first recorded | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | |||||
![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() |
0..* | Reference(Condition) | Health issues this plan addresses | |||||
![]() ![]() |
0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() |
0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If true, activity is prohibiting action | |||||
![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | How to consume/day? Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
| CarePlan.activity.detail.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from CarePlan
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |
![]() ![]() |
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. | |
![]() ![]() |
1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | |
![]() ![]() |
1..1 | Reference(Patient | Group) | Who the care plan is for | |
![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 |
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity |
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |
![]() ![]() ![]() ![]() |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | |
![]() ![]() ![]() ![]() |
0..1 | boolean | If true, activity is prohibiting action | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
Differential View
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | CarePlan | Method requested | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | |||||
![]() ![]() |
0..* | Identifier | External Ids for this plan | |||||
![]() ![]() |
0..* | canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() |
0..* | Reference(CarePlan) | Fulfills CarePlan | |||||
![]() ![]() |
0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | |||||
![]() ![]() |
0..* | Reference(CarePlan) | Part of referenced CarePlan | |||||
![]() ![]() |
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. | |||||
![]() ![]() |
1..1 | code | proposal | plan | order | option Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan. | |||||
![]() ![]() |
0..* | CodeableConcept | Type of plan Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc. | |||||
![]() ![]() |
0..1 | string | Human-friendly name for the care plan | |||||
![]() ![]() |
0..1 | string | Summary of nature of plan | |||||
![]() ![]() |
1..1 | Reference(Patient | Group) | Who the care plan is for | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter created as part of | |||||
![]() ![]() |
0..1 | Period | Time period plan covers | |||||
![]() ![]() |
0..1 | dateTime | Date record was first recorded | |||||
![]() ![]() |
0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | |||||
![]() ![]() |
0..* | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who provided the content of the care plan | |||||
![]() ![]() |
0..* | Reference(CareTeam) | Who's involved in plan? | |||||
![]() ![]() |
0..* | Reference(Condition) | Health issues this plan addresses | |||||
![]() ![]() |
0..* | Reference(Resource) | Information considered as part of plan | |||||
![]() ![]() |
0..* | Reference(Goal) | Desired outcome of plan | |||||
![]() ![]() |
C | 0..* | BackboneElement | Action to occur as part of plan Constraints: cpl-3 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Results of the activity Binding: CarePlanActivityOutcome (example): Identifies the results of the activity. | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Appointment, Encounter, Procedure, etc. | |||||
![]() ![]() ![]() |
0..* | Annotation | Comments about the activity status/progress | |||||
![]() ![]() ![]() |
C | 0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) | Activity details defined in specific resource | ||||
![]() ![]() ![]() |
C | 0..1 | BackboneElement | In-line definition of activity | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |||||
![]() ![]() ![]() ![]() |
0..* | canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) | Instantiates FHIR protocol or definition | |||||
![]() ![]() ![]() ![]() |
0..* | uri | Instantiates external protocol or definition | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Detail type of activity Binding: http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values (required) | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Why activity should be done or why activity was prohibited Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc. | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) | Why activity is needed | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Goal) | Goals this activity relates to | |||||
![]() ![]() ![]() ![]() |
1..1 | code | not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reason for current status | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If true, activity is prohibiting action | |||||
![]() ![]() ![]() ![]() |
0..1 | When activity is to occur | ||||||
![]() ![]() ![]() ![]() ![]() |
Timing | |||||||
![]() ![]() ![]() ![]() ![]() |
Period | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Location) | Where it should happen | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) | Who will be responsible? | |||||
![]() ![]() ![]() ![]() |
0..1 | What is to be administered/supplied Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity. | ||||||
![]() ![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() ![]() ![]() |
Reference(Medication | Substance) | |||||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | How to consume/day? Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | How much to administer/supply/consume Constraints: sqty-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Extra info describing activity to perform | |||||
![]() ![]() |
0..* | Annotation | Comments about the plan | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| CarePlan.status | Base | required | RequestStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍4.0.1 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.outcomeCodeableConcept | Base | example | Care Plan Activity Outcome | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.kind | Base | required | Care Plan Activity Kind | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.code | Base | required | http://hl7.org/fhir/who-int/core/ImplementationGuide/core/ValueSet/careplanbirthcontrolmethods-values | Not State | Unknown |
| CarePlan.activity.detail.reasonCode | Base | example | SNOMED CT Clinical Findings | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.status | Base | required | CarePlanActivityStatus | 📍4.0.1 | FHIR Std. |
| CarePlan.activity.detail.product[x] | Base | example | SNOMED CT Medication Codes | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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()
|
| sqty-1 | error | CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from CarePlan
Other representations of profile: CSV, Excel, Schematron