FHIR Implementation Guide for ABDM
6.5.0 - active India flag

Banner

FHIR Implementation Guide for ABDM - Local Development build (v6.5.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: CarePlan

Official URL: https://nrces.in/ndhm/fhir/r4/StructureDefinition/CarePlan Version: 6.5.0
Draft as of 2020-08-17 Computable Name: CarePlan

This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient.

This profile sets minimum expectations for the CarePlan resource to record, search, and fetch assessment and plan of treatment data associated with a patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn Σ 0..* Reference(CarePlan) Fulfills 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 Σ 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.
.... coding SΣ 0..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Group | Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... author Σ 0..1 Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who provided the content of the care plan
... addresses Σ 0..* Reference(Condition) Health issues this plan addresses
... goal S 0..* Reference(Goal) Desired outcome of plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... basedOn 0..* Reference(CarePlan) Fulfills CarePlan
... replaces 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf 0..* Reference(CarePlan) Part of referenced CarePlan
... intent S 1..1 code proposal | plan | order | option
... category
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... subject S 1..1 Reference(Group | Patient) Who the care plan is for
... encounter 0..1 Reference(Encounter) Encounter created as part of
... author 0..1 Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
.... identifier
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who provided the content of the care plan
... addresses 0..* Reference(Condition) Health issues this plan addresses
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity
.... reference 0..1 Reference(CommunicationRequest | DeviceRequest | NutritionOrder | Task | VisionPrescription | RequestGroup | ServiceRequest | MedicationRequest | Appointment) Activity details defined in specific resource
.... detail
..... reasonReference 0..* Reference(DiagnosticReport | Condition | Observation | DocumentReference) Why activity is needed
..... performer 0..* Reference(RelatedPerson | CareTeam | HealthcareService | Device | Practitioner | PractitionerRole | Organization | Patient) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
...... productCodeableConcept CodeableConcept
...... productReference Reference(Substance | Medication)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... 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 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 Σ 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... 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(Group | Patient) 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(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... 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 ?!Σ 0..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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... display Σ 0..1 string Text alternative for the resource
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) 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 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... 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 C 0..1 Reference(CommunicationRequest | DeviceRequest | NutritionOrder | Task | VisionPrescription | RequestGroup | ServiceRequest | MedicationRequest | Appointment) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... 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
..... kind 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.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: 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.
..... reasonReference 0..* Reference(DiagnosticReport | Condition | Observation | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(RelatedPerson | CareTeam | HealthcareService | Device | Practitioner | PractitionerRole | Organization | Patient) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Substance | Medication)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category|4.0.1
From the FHIR Standard
CarePlan.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
CarePlan.author.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CarePlan.author.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
From the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome|4.0.1
From the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
From the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code|4.0.1
From the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1
From the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... basedOn Σ 0..* Reference(CarePlan) Fulfills 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 Σ 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.
.... coding SΣ 0..* Coding Code defined by a terminology system
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
.... text SΣ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Group | Patient) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
... author Σ 0..1 Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who provided the content of the care plan
... addresses Σ 0..* Reference(Condition) Health issues this plan addresses
... goal S 0..* Reference(Goal) Desired outcome of plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... basedOn 0..* Reference(CarePlan) Fulfills CarePlan
... replaces 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf 0..* Reference(CarePlan) Part of referenced CarePlan
... intent S 1..1 code proposal | plan | order | option
... category
.... coding S 0..* Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1 code Symbol in syntax defined by the system
..... display 1..1 string Representation defined by the system
.... text S 0..1 string Plain text representation of the concept
... subject S 1..1 Reference(Group | Patient) Who the care plan is for
... encounter 0..1 Reference(Encounter) Encounter created as part of
... author 0..1 Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
.... identifier
..... assigner 0..1 Reference(Organization) Organization that issued id (may be just text)
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who provided the content of the care plan
... addresses 0..* Reference(Condition) Health issues this plan addresses
... goal S 0..* Reference(Goal) Desired outcome of plan
... activity
.... reference 0..1 Reference(CommunicationRequest | DeviceRequest | NutritionOrder | Task | VisionPrescription | RequestGroup | ServiceRequest | MedicationRequest | Appointment) Activity details defined in specific resource
.... detail
..... reasonReference 0..* Reference(DiagnosticReport | Condition | Observation | DocumentReference) Why activity is needed
..... performer 0..* Reference(RelatedPerson | CareTeam | HealthcareService | Device | Practitioner | PractitionerRole | Organization | Patient) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
...... productCodeableConcept CodeableConcept
...... productReference Reference(Substance | Medication)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan 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.
Additional BindingsPurpose
AllLanguages Max Binding
... text 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
... 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 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 Σ 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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 0..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://snomed.info/sct
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
..... display Σ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text SΣ 0..1 string Plain text representation of the concept
... 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(Group | Patient) 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(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) Who is the designated responsible party
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... 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 ?!Σ 0..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 Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value Σ 0..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)
.... display Σ 0..1 string Text alternative for the resource
... contributor 0..* Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization) 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 0..* Reference(Goal) Desired outcome of plan
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... 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 C 0..1 Reference(CommunicationRequest | DeviceRequest | NutritionOrder | Task | VisionPrescription | RequestGroup | ServiceRequest | MedicationRequest | Appointment) Activity details defined in specific resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... 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
..... kind 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.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: 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.
..... reasonReference 0..* Reference(DiagnosticReport | Condition | Observation | DocumentReference) Why activity is needed
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
..... performer 0..* Reference(RelatedPerson | CareTeam | HealthcareService | Device | Practitioner | PractitionerRole | Organization | Patient) Who will be responsible?
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... productCodeableConcept CodeableConcept
...... productReference Reference(Substance | Medication)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
CarePlan.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages|4.0.1
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
From the FHIR Standard
CarePlan.intentrequiredCarePlanIntent
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
From the FHIR Standard
CarePlan.categoryexampleCarePlanCategory
http://hl7.org/fhir/ValueSet/care-plan-category|4.0.1
From the FHIR Standard
CarePlan.author.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types|4.0.1
From the FHIR Standard
CarePlan.author.identifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
CarePlan.author.identifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type|4.0.1
From the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome|4.0.1
From the FHIR Standard
CarePlan.activity.detail.kindrequiredCarePlanActivityKind
http://hl7.org/fhir/ValueSet/care-plan-activity-kind|4.0.1
From the FHIR Standard
CarePlan.activity.detail.codeexampleProcedureCodes(SNOMEDCT)
http://hl7.org/fhir/ValueSet/procedure-code|4.0.1
From the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings|4.0.1
From the FHIR Standard
CarePlan.activity.detail.statusrequiredCarePlanActivityStatus
http://hl7.org/fhir/ValueSet/care-plan-activity-status|4.0.1
From the FHIR Standard
CarePlan.activity.detail.product[x]exampleSNOMEDCTMedicationCodes
http://hl7.org/fhir/ValueSet/medication-codes|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cpl-3errorCarePlan.activityProvide a reference or detail, not both
: detail.empty() or reference.empty()
dom-2errorCarePlanIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorCarePlanIf 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-4errorCarePlanIf 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-5errorCarePlanIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceCarePlanA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron