Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions
| 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_R5 | ||
This cross-version profile allows STU3 CarePlan content to be represented via FHIR R5 CarePlan resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  CarePlan |
0..* | CarePlan(5.0.0) | Healthcare plan for patient or group | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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 R5(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R5(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 |
| 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 | directive 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 |
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: Who care plan is for 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 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.subject.reference | 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.subject.extension, CarePlan.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CarePlan
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan(5.0.0) | Healthcare plan for patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
 meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | Meta | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels  (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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 R5(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R5(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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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 | ServiceRequest | RequestOrchestration | NutritionOrder) | Fulfills plan, proposal or order | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: Fulfills care plan 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: replaces 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | STU3: partOf 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| 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 | directive 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: Who care plan is for 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | ||||
| id |
0..1 | id | 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| created |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| custodian |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:author |
0..1 | Reference(Resource) | STU3: Who is responsible for contents of the plan 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| 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? | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:careTeam |
0..1 | Reference(Resource) | STU3: careTeam 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| addresses |
Σ | 0..* | CodeableReference(Condition) | Health issues this plan addresses Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:addresses |
0..* | Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition) | STU3: addresses additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.addresses Constraints: ext-1 | |||||
| concept |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
| reference |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInfo |
0..1 | Reference(Resource) | STU3: supportingInfo 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:goal |
0..1 | Reference(Resource) | STU3: goal 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| activity |
0..* | BackboneElement | Action to occur or has occurred as part of plan | |||||
| 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:outcomeCodeableConcept |
0..* | CodeableConcept | STU3: Results of the activity (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.outcomeCodeableConcept Constraints: ext-1 | |||||
| extension:outcomeReference |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) | STU3: Appointment, Encounter, Procedure, etc. (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.outcomeReference Constraints: ext-1 | |||||
| extension:detail |
0..1 | (Complex) | STU3: In-line definition of activity (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| performedActivity |
0..* | CodeableReference(Resource) | Results of the activity (concept, or Appointment, Encounter, Procedure, etc.) Binding: CarePlanActivityPerformed (example): Identifies the results of the activity. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:progress |
0..* | Annotation | STU3: progress additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.progress Constraints: ext-1 | |||||
 author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| plannedActivityReference |
0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestOrchestration | ImmunizationRecommendation | SupplyRequest) | Activity that is intended to be part of the care plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reference |
0..1 | Reference(Resource) | STU3: Activity details defined in specific resource 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments about the plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.meta.security | Base | extensible |
All Security Labels
|
📍5.0.0 | tx.fhir.org |
| CarePlan.meta.tag | Base | example | Common Tags | 📍5.0.0 | FHIR Std. |
| CarePlan.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CarePlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CarePlan.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| CarePlan.basedOn.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.replaces.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.partOf.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍5.0.0 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍5.0.0 | FHIR Std. |
| CarePlan.subject.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.encounter.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.custodian.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.careTeam.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.addresses | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| CarePlan.supportingInfo.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.goal.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.activity.performedActivity | Base | example | Care Plan Activity Performed | 📍5.0.0 | FHIR Std. |
| CarePlan.activity.plannedActivityReference.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.meta.extension, CarePlan.meta.extension:meta, CarePlan.meta.versionId, CarePlan.meta.lastUpdated, CarePlan.meta.source, CarePlan.meta.profile, CarePlan.meta.security, CarePlan.meta.tag, CarePlan.implicitRules, CarePlan.language, CarePlan.text, CarePlan.text.extension, CarePlan.text.extension:text, CarePlan.text.status, CarePlan.text.div, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.identifier.use, CarePlan.identifier.type, CarePlan.identifier.system, CarePlan.identifier.value, CarePlan.identifier.period, CarePlan.identifier.assigner, CarePlan.instantiatesCanonical, CarePlan.instantiatesUri, CarePlan.basedOn, CarePlan.basedOn.extension, CarePlan.basedOn.extension:basedOn, CarePlan.basedOn.reference, CarePlan.basedOn.type, CarePlan.basedOn.identifier, CarePlan.basedOn.display, CarePlan.replaces, CarePlan.replaces.extension, CarePlan.replaces.extension:replaces, CarePlan.replaces.reference, CarePlan.replaces.type, CarePlan.replaces.identifier, CarePlan.replaces.display, CarePlan.partOf, CarePlan.partOf.extension, CarePlan.partOf.extension:partOf, CarePlan.partOf.reference, CarePlan.partOf.type, CarePlan.partOf.identifier, CarePlan.partOf.display, CarePlan.status, CarePlan.intent, CarePlan.category, CarePlan.title, CarePlan.description, CarePlan.subject, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.subject.reference, CarePlan.subject.type, CarePlan.subject.identifier, CarePlan.subject.display, CarePlan.encounter, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.encounter.reference, CarePlan.encounter.type, CarePlan.encounter.identifier, CarePlan.encounter.display, CarePlan.period, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.period.start, CarePlan.period.end, CarePlan.created, CarePlan.custodian, CarePlan.custodian.extension, CarePlan.custodian.extension:author, CarePlan.custodian.reference, CarePlan.custodian.type, CarePlan.custodian.identifier, CarePlan.custodian.display, CarePlan.contributor, CarePlan.careTeam, CarePlan.careTeam.extension, CarePlan.careTeam.extension:careTeam, CarePlan.careTeam.reference, CarePlan.careTeam.type, CarePlan.careTeam.identifier, CarePlan.careTeam.display, CarePlan.addresses, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.addresses.concept, CarePlan.addresses.reference, CarePlan.supportingInfo, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:supportingInfo, CarePlan.supportingInfo.reference, CarePlan.supportingInfo.type, CarePlan.supportingInfo.identifier, CarePlan.supportingInfo.display, CarePlan.goal, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.goal.reference, CarePlan.goal.type, CarePlan.goal.identifier, CarePlan.goal.display, CarePlan.activity, CarePlan.activity.extension, CarePlan.activity.extension:outcomeCodeableConcept, CarePlan.activity.extension:outcomeReference, CarePlan.activity.extension:detail, CarePlan.activity.modifierExtension, CarePlan.activity.performedActivity, CarePlan.activity.progress, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.progress.author[x], CarePlan.activity.progress.time, CarePlan.activity.progress.text, CarePlan.activity.plannedActivityReference, CarePlan.activity.plannedActivityReference.extension, CarePlan.activity.plannedActivityReference.extension:reference, CarePlan.activity.plannedActivityReference.reference, CarePlan.activity.plannedActivityReference.type, CarePlan.activity.plannedActivityReference.identifier, CarePlan.activity.plannedActivityReference.display, CarePlan.note, CarePlan.note.extension, CarePlan.note.extension:note, CarePlan.note.author[x], CarePlan.note.time, CarePlan.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CarePlan.meta.extension, CarePlan.meta.extension:meta, CarePlan.text.extension, CarePlan.text.extension:text, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.basedOn.extension, CarePlan.basedOn.extension:basedOn, CarePlan.replaces.extension, CarePlan.replaces.extension:replaces, CarePlan.partOf.extension, CarePlan.partOf.extension:partOf, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.custodian.extension, CarePlan.custodian.extension:author, CarePlan.careTeam.extension, CarePlan.careTeam.extension:careTeam, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:supportingInfo, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.activity.extension, CarePlan.activity.extension:outcomeCodeableConcept, CarePlan.activity.extension:outcomeReference, CarePlan.activity.extension:detail, CarePlan.activity.modifierExtension, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.plannedActivityReference.extension, CarePlan.activity.plannedActivityReference.extension:reference, CarePlan.note.extension, CarePlan.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from CarePlan
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| CarePlan |
0..* | CarePlan(5.0.0) | Healthcare plan for patient or group | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| 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 R5(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R5(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 |
| 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 | directive 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 |
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
| extension:subject |
0..1 | Reference(Resource) | STU3: Who care plan is for 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 |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍5.0.0 | FHIR Std. |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.subject.reference | 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.subject.extension, CarePlan.subject.extension:subject | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from CarePlan
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| CarePlan |
0..* | CarePlan(5.0.0) | Healthcare plan for patient or group | |||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:meta |
0..1 | Meta | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.meta Constraints: ext-1 | |||||
| versionId |
Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated |
Σ | 0..1 | instant | When the resource version last changed | ||||
| source |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| profile |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
| security |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
| 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 | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:text |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.text Constraints: ext-1 | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
| 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 R5(0.1.0) | PlanDefinition | Cross-version Profile for STU3.Questionnaire for use in FHIR R5(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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:identifier |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.identifier Constraints: ext-1 | |||||
| use |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| 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 | ServiceRequest | RequestOrchestration | NutritionOrder) | Fulfills plan, proposal or order | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:basedOn |
0..1 | Reference(Resource) | STU3: Fulfills care plan 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| replaces |
Σ | 0..* | Reference(CarePlan) | CarePlan replaced by this CarePlan | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:replaces |
0..1 | Reference(Resource) | STU3: replaces 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| partOf |
Σ | 0..* | Reference(CarePlan) | Part of referenced CarePlan | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:partOf |
0..1 | Reference(Resource) | STU3: partOf 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| 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 | directive 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 | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:subject |
0..1 | Reference(Resource) | STU3: Who care plan is for 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| encounter |
Σ | 0..1 | Reference(Encounter) | The Encounter during which this CarePlan was created | ||||
| id |
0..1 | id | 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| period |
Σ | 0..1 | Period | Time period plan covers | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:period |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.period Constraints: ext-1 | |||||
| start |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
| end |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| created |
Σ | 0..1 | dateTime | Date record was first recorded | ||||
| custodian |
Σ | 0..1 | Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) | Who is the designated responsible party | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:author |
0..1 | Reference(Resource) | STU3: Who is responsible for contents of the plan 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| 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? | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:careTeam |
0..1 | Reference(Resource) | STU3: careTeam 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| addresses |
Σ | 0..* | CodeableReference(Condition) | Health issues this plan addresses Binding: SNOMEDCTClinicalFindings (example): Codes that describe the health issues this plan addresses. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:addresses |
0..* | Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition) | STU3: addresses additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.addresses Constraints: ext-1 | |||||
| concept |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
| reference |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
| supportingInfo |
0..* | Reference(Resource) | Information considered as part of plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:supportingInfo |
0..1 | Reference(Resource) | STU3: supportingInfo 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| goal |
0..* | Reference(Goal) | Desired outcome of plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:goal |
0..1 | Reference(Resource) | STU3: goal 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| activity |
0..* | BackboneElement | Action to occur or has occurred as part of plan | |||||
| 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:outcomeCodeableConcept |
0..* | CodeableConcept | STU3: Results of the activity (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.outcomeCodeableConcept Constraints: ext-1 | |||||
| extension:outcomeReference |
0..* | Reference(Cross-version Profile for STU3.Resource for use in FHIR R5(0.1.0) | Resource) | STU3: Appointment, Encounter, Procedure, etc. (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.outcomeReference Constraints: ext-1 | |||||
| extension:detail |
0..1 | (Complex) | STU3: In-line definition of activity (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.detail Constraints: ext-1 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
| performedActivity |
0..* | CodeableReference(Resource) | Results of the activity (concept, or Appointment, Encounter, Procedure, etc.) Binding: CarePlanActivityPerformed (example): Identifies the results of the activity. | |||||
| progress |
0..* | Annotation | Comments about the activity status/progress | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:progress |
0..* | Annotation | STU3: progress additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.activity.progress Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| plannedActivityReference |
0..1 | Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestOrchestration | ImmunizationRecommendation | SupplyRequest) | Activity that is intended to be part of the care plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:reference |
0..1 | Reference(Resource) | STU3: Activity details defined in specific resource 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") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display |
ΣC | 0..1 | string | Text alternative for the resource | ||||
| note |
0..* | Annotation | Comments about the plan | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:note |
0..* | Annotation | STU3: note additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-CarePlan.note Constraints: ext-1 | |||||
| author[x] |
Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference |
Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Organization) | |||||||
| authorString |
string | |||||||
| time |
Σ | 0..1 | dateTime | When the annotation was made | ||||
| text |
Σ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| CarePlan.meta.security | Base | extensible |
All Security Labels
|
📍5.0.0 | tx.fhir.org |
| CarePlan.meta.tag | Base | example | Common Tags | 📍5.0.0 | FHIR Std. |
| CarePlan.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| CarePlan.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| CarePlan.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| CarePlan.basedOn.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.replaces.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.partOf.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.status | Base | required | RequestStatus | 📍5.0.0 | FHIR Std. |
| CarePlan.intent | Base | required | Care Plan Intent | 📍5.0.0 | FHIR Std. |
| CarePlan.category | Base | example | Care Plan Category | 📍5.0.0 | FHIR Std. |
| CarePlan.subject.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.encounter.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.custodian.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.careTeam.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.addresses | Base | example | SNOMED CT Clinical Findings | 📍5.0.0 | FHIR Std. |
| CarePlan.supportingInfo.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.goal.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| CarePlan.activity.performedActivity | Base | example | Care Plan Activity Performed | 📍5.0.0 | FHIR Std. |
| CarePlan.activity.plannedActivityReference.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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.meta.extension, CarePlan.meta.extension:meta, CarePlan.meta.versionId, CarePlan.meta.lastUpdated, CarePlan.meta.source, CarePlan.meta.profile, CarePlan.meta.security, CarePlan.meta.tag, CarePlan.implicitRules, CarePlan.language, CarePlan.text, CarePlan.text.extension, CarePlan.text.extension:text, CarePlan.text.status, CarePlan.text.div, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.identifier.use, CarePlan.identifier.type, CarePlan.identifier.system, CarePlan.identifier.value, CarePlan.identifier.period, CarePlan.identifier.assigner, CarePlan.instantiatesCanonical, CarePlan.instantiatesUri, CarePlan.basedOn, CarePlan.basedOn.extension, CarePlan.basedOn.extension:basedOn, CarePlan.basedOn.reference, CarePlan.basedOn.type, CarePlan.basedOn.identifier, CarePlan.basedOn.display, CarePlan.replaces, CarePlan.replaces.extension, CarePlan.replaces.extension:replaces, CarePlan.replaces.reference, CarePlan.replaces.type, CarePlan.replaces.identifier, CarePlan.replaces.display, CarePlan.partOf, CarePlan.partOf.extension, CarePlan.partOf.extension:partOf, CarePlan.partOf.reference, CarePlan.partOf.type, CarePlan.partOf.identifier, CarePlan.partOf.display, CarePlan.status, CarePlan.intent, CarePlan.category, CarePlan.title, CarePlan.description, CarePlan.subject, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.subject.reference, CarePlan.subject.type, CarePlan.subject.identifier, CarePlan.subject.display, CarePlan.encounter, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.encounter.reference, CarePlan.encounter.type, CarePlan.encounter.identifier, CarePlan.encounter.display, CarePlan.period, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.period.start, CarePlan.period.end, CarePlan.created, CarePlan.custodian, CarePlan.custodian.extension, CarePlan.custodian.extension:author, CarePlan.custodian.reference, CarePlan.custodian.type, CarePlan.custodian.identifier, CarePlan.custodian.display, CarePlan.contributor, CarePlan.careTeam, CarePlan.careTeam.extension, CarePlan.careTeam.extension:careTeam, CarePlan.careTeam.reference, CarePlan.careTeam.type, CarePlan.careTeam.identifier, CarePlan.careTeam.display, CarePlan.addresses, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.addresses.concept, CarePlan.addresses.reference, CarePlan.supportingInfo, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:supportingInfo, CarePlan.supportingInfo.reference, CarePlan.supportingInfo.type, CarePlan.supportingInfo.identifier, CarePlan.supportingInfo.display, CarePlan.goal, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.goal.reference, CarePlan.goal.type, CarePlan.goal.identifier, CarePlan.goal.display, CarePlan.activity, CarePlan.activity.extension, CarePlan.activity.extension:outcomeCodeableConcept, CarePlan.activity.extension:outcomeReference, CarePlan.activity.extension:detail, CarePlan.activity.modifierExtension, CarePlan.activity.performedActivity, CarePlan.activity.progress, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.progress.author[x], CarePlan.activity.progress.time, CarePlan.activity.progress.text, CarePlan.activity.plannedActivityReference, CarePlan.activity.plannedActivityReference.extension, CarePlan.activity.plannedActivityReference.extension:reference, CarePlan.activity.plannedActivityReference.reference, CarePlan.activity.plannedActivityReference.type, CarePlan.activity.plannedActivityReference.identifier, CarePlan.activity.plannedActivityReference.display, CarePlan.note, CarePlan.note.extension, CarePlan.note.extension:note, CarePlan.note.author[x], CarePlan.note.time, CarePlan.note.text | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | CarePlan.meta.extension, CarePlan.meta.extension:meta, CarePlan.text.extension, CarePlan.text.extension:text, CarePlan.extension, CarePlan.extension:definition, CarePlan.modifierExtension, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.basedOn.extension, CarePlan.basedOn.extension:basedOn, CarePlan.replaces.extension, CarePlan.replaces.extension:replaces, CarePlan.partOf.extension, CarePlan.partOf.extension:partOf, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.custodian.extension, CarePlan.custodian.extension:author, CarePlan.careTeam.extension, CarePlan.careTeam.extension:careTeam, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:supportingInfo, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.activity.extension, CarePlan.activity.extension:outcomeCodeableConcept, CarePlan.activity.extension:outcomeReference, CarePlan.activity.extension:detail, CarePlan.activity.modifierExtension, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.plannedActivityReference.extension, CarePlan.activity.plannedActivityReference.extension:reference, CarePlan.note.extension, CarePlan.note.extension:note | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | CarePlan.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | CarePlan.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from CarePlan
Summary
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r3.r5#0.1.0 based on FHIR 5.0.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
