HL7 FHIR® CareConnect Baseline Profiles for STU3 (Draft Standard for Trial Use)

There are no (further) constraints on this element

Element id

CarePlan

Short description

Healthcare plan for patient or group

Alternate names

Care Team

Definition

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty()
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[classCode=PCPR, moodCode=INT]
w5: clinical.careprovision

0..1

There are no (further) constraints on this element

Element id

CarePlan.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

CarePlan.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

CarePlan.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Data type

Binding

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

CarePlan.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, dom-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

CarePlan.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier

Short description

External Ids for this plan

Definition

This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

Requirements

Need to allow connection to a wider workflow.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
v2: PTH-3
rim: .id
w5: id

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Element id

CarePlan.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

definition

Σ C

0..*

There are no (further) constraints on this element

Element id

CarePlan.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

basedOn

Σ C

0..*

Element id

CarePlan.basedOn

Short description

Fulfills care plan

Alternate names

fulfills

Definition

A care plan that is fulfilled in whole or in part by this care plan.

Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

Σ C

0..*

Element id

CarePlan.replaces

Short description

CarePlan replaced by this CarePlan

Alternate names

supersedes

Definition

Completed or terminated care plan whose function is taken by this new care plan.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Comments

The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

partOf

Σ C

0..*

Element id

CarePlan.partOf

Short description

Part of referenced CarePlan

Definition

A larger care plan of which this particular care plan is a component or step.

Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.status

Short description

Definition

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments

The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the care plan.

This element is labeled as a modifier because the status contains the code entered-in-error] that marks the plan as not currently valid.

Data type

Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

CarePlanStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: PTH-5
rim: .statusCode planned = new active = active completed = completed
w5: status

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.intent

Short description

proposal | plan | order | option

Definition

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a care plan

CarePlanIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent

category

0..*

There are no (further) constraints on this element

Element id

CarePlan.category

Short description

Type of plan

Definition

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

Requirements

Used for filtering what plan(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

Data type

Binding

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

Care Plan Category (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInfo
w5: class

title

0..1

There are no (further) constraints on this element

Element id

CarePlan.title

Short description

Human-friendly name for the CarePlan

Definition

Human-friendly name for the CarePlan.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.description

Short description

Summary of nature of plan

Definition

A description of the scope and nature of the plan.

Requirements

Provides more detail than conveyed by category.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
w5: what

subject

Σ C

1..1

Element id

CarePlan.subject

Short description

Who care plan is for

Alternate names

patient

Definition

Identifies the patient or group whose intended care is described by the plan.

Comments

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
v2: PID-3
rim: .participation[typeCode=PAT].role[classCode=PAT]
w5: who.focus

context

Σ C

0..1

Element id

CarePlan.context

Short description

Created in context of

Alternate names

encounter

Definition

Identifies the original context in which this particular CarePlan was created.

Comments

Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context
v2: Associated PV1
rim: .
w5: context

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.period

Short description

Time period plan covers

Alternate names

timing

Definition

Indicates when the plan did (or is intended to) come into effect and end.

Requirements

Allows tracking what plan(s) are in effect at a particular time.

Comments

Any activities scheduled as part of the plan should be constrained to the specified period regardless of whether the activities are planned within a single encounter/episode or across multiple encounters/episodes (e.g. the longitudinal management of a chronic condition).

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Request.occurrencePeriod
v2: GOL-7 / GOL-8
rim: .effectiveTime
w5: when.init

author

Σ C

0..*

Element id

CarePlan.author

Short description

Who is responsible for contents of the plan

Definition

Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

Comments

Collaborative care plans may have multiple authors.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester.agent (if only one author)
w5: who.source

careTeam

0..*

Element id

CarePlan.careTeam

Short description

Who's involved in plan?

Definition

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer (similar but does not entail CareTeam)
w5: who.actor

addresses

Σ C

0..*

Element id

CarePlan.addresses

Short description

Health issues this plan addresses

Definition

Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

Requirements

Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
v2: PRB-4
rim: .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]
w5: why

supportingInfo

0..*

There are no (further) constraints on this element

Element id

CarePlan.supportingInfo

Short description

Information considered as part of plan

Definition

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.

Requirements

Identifies barriers and other considerations associated with the care plan.

Comments

Use "concern" to identify specific conditions addressed by the care plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.goal

Short description

Desired outcome of plan

Definition

Describes the intended objective(s) of carrying out the care plan.

Requirements

Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.

Comments

Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].

activity

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity

Short description

Action to occur as part of plan

Definition

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

Requirements

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: no mapping NOTE: This is a list of contained Request-Event tuples!
rim: .outboundRelationship[typeCode=COMP].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeCodeableConcept

Short description

Results of the activity

Definition

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Data type

Care Plan Activity Outcome (example)

Binding

Identifies the results of the activity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

outcomeReference

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

Requirements

Links plan to resulting actions.

Comments

The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lb and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event that is outcome of Request in activity.reference
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.status (Annotation instead of CodableConcept)
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

reference

0..1

Element id

CarePlan.activity.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Standard extension exists (goal-pertainstogoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request that resulted in Event in activity.actionResulting
rim: .outboundRelationship[typeCode=COMP].target

detail

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail

Short description

In-line definition of activity

Definition

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Requirements

Details in a simple form for generic care plan systems.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

category

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.category

Short description

Definition

High-level categorization of the type of activity in a care plan.

Requirements

May determine what types of extensions are permitted.

Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Data type

CarePlanActivityCategory (example)

Binding

High-level categorization of the type of activity in a care plan.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInformation
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

definition

0..1

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

code

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.code

Short description

Detail type of activity

Definition

Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

Data type

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

Care Plan Activity (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

reasonCode

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

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.

Activity Reason (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..*

Element id

CarePlan.activity.detail.reasonReference

Short description

Condition triggering need for activity

Definition

Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.goal
rim: .outboundRelationship[typeCode<=OBJ].

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.status

Short description

Definition

Identifies what progress is being made for the specific activity.

Requirements

Indicates progress against the plan, whether the activity is still relevant for the plan.

Comments

Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated.
The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.

Data type

CarePlanActivityStatus (required)

Binding

Indicates where the activity is at in its overall life cycle.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

prohibited

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.prohibited

Short description

Do NOT do

Definition

If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Default value

false

Mappings

rim: n/a
rim: actionNegationInd

scheduled[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.scheduled[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence
v2: TQ1
rim: .effectiveTime

scheduledPeriod

There are no (further) constraints on this element

Data type

scheduledString

There are no (further) constraints on this element

Data type

scheduledTiming

There are no (further) constraints on this element

Data type

location

0..1

Element id

CarePlan.activity.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..*

Element id

CarePlan.activity.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 e {provider participations} ) / PRT-5 : ( PRV-4 e {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

SNOMED CT Medication Codes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

productCodeableConcept

Data type

productReference

Data type

dailyAmount

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.description

Short description

Extra info describing activity to perform

Definition

This provides a textual description of constraints on the intended activity occurrence, including relation to other activities. It may also include objectives, pre-conditions and end-conditions. Finally, it may convey specifics about the activity such as body site, method, route, etc.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.note
v2: NTE?
rim: .text

note

0..*

There are no (further) constraints on this element

Element id

CarePlan.note

Short description

Comments about the plan

Definition

General notes about the care plan not covered elsewhere.

Requirements

Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.

Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.note.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

Differential View

CareConnect-CarePlan-1 (CarePlan)

There are no (further) constraints on this element

Element id

CarePlan

Short description

Healthcare plan for patient or group

Alternate names

Care Team

Definition

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty()
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[classCode=PCPR, moodCode=INT]
w5: clinical.careprovision

0..1

There are no (further) constraints on this element

Element id

CarePlan.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

CarePlan.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

CarePlan.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

CarePlan.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, dom-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

CarePlan.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier

Short description

External Ids for this plan

Definition

Requirements

Need to allow connection to a wider workflow.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
v2: PTH-3
rim: .id
w5: id

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Element id

CarePlan.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

definition

Σ C

0..*

There are no (further) constraints on this element

Element id

CarePlan.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

basedOn

Σ C

0..*

Element id

CarePlan.basedOn

Short description

Fulfills care plan

Alternate names

fulfills

Definition

A care plan that is fulfilled in whole or in part by this care plan.

Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

Σ C

0..*

Element id

CarePlan.replaces

Short description

CarePlan replaced by this CarePlan

Alternate names

supersedes

Definition

Completed or terminated care plan whose function is taken by this new care plan.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

partOf

Σ C

0..*

Element id

CarePlan.partOf

Short description

Part of referenced CarePlan

Definition

A larger care plan of which this particular care plan is a component or step.

Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.status

Short description

Definition

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error] that marks the plan as not currently valid.

Data type

Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

CarePlanStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: PTH-5
rim: .statusCode planned = new active = active completed = completed
w5: status

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.intent

Short description

proposal | plan | order | option

Definition

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a care plan

CarePlanIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent

category

0..*

There are no (further) constraints on this element

Element id

CarePlan.category

Short description

Type of plan

Definition

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

Requirements

Used for filtering what plan(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

Data type

Binding

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

Care Plan Category (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInfo
w5: class

title

0..1

There are no (further) constraints on this element

Element id

CarePlan.title

Short description

Human-friendly name for the CarePlan

Definition

Human-friendly name for the CarePlan.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.description

Short description

Summary of nature of plan

Definition

A description of the scope and nature of the plan.

Requirements

Provides more detail than conveyed by category.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
w5: what

subject

Σ C

1..1

Element id

CarePlan.subject

Short description

Who care plan is for

Alternate names

patient

Definition

Identifies the patient or group whose intended care is described by the plan.

Comments

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
v2: PID-3
rim: .participation[typeCode=PAT].role[classCode=PAT]
w5: who.focus

context

Σ C

0..1

Element id

CarePlan.context

Short description

Created in context of

Alternate names

encounter

Definition

Identifies the original context in which this particular CarePlan was created.

Comments

Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context
v2: Associated PV1
rim: .
w5: context

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.period

Short description

Time period plan covers

Alternate names

timing

Definition

Indicates when the plan did (or is intended to) come into effect and end.

Requirements

Allows tracking what plan(s) are in effect at a particular time.

Comments

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Request.occurrencePeriod
v2: GOL-7 / GOL-8
rim: .effectiveTime
w5: when.init

author

Σ C

0..*

Element id

CarePlan.author

Short description

Who is responsible for contents of the plan

Definition

Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

Comments

Collaborative care plans may have multiple authors.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester.agent (if only one author)
w5: who.source

careTeam

0..*

Element id

CarePlan.careTeam

Short description

Who's involved in plan?

Definition

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer (similar but does not entail CareTeam)
w5: who.actor

addresses

Σ C

0..*

Element id

CarePlan.addresses

Short description

Health issues this plan addresses

Definition

Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
v2: PRB-4
rim: .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]
w5: why

supportingInfo

0..*

There are no (further) constraints on this element

Element id

CarePlan.supportingInfo

Short description

Information considered as part of plan

Definition

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.

Requirements

Identifies barriers and other considerations associated with the care plan.

Comments

Use "concern" to identify specific conditions addressed by the care plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.goal

Short description

Desired outcome of plan

Definition

Describes the intended objective(s) of carrying out the care plan.

Requirements

Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.

Comments

Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].

activity

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity

Short description

Action to occur as part of plan

Definition

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

Requirements

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: no mapping NOTE: This is a list of contained Request-Event tuples!
rim: .outboundRelationship[typeCode=COMP].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeCodeableConcept

Short description

Results of the activity

Definition

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Data type

Care Plan Activity Outcome (example)

Binding

Identifies the results of the activity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

outcomeReference

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Requirements

Links plan to resulting actions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event that is outcome of Request in activity.reference
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.status (Annotation instead of CodableConcept)
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

reference

0..1

Element id

CarePlan.activity.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request that resulted in Event in activity.actionResulting
rim: .outboundRelationship[typeCode=COMP].target

detail

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail

Short description

In-line definition of activity

Definition

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Requirements

Details in a simple form for generic care plan systems.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

category

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.category

Short description

Definition

High-level categorization of the type of activity in a care plan.

Requirements

May determine what types of extensions are permitted.

Comments

Data type

CarePlanActivityCategory (example)

Binding

High-level categorization of the type of activity in a care plan.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInformation
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

definition

0..1

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

code

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.code

Short description

Detail type of activity

Definition

Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

Data type

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

Care Plan Activity (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

reasonCode

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

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.

Activity Reason (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..*

Element id

CarePlan.activity.detail.reasonReference

Short description

Condition triggering need for activity

Definition

Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.goal
rim: .outboundRelationship[typeCode<=OBJ].

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.status

Short description

Definition

Identifies what progress is being made for the specific activity.

Requirements

Indicates progress against the plan, whether the activity is still relevant for the plan.

Comments

Data type

CarePlanActivityStatus (required)

Binding

Indicates where the activity is at in its overall life cycle.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

prohibited

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.prohibited

Short description

Do NOT do

Definition

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Default value

false

Mappings

rim: n/a
rim: actionNegationInd

scheduled[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.scheduled[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence
v2: TQ1
rim: .effectiveTime

scheduledPeriod

There are no (further) constraints on this element

Data type

scheduledString

There are no (further) constraints on this element

Data type

scheduledTiming

There are no (further) constraints on this element

Data type

location

0..1

Element id

CarePlan.activity.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..*

Element id

CarePlan.activity.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 e {provider participations} ) / PRT-5 : ( PRV-4 e {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

SNOMED CT Medication Codes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

productCodeableConcept

Data type

productReference

Data type

dailyAmount

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.description

Short description

Extra info describing activity to perform

Definition

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.note
v2: NTE?
rim: .text

note

0..*

There are no (further) constraints on this element

Element id

CarePlan.note

Short description

Comments about the plan

Definition

General notes about the care plan not covered elsewhere.

Requirements

Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.note.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

Hybrid View

CareConnect-CarePlan-1 (CarePlan)

There are no (further) constraints on this element

Element id

CarePlan

Short description

Healthcare plan for patient or group

Alternate names

Care Team

Definition

Data type

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty()
dom-4: 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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty()

Mappings

rim: Entity. Role, or Act
workflow: Request
rim: Act[classCode=PCPR, moodCode=INT]
w5: clinical.careprovision

0..1

There are no (further) constraints on this element

Element id

CarePlan.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

There are no (further) constraints on this element

Element id

CarePlan.meta

Short description

Metadata about the resource

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A

implicitRules

Σ ?!

0..1

There are no (further) constraints on this element

Element id

CarePlan.implicitRules

Short description

A set of rules under which this content was created

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Comments

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

Comments

Data type

Binding

A human language.

Common Languages (extensible)

Binding extensions

maxValueSet	All Languages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

text

0..1

There are no (further) constraints on this element

Element id

CarePlan.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, dom-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

There are no (further) constraints on this element

Element id

CarePlan.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Data type

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier

Short description

External Ids for this plan

Definition

Requirements

Need to allow connection to a wider workflow.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
workflow: Request.identifier
v2: PTH-3
rim: .id
w5: id

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.identifier.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.use

Short description

usual | official | temp | secondary (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Data type

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

CarePlan.identifier.type

Short description

Description of identifier

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

Identifier Type Codes (extensible)

Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.value

Short description

The value that is unique

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.identifier.period

Short description

Time period when id is/was valid for use

Definition

Time period during which identifier is/was valid for use.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Element id

CarePlan.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

definition

Σ C

0..*

There are no (further) constraints on this element

Element id

CarePlan.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

basedOn

Σ C

0..*

Element id

CarePlan.basedOn

Short description

Fulfills care plan

Alternate names

fulfills

Definition

A care plan that is fulfilled in whole or in part by this care plan.

Requirements

Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.basedOn

replaces

Σ C

0..*

Element id

CarePlan.replaces

Short description

CarePlan replaced by this CarePlan

Alternate names

supersedes

Definition

Completed or terminated care plan whose function is taken by this new care plan.

Requirements

Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.replaces

partOf

Σ C

0..*

Element id

CarePlan.partOf

Short description

Part of referenced CarePlan

Definition

A larger care plan of which this particular care plan is a component or step.

Comments

Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)

status

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.status

Short description

Definition

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

Requirements

Allows clinicians to determine whether the plan is actionable or not.

Comments

This element is labeled as a modifier because the status contains the code entered-in-error] that marks the plan as not currently valid.

Data type

Binding

Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.

CarePlanStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: PTH-5
rim: .statusCode planned = new active = active completed = completed
w5: status

intent

Σ ?!

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.intent

Short description

proposal | plan | order | option

Definition

Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.

Requirements

Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.

Comments

This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

Data type

Binding

Codes indicating the degree of authority/intentionality associated with a care plan

CarePlanIntent (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.intent

category

0..*

There are no (further) constraints on this element

Element id

CarePlan.category

Short description

Type of plan

Definition

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.

Requirements

Used for filtering what plan(s) are retrieved and displayed to different types of users.

Comments

There may be multiple axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

Data type

Binding

Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", etc.

Care Plan Category (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInfo
w5: class

title

0..1

There are no (further) constraints on this element

Element id

CarePlan.title

Short description

Human-friendly name for the CarePlan

Definition

Human-friendly name for the CarePlan.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.description

Short description

Summary of nature of plan

Definition

A description of the scope and nature of the plan.

Requirements

Provides more detail than conveyed by category.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
w5: what

subject

Σ C

1..1

Element id

CarePlan.subject

Short description

Who care plan is for

Alternate names

patient

Definition

Identifies the patient or group whose intended care is described by the plan.

Comments

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.subject
v2: PID-3
rim: .participation[typeCode=PAT].role[classCode=PAT]
w5: who.focus

context

Σ C

0..1

Element id

CarePlan.context

Short description

Created in context of

Alternate names

encounter

Definition

Identifies the original context in which this particular CarePlan was created.

Comments

Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

Data type

Reference(CareConnect-Encounter-1 | CareConnect-EpisodeOfCare-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.context
v2: Associated PV1
rim: .
w5: context

period

Σ C

0..1

There are no (further) constraints on this element

Element id

CarePlan.period

Short description

Time period plan covers

Alternate names

timing

Definition

Indicates when the plan did (or is intended to) come into effect and end.

Requirements

Allows tracking what plan(s) are in effect at a particular time.

Comments

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.empty() or end.empty() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
workflow: Request.occurrencePeriod
v2: GOL-7 / GOL-8
rim: .effectiveTime
w5: when.init

author

Σ C

0..*

Element id

CarePlan.author

Short description

Who is responsible for contents of the plan

Definition

Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

Comments

Collaborative care plans may have multiple authors.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.requester.agent (if only one author)
w5: who.source

careTeam

0..*

Element id

CarePlan.careTeam

Short description

Who's involved in plan?

Definition

Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.

Requirements

Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer (similar but does not entail CareTeam)
w5: who.actor

addresses

Σ C

0..*

Element id

CarePlan.addresses

Short description

Health issues this plan addresses

Definition

Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.

Requirements

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference
v2: PRB-4
rim: .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]
w5: why

supportingInfo

0..*

There are no (further) constraints on this element

Element id

CarePlan.supportingInfo

Short description

Information considered as part of plan

Definition

Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include co-morbidities, recent procedures, limitations, recent assessments, etc.

Requirements

Identifies barriers and other considerations associated with the care plan.

Comments

Use "concern" to identify specific conditions addressed by the care plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.supportingInfo

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.goal

Short description

Desired outcome of plan

Definition

Describes the intended objective(s) of carrying out the care plan.

Requirements

Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.

Comments

Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: GOL.1
rim: .outboundRelationship[typeCode<=OBJ].

activity

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity

Short description

Action to occur as part of plan

Definition

Identifies a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring, education, etc.

Requirements

Allows systems to prompt for performance of planned activities, and validate plans against best practice.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
cpl-3: Provide a reference or detail, not both
detail.empty() or reference.empty()

Mappings

rim: n/a
workflow: no mapping NOTE: This is a list of contained Request-Event tuples!
rim: .outboundRelationship[typeCode=COMP].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

outcomeCodeableConcept

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeCodeableConcept

Short description

Results of the activity

Definition

Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

Comments

Note that this should not duplicate the activity status (e.g. completed or in progress).

Data type

Care Plan Activity Outcome (example)

Binding

Identifies the results of the activity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD

outcomeReference

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.outcomeReference

Short description

Appointment, Encounter, Procedure, etc.

Definition

Requirements

Links plan to resulting actions.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Event that is outcome of Request in activity.reference
rim: .inboundRelationship[typeCode=FLFS].source

progress

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress

Short description

Comments about the activity status/progress

Definition

Notes about the adherence/status/progress of the activity.

Requirements

Can be used to capture information about adherence, progress, concerns, etc.

Comments

This element should NOT be used to describe the activity to be performed - that occurs either within the resource pointed to by activity.detail.reference or in activity.detail.description.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Event.status (Annotation instead of CodableConcept)
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.activity.progress.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.text

reference

0..1

Element id

CarePlan.activity.reference

Short description

Activity details defined in specific resource

Definition

The details of the proposed activity represented in a specific resource.

Requirements

Details in a form consistent with other applications and contexts of use.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request that resulted in Event in activity.actionResulting
rim: .outboundRelationship[typeCode=COMP].target

detail

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail

Short description

In-line definition of activity

Definition

A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

Requirements

Details in a simple form for generic care plan systems.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1, cpl-3

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
rim: .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content, modifiers

Definition

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

category

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.category

Short description

Definition

High-level categorization of the type of activity in a care plan.

Requirements

May determine what types of extensions are permitted.

Comments

Data type

CarePlanActivityCategory (example)

Binding

High-level categorization of the type of activity in a care plan.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.supportingInformation
rim: .inboundRelationship[typeCode=COMP].source[classCode=LIST].code

definition

0..1

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.definition

Short description

Protocol or definition

Definition

Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.

Requirements

Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

Comments

Data type

Reference(ActivityDefinition | PlanDefinition | Questionnaire)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.definition

code

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.code

Short description

Detail type of activity

Definition

Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.

Requirements

Allows matching performed to planned as well as validation against protocols.

Comments

Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

Data type

Binding

Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

Care Plan Activity (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.code
v2: OBR-4 / RXE-2 / RXO-1 / RXD-2
rim: .code

reasonCode

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.reasonCode

Short description

Why activity should be done or why activity was prohibited

Definition

Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

Comments

This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

Data type

Binding

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.

Activity Reason (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
workflow: Request.reasonCode

reasonReference

0..*

Element id

CarePlan.activity.detail.reasonReference

Short description

Condition triggering need for activity

Definition

Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

Comments

Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.reasonReference

goal

0..*

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.goal

Short description

Goals this activity relates to

Definition

Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

Requirements

So that participants know the link explicitly.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.goal
rim: .outboundRelationship[typeCode<=OBJ].

status

1..1

codeBinding

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.status

Short description

Definition

Identifies what progress is being made for the specific activity.

Requirements

Indicates progress against the plan, whether the activity is still relevant for the plan.

Comments

Data type

CarePlanActivityStatus (required)

Binding

Indicates where the activity is at in its overall life cycle.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.status (uses different ValueSet)
v2: ORC-5?
rim: .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted

statusReason

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.statusReason

Short description

Reason for current status

Definition

Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

Comments

Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

prohibited

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.prohibited

Short description

Do NOT do

Definition

Requirements

Captures intention to not do something that may have been previously typical.

Comments

This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Default value

false

Mappings

rim: n/a
rim: actionNegationInd

scheduled[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.scheduled[x]

Short description

When activity is to occur

Definition

The period, timing or frequency upon which the described activity is to occur.

Requirements

Allows prompting for activities and detection of missed planned activities.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.occurrence
v2: TQ1
rim: .effectiveTime

scheduledPeriod

There are no (further) constraints on this element

Data type

scheduledString

There are no (further) constraints on this element

Data type

scheduledTiming

There are no (further) constraints on this element

Data type

location

0..1

Element id

CarePlan.activity.detail.location

Short description

Where it should happen

Definition

Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

Requirements

Helps in planning of activity.

Comments

May reference a specific clinical location or may identify a type of location.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: OBR-24(???!!)
rim: .participation[typeCode=LOC].role

performer

0..*

Element id

CarePlan.activity.detail.performer

Short description

Who will be responsible?

Definition

Identifies who's expected to be involved in the activity.

Requirements

Helps in planning of activity.

Comments

A performer MAY also be a participant in the care plan.

Data type

Reference(CareConnect-CareTeam-1 | CareConnect-Organization-1 | CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
workflow: Request.performer
v2: PRT-5 : ( PRV-4 e {provider participations} ) / PRT-5 : ( PRV-4 e {non-provider person participations} ) / PRT-5 : ( PRV-4 = (patient non-subject of care) ) / PRT-8
rim: .participation[typeCode=PFM]

product[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.product[x]

Short description

What is to be administered/supplied

Definition

Identifies the food, drug or other product to be consumed or supplied in the activity.

Binding

A product supplied or administered as part of a care plan activity.

SNOMED CT Medication Codes (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: RXE-2 / RXO-1 / RXD-2
rim: .participation[typeCode=PRD].role

productCodeableConcept

Data type

productReference

Data type

dailyAmount

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.dailyAmount

Short description

How to consume/day?

Alternate names

daily dose

Definition

Identifies the quantity expected to be consumed in a given day.

Requirements

Allows rough dose checking.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-23 / RXE-19 / RXD-12
rim: .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity

quantity

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.quantity

Short description

How much to administer/supply/consume

Definition

Identifies the quantity expected to be supplied, administered or consumed by the subject.

Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
rim: .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity

description

0..1

There are no (further) constraints on this element

Element id

CarePlan.activity.detail.description

Short description

Extra info describing activity to perform

Definition

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
workflow: Request.note
v2: NTE?
rim: .text

note

0..*

There are no (further) constraints on this element

Element id

CarePlan.note

Short description

Comments about the plan

Definition

General notes about the care plan not covered elsewhere.

Requirements

Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.

Comments

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act
workflow: Request.note
v2: NTE?
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.id

Short description

xml:id (or equivalent in JSON)

Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a

extension

0..*

There are no (further) constraints on this element

Element id

CarePlan.note.extension

Short description

Additional Content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Data type

Reference(CareConnect-Patient-1 | CareConnect-Practitioner-1 | CareConnect-RelatedPerson-1)

authorString

Data type

time

0..1

There are no (further) constraints on this element

Element id

CarePlan.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() | (children().count() > id.count())

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

There are no (further) constraints on this element

Element id

CarePlan.note.text

Short description

The annotation - text content

Definition

The text of the annotation.

Comments

Note that FHIR strings may not exceed 1MB in size

Data type