FHIR Implementation Guide for NDHM CI Build v2.0
banner

NDHM (R4), Published and maintained by NRCeS for NHA.
This version is based on the NDHM Health Data Interchange Specifications 1.0 and updated periodically.

StructureDefinition-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. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.

Examples

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: https://nrces.in/ndhm/fhir/r4/StructureDefinition/CarePlan

This profile builds on CarePlan


Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare 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
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order | option
... category
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject S1..1Reference(Group | Patient)Who the care plan is for
... encounter 0..1Reference(Encounter)Encounter created as part of
... author 0..1Reference(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 S0..*Reference(Goal)Desired outcome of plan

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan)Fulfills CarePlan
... replaces ΣI0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf ΣI0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category ΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... title ΣI0..1stringHuman-friendly name for the care plan
... description ΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(Group | Patient)Who the care plan is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period ΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author ΣI0..1Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization)Who is the designated responsible party
... contributor I0..*Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization)Who provided the content of the care plan
... careTeam I0..*Reference(CareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal SI0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept I0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress I0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical I0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri I0..*uriInstantiates external protocol or definition
..... code I0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!I1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason I0..1CodeableConceptReason for current status
..... doNotPerform ?!I0..1booleanIf true, activity is prohibiting action
..... scheduled[x] I0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location I0..1Reference(Location)Where it should happen
..... performer I0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description I0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

Summary

Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 6 elements
Fixed Value: 1 element

Structures

This structure refers to these other structures:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..*CarePlanHealthcare 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
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | order | option
... category
.... coding S0..*CodingCode defined by a terminology system
..... system 0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... code 1..1codeSymbol in syntax defined by the system
..... display 1..1stringRepresentation defined by the system
.... text S0..1stringPlain text representation of the concept
... subject S1..1Reference(Group | Patient)Who the care plan is for
... encounter 0..1Reference(Encounter)Encounter created as part of
... author 0..1Reference(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 S0..*Reference(Goal)Desired outcome of plan

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan I0..*CarePlanHealthcare plan for patient or group
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierExternal Ids for this plan
... instantiatesCanonical ΣI0..*canonical(PlanDefinition | Questionnaire | Measure | ActivityDefinition | OperationDefinition)Instantiates FHIR protocol or definition
... instantiatesUri ΣI0..*uriInstantiates external protocol or definition
... basedOn ΣI0..*Reference(CarePlan)Fulfills CarePlan
... replaces ΣI0..*Reference(CarePlan)CarePlan replaced by this CarePlan
... partOf ΣI0..*Reference(CarePlan)Part of referenced CarePlan
... status ?!SΣI1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required)
... intent ?!SΣI1..1codeproposal | plan | order | option
Binding: CarePlanIntent (required)
... category ΣI0..*CodeableConceptType of plan
Binding: CarePlanCategory (example)
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣI0..*CodingCode defined by a terminology system
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣI0..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
..... version ΣI0..1stringVersion of the system - if relevant
..... code ΣI1..1codeSymbol in syntax defined by the system
..... display ΣI1..1stringRepresentation defined by the system
..... userSelected ΣI0..1booleanIf this coding was chosen directly by the user
.... text SΣI0..1stringPlain text representation of the concept
... title ΣI0..1stringHuman-friendly name for the care plan
... description ΣI0..1stringSummary of nature of plan
... subject SΣI1..1Reference(Group | Patient)Who the care plan is for
... encounter ΣI0..1Reference(Encounter)Encounter created as part of
... period ΣI0..1PeriodTime period plan covers
... created ΣI0..1dateTimeDate record was first recorded
... author ΣI0..1Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization)Who is the designated responsible party
... contributor I0..*Reference(Device | RelatedPerson | CareTeam | Patient | Practitioner | PractitionerRole | Organization)Who provided the content of the care plan
... careTeam I0..*Reference(CareTeam)Who's involved in plan?
... addresses ΣI0..*Reference(Condition)Health issues this plan addresses
... supportingInfo I0..*Reference(Resource)Information considered as part of plan
... goal SI0..*Reference(Goal)Desired outcome of plan
... activity I0..*BackboneElementAction to occur as part of plan
cpl-3: Provide a reference or detail, not both
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... outcomeCodeableConcept I0..*CodeableConceptResults of the activity
Binding: CarePlanActivityOutcome (example)
.... outcomeReference I0..*Reference(Resource)Appointment, Encounter, Procedure, etc.
.... progress I0..*AnnotationComments about the activity status/progress
.... reference I0..1Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup)Activity details defined in specific resource
.... detail I0..1BackboneElementIn-line definition of activity
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... kind I0..1codeAppointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required)
..... instantiatesCanonical I0..*canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition)Instantiates FHIR protocol or definition
..... instantiatesUri I0..*uriInstantiates external protocol or definition
..... code I0..1CodeableConceptDetail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example)
..... reasonCode I0..*CodeableConceptWhy activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example)
..... reasonReference I0..*Reference(Condition | Observation | DiagnosticReport | DocumentReference)Why activity is needed
..... goal I0..*Reference(Goal)Goals this activity relates to
..... status ?!I1..1codenot-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required)
..... statusReason I0..1CodeableConceptReason for current status
..... doNotPerform ?!I0..1booleanIf true, activity is prohibiting action
..... scheduled[x] I0..1When activity is to occur
...... scheduledTimingTiming
...... scheduledPeriodPeriod
...... scheduledStringstring
..... location I0..1Reference(Location)Where it should happen
..... performer I0..*Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device)Who will be responsible?
..... product[x] I0..1What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example)
...... productCodeableConceptCodeableConcept
...... productReferenceReference(Medication | Substance)
..... dailyAmount I0..1SimpleQuantityHow to consume/day?
..... quantity I0..1SimpleQuantityHow much to administer/supply/consume
..... description I0..1stringExtra info describing activity to perform
... note I0..*AnnotationComments about the plan

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron