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

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

Resource Profile: Profile_R2_CarePlan_R4

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

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

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
Constraints: ext-1
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
Constraints: ext-1
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) DSTU2: Who care plan is for additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error CarePlan.implicitRules, CarePlan.extension, CarePlan.extension:modified, CarePlan.extension:code, CarePlan.extension:plan, CarePlan.modifierExtension, CarePlan.status, CarePlan.intent, CarePlan.subject, CarePlan.subject.extension, CarePlan.subject.extension:subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:modified, CarePlan.extension:code, CarePlan.extension:plan, 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) DSTU2: Who care plan is for additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) DSTU2: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.period
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) DSTU2: Who is responsible for contents of the plan
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... careTeam
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:role 0..1 CodeableConcept DSTU2: Type of involvement (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.role
..... extension:member 0..1 Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for DSTU2.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for DSTU2.Organization for use in FHIR R4(0.1.0) | Organization) DSTU2: Who is involved (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.member
... addresses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addresses 0..* Reference(Resource) DSTU2: addresses additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... supportingInfo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:support 0..* Reference(Resource) DSTU2: support additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... goal
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:goal 0..* Reference(Resource) DSTU2: goal additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... activity
.... outcomeReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actionResulting 0..* Reference(Resource) DSTU2: Appointments, orders, etc. additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... progress
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:progress 0..* Annotation DSTU2: progress additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.progress
.... reference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Reference(Resource) DSTU2: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:scheduled 0..1 Timing, Period DSTU2: scheduled additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.scheduled
..... reasonReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* Reference(Resource) DSTU2: Condition triggering need for activity additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... goal
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:goal 0..* Reference(Resource) DSTU2: goal additional types
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 DSTU2: not-started | scheduled | in-progress | on-hold | completed | cancelled additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
..... location
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... performer
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* Reference(Resource) DSTU2: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... productReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..1 Reference(Resource) DSTU2: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.note

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... 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:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: All Security Labels . (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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... 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:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.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 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
Constraints: ext-1
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
Constraints: ext-1
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
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 string 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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.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: Identifier Type Codes (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 Σ 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) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category Σ 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
.... 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:subject 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) DSTU2: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period plan covers
.... 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.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
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
.... 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:author 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:role 0..1 CodeableConcept DSTU2: Type of involvement (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.role
Constraints: ext-1
..... extension:member 0..1 Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for DSTU2.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for DSTU2.Organization for use in FHIR R4(0.1.0) | Organization) DSTU2: Who is involved (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.member
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... addresses Σ 0..* Reference(Condition) Health issues this plan addresses
.... 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:addresses 0..1 Reference(Resource) DSTU2: addresses additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... supportingInfo 0..* Reference(Resource) Information considered 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:support 0..1 Reference(Resource) DSTU2: support additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... goal 0..* Reference(Goal) Desired outcome 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:goal 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
..... 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:actionResulting 0..1 Reference(Resource) DSTU2: Appointments, orders, etc. additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... progress 0..* Annotation Comments about the activity status/progress
..... 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:progress 0..* Annotation DSTU2: progress additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.progress
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
.... reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... 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:reference 0..1 Reference(Resource) DSTU2: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:scheduled 0..1 Timing, Period DSTU2: scheduled additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.scheduled
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
...... 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:reasonReference 0..1 Reference(Resource) DSTU2: Condition triggering need for activity additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... goal 0..* Reference(Goal) Goals this activity relates to
...... 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:goal 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:status 0..1 code DSTU2: not-started | scheduled | in-progress | on-hold | completed | cancelled additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
Constraints: ext-1
...... value 0..1 string Primitive value for code
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
...... 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:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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:performer 0..1 Reference(Resource) DSTU2: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... product[x]All Types Content/Rules for all Types
....... 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:alternateReference 0..1 Reference(Resource) DSTU2: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan
.... 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:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
CarePlan.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
CarePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.subject.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.author.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.careTeam.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.addresses.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.supportingInfo.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.goal.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeReference.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.reference.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonReference.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​goal.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​location.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​performer.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error CarePlan.meta, CarePlan.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:modified, CarePlan.extension:code, CarePlan.extension:plan, 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.replaces, CarePlan.partOf, 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.author, CarePlan.author.extension, CarePlan.author.extension:author, CarePlan.author.reference, CarePlan.author.type, CarePlan.author.identifier, CarePlan.author.display, CarePlan.contributor, CarePlan.careTeam, CarePlan.careTeam.extension, CarePlan.careTeam.extension:role, CarePlan.careTeam.extension:member, CarePlan.careTeam.reference, CarePlan.careTeam.type, CarePlan.careTeam.identifier, CarePlan.careTeam.display, CarePlan.addresses, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.addresses.reference, CarePlan.addresses.type, CarePlan.addresses.identifier, CarePlan.addresses.display, CarePlan.supportingInfo, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:support, 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.modifierExtension, CarePlan.activity.outcomeCodeableConcept, CarePlan.activity.outcomeReference, CarePlan.activity.outcomeReference.extension, CarePlan.activity.outcomeReference.extension:actionResulting, CarePlan.activity.outcomeReference.reference, CarePlan.activity.outcomeReference.type, CarePlan.activity.outcomeReference.identifier, CarePlan.activity.outcomeReference.display, 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.reference, CarePlan.activity.reference.extension, CarePlan.activity.reference.extension:reference, CarePlan.activity.reference.reference, CarePlan.activity.reference.type, CarePlan.activity.reference.identifier, CarePlan.activity.reference.display, CarePlan.activity.detail, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:scheduled, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.kind, CarePlan.activity.detail.instantiatesCanonical, CarePlan.activity.detail.instantiatesUri, CarePlan.activity.detail.code, CarePlan.activity.detail.reasonCode, CarePlan.activity.detail.reasonReference, CarePlan.activity.detail.reasonReference.extension, CarePlan.activity.detail.reasonReference.extension:reasonReference, CarePlan.activity.detail.reasonReference.reference, CarePlan.activity.detail.reasonReference.type, CarePlan.activity.detail.reasonReference.identifier, CarePlan.activity.detail.reasonReference.display, CarePlan.activity.detail.goal, CarePlan.activity.detail.goal.extension, CarePlan.activity.detail.goal.extension:goal, CarePlan.activity.detail.goal.reference, CarePlan.activity.detail.goal.type, CarePlan.activity.detail.goal.identifier, CarePlan.activity.detail.goal.display, CarePlan.activity.detail.status, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason, CarePlan.activity.detail.doNotPerform, CarePlan.activity.detail.scheduled[x], CarePlan.activity.detail.location, CarePlan.activity.detail.location.extension, CarePlan.activity.detail.location.extension:location, CarePlan.activity.detail.location.reference, CarePlan.activity.detail.location.type, CarePlan.activity.detail.location.identifier, CarePlan.activity.detail.location.display, CarePlan.activity.detail.performer, CarePlan.activity.detail.performer.extension, CarePlan.activity.detail.performer.extension:performer, CarePlan.activity.detail.performer.reference, CarePlan.activity.detail.performer.type, CarePlan.activity.detail.performer.identifier, CarePlan.activity.detail.performer.display, CarePlan.activity.detail.product[x], CarePlan.activity.detail.product[x].extension, CarePlan.activity.detail.product[x].extension:alternateReference, CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity, CarePlan.activity.detail.description, 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:modified, CarePlan.extension:code, CarePlan.extension:plan, CarePlan.modifierExtension, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.author.extension, CarePlan.author.extension:author, CarePlan.careTeam.extension, CarePlan.careTeam.extension:role, CarePlan.careTeam.extension:member, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:support, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.outcomeReference.extension, CarePlan.activity.outcomeReference.extension:actionResulting, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.reference.extension, CarePlan.activity.reference.extension:reference, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:scheduled, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.reasonReference.extension, CarePlan.activity.detail.reasonReference.extension:reasonReference, CarePlan.activity.detail.goal.extension, CarePlan.activity.detail.goal.extension:goal, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.location.extension, CarePlan.activity.detail.location.extension:location, CarePlan.activity.detail.performer.extension, CarePlan.activity.detail.performer.extension:performer, CarePlan.activity.detail.product[x].extension, CarePlan.activity.detail.product[x].extension:alternateReference, 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
Constraints: ext-1
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
Constraints: ext-1
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) DSTU2: Who care plan is for additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error CarePlan.implicitRules, CarePlan.extension, CarePlan.extension:modified, CarePlan.extension:code, CarePlan.extension:plan, CarePlan.modifierExtension, CarePlan.status, CarePlan.intent, CarePlan.subject, CarePlan.subject.extension, CarePlan.subject.extension:subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error CarePlan.extension, CarePlan.extension:modified, CarePlan.extension:code, CarePlan.extension:plan, 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.text
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) DSTU2: Who care plan is for additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... encounter
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:context 0..1 Reference(Resource) DSTU2: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... period
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.period
... author
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:author 0..* Reference(Resource) DSTU2: Who is responsible for contents of the plan
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... careTeam
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:role 0..1 CodeableConcept DSTU2: Type of involvement (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.role
..... extension:member 0..1 Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for DSTU2.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for DSTU2.Organization for use in FHIR R4(0.1.0) | Organization) DSTU2: Who is involved (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.member
... addresses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addresses 0..* Reference(Resource) DSTU2: addresses additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... supportingInfo
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:support 0..* Reference(Resource) DSTU2: support additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... goal
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:goal 0..* Reference(Resource) DSTU2: goal additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... activity
.... outcomeReference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:actionResulting 0..* Reference(Resource) DSTU2: Appointments, orders, etc. additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... progress
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:progress 0..* Annotation DSTU2: progress additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.progress
.... reference
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:reference 0..1 Reference(Resource) DSTU2: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
.... detail
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:scheduled 0..1 Timing, Period DSTU2: scheduled additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.scheduled
..... reasonReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:reasonReference 0..* Reference(Resource) DSTU2: Condition triggering need for activity additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... goal
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:goal 0..* Reference(Resource) DSTU2: goal additional types
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 DSTU2: not-started | scheduled | in-progress | on-hold | completed | cancelled additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
..... location
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... performer
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:performer 0..* Reference(Resource) DSTU2: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
..... productReference
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... extension:alternateReference 0..1 Reference(Resource) DSTU2: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.note

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. CarePlan 0..* CarePlan(4.0.1) Healthcare plan for patient or group
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
.... 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:meta 0..1 Meta DSTU2: meta additional types
URL: http://hl7.org/fhir/1.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: All Security Labels . (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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
.... 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:text 0..1 (Complex) DSTU2: text additional types
URL: http://hl7.org/fhir/1.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 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:modified 0..1 dateTime DSTU2: When last updated (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.modified
Constraints: ext-1
.... extension:code 0..1 code DSTU2: includes | replaces | fulfills (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.code
Binding: R2CarePlanRelationshipForR4 (0.1.0) (required): Codes identifying the types of relationships between two plans.
Constraints: ext-1
.... extension:plan 1..1 Reference(Cross-version Profile for DSTU2.CarePlan for use in FHIR R4(0.1.0) | CarePlan) DSTU2: Plan relationship exists with (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.relatedPlan.plan
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 string 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 DSTU2: identifier additional types
URL: http://hl7.org/fhir/1.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: Identifier Type Codes (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 Σ 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) Fulfills CarePlan
... replaces Σ 0..* Reference(CarePlan) CarePlan replaced by this CarePlan
... partOf Σ 0..* Reference(CarePlan) Part of referenced CarePlan
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
... intent ?!Σ 1..1 code proposal | plan | order | option
Binding: CarePlanIntent (required): Codes indicating the degree of authority/intentionality associated with a care plan.
... category Σ 0..* CodeableConcept Type of plan
Binding: CarePlanCategory (example): Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.
... title Σ 0..1 string Human-friendly name for the care plan
... description Σ 0..1 string Summary of nature of plan
... subject Σ 1..1 Reference(Patient | Group) Who the care plan is for
.... 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:subject 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter Σ 0..1 Reference(Encounter) Encounter created as part of
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:context 0..1 Reference(Resource) DSTU2: Created in context of additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... period Σ 0..1 Period Time period plan covers
.... 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:period 0..1 Period DSTU2: period additional types
URL: http://hl7.org/fhir/1.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
... author Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam) Who is the designated responsible party
.... 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:author 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:role 0..1 CodeableConcept DSTU2: Type of involvement (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.role
Constraints: ext-1
..... extension:member 0..1 Reference(Cross-version Profile for DSTU2.Practitioner for use in FHIR R4(0.1.0) | PractitionerRole | Cross-version Profile for DSTU2.RelatedPerson for use in FHIR R4(0.1.0) | RelatedPerson | Cross-version Profile for DSTU2.Patient for use in FHIR R4(0.1.0) | Patient | Cross-version Profile for DSTU2.Organization for use in FHIR R4(0.1.0) | Organization) DSTU2: Who is involved (new)
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.participant.member
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... addresses Σ 0..* Reference(Condition) Health issues this plan addresses
.... 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:addresses 0..1 Reference(Resource) DSTU2: addresses additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... supportingInfo 0..* Reference(Resource) Information considered 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:support 0..1 Reference(Resource) DSTU2: support additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... goal 0..* Reference(Goal) Desired outcome 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:goal 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... activity C 0..* BackboneElement Action to occur as part of plan
Constraints: cpl-3
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... outcomeCodeableConcept 0..* CodeableConcept Results of the activity
Binding: CarePlanActivityOutcome (example): Identifies the results of the activity.
.... outcomeReference 0..* Reference(Resource) Appointment, Encounter, Procedure, etc.
..... 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:actionResulting 0..1 Reference(Resource) DSTU2: Appointments, orders, etc. additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... progress 0..* Annotation Comments about the activity status/progress
..... 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:progress 0..* Annotation DSTU2: progress additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.progress
Constraints: ext-1
..... author[x] Σ 0..1 Individual responsible for the annotation
...... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
...... authorString string
..... time Σ 0..1 dateTime When the annotation was made
..... text Σ 1..1 markdown The annotation - text content (as markdown)
.... reference C 0..1 Reference(Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription | RequestGroup) Activity details defined in specific resource
..... 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:reference 0..1 Reference(Resource) DSTU2: reference
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... detail C 0..1 BackboneElement In-line definition of activity
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:scheduled 0..1 Timing, Period DSTU2: scheduled additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.scheduled
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... kind 0..1 code Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription
Binding: CarePlanActivityKind (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity.
..... instantiatesCanonical 0..* canonical(PlanDefinition | ActivityDefinition | Questionnaire | Measure | OperationDefinition) Instantiates FHIR protocol or definition
..... instantiatesUri 0..* uri Instantiates external protocol or definition
..... code 0..1 CodeableConcept Detail type of activity
Binding: ProcedureCodes(SNOMEDCT) (example): Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.
..... reasonCode 0..* CodeableConcept Why activity should be done or why activity was prohibited
Binding: SNOMEDCTClinicalFindings (example): Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.
..... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Why activity is needed
...... 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:reasonReference 0..1 Reference(Resource) DSTU2: Condition triggering need for activity additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... goal 0..* Reference(Goal) Goals this activity relates to
...... 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:goal 0..1 Reference(Resource) DSTU2: 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")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... status ?! 1..1 code not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error
Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle.
...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
....... extension:status 0..1 code DSTU2: not-started | scheduled | in-progress | on-hold | completed | cancelled additional codes
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.activity.detail.status
Binding: CarePlanActivityStatus (required): Indicates where the activity is at in its overall life cycle.
Constraints: ext-1
...... value 0..1 string Primitive value for code
..... statusReason 0..1 CodeableConcept Reason for current status
..... doNotPerform ?! 0..1 boolean If true, activity is prohibiting action
..... scheduled[x] 0..1 When activity is to occur
...... scheduledTiming Timing
...... scheduledPeriod Period
...... scheduledString string
..... location 0..1 Reference(Location) Where it should happen
...... 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:location 0..1 Reference(Resource) DSTU2: location additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... performer 0..* Reference(Practitioner | PractitionerRole | Organization | RelatedPerson | Patient | CareTeam | HealthcareService | Device) Who will be responsible?
...... 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:performer 0..1 Reference(Resource) DSTU2: performer
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
...... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType . (extensible): Aa resource (or, for logical models, the URI of the logical model).
...... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
...... display Σ 0..1 string Text alternative for the resource
..... product[x] 0..1 What is to be administered/supplied
Binding: SNOMEDCTMedicationCodes (example): A product supplied or administered as part of a care plan activity.
...... product[x]All Types Content/Rules for all Types
....... 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:alternateReference 0..1 Reference(Resource) DSTU2: product
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
...... productCodeableConcept CodeableConcept
...... productReference Reference(Medication | Substance)
..... dailyAmount 0..1 SimpleQuantity(4.0.1) How to consume/day?
..... quantity 0..1 SimpleQuantity(4.0.1) How much to administer/supply/consume
..... description 0..1 string Extra info describing activity to perform
... note 0..* Annotation Comments about the plan
.... 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:note 0..1 Annotation DSTU2: note additional types
URL: http://hl7.org/fhir/1.0/StructureDefinition/extension-CarePlan.note
Constraints: ext-1
.... author[x] Σ 0..1 Individual responsible for the annotation
..... authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
..... authorString string
.... time Σ 0..1 dateTime When the annotation was made
.... text Σ 1..1 markdown The annotation - text content (as markdown)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
CarePlan.meta.security Base extensible SecurityLabels . 📍4.0.1 tx.fhir.org
CarePlan.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
CarePlan.language Base preferred Common Languages 📍4.0.1 FHIR Std.
CarePlan.text.status Base required NarrativeStatus 📍4.0.1 FHIR Std.
CarePlan.identifier.​use Base required IdentifierUse 📍4.0.1 FHIR Std.
CarePlan.identifier.​type Base extensible IdentifierType 📍4.0.1 FHIR Std.
CarePlan.status Base required RequestStatus 📍4.0.1 FHIR Std.
CarePlan.intent Base required Care Plan Intent 📍4.0.1 FHIR Std.
CarePlan.category Base example Care Plan Category 📍4.0.1 FHIR Std.
CarePlan.subject.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.encounter.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.author.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.careTeam.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.addresses.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.supportingInfo.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.goal.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.outcomeCodeableConcept Base example Care Plan Activity Outcome 📍4.0.1 FHIR Std.
CarePlan.activity.outcomeReference.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.reference.​type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​kind Base required Care Plan Activity Kind 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​code Base example Procedure Codes (SNOMED CT) 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonCode Base example SNOMED CT Clinical Findings 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​reasonReference.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​goal.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​status Base required CarePlanActivityStatus 📍4.0.1 FHIR Std.
CarePlan.activity.detail.​location.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​performer.type Base extensible ResourceType . 📍4.0.1 tx.fhir.org
CarePlan.activity.detail.​product[x] Base example SNOMED CT Medication Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cpl-3 error CarePlan.activity Provide a reference or detail, not both detail.empty() or reference.empty()
dom-2 error CarePlan If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error CarePlan If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error CarePlan If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error CarePlan If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice CarePlan A resource should have narrative for robust management text.`div`.exists()
ele-1 error CarePlan.meta, CarePlan.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:modified, CarePlan.extension:code, CarePlan.extension:plan, 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.replaces, CarePlan.partOf, 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.author, CarePlan.author.extension, CarePlan.author.extension:author, CarePlan.author.reference, CarePlan.author.type, CarePlan.author.identifier, CarePlan.author.display, CarePlan.contributor, CarePlan.careTeam, CarePlan.careTeam.extension, CarePlan.careTeam.extension:role, CarePlan.careTeam.extension:member, CarePlan.careTeam.reference, CarePlan.careTeam.type, CarePlan.careTeam.identifier, CarePlan.careTeam.display, CarePlan.addresses, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.addresses.reference, CarePlan.addresses.type, CarePlan.addresses.identifier, CarePlan.addresses.display, CarePlan.supportingInfo, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:support, 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.modifierExtension, CarePlan.activity.outcomeCodeableConcept, CarePlan.activity.outcomeReference, CarePlan.activity.outcomeReference.extension, CarePlan.activity.outcomeReference.extension:actionResulting, CarePlan.activity.outcomeReference.reference, CarePlan.activity.outcomeReference.type, CarePlan.activity.outcomeReference.identifier, CarePlan.activity.outcomeReference.display, 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.reference, CarePlan.activity.reference.extension, CarePlan.activity.reference.extension:reference, CarePlan.activity.reference.reference, CarePlan.activity.reference.type, CarePlan.activity.reference.identifier, CarePlan.activity.reference.display, CarePlan.activity.detail, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:scheduled, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.kind, CarePlan.activity.detail.instantiatesCanonical, CarePlan.activity.detail.instantiatesUri, CarePlan.activity.detail.code, CarePlan.activity.detail.reasonCode, CarePlan.activity.detail.reasonReference, CarePlan.activity.detail.reasonReference.extension, CarePlan.activity.detail.reasonReference.extension:reasonReference, CarePlan.activity.detail.reasonReference.reference, CarePlan.activity.detail.reasonReference.type, CarePlan.activity.detail.reasonReference.identifier, CarePlan.activity.detail.reasonReference.display, CarePlan.activity.detail.goal, CarePlan.activity.detail.goal.extension, CarePlan.activity.detail.goal.extension:goal, CarePlan.activity.detail.goal.reference, CarePlan.activity.detail.goal.type, CarePlan.activity.detail.goal.identifier, CarePlan.activity.detail.goal.display, CarePlan.activity.detail.status, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.statusReason, CarePlan.activity.detail.doNotPerform, CarePlan.activity.detail.scheduled[x], CarePlan.activity.detail.location, CarePlan.activity.detail.location.extension, CarePlan.activity.detail.location.extension:location, CarePlan.activity.detail.location.reference, CarePlan.activity.detail.location.type, CarePlan.activity.detail.location.identifier, CarePlan.activity.detail.location.display, CarePlan.activity.detail.performer, CarePlan.activity.detail.performer.extension, CarePlan.activity.detail.performer.extension:performer, CarePlan.activity.detail.performer.reference, CarePlan.activity.detail.performer.type, CarePlan.activity.detail.performer.identifier, CarePlan.activity.detail.performer.display, CarePlan.activity.detail.product[x], CarePlan.activity.detail.product[x].extension, CarePlan.activity.detail.product[x].extension:alternateReference, CarePlan.activity.detail.dailyAmount, CarePlan.activity.detail.quantity, CarePlan.activity.detail.description, 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:modified, CarePlan.extension:code, CarePlan.extension:plan, CarePlan.modifierExtension, CarePlan.identifier.extension, CarePlan.identifier.extension:identifier, CarePlan.subject.extension, CarePlan.subject.extension:subject, CarePlan.encounter.extension, CarePlan.encounter.extension:context, CarePlan.period.extension, CarePlan.period.extension:period, CarePlan.author.extension, CarePlan.author.extension:author, CarePlan.careTeam.extension, CarePlan.careTeam.extension:role, CarePlan.careTeam.extension:member, CarePlan.addresses.extension, CarePlan.addresses.extension:addresses, CarePlan.supportingInfo.extension, CarePlan.supportingInfo.extension:support, CarePlan.goal.extension, CarePlan.goal.extension:goal, CarePlan.activity.extension, CarePlan.activity.modifierExtension, CarePlan.activity.outcomeReference.extension, CarePlan.activity.outcomeReference.extension:actionResulting, CarePlan.activity.progress.extension, CarePlan.activity.progress.extension:progress, CarePlan.activity.reference.extension, CarePlan.activity.reference.extension:reference, CarePlan.activity.detail.extension, CarePlan.activity.detail.extension:scheduled, CarePlan.activity.detail.modifierExtension, CarePlan.activity.detail.reasonReference.extension, CarePlan.activity.detail.reasonReference.extension:reasonReference, CarePlan.activity.detail.goal.extension, CarePlan.activity.detail.goal.extension:goal, CarePlan.activity.detail.status.extension, CarePlan.activity.detail.status.extension:status, CarePlan.activity.detail.location.extension, CarePlan.activity.detail.location.extension:location, CarePlan.activity.detail.performer.extension, CarePlan.activity.detail.performer.extension:performer, CarePlan.activity.detail.product[x].extension, CarePlan.activity.detail.product[x].extension:alternateReference, 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()

 

Other representations of profile: CSV, Excel, Schematron