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

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

Resource Profile: Profile_R4_CarePlan_R3

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

This cross-version profile allows R4 CarePlan content to be represented via FHIR STU3 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 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
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 care plan is for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required CarePlanStatus 📍3.0.2 FHIR Std.
CarePlan.intent Base required CarePlanIntent 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error CarePlan If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... definition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesCanonical
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is the designated responsible party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri
..... category
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:kind 0..1 code R4: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.kind
Binding: R4CarePlanActivityKindForR3 (0.1.0) (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical
..... reasonReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Why activity is needed
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... status
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:status 0..1 code R4: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: R4CarePlanActivityStatusForR3 (0.1.0) (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 CodeableConcept R4: statusReason additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
..... performer
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages 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
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... definition Σ 0..* Reference(PlanDefinition | Questionnaire) Protocol or definition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesCanonical
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... basedOn Σ 0..* Reference(CarePlan) Fulfills care plan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: CarePlanStatus (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: Care Plan Category (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 CarePlan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who care plan is for
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Created in context of
... period Σ 0..1 Period Time period plan covers
... author Σ 0..* Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam) Who is responsible for contents of the plan
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is the designated responsible party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: Care Plan Activity Outcome (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 | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... category 0..1 CodeableConcept diet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:kind 0..1 code R4: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.kind
Binding: R4CarePlanActivityKindForR3 (0.1.0) (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... definition 0..1 Reference(PlanDefinition | ActivityDefinition | Questionnaire) Protocol or definition
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... code 0..1 CodeableConcept Detail type of activity
Binding: Care Plan Activity (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: Activity Reason (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) Condition triggering need for activity
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Why activity is needed
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
Binding: CarePlanActivityStatus . (required): Indicates where the activity is at in 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
....... extension:status 0..1 code R4: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: R4CarePlanActivityStatusForR3 (0.1.0) (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
...... value 0..1 code Primitive value for code
..... statusReason 0..1 string Reason for current status
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 CodeableConcept R4: statusReason additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prohibited ?! 0..1 boolean Do NOT do
..... 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 | Organization | RelatedPerson | Patient | CareTeam) Who will be responsible?
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMED CT Medication Codes (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

Path Status Usage ValueSet Version Source
CarePlan.language Base extensible Common Languages 📍3.0.2 FHIR Std.
CarePlan.status Base required CarePlanStatus 📍3.0.2 FHIR Std.
CarePlan.intent Base required CarePlanIntent 📍3.0.2 FHIR Std.
CarePlan.category Base example Care Plan Category 📍3.0.2 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​category Base example CarePlanActivityCategory 📍1.0.0 FHIR Std.
CarePlan.activity.detail.​code Base example Care Plan Activity 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example Activity Reason 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus . 📍3.0.2 tx.fhir.org
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍3.0.2 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-1 error CarePlan If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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 care plan is for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required CarePlanStatus 📍3.0.2 FHIR Std.
CarePlan.intent Base required CarePlanIntent 📍3.0.2 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-1 error CarePlan If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from CarePlan

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... definition
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesCanonical
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is the designated responsible party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri
..... category
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:kind 0..1 code R4: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.kind
Binding: R4CarePlanActivityKindForR3 (0.1.0) (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... definition
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical
..... reasonReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Why activity is needed
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... status
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:status 0..1 code R4: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: R4CarePlanActivityStatusForR3 (0.1.0) (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
..... statusReason
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 CodeableConcept R4: statusReason additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
..... performer
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: Common Languages (extensible): A human language.
Additional BindingsPurpose
All Languages 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
.... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesUri
.... extension:created 0..1 dateTime R4: Date record was first recorded (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.created
.... extension:contributor 0..* Reference(Cross-version Profile for R4.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) R4: Who provided the content of the care plan (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.contributor
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier External Ids for this plan
... definition Σ 0..* Reference(PlanDefinition | Questionnaire) Protocol or definition
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.instantiatesCanonical
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... basedOn Σ 0..* Reference(CarePlan) Fulfills care plan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | suspended | completed | entered-in-error | cancelled | unknown
Binding: CarePlanStatus (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: Care Plan Category (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 CarePlan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who care plan is for
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Created in context of
... period Σ 0..1 Period Time period plan covers
... author Σ 0..* Reference(Patient | Practitioner | RelatedPerson | Organization | CareTeam) Who is responsible for contents of the plan
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Who is the designated responsible party
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: Care Plan Activity Outcome (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 | ProcedureRequest | ReferralRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:instantiatesUri 0..* uri R4: Instantiates external protocol or definition (new)
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... category 0..1 CodeableConcept diet | drug | encounter | observation | procedure | supply | other
Binding: CarePlanActivityCategory (example): High-level categorization of the type of activity in a care plan.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:kind 0..1 code R4: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.kind
Binding: R4CarePlanActivityKindForR3 (0.1.0) (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
...... coding Σ 0..* Coding Code defined by a terminology system
...... text Σ 0..1 string Plain text representation of the concept
..... definition 0..1 Reference(PlanDefinition | ActivityDefinition | Questionnaire) Protocol or definition
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:instantiatesCanonical 0..* uri R4: Instantiates FHIR protocol or definition additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... code 0..1 CodeableConcept Detail type of activity
Binding: Care Plan Activity (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: Activity Reason (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) Condition triggering need for activity
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: Why activity is needed
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... goal 0..* Reference(Goal) Goals this activity relates to
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
Binding: CarePlanActivityStatus . (required): Indicates where the activity is at in 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
....... extension:status 0..1 code R4: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: R4CarePlanActivityStatusForR3 (0.1.0) (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
...... value 0..1 code Primitive value for code
..... statusReason 0..1 string Reason for current status
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:statusReason 0..1 CodeableConcept R4: statusReason additional types
URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-CarePlan.activity.detail.statusReason
...... value 0..1 string Primitive value for string
Max Length:1048576
..... prohibited ?! 0..1 boolean Do NOT do
..... 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 | Organization | RelatedPerson | Patient | CareTeam) Who will be responsible?
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] R4: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMED CT Medication Codes (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

Path Status Usage ValueSet Version Source
CarePlan.language Base extensible Common Languages 📍3.0.2 FHIR Std.
CarePlan.status Base required CarePlanStatus 📍3.0.2 FHIR Std.
CarePlan.intent Base required CarePlanIntent 📍3.0.2 FHIR Std.
CarePlan.category Base example Care Plan Category 📍3.0.2 FHIR Std.
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​category Base example CarePlanActivityCategory 📍1.0.0 FHIR Std.
CarePlan.activity.detail.​code Base example Care Plan Activity 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example Activity Reason 📍3.0.2 FHIR Std.
CarePlan.activity.detail.​status Base required CarePlanActivityStatus . 📍3.0.2 tx.fhir.org
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍3.0.2 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-1 error CarePlan If the resource is contained in another resource, it SHALL NOT contain any narrative contained.text.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 contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() | (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron