STU 3 Ballot
Clinical SummaryThis page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
. Page versions: R5 R4B R4 R3 R2
StructureDefinition for careplan
{
"resourceType": "StructureDefinition",
"id": "CarePlan",
"meta": {
"lastUpdated": "2016-08-11T17:02:54.322+10:00"
},
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1
}
],
"url": "http://hl7.org/fhir/StructureDefinition/CarePlan",
"name": "CarePlan",
"status": "draft",
"publisher": "Health Level Seven International (Patient Care)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
},
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
}
]
}
],
"date": "2016-08-11T17:02:54+10:00",
"description": "Base StructureDefinition for CarePlan Resource",
"fhirVersion": "1.6.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "CarePlan",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"element": [
{
"id": "CarePlan",
"path": "CarePlan",
"short": "Healthcare plan for patient or group",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
},
{
"identity": "w5",
"map": "clinical.careprovision"
}
]
},
{
"id": "CarePlan.id",
"path": "CarePlan.id",
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "CarePlan.meta",
"path": "CarePlan.meta",
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "CarePlan.implicitRules",
"path": "CarePlan.implicitRules",
"short": "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 as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "CarePlan.language",
"path": "CarePlan.language",
"short": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "*"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id": "CarePlan.text",
"path": "CarePlan.text",
"short": "Text summary of the resource, for human interpretation",
"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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "CarePlan.contained",
"path": "CarePlan.contained",
"short": "Contained, inline 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.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.extension",
"path": "CarePlan.extension",
"short": "Additional Content defined by implementations",
"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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.modifierExtension",
"path": "CarePlan.modifierExtension",
"short": "Extensions that cannot be ignored",
"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": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.identifier",
"path": "CarePlan.identifier",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PTH-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "CarePlan.subject",
"path": "CarePlan.subject",
"short": "Who care plan is for",
"definition": "Identifies the patient or group whose intended care is described by the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"id": "CarePlan.status",
"path": "CarePlan.status",
"short": "proposed | draft | active | completed | cancelled",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5"
},
{
"identity": "rim",
"map": ".statusCode planned = new active = active completed = completed"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CarePlan.context",
"path": "CarePlan.context",
"short": "Created in context of",
"definition": "Identifies the context in which this particular CarePlan is defined.",
"comments": "Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "Associated PV1"
},
{
"identity": "rim",
"map": "."
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CarePlan.period",
"path": "CarePlan.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "GOL-7 / GOL-8"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "CarePlan.author",
"path": "CarePlan.author",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"id": "CarePlan.modified",
"path": "CarePlan.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PTH-6"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"id": "CarePlan.category",
"path": "CarePlan.category",
"short": "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.",
"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.",
"requirements": "Used for filtering what plan(s) are retrieved and displayed to different types of users.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-category"
}
}
},
{
"id": "CarePlan.description",
"path": "CarePlan.description",
"short": "Summary of nature of plan",
"definition": "A description of the scope and nature of the plan.",
"requirements": "Provides more detail than conveyed by category.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CarePlan.addresses",
"path": "CarePlan.addresses",
"short": "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. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRB-4"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"id": "CarePlan.support",
"path": "CarePlan.support",
"short": "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.",
"comments": "Use \"concern\" to identify specific conditions addressed by the care plan.",
"requirements": "Identifies barriers and other considerations associated with the care plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"id": "CarePlan.relatedPlan",
"path": "CarePlan.relatedPlan",
"short": "Plans related to this one",
"definition": "Identifies CarePlans with some sort of formal relationship to the current plan.",
"comments": "Relationships are uni-directional with the \"newer\" plan pointing to the older one.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CarePlan.relatedPlan.id",
"path": "CarePlan.relatedPlan.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.relatedPlan.extension",
"path": "CarePlan.relatedPlan.extension",
"short": "Additional Content defined by implementations",
"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": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.relatedPlan.modifierExtension",
"path": "CarePlan.relatedPlan.modifierExtension",
"short": "Extensions that cannot be ignored",
"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": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.relatedPlan.code",
"path": "CarePlan.relatedPlan.code",
"short": "includes | replaces | fulfills",
"definition": "Identifies the type of relationship this plan has to the target plan.",
"comments": "Read the relationship as \"this plan\" [relatedPlan.code] \"relatedPlan.plan\"; e.g. This plan includes Plan B.\n\nAdditional relationship types can be proposed for future releases or handled as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Codes identifying the types of relationships between two plans.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-relationship"
}
}
},
{
"id": "CarePlan.relatedPlan.plan",
"path": "CarePlan.relatedPlan.plan",
"short": "Plan relationship exists with",
"definition": "A reference to the plan to which a relationship is asserted.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
]
},
{
"id": "CarePlan.careTeam",
"path": "CarePlan.careTeam",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
]
},
{
"id": "CarePlan.goal",
"path": "CarePlan.goal",
"short": "Desired outcome of plan",
"definition": "Describes the intended objective(s) of carrying out the care plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.activity",
"path": "CarePlan.activity",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ctm-3",
"severity": "error",
"human": "Provide a reference or detail, not both",
"expression": "detail.empty() or reference.empty()",
"xpath": "not(exists(f:detail)) or not(exists(f:reference))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"id": "CarePlan.activity.id",
"path": "CarePlan.activity.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.extension",
"path": "CarePlan.activity.extension",
"short": "Additional Content defined by implementations",
"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": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.modifierExtension",
"path": "CarePlan.activity.modifierExtension",
"short": "Extensions that cannot be ignored",
"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": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.actionResulting",
"path": "CarePlan.activity.actionResulting",
"short": "Appointments, orders, etc.",
"definition": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"requirements": "Links plan to resulting actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"id": "CarePlan.activity.outcome",
"path": "CarePlan.activity.outcome",
"short": "Results of the activity",
"definition": "Results of the careplan activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Identifies the results of the activity"
}
},
{
"id": "CarePlan.activity.progress",
"path": "CarePlan.activity.progress",
"short": "Comments about the activity status/progress",
"definition": "Notes about the adherence/status/progress of the activity.",
"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.",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"id": "CarePlan.activity.reference",
"path": "CarePlan.activity.reference",
"short": "Activity details defined in specific resource",
"definition": "The details of the proposed activity represented in a specific resource.",
"comments": "Standard extension exists (http://hl7-fhir.github.io/extension-goal-pertainstogoal.html) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference\rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan.",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceUseRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/SupplyRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
],
"condition": [
"ctm-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"id": "CarePlan.activity.detail",
"path": "CarePlan.activity.detail",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ctm-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}
]
},
{
"id": "CarePlan.activity.detail.id",
"path": "CarePlan.activity.detail.id",
"representation": [
"xmlAttr"
],
"short": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.extension",
"path": "CarePlan.activity.detail.extension",
"short": "Additional Content defined by implementations",
"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": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.modifierExtension",
"path": "CarePlan.activity.detail.modifierExtension",
"short": "Extensions that cannot be ignored",
"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": "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.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.category",
"path": "CarePlan.activity.detail.category",
"short": "diet | drug | encounter | observation | procedure | supply | other",
"definition": "High-level categorization of the type of activity in a care plan.",
"requirements": "May determine what types of extensions are permitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "High-level categorization of the type of activity in a care plan.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
},
{
"id": "CarePlan.activity.detail.definition",
"path": "CarePlan.activity.detail.definition",
"short": "Protocol or definition",
"definition": "Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
]
},
{
"id": "CarePlan.activity.detail.code",
"path": "CarePlan.activity.detail.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4 / RXE-2 / RXO-1 / RXD-2"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "CarePlan.activity.detail.reasonCode",
"path": "CarePlan.activity.detail.reasonCode",
"short": "Why activity should be done",
"definition": "Provides the rationale that drove the inclusion of this particular activity as part of the plan.",
"comments": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/activity-reason"
}
}
},
{
"id": "CarePlan.activity.detail.reasonReference",
"path": "CarePlan.activity.detail.reasonReference",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
]
},
{
"id": "CarePlan.activity.detail.goal",
"path": "CarePlan.activity.detail.goal",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.activity.detail.status",
"path": "CarePlan.activity.detail.status",
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled",
"definition": "Identifies what progress is being made for the specific activity.",
"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.",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"strength": "required",
"description": "Indicates where the activity is at in its overall life cycle.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-5?"
},
{
"identity": "rim",
"map": ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason",
"path": "CarePlan.activity.detail.statusReason",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Describes why the current activity has the status it does; e.g. \"Recovering from injury\" as a reason for non-started or on-hold, \"Patient does not enjoy activity\" as a reason for cancelling a planned activity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/goal-status-reason"
}
}
},
{
"id": "CarePlan.activity.detail.prohibited",
"path": "CarePlan.activity.detail.prohibited",
"short": "Do NOT do",
"definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan.",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"id": "CarePlan.activity.detail.scheduled[x]",
"path": "CarePlan.activity.detail.scheduled[x]",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "CarePlan.activity.detail.location",
"path": "CarePlan.activity.detail.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may identify a type of location.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-24(???!!)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
}
]
},
{
"id": "CarePlan.activity.detail.performer",
"path": "CarePlan.activity.detail.performer",
"short": "Who will be responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"comments": "A performer MAY also be a participant in the care plan.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "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"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"id": "CarePlan.activity.detail.product[x]",
"path": "CarePlan.activity.detail.product[x]",
"short": "What is to be administered/supplied",
"definition": "Identifies the food, drug or other product to be consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"strength": "example",
"description": "A product supplied or administered as part of a care plan activity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-2 / RXO-1 / RXD-2"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"id": "CarePlan.activity.detail.dailyAmount",
"path": "CarePlan.activity.detail.dailyAmount",
"short": "How to consume/day?",
"definition": "Identifies the quantity expected to be consumed in a given day.",
"requirements": "Allows rough dose checking.",
"alias": [
"daily dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXO-23 / RXE-19 / RXD-12"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}
]
},
{
"id": "CarePlan.activity.detail.quantity",
"path": "CarePlan.activity.detail.quantity",
"short": "How much to administer/supply/consume",
"definition": "Identifies the quantity expected to be supplied, administered or consumed by the subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "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"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}
]
},
{
"id": "CarePlan.activity.detail.description",
"path": "CarePlan.activity.detail.description",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "CarePlan.note",
"path": "CarePlan.note",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
},
"differential": {
"element": [
{
"id": "CarePlan",
"path": "CarePlan",
"short": "Healthcare plan for patient or group",
"definition": "Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.",
"alias": [
"Care Team"
],
"min": 0,
"max": "*",
"mapping": [
{
"identity": "rim",
"map": "Act[classCode=PCPR, moodCode=INT]"
},
{
"identity": "w5",
"map": "clinical.careprovision"
}
]
},
{
"id": "CarePlan.identifier",
"path": "CarePlan.identifier",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PTH-3"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "CarePlan.subject",
"path": "CarePlan.subject",
"short": "Who care plan is for",
"definition": "Identifies the patient or group whose intended care is described by the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
}
]
},
{
"id": "CarePlan.status",
"path": "CarePlan.status",
"short": "proposed | draft | active | completed | cancelled",
"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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "PTH-5"
},
{
"identity": "rim",
"map": ".statusCode planned = new active = active completed = completed"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CarePlan.context",
"path": "CarePlan.context",
"short": "Created in context of",
"definition": "Identifies the context in which this particular CarePlan is defined.",
"comments": "Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "Associated PV1"
},
{
"identity": "rim",
"map": "."
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CarePlan.period",
"path": "CarePlan.period",
"short": "Time period plan covers",
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"comments": "Any activities scheduled as part of the plan should be constrained to the specified period.",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "GOL-7 / GOL-8"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "CarePlan.author",
"path": "CarePlan.author",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true
},
{
"id": "CarePlan.modified",
"path": "CarePlan.modified",
"short": "When last updated",
"definition": "Identifies the most recent date on which the plan has been revised.",
"requirements": "Indicates how current the plan is.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PTH-6"
},
{
"identity": "rim",
"map": ".participation[typeCode=AUT].time"
}
]
},
{
"id": "CarePlan.category",
"path": "CarePlan.category",
"short": "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.",
"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.",
"requirements": "Used for filtering what plan(s) are retrieved and displayed to different types of users.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "Identifies what \"kind\" of plan this is to support differentiation between multiple co-existing plans; e.g. \"Home health\", \"psychiatric\", \"asthma\", \"disease management\", etc.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-category"
}
}
},
{
"id": "CarePlan.description",
"path": "CarePlan.description",
"short": "Summary of nature of plan",
"definition": "A description of the scope and nature of the plan.",
"requirements": "Provides more detail than conveyed by category.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"id": "CarePlan.addresses",
"path": "CarePlan.addresses",
"short": "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. Also scopes plans - multiple plans may exist addressing different concerns.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PRB-4"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
}
]
},
{
"id": "CarePlan.support",
"path": "CarePlan.support",
"short": "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.",
"comments": "Use \"concern\" to identify specific conditions addressed by the care plan.",
"requirements": "Identifies barriers and other considerations associated with the care plan.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
]
},
{
"id": "CarePlan.relatedPlan",
"path": "CarePlan.relatedPlan",
"short": "Plans related to this one",
"definition": "Identifies CarePlans with some sort of formal relationship to the current plan.",
"comments": "Relationships are uni-directional with the \"newer\" plan pointing to the older one.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "CarePlan.relatedPlan.code",
"path": "CarePlan.relatedPlan.code",
"short": "includes | replaces | fulfills",
"definition": "Identifies the type of relationship this plan has to the target plan.",
"comments": "Read the relationship as \"this plan\" [relatedPlan.code] \"relatedPlan.plan\"; e.g. This plan includes Plan B.\n\nAdditional relationship types can be proposed for future releases or handled as extensions.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "Codes identifying the types of relationships between two plans.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-relationship"
}
}
},
{
"id": "CarePlan.relatedPlan.plan",
"path": "CarePlan.relatedPlan.plan",
"short": "Plan relationship exists with",
"definition": "A reference to the plan to which a relationship is asserted.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
]
},
{
"id": "CarePlan.careTeam",
"path": "CarePlan.careTeam",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
]
},
{
"id": "CarePlan.goal",
"path": "CarePlan.goal",
"short": "Desired outcome of plan",
"definition": "Describes the intended objective(s) of carrying out the care plan.",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.activity",
"path": "CarePlan.activity",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ctm-3",
"severity": "error",
"human": "Provide a reference or detail, not both",
"expression": "detail.empty() or reference.empty()",
"xpath": "not(exists(f:detail)) or not(exists(f:reference))"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"id": "CarePlan.activity.actionResulting",
"path": "CarePlan.activity.actionResulting",
"short": "Appointments, orders, etc.",
"definition": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"requirements": "Links plan to resulting actions.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"id": "CarePlan.activity.outcome",
"path": "CarePlan.activity.outcome",
"short": "Results of the activity",
"definition": "Results of the careplan activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Identifies the results of the activity"
}
},
{
"id": "CarePlan.activity.progress",
"path": "CarePlan.activity.progress",
"short": "Comments about the activity status/progress",
"definition": "Notes about the adherence/status/progress of the activity.",
"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.",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"id": "CarePlan.activity.reference",
"path": "CarePlan.activity.reference",
"short": "Activity details defined in specific resource",
"definition": "The details of the proposed activity represented in a specific resource.",
"comments": "Standard extension exists (http://hl7-fhir.github.io/extension-goal-pertainstogoal.html) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference\rThe goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan.",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Appointment"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DeviceUseRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/MedicationOrder"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/NutritionRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/SupplyRequest"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
}
],
"condition": [
"ctm-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"id": "CarePlan.activity.detail",
"path": "CarePlan.activity.detail",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"ctm-3"
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target"
}
]
},
{
"id": "CarePlan.activity.detail.category",
"path": "CarePlan.activity.detail.category",
"short": "diet | drug | encounter | observation | procedure | supply | other",
"definition": "High-level categorization of the type of activity in a care plan.",
"requirements": "May determine what types of extensions are permitted.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "High-level categorization of the type of activity in a care plan.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-category"
}
},
"mapping": [
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
},
{
"id": "CarePlan.activity.detail.definition",
"path": "CarePlan.activity.detail.definition",
"short": "Protocol or definition",
"definition": "Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
]
},
{
"id": "CarePlan.activity.detail.code",
"path": "CarePlan.activity.detail.code",
"short": "Detail type of activity",
"definition": "Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity"
}
},
"mapping": [
{
"identity": "v2",
"map": "OBR-4 / RXE-2 / RXO-1 / RXD-2"
},
{
"identity": "rim",
"map": ".code"
}
]
},
{
"id": "CarePlan.activity.detail.reasonCode",
"path": "CarePlan.activity.detail.reasonCode",
"short": "Why activity should be done",
"definition": "Provides the rationale that drove the inclusion of this particular activity as part of the plan.",
"comments": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/activity-reason"
}
}
},
{
"id": "CarePlan.activity.detail.reasonReference",
"path": "CarePlan.activity.detail.reasonReference",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
]
},
{
"id": "CarePlan.activity.detail.goal",
"path": "CarePlan.activity.detail.goal",
"short": "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.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.activity.detail.status",
"path": "CarePlan.activity.detail.status",
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled",
"definition": "Identifies what progress is being made for the specific activity.",
"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.",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"strength": "required",
"description": "Indicates where the activity is at in its overall life cycle.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-status"
}
},
"mapping": [
{
"identity": "v2",
"map": "ORC-5?"
},
{
"identity": "rim",
"map": ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason",
"path": "CarePlan.activity.detail.statusReason",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "example",
"description": "Describes why the current activity has the status it does; e.g. \"Recovering from injury\" as a reason for non-started or on-hold, \"Patient does not enjoy activity\" as a reason for cancelling a planned activity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/goal-status-reason"
}
}
},
{
"id": "CarePlan.activity.detail.prohibited",
"path": "CarePlan.activity.detail.prohibited",
"short": "Do NOT do",
"definition": "If true, indicates that the described activity is one that must NOT be engaged in when following the plan.",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "actionNegationInd"
}
]
},
{
"id": "CarePlan.activity.detail.scheduled[x]",
"path": "CarePlan.activity.detail.scheduled[x]",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "TQ1"
},
{
"identity": "rim",
"map": ".effectiveTime"
}
]
},
{
"id": "CarePlan.activity.detail.location",
"path": "CarePlan.activity.detail.location",
"short": "Where it should happen",
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"comments": "May reference a specific clinical location or may identify a type of location.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-24(???!!)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
}
]
},
{
"id": "CarePlan.activity.detail.performer",
"path": "CarePlan.activity.detail.performer",
"short": "Who will be responsible?",
"definition": "Identifies who's expected to be involved in the activity.",
"comments": "A performer MAY also be a participant in the care plan.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"mapping": [
{
"identity": "v2",
"map": "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"
},
{
"identity": "rim",
"map": ".participation[typeCode=PFM]"
}
]
},
{
"id": "CarePlan.activity.detail.product[x]",
"path": "CarePlan.activity.detail.product[x]",
"short": "What is to be administered/supplied",
"definition": "Identifies the food, drug or other product to be consumed or supplied in the activity.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"strength": "example",
"description": "A product supplied or administered as part of a care plan activity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-2 / RXO-1 / RXD-2"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"id": "CarePlan.activity.detail.dailyAmount",
"path": "CarePlan.activity.detail.dailyAmount",
"short": "How to consume/day?",
"definition": "Identifies the quantity expected to be consumed in a given day.",
"requirements": "Allows rough dose checking.",
"alias": [
"daily dose"
],
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "RXO-23 / RXE-19 / RXD-12"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity"
}
]
},
{
"id": "CarePlan.activity.detail.quantity",
"path": "CarePlan.activity.detail.quantity",
"short": "How much to administer/supply/consume",
"definition": "Identifies the quantity expected to be supplied, administered or consumed by the subject.",
"min": 0,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping": [
{
"identity": "v2",
"map": "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"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity"
}
]
},
{
"id": "CarePlan.activity.detail.description",
"path": "CarePlan.activity.detail.description",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "CarePlan.note",
"path": "CarePlan.note",
"short": "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.",
"min": 0,
"max": "1",
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
}
]
}
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000. QA Page
Links: Search |
Version History |
Table of Contents |
Compare to DSTU2 |
|
Propose a change