Extensions for Using Data Elements from FHIR STU3 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR STU3 in FHIR R4 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R3_CarePlan_R4

Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-CarePlan Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R3_CarePlan_R4

This cross-version profile allows STU3 CarePlan content to be represented via FHIR R4 CarePlan resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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(4.0.1) Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
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 CarePlan.implicitRules, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.status, CarePlan.intent, CarePlan.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension Must 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(4.0.1) Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... activity
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.definition
..... status
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:status 0..1 code STU3: not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
..... statusReason
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 string STU3: statusReason additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 ?!Σ 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.
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 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 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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(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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.definition
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:status 0..1 code STU3: not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
Constraints: ext-1
...... value 0..1 string Primitive value for code
..... statusReason 0..1 CodeableConcept Reason for current status
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:statusReason 0..1 string STU3: statusReason additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
Constraints: ext-1
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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(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

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.encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
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 example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
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.

Constraints

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 CarePlan.meta, CarePlan.implicitRules, CarePlan.language, CarePlan.text, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier, CarePlan.instantiatesCanonical, CarePlan.instantiatesUri, CarePlan.basedOn, CarePlan.replaces, CarePlan.partOf, CarePlan.status, CarePlan.intent, CarePlan.category, CarePlan.title, CarePlan.description, CarePlan.subject, CarePlan.encounter, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.encounter.reference, CarePlan.encounter.type, CarePlan.encounter.identifier, CarePlan.encounter.display, CarePlan.period, CarePlan.created, CarePlan.author, CarePlan.contributor, CarePlan.careTeam, CarePlan.addresses, CarePlan.supportingInfo, CarePlan.goal, CarePlan.activity, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.outcomeCodeableConcept, CarePlan.activity.outcomeReference, CarePlan.activity.progress, CarePlan.activity.reference, CarePlan.activity.detail, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:definition, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.kind, CarePlan.activity.detail.instantiatesCanonical, CarePlan.activity.detail.instantiatesUri, CarePlan.activity.detail.code, CarePlan.activity.detail.reasonCode, CarePlan.activity.detail.reasonReference, CarePlan.activity.detail.goal, CarePlan.activity.detail.status, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason, CarePlan.activity.detail.statusReason.extension, CarePlan.activity.detail.statusReason.extension:statusReason, CarePlan.activity.detail.statusReason.coding, CarePlan.activity.detail.statusReason.text, CarePlan.activity.detail.doNotPerform, CarePlan.activity.detail.scheduled[x], CarePlan.activity.detail.location, CarePlan.activity.detail.performer, CarePlan.activity.detail.product[x], CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity, CarePlan.activity.detail.description, CarePlan.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:definition, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason.extension, CarePlan.activity.detail.statusReason.extension:statusReason Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for

doco Documentation for this format

Terminology Bindings

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.

Constraints

Id Grade Path(s) Description Expression
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 CarePlan.implicitRules, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.status, CarePlan.intent, CarePlan.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension Must 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(4.0.1) Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) STU3: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... activity
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.definition
..... status
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:status 0..1 code STU3: not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
..... statusReason
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 string STU3: statusReason additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) 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
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:definition 0..* Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.definition
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... 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 ?!Σ 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.
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) STU3: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period plan covers
... created Σ 0..1 dateTime Date record was first recorded
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
... contributor 0..* Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who provided the content of the care plan
... careTeam 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 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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(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
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:definition 0..1 Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R4(0.1.0) | PlanDefinition | Cross-version Profile for STU3.ActivityDefinition for use in FHIR R4(0.1.0) | ActivityDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R4(0.1.0) | Questionnaire) STU3: Protocol or definition (new)
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.definition
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:status 0..1 code STU3: not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
Constraints: ext-1
...... value 0..1 string Primitive value for code
..... statusReason 0..1 CodeableConcept Reason for current status
...... id 0..1 string Unique id for inter-element referencing
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:statusReason 0..1 string STU3: statusReason additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
Constraints: ext-1
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... 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(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

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.encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
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 example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
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.

Constraints

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 CarePlan.meta, CarePlan.implicitRules, CarePlan.language, CarePlan.text, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier, CarePlan.instantiatesCanonical, CarePlan.instantiatesUri, CarePlan.basedOn, CarePlan.replaces, CarePlan.partOf, CarePlan.status, CarePlan.intent, CarePlan.category, CarePlan.title, CarePlan.description, CarePlan.subject, CarePlan.encounter, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.encounter.reference, CarePlan.encounter.type, CarePlan.encounter.identifier, CarePlan.encounter.display, CarePlan.period, CarePlan.created, CarePlan.author, CarePlan.contributor, CarePlan.careTeam, CarePlan.addresses, CarePlan.supportingInfo, CarePlan.goal, CarePlan.activity, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.outcomeCodeableConcept, CarePlan.activity.outcomeReference, CarePlan.activity.progress, CarePlan.activity.reference, CarePlan.activity.detail, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:definition, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.kind, CarePlan.activity.detail.instantiatesCanonical, CarePlan.activity.detail.instantiatesUri, CarePlan.activity.detail.code, CarePlan.activity.detail.reasonCode, CarePlan.activity.detail.reasonReference, CarePlan.activity.detail.goal, CarePlan.activity.detail.status, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason, CarePlan.activity.detail.statusReason.extension, CarePlan.activity.detail.statusReason.extension:statusReason, CarePlan.activity.detail.statusReason.coding, CarePlan.activity.detail.statusReason.text, CarePlan.activity.detail.doNotPerform, CarePlan.activity.detail.scheduled[x], CarePlan.activity.detail.location, CarePlan.activity.detail.performer, CarePlan.activity.detail.product[x], CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity, CarePlan.activity.detail.description, CarePlan.note All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:definition, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason.extension, CarePlan.activity.detail.statusReason.extension:statusReason Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron