Cross Border Data Exchange IG
1.0.0 - CI Build International flag

Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions

Resource Profile: TreatmentPlan - IEHR

Official URL: http://interopehrate.eu/fhir/StructureDefinition/TreatmentPlan-IEHR Version: 1.0.0
Draft as of 2024-04-08 Computable Name: TreatmentPlanIEHR

Usage:

Formal Views of Profile Content

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

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan CarePlan
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... intent S 1..1 code proposal | plan | order | option
Fixed Value: plan
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
... description S 1..1 string Summary of nature of plan
... subject S 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter S 0..1 Reference(Encounter-IEHR) Encounter created as part of
... created S 1..1 dateTime Date record was first recorded
... author S 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... Slices for addresses 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... activity
.... reference S 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... status ?!Σ 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.


Fixed Value: plan
... category SΣ 1..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.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... description SΣ 1..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter-IEHR) Encounter created as part of
... created SΣ 1..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... Slices for addresses Σ 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition Σ 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion Σ 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... activity C 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
.... reference SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleFixed Value: LOINC code 18776-5("Plan of care note")
http://hl7.org/fhir/ValueSet/care-plan-category
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... 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 ?!Σ 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.


Fixed Value: plan
... category SΣ 1..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.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... title Σ 0..1 string Human-friendly name for the care plan
... description SΣ 1..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter-IEHR) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
... created SΣ 1..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(CareTeam) Who's involved in plan?
... Slices for addresses Σ 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition Σ 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion Σ 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 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 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) 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(Condition | Observation | DiagnosticReport | 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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) 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(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity How to consume/day?
..... quantity 0..1 SimpleQuantity 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

PathConformanceValueSet / CodeURI
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleFixed Value: LOINC code 18776-5("Plan of care note")
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
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
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
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
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()

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan CarePlan
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... intent S 1..1 code proposal | plan | order | option
Fixed Value: plan
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
... description S 1..1 string Summary of nature of plan
... subject S 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter S 0..1 Reference(Encounter-IEHR) Encounter created as part of
... created S 1..1 dateTime Date record was first recorded
... author S 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... Slices for addresses 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... activity
.... reference S 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... status ?!Σ 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.


Fixed Value: plan
... category SΣ 1..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.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... description SΣ 1..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter-IEHR) Encounter created as part of
... created SΣ 1..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... Slices for addresses Σ 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition Σ 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion Σ 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... activity C 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
.... reference SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleFixed Value: LOINC code 18776-5("Plan of care note")
http://hl7.org/fhir/ValueSet/care-plan-category
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension S 0..* Extension Extension
Slice: Unordered, Open by value:url
... Provenance S 1..1 Reference(Provenance-IEHR) Extension
URL: http://interopehrate.eu/fhir/StructureDefinition/ProvenanceExtension-IEHR
... 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 ?!Σ 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.


Fixed Value: plan
... category SΣ 1..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.



Fixed Value: As shown
.... id 0..0 string Unique id for inter-element referencing
.... extension 0..0 Extension Additional content defined by implementations
.... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
..... version 0..0 string Version of the system - if relevant
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 18776-5
..... display 1..1 string Representation defined by the system
Fixed Value: Plan of care note
..... userSelected 0..0 boolean If this coding was chosen directly by the user
.... text 0..0 string Plain text representation of the concept
... title Σ 0..1 string Human-friendly name for the care plan
... description SΣ 1..1 string Summary of nature of plan
... subject SΣ 1..1 Reference(Patient-IEHR) Who the care plan is for
... encounter SΣ 0..1 Reference(Encounter-IEHR) Encounter created as part of
... period Σ 0..1 Period Time period plan covers
... created SΣ 1..1 dateTime Date record was first recorded
... author SΣ 1..1 Reference(Patient-IEHR | Practitioner (IPS) | Organization (IPS) | PractitionerRole (IPS) | Device | CareTeam | RelatedPerson) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 0..* Reference(CareTeam) Who's involved in plan?
... Slices for addresses Σ 0..* Reference(Condition-IEHR | DiagnosticConclusion) Health issues this plan addresses
Slice: Unordered, Open by profile:$this.resolve()
.... addresses:addressedCondition Σ 0..* Reference(Condition-IEHR) Health issues this plan addresses
.... addresses:addressedConclusion Σ 0..* Reference(DiagnosticConclusion) Health issues this plan addresses
... supportingInfo 0..* Reference(Resource) Information considered as part of plan
... goal 0..* Reference(Goal) Desired outcome of plan
... activity C 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 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
.... progress 0..* Annotation Comments about the activity status/progress
.... reference SC 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) 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(Condition | Observation | DiagnosticReport | 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(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) 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(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity How to consume/day?
..... quantity 0..1 SimpleQuantity 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

PathConformanceValueSet / CodeURI
CarePlan.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
CarePlan.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
CarePlan.intentrequiredFixed Value: plan
http://hl7.org/fhir/ValueSet/care-plan-intent|4.0.1
from the FHIR Standard
CarePlan.categoryexampleFixed Value: LOINC code 18776-5("Plan of care note")
http://hl7.org/fhir/ValueSet/care-plan-category
from the FHIR Standard
CarePlan.activity.outcomeCodeableConceptexampleCarePlanActivityOutcome
http://hl7.org/fhir/ValueSet/care-plan-activity-outcome
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
from the FHIR Standard
CarePlan.activity.detail.reasonCodeexampleSNOMEDCTClinicalFindings
http://hl7.org/fhir/ValueSet/clinical-findings
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
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