{
"description": null,
"_filename": "StructureDefinition-us-core-careplan.json",
"package_name": "hl7.fhir.us.core",
"date": "2016-08-01",
"derivation": "constraint",
"publisher": "Health Level Seven International (FHIR-Infrastructure)",
"name": "US Core CarePlan Profile",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "CarePlan",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.0.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"source": "DomainResource",
"severity": "error",
"expression": "contained.text.empty()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "DomainResource",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
} ],
"path": "CarePlan",
"min": 0,
"definition": "The US Core CarePlan Profile is based upon the core FHIR CarePlan Resource and created to meet the 2015 Edition Common Clinical Data Set 'Assessment and Plan of Treatment requirements.",
"short": "US Core CarePlan Profile",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Act[classCode=PCPR, moodCode=INT]",
"identity": "rim"
}, {
"map": "clinical.careprovision",
"identity": "w5"
} ],
"mustSupport": false,
"sliceName": "USCoreCarePlan",
"alias": [ "Care Team" ],
"max": "*",
"id": "CarePlan:uscorecareplan",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan"
},
"isSummary": false
}, {
"path": "CarePlan.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"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.",
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.id",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"path": "CarePlan.meta",
"min": 0,
"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.",
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"path": "CarePlan.implicitRules",
"min": 0,
"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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"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.",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.implicitRules",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"path": "CarePlan.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"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).",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages"
}
} ],
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.language",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
}
}, {
"path": "CarePlan.text",
"min": 1,
"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.",
"short": "Text summary of the resource, for human interpretation",
"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.",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"mustSupport": true,
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "CarePlan:uscorecareplan.text",
"condition": [ "dom-1" ],
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "CarePlan.text.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CarePlan:uscorecareplan.text.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CarePlan.text.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.text.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CarePlan.text.status",
"min": 1,
"definition": "generated | additional.",
"short": "generated | extensions | additional | empty",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Constrained value set of narrative statuses.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.text.status",
"base": {
"max": "1",
"min": 1,
"path": "Narrative.status"
},
"isSummary": false
}, {
"constraint": [ {
"key": "txt-1",
"human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained style attributes",
"xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])",
"severity": "error",
"expression": "htmlchecks()"
}, {
"key": "txt-2",
"human": "The narrative SHALL have some non-whitespace content",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"severity": "error",
"expression": "htmlchecks()"
} ],
"path": "CarePlan.text.div",
"min": 1,
"definition": "The actual narrative content, a stripped down version of XHTML.",
"short": "Limited xhtml content",
"comments": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "xhtml"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.text.div",
"base": {
"max": "1",
"min": 1,
"path": "Narrative.div"
}
}, {
"path": "CarePlan.contained",
"min": 0,
"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.",
"short": "Contained, inline Resources",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "CarePlan:uscorecareplan.contained",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"path": "CarePlan.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.extension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
}
}, {
"path": "CarePlan.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
}
}, {
"path": "CarePlan.identifier",
"requirements": "Need to allow connection to a wider workflow.",
"min": 0,
"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).",
"short": "External Ids for this plan",
"mapping": [ {
"map": "PTH-3",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.identifier",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.identifier"
},
"isSummary": true
}, {
"path": "CarePlan.status",
"requirements": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"min": 1,
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"isModifier": true,
"short": "proposed | draft | active | suspended | completed | entered-in-error | cancelled | unknown",
"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.",
"mapping": [ {
"map": "PTH-5",
"identity": "v2"
}, {
"map": ".statusCode planned = new active = active completed = completed",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": 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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.status",
"base": {
"max": "1",
"min": 1,
"path": "CarePlan.status"
},
"isSummary": false
}, {
"path": "CarePlan.category",
"requirements": "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.",
"min": 1,
"definition": "Type of plan.",
"short": "Type of plan",
"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.",
"mapping": [ {
"map": "class",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": 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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.category",
"patternCodeableConcept": {
"coding": [ {
"code": "assess-plan",
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category"
} ]
},
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.category"
},
"isSummary": false
}, {
"path": "CarePlan.category.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CarePlan:uscorecareplan.category.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CarePlan.category.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.category.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CarePlan.category.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"mapping": [ {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.category.coding",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"path": "CarePlan.category.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"mapping": [ {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.category.text",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"path": "CarePlan.description",
"requirements": "Provides more detail than conveyed by category.",
"min": 0,
"definition": "A description of the scope and nature of the plan.",
"short": "Summary of nature of plan",
"mapping": [ {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.description",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.description"
},
"isSummary": true
}, {
"path": "CarePlan.subject",
"requirements": "Identifies the patient or group whose intended care is described by the plan.",
"min": 1,
"definition": "Who care plan is for.",
"short": "Who care plan is for",
"mapping": [ {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".participation[typeCode=PAT].role[classCode=PAT]",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
} ],
"mustSupport": true,
"max": "1",
"id": "CarePlan:uscorecareplan.subject",
"base": {
"max": "1",
"min": 1,
"path": "CarePlan.subject"
},
"isSummary": false
}, {
"path": "CarePlan.context",
"min": 0,
"definition": "Identifies the original context in which this particular CarePlan was created.",
"short": "Created in context of",
"comments": "Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.",
"mapping": [ {
"map": "Associated PV1",
"identity": "v2"
}, {
"map": ".",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.context",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.context"
},
"isSummary": true
}, {
"path": "CarePlan.period",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"min": 0,
"definition": "Indicates when the plan did (or is intended to) come into effect and end.",
"short": "Time period plan covers",
"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).",
"mapping": [ {
"map": "GOL-7 / GOL-8",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.period",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.period"
},
"isSummary": true
}, {
"path": "CarePlan.modified",
"requirements": "Indicates how current the plan is.",
"min": 0,
"definition": "Identifies the most recent date on which the plan has been revised.",
"short": "When last updated",
"mapping": [ {
"map": "PTH-6",
"identity": "v2"
}, {
"map": ".participation[typeCode=AUT].time",
"identity": "rim"
}, {
"map": "when.recorded",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.modified",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.modified"
},
"isSummary": true
}, {
"path": "CarePlan.author",
"min": 0,
"definition": "Identifies the individual(s) or ogranization who is responsible for the content of the care plan.",
"short": "Who is responsible for contents of the plan",
"comments": "Collaborative care plans may have multiple authors.",
"mapping": [ {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.author",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.author"
},
"isSummary": true
}, {
"path": "CarePlan.careTeam",
"requirements": "Allows representation of care teams, helps scope care plan. In some cases may be a determiner of access permissions.",
"min": 0,
"definition": "Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.",
"short": "Who's involved in plan?",
"mapping": [ {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.careTeam",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.careTeam"
}
}, {
"path": "CarePlan.addresses",
"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.",
"min": 0,
"definition": "Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.",
"short": "Health issues this plan addresses",
"mapping": [ {
"map": "PRB-4",
"identity": "v2"
}, {
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]",
"identity": "rim"
}, {
"map": "why",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.addresses",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.addresses"
},
"isSummary": true
}, {
"path": "CarePlan.support",
"requirements": "Identifies barriers and other considerations associated with the care plan.",
"min": 0,
"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.",
"short": "Information considered as part of plan",
"comments": "Use \"concern\" to identify specific conditions addressed by the care plan.",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.support",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.support"
}
}, {
"id": "CarePlan:uscorecareplan.definition",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.definition"
},
"path": "CarePlan.definition",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
} ],
"short": "Protocol or definition",
"definition": "Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with."
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
} ],
"path": "CarePlan.relatedPlan",
"min": 0,
"definition": "Identifies CarePlans with some sort of formal relationship to the current plan.",
"short": "Plans related to this one",
"comments": "Relationships are uni-directional with the \"newer\" plan pointing to the older one.",
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.relatedPlan",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.relatedPlan"
}
}, {
"path": "CarePlan.relatedPlan.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CarePlan:uscorecareplan.relatedPlan.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CarePlan.relatedPlan.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.relatedPlan.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CarePlan.relatedPlan.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CarePlan:uscorecareplan.relatedPlan.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "CarePlan.relatedPlan.code",
"min": 0,
"definition": "Identifies the type of relationship this plan has to the target plan.",
"short": "includes | replaces | fulfills",
"comments": "Read the relationship as \"this plan\" [relatedPlan.code] \"relatedPlan.plan\"; e.g. This plan includes Plan B. Additional relationship types can be proposed for future releases or handled as extensions.",
"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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.relatedPlan.code",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.relatedPlan.code"
}
}, {
"id": "CarePlan:uscorecareplan.relatedPlan.plan",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "CarePlan.relatedPlan.plan"
},
"path": "CarePlan.relatedPlan.plan",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
} ],
"short": "Plan relationship exists with",
"definition": "A reference to the plan to which a relationship is asserted."
}, {
"path": "CarePlan.goal",
"requirements": "Provides context for plan. Allows plan effectiveness to be evaluated by clinicians.",
"min": 0,
"definition": "Describes the intended objective(s) of carrying out the care plan.",
"short": "Desired outcome of plan",
"comments": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"mapping": [ {
"map": "GOL.1",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode<=OBJ].",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Goal"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.goal",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.goal"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
}, {
"key": "ctm-3",
"human": "Provide a reference or detail, not both",
"xpath": "not(exists(f:detail)) or not(exists(f:reference))",
"severity": "error",
"expression": "detail.empty() or reference.empty()"
} ],
"path": "CarePlan.activity",
"requirements": "Allows systems to prompt for performance of planned activities, and validate plans against best practice.",
"min": 0,
"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.",
"short": "Action to occur as part of plan",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity"
}
}, {
"path": "CarePlan.activity.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CarePlan.activity.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CarePlan.activity.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "CarePlan.activity.actionResulting",
"requirements": "Links plan to resulting actions.",
"min": 0,
"definition": "Resources that describe follow-on actions resulting from the plan, such as drug prescriptions, encounter records, appointments, etc.",
"short": "Appointments, orders, etc.",
"mapping": [ {
"map": ".inboundRelationship[typeCode=FLFS].source",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.actionResulting",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.actionResulting"
}
}, {
"path": "CarePlan.activity.outcome",
"min": 0,
"definition": "Results of the careplan activity.",
"short": "Results of the activity",
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"description": "Identifies the results of the activity"
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.outcome",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.outcome"
}
}, {
"path": "CarePlan.activity.progress",
"requirements": "Can be used to capture information about adherence, progress, concerns, etc.",
"min": 0,
"definition": "Notes about the adherence/status/progress of the activity.",
"short": "Comments about the activity status/progress",
"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.",
"mapping": [ {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.progress",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.progress"
}
}, {
"path": "CarePlan.activity.reference",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"definition": "The details of the proposed activity represented in a specific resource.",
"short": "Activity details defined in specific resource",
"comments": "Standard extension exists ([goal-pertainstogoal](extension-goal-pertainstogoal.html)) 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.",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP].target",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Appointment"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CommunicationRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DeviceUseRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/DiagnosticRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/NutritionRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcessRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.reference",
"condition": [ "ctm-3" ],
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.reference"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "Element",
"severity": "error",
"expression": "children().count() > id.count()"
} ],
"path": "CarePlan.activity.detail",
"requirements": "Details in a simple form for generic care plan systems.",
"min": 0,
"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.",
"short": "In-line definition of activity",
"mapping": [ {
"map": ".outboundRelationship[typeCode=COMP, subsetCode=SUMM].target",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail",
"condition": [ "ctm-3" ],
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail"
}
}, {
"path": "CarePlan.activity.detail.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.id",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"path": "CarePlan.activity.detail.extension",
"min": 0,
"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.",
"short": "Additional Content defined by implementations",
"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.",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.extension",
"base": {
"max": "*",
"min": 0,
"path": "Element.extension"
}
}, {
"path": "CarePlan.activity.detail.modifierExtension",
"min": 0,
"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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"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.",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.modifierExtension",
"base": {
"max": "*",
"min": 0,
"path": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"path": "CarePlan.activity.detail.category",
"requirements": "May determine what types of extensions are permitted.",
"min": 0,
"definition": "High-level categorization of the type of activity in a care plan.",
"short": "diet | drug | encounter | observation | procedure | supply | other",
"mapping": [ {
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code",
"identity": "rim"
} ],
"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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.category",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.category"
}
}, {
"path": "CarePlan.activity.detail.definition",
"requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min": 0,
"definition": "Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.",
"short": "Protocol or definition",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.definition",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.definition"
}
}, {
"path": "CarePlan.activity.detail.code",
"requirements": "Allows matching performed to planned as well as validation against protocols.",
"min": 0,
"definition": "Detailed description of the type of planned activity; e.g. What lab test, what procedure, what kind of encounter.",
"short": "Detail type of activity",
"comments": "Tends to be less relevant for activities involving particular products. Codes should not convey negation - use \"prohibited\" instead.",
"mapping": [ {
"map": "OBR-4 / RXE-2 / RXO-1 / RXD-2",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.code",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.code"
}
}, {
"path": "CarePlan.activity.detail.reasonCode",
"min": 0,
"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.",
"short": "Why activity should be done or why activity was prohibited",
"comments": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"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"
}
},
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.reasonCode",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.detail.reasonCode"
}
}, {
"path": "CarePlan.activity.detail.reasonReference",
"min": 0,
"definition": "Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.",
"short": "Condition triggering need for activity",
"comments": "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.reasonReference",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.detail.reasonReference"
}
}, {
"path": "CarePlan.activity.detail.goal",
"requirements": "So that participants know the link explicitly.",
"min": 0,
"definition": "Internal reference that identifies the goals that this activity is intended to contribute towards meeting.",
"short": "Goals this activity relates to",
"mapping": [ {
"map": ".outboundRelationship[typeCode<=OBJ].",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Goal"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.goal",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.detail.goal"
}
}, {
"path": "CarePlan.activity.detail.status",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 1,
"definition": "Identifies what progress is being made for the specific activity.",
"isModifier": true,
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown",
"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.",
"mapping": [ {
"map": "ORC-5?",
"identity": "v2"
}, {
"map": ".statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.status",
"base": {
"max": "1",
"min": 1,
"path": "CarePlan.activity.detail.status"
}
}, {
"path": "CarePlan.activity.detail.statusReason",
"min": 0,
"definition": "Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.",
"short": "Reason for current status",
"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.",
"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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.statusReason",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.statusReason"
}
}, {
"path": "CarePlan.activity.detail.prohibited",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 0,
"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.",
"isModifier": true,
"short": "Do NOT do",
"mapping": [ {
"map": "actionNegationInd",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": false,
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.prohibited",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.prohibited"
}
}, {
"path": "CarePlan.activity.detail.scheduled[x]",
"requirements": "Allows prompting for activities and detection of missed planned activities.",
"min": 0,
"definition": "The period, timing or frequency upon which the described activity is to occur.",
"short": "When activity is to occur",
"mapping": [ {
"map": "TQ1",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "Timing"
}, {
"code": "Period"
}, {
"code": "string"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.scheduled[x]",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.scheduled[x]"
}
}, {
"path": "CarePlan.activity.detail.location",
"requirements": "Helps in planning of activity.",
"min": 0,
"definition": "Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.",
"short": "Where it should happen",
"comments": "May reference a specific clinical location or may identify a type of location.",
"mapping": [ {
"map": "OBR-24(???!!)",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.location",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.location"
}
}, {
"path": "CarePlan.activity.detail.performer",
"requirements": "Helps in planning of activity.",
"min": 0,
"definition": "Identifies who's expected to be involved in the activity.",
"short": "Who will be responsible?",
"comments": "A performer MAY also be a participant in the care plan.",
"mapping": [ {
"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": "v2"
}, {
"map": ".participation[typeCode=PFM]",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
} ],
"max": "*",
"id": "CarePlan:uscorecareplan.activity.detail.performer",
"base": {
"max": "*",
"min": 0,
"path": "CarePlan.activity.detail.performer"
}
}, {
"path": "CarePlan.activity.detail.product[x]",
"min": 0,
"definition": "Identifies the food, drug or other product to be consumed or supplied in the activity.",
"short": "What is to be administered/supplied",
"mapping": [ {
"map": "RXE-2 / RXO-1 / RXD-2",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRD].role",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
}, {
"code": "Reference",
"targetProfile": "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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.product[x]",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.product[x]"
}
}, {
"path": "CarePlan.activity.detail.dailyAmount",
"requirements": "Allows rough dose checking.",
"min": 0,
"definition": "Identifies the quantity expected to be consumed in a given day.",
"short": "How to consume/day?",
"mapping": [ {
"map": "RXO-23 / RXE-19 / RXD-12",
"identity": "v2"
}, {
"map": ".outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"alias": [ "daily dose" ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.dailyAmount",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.dailyAmount"
}
}, {
"path": "CarePlan.activity.detail.quantity",
"min": 0,
"definition": "Identifies the quantity expected to be supplied, administered or consumed by the subject.",
"short": "How much to administer/supply/consume",
"mapping": [ {
"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": "v2"
}, {
"map": ".outboundRelationship[typeCode=COMP][classCode=SPLY].quantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.quantity",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.quantity"
}
}, {
"path": "CarePlan.activity.detail.description",
"min": 0,
"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.",
"short": "Extra info describing activity to perform",
"mapping": [ {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.activity.detail.description",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.activity.detail.description"
}
}, {
"path": "CarePlan.note",
"requirements": "Used to capture information that applies to the plan as a whole that doesn't fit into discrete elements.",
"min": 0,
"definition": "General notes about the care plan not covered elsewhere.",
"short": "Comments about the plan",
"mapping": [ {
"map": "NTE?",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "1",
"id": "CarePlan:uscorecareplan.note",
"base": {
"max": "1",
"min": 0,
"path": "CarePlan.note"
}
} ]
},
"status": "draft",
"id": "b0c97c7a-844d-430e-97d1-1f6e04d136b8",
"kind": "resource",
"url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-careplan",
"version": null,
"differential": {
"element": [ {
"id": "CarePlan:uscorecareplan",
"path": "CarePlan",
"short": "US Core CarePlan Profile",
"isSummary": false,
"sliceName": "USCoreCarePlan",
"definition": "The US Core CarePlan Profile is based upon the core FHIR CarePlan Resource and created to meet the 2015 Edition Common Clinical Data Set 'Assessment and Plan of Treatment requirements.",
"isModifier": false,
"mustSupport": false
}, {
"id": "CarePlan:uscorecareplan.text",
"max": "1",
"min": 1,
"path": "CarePlan.text",
"type": [ {
"code": "Narrative"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "CarePlan:uscorecareplan.text.status",
"path": "CarePlan.text.status",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"description": "Constrained value set of narrative statuses.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/us/core/ValueSet/us-core-narrative-status"
}
},
"isSummary": false,
"definition": "generated | additional.",
"isModifier": false,
"mustSupport": true
}, {
"path": "CarePlan.status",
"requirements": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"min": 1,
"isModifier": false,
"type": [ {
"code": "code"
} ],
"mustSupport": 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"
}
},
"max": "1",
"id": "CarePlan:uscorecareplan.status",
"isSummary": false
}, {
"path": "CarePlan.category",
"requirements": "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.",
"min": 1,
"definition": "Type of plan.",
"isModifier": false,
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"max": "1",
"id": "CarePlan:uscorecareplan.category",
"patternCodeableConcept": {
"coding": [ {
"code": "assess-plan",
"system": "http://hl7.org/fhir/us/core/CodeSystem/careplan-category"
} ]
},
"isSummary": false
}, {
"id": "CarePlan:uscorecareplan.category.system",
"max": "1",
"min": 1,
"path": "CarePlan.category.coding.system",
"type": [ {
"code": "uri"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"id": "CarePlan:uscorecareplan.category.system.code",
"max": "1",
"min": 1,
"path": "CarePlan.category.coding.code",
"type": [ {
"code": "code"
} ],
"isSummary": false,
"isModifier": false,
"mustSupport": true
}, {
"path": "CarePlan.subject",
"requirements": "Identifies the patient or group whose intended care is described by the plan.",
"min": 1,
"definition": "Who care plan is for.",
"isModifier": false,
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
} ],
"mustSupport": true,
"max": "1",
"id": "CarePlan:uscorecareplan.subject",
"isSummary": false
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://www.healthit.gov",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}