FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-CarePlan.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-CarePlan
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CarePlan | 0..* | CarePlan | Healthcare plan for patient or group | |
  meta | ||||
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:meta | 0..1 | Meta | R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.meta | |
| text | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:text | 0..1 | (Complex) | R4B: text additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.text | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:instantiatesUri | 0..* | uri | R4B: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesUri | |
| extension:created | 0..1 | dateTime | R4B: Date record was first recorded (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.created | |
| extension:contributor | 0..* | Reference(Cross-version Profile for R4B.Patient for use in FHIR STU3(0.1.0) | Patient | Cross-version Profile for R4B.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4B.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4B.Device for use in FHIR STU3(0.1.0) | Device | Cross-version Profile for R4B.RelatedPerson for use in FHIR STU3(0.1.0) | RelatedPerson | Cross-version Profile for R4B.Organization for use in FHIR STU3(0.1.0) | Organization | Cross-version Profile for R4B.CareTeam for use in FHIR STU3(0.1.0) | CareTeam) | R4B: Who provided the content of the care plan (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.contributor | |
| identifier | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | 0..* | Identifier | R4B: identifier additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.identifier | |
| definition | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:instantiatesCanonical | 0..* | uri | R4B: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesCanonical | |
| basedOn | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:basedOn | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Fulfills CarePlan additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| replaces | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:replaces | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: replaces additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| partOf | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:partOf | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| subject | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:subject | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Who the care plan is for additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| context | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:encounter | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Encounter created as part of additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| period | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:period | 0..1 | Period | R4B: period additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.period | |
| author | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:author | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Who is the designated responsible party URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| careTeam | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:careTeam | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: careTeam additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| addresses | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:addresses | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: addresses additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| supportingInfo | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:supportingInfo | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: supportingInfo additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| goal | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:goal | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: goal additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| activity | ||||
| outcomeReference | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:outcomeReference | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: outcomeReference additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| progress | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:progress | 0..* | Annotation | R4B: progress additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.progress | |
| reference | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:reference | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: reference URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| detail | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:instantiatesUri | 0..* | uri | R4B: Instantiates external protocol or definition (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri | |
| extension:scheduled | 0..1 | Timing, Period | R4B: scheduled additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.scheduled | |
| category | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:kind | 0..1 | code | R4B: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.kind Binding: R4BCarePlanActivityKindForR3 (0.1.0) (required): Resource types defined as part of FHIR that can be represented as in-line definitions of a care plan activity. | |
| definition | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:instantiatesCanonical | 0..* | uri | R4B: Instantiates FHIR protocol or definition additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical | |
| reasonReference | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:reasonReference | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Why activity is needed URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| goal | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:goal | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: goal additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| status | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:status | 0..1 | code | R4B: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.status Binding: CarePlanActivityStatus (required): Codes that reflect the current state of a care plan activity within its overall life cycle. | |
| statusReason | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:statusReason | 0..1 | CodeableConcept | R4B: statusReason additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.statusReason | |
| location | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:location | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: location additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| performer | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:performer | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: performer URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| productReference | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:alternateReference | 0..* | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: product URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| note | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:note | 0..* | Annotation | R4B: note additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.note | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-CarePlan",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-CarePlan",
"version": "0.1.0",
"name": "Profile_R4B_CarePlan_R3",
"title": "Cross-version Profile for R4B.CarePlan for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:24.8658207-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B CarePlan content to be represented via FHIR STU3 CarePlan resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow 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/CarePlan",
"derivation": "constraint",
"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": "*",
"base": {
"path": "CarePlan",
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"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))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Request"
},
{
"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.",
"comment": "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": "1"
},
"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": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "CarePlan.meta.id",
"path": "CarePlan.meta.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.meta.extension",
"path": "CarePlan.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.meta.extension:meta",
"path": "CarePlan.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `CarePlan.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `CarePlan.meta` is mapped to FHIR STU3 element `CarePlan.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.meta` do not cover the following types: Meta.\nThe mappings for `CarePlan.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.meta|0.1.0"
}
]
},
{
"id": "CarePlan.meta.versionId",
"path": "CarePlan.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "CarePlan.meta.lastUpdated",
"path": "CarePlan.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "CarePlan.meta.profile",
"path": "CarePlan.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "CarePlan.meta.security",
"path": "CarePlan.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "CarePlan.meta.tag",
"path": "CarePlan.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"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.",
"comment": "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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"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.",
"comment": "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": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"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.",
"comment": "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": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "CarePlan.text.id",
"path": "CarePlan.text.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.text.extension",
"path": "CarePlan.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.text.extension:text",
"path": "CarePlan.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `CarePlan.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `CarePlan.text` is mapped to FHIR STU3 element `CarePlan.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.text` do not cover the following types: Narrative.\nThe mappings for `CarePlan.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.text|0.1.0"
}
]
},
{
"id": "CarePlan.text.status",
"path": "CarePlan.text.status",
"short": "generated | extensions | additional | empty",
"definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}
],
"strength": "required",
"description": "The status of a resource narrative",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/narrative-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.text.div",
"path": "CarePlan.text.div",
"short": "Limited xhtml content",
"definition": "The actual narrative content, a stripped down version of XHTML.",
"comment": "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, <a> 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.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [
{
"code": "xhtml"
}
],
"constraint": [
{
"key": "txt-1",
"severity": "error",
"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, <a> elements (either name or href), images and internally contained style attributes",
"expression": "htmlchecks()",
"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'))])",
"source": "http://hl7.org/fhir/StructureDefinition/CarePlan"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlchecks()",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "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",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.extension:instantiatesUri",
"path": "CarePlan.extension",
"sliceName": "instantiatesUri",
"short": "R4B: Instantiates external protocol or definition (new)",
"definition": "R4B: `CarePlan.instantiatesUri` (new:uri)",
"comment": "Element `CarePlan.instantiatesUri` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.instantiatesUri` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesUri|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "CarePlan.extension:created",
"path": "CarePlan.extension",
"sliceName": "created",
"short": "R4B: Date record was first recorded (new)",
"definition": "R4B: `CarePlan.created` (new:dateTime)",
"comment": "Element `CarePlan.created` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.created` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.created|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "CarePlan.extension:contributor",
"path": "CarePlan.extension",
"sliceName": "contributor",
"short": "R4B: Who provided the content of the care plan (new)",
"definition": "R4B: `CarePlan.contributor` (new:Reference(Patient,Practitioner,PractitionerRole,Device,RelatedPerson,Organization,CareTeam))",
"comment": "Element `CarePlan.contributor` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.contributor` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nCollaborative care plans may have multiple contributors.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.contributor|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"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.",
"comment": "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": "*",
"base": {
"path": "CarePlan.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.identifier"
},
{
"identity": "v2",
"map": "PTH-3"
},
{
"identity": "rim",
"map": ".id"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "CarePlan.identifier.id",
"path": "CarePlan.identifier.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.identifier.extension",
"path": "CarePlan.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.identifier.extension:identifier",
"path": "CarePlan.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `CarePlan.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `CarePlan.identifier` is mapped to FHIR STU3 element `CarePlan.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.identifier` do not cover the following types: Identifier.\nThe mappings for `CarePlan.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nThis is a business identifier, not a resource identifier (see [discussion](https://hl7.org/fhir/resource.htm#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.identifier|0.1.0"
}
]
},
{
"id": "CarePlan.identifier.use",
"path": "CarePlan.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CarePlan.identifier.type",
"path": "CarePlan.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "CarePlan.identifier.system",
"path": "CarePlan.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "CarePlan.identifier.value",
"path": "CarePlan.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "CarePlan.identifier.period",
"path": "CarePlan.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "CarePlan.identifier.assigner",
"path": "CarePlan.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "CarePlan.definition",
"path": "CarePlan.definition",
"short": "Protocol or definition",
"definition": "Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.definition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.definition"
}
]
},
{
"id": "CarePlan.definition.id",
"path": "CarePlan.definition.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.definition.extension",
"path": "CarePlan.definition.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.definition.extension:instantiatesCanonical",
"path": "CarePlan.definition.extension",
"sliceName": "instantiatesCanonical",
"short": "R4B: Instantiates FHIR protocol or definition additional types",
"definition": "R4B: `CarePlan.instantiatesCanonical` additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))",
"comment": "Element `CarePlan.instantiatesCanonical` is mapped to FHIR STU3 element `CarePlan.definition` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.instantiatesCanonical` do not cover the following types: canonical.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesCanonical|0.1.0"
}
]
},
{
"id": "CarePlan.definition.reference",
"path": "CarePlan.definition.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.definition.identifier",
"path": "CarePlan.definition.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.definition.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.definition.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.basedOn",
"path": "CarePlan.basedOn",
"short": "Fulfills care plan",
"definition": "A care plan that is fulfilled in whole or in part by this care plan.",
"requirements": "Allows tracing of the care plan and tracking whether proposals/recommendations were acted upon.",
"alias": [
"fulfills"
],
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.basedOn",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.basedOn"
}
]
},
{
"id": "CarePlan.basedOn.id",
"path": "CarePlan.basedOn.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.basedOn.extension",
"path": "CarePlan.basedOn.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.basedOn.extension:basedOn",
"path": "CarePlan.basedOn.extension",
"sliceName": "basedOn",
"short": "R4B: Fulfills CarePlan additional types",
"definition": "R4B: `CarePlan.basedOn` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.basedOn` is mapped to FHIR STU3 element `CarePlan.basedOn` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.basedOn` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.basedOn` with unmapped reference targets: CarePlan.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.basedOn.reference",
"path": "CarePlan.basedOn.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.basedOn.identifier",
"path": "CarePlan.basedOn.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.basedOn.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.basedOn.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.replaces",
"path": "CarePlan.replaces",
"short": "CarePlan replaced by this CarePlan",
"definition": "Completed or terminated care plan whose function is taken by this new care plan.",
"comment": "The replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"requirements": "Allows tracing the continuation of a therapy or administrative process instantiated through multiple care plans.",
"alias": [
"supersedes"
],
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.replaces",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.replaces"
}
]
},
{
"id": "CarePlan.replaces.id",
"path": "CarePlan.replaces.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.replaces.extension",
"path": "CarePlan.replaces.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.replaces.extension:replaces",
"path": "CarePlan.replaces.extension",
"sliceName": "replaces",
"short": "R4B: replaces additional types",
"definition": "R4B: `CarePlan.replaces` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.replaces` is mapped to FHIR STU3 element `CarePlan.replaces` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.replaces` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.replaces` with unmapped reference targets: CarePlan.\nThe replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.replaces.reference",
"path": "CarePlan.replaces.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.replaces.identifier",
"path": "CarePlan.replaces.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.replaces.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.replaces.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.partOf",
"path": "CarePlan.partOf",
"short": "Part of referenced CarePlan",
"definition": "A larger care plan of which this particular care plan is a component or step.",
"comment": "Each care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.partOf",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
],
"isSummary": true
},
{
"id": "CarePlan.partOf.id",
"path": "CarePlan.partOf.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.partOf.extension",
"path": "CarePlan.partOf.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.partOf.extension:partOf",
"path": "CarePlan.partOf.extension",
"sliceName": "partOf",
"short": "R4B: partOf additional types",
"definition": "R4B: `CarePlan.partOf` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.partOf` is mapped to FHIR STU3 element `CarePlan.partOf` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.partOf` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.partOf` with unmapped reference targets: CarePlan.\nEach care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.partOf.reference",
"path": "CarePlan.partOf.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.partOf.identifier",
"path": "CarePlan.partOf.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.partOf.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.partOf.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.status",
"path": "CarePlan.status",
"short": "draft | active | suspended | completed | entered-in-error | cancelled | unknown",
"definition": "Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.",
"comment": "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.\n\nThis element is labeled as a modifier because the status contains the code entered-in-error] that marks the plan as not currently valid.",
"requirements": "Allows clinicians to determine whether the plan is actionable or not.",
"min": 1,
"max": "1",
"base": {
"path": "CarePlan.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanStatus"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status (uses different ValueSet)"
},
{
"identity": "v2",
"map": "PTH-5"
},
{
"identity": "rim",
"map": ".statusCode planned = new active = active completed = completed"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "CarePlan.intent",
"path": "CarePlan.intent",
"short": "proposal | plan | order | option",
"definition": "Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.",
"comment": "This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.",
"requirements": "Proposals/recommendations, plans and orders all use the same structure and can exist in the same fulfillment chain.",
"min": 1,
"max": "1",
"base": {
"path": "CarePlan.intent",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanIntent"
}
],
"strength": "required",
"description": "Codes indicating the degree of authority/intentionality associated with a care plan",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-intent|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.intent"
}
]
},
{
"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.",
"comment": "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": "*",
"base": {
"path": "CarePlan.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanCategory"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
},
{
"identity": "w5",
"map": "class"
}
]
},
{
"id": "CarePlan.title",
"path": "CarePlan.title",
"short": "Human-friendly name for the CarePlan",
"definition": "Human-friendly name for the CarePlan.",
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.title",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true
},
{
"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",
"base": {
"path": "CarePlan.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "what"
}
]
},
{
"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.",
"alias": [
"patient"
],
"min": 1,
"max": "1",
"base": {
"path": "CarePlan.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Group"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.subject"
},
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "CarePlan.subject.id",
"path": "CarePlan.subject.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.subject.extension",
"path": "CarePlan.subject.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.subject.extension:subject",
"path": "CarePlan.subject.extension",
"sliceName": "subject",
"short": "R4B: Who the care plan is for additional types",
"definition": "R4B: `CarePlan.subject` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.subject` is mapped to FHIR STU3 element `CarePlan.subject` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.subject` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.subject` with unmapped reference targets: Group, Patient.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.subject.reference",
"path": "CarePlan.subject.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.subject.identifier",
"path": "CarePlan.subject.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.subject.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.subject.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.context",
"path": "CarePlan.context",
"short": "Created in context of",
"definition": "Identifies the original context in which this particular CarePlan was created.",
"comment": "Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.",
"alias": [
"encounter"
],
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Encounter"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/EpisodeOfCare"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.context"
},
{
"identity": "v2",
"map": "Associated PV1"
},
{
"identity": "rim",
"map": "."
},
{
"identity": "w5",
"map": "context"
}
]
},
{
"id": "CarePlan.context.id",
"path": "CarePlan.context.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.context.extension",
"path": "CarePlan.context.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.context.extension:encounter",
"path": "CarePlan.context.extension",
"sliceName": "encounter",
"short": "R4B: Encounter created as part of additional types",
"definition": "R4B: `CarePlan.encounter` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.encounter` is mapped to FHIR STU3 element `CarePlan.context` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.encounter` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.encounter` with unmapped reference targets: Encounter.\nThis will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.context.reference",
"path": "CarePlan.context.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.context.identifier",
"path": "CarePlan.context.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.context.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.context.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "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).",
"requirements": "Allows tracking what plan(s) are in effect at a particular time.",
"alias": [
"timing"
],
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrencePeriod"
},
{
"identity": "v2",
"map": "GOL-7 / GOL-8"
},
{
"identity": "rim",
"map": ".effectiveTime"
},
{
"identity": "w5",
"map": "when.init"
}
]
},
{
"id": "CarePlan.period.id",
"path": "CarePlan.period.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.period.extension",
"path": "CarePlan.period.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.period.extension:period",
"path": "CarePlan.period.extension",
"sliceName": "period",
"short": "R4B: period additional types",
"definition": "R4B: `CarePlan.period` additional types (Period) additional types from child elements (end, start)",
"comment": "Element `CarePlan.period` is mapped to FHIR STU3 element `CarePlan.period` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.period` do not cover the following types: Period.\nThe mappings for `CarePlan.period` do not cover the following types based on type expansion: end, start.\nAny 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).",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.period|0.1.0"
}
]
},
{
"id": "CarePlan.period.start",
"path": "CarePlan.period.start",
"short": "Starting time with inclusive boundary",
"definition": "The start of the period. The boundary is inclusive.",
"comment": "If the low element is missing, the meaning is that the low boundary is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Period.start",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"condition": [
"per-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "DR.1"
},
{
"identity": "rim",
"map": "./low"
}
]
},
{
"id": "CarePlan.period.end",
"path": "CarePlan.period.end",
"short": "End time with inclusive boundary, if not ongoing",
"definition": "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment": "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min": 0,
"max": "1",
"base": {
"path": "Period.end",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"meaningWhenMissing": "If the end of the period is missing, it means that the period is ongoing",
"condition": [
"per-1"
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "DR.2"
},
{
"identity": "rim",
"map": "./high"
}
]
},
{
"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.",
"comment": "Collaborative care plans may have multiple authors.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.author",
"min": 0,
"max": "*"
},
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.requester.agent (if only one author)"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "CarePlan.author.id",
"path": "CarePlan.author.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.author.extension",
"path": "CarePlan.author.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.author.extension:author",
"path": "CarePlan.author.extension",
"sliceName": "author",
"short": "R4B: Who is the designated responsible party",
"definition": "R4B: `CarePlan.author`",
"comment": "Element `CarePlan.author` is mapped to FHIR STU3 element `CarePlan.author` as `RelatedTo`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.author` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nThe author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.author.reference",
"path": "CarePlan.author.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.author.identifier",
"path": "CarePlan.author.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.author.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.author.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"base": {
"path": "CarePlan.careTeam",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer (similar but does not entail CareTeam)"
},
{
"identity": "w5",
"map": "who.actor"
}
]
},
{
"id": "CarePlan.careTeam.id",
"path": "CarePlan.careTeam.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.careTeam.extension",
"path": "CarePlan.careTeam.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.careTeam.extension:careTeam",
"path": "CarePlan.careTeam.extension",
"sliceName": "careTeam",
"short": "R4B: careTeam additional types",
"definition": "R4B: `CarePlan.careTeam` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.careTeam` is mapped to FHIR STU3 element `CarePlan.careTeam` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.careTeam` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.careTeam` with unmapped reference targets: CareTeam.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.careTeam.reference",
"path": "CarePlan.careTeam.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.careTeam.identifier",
"path": "CarePlan.careTeam.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.careTeam.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.careTeam.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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. 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,
"max": "*",
"base": {
"path": "CarePlan.addresses",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"isSummary": true,
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
},
{
"identity": "v2",
"map": "PRB-4"
},
{
"identity": "rim",
"map": ".actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]"
},
{
"identity": "w5",
"map": "why"
}
]
},
{
"id": "CarePlan.addresses.id",
"path": "CarePlan.addresses.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.addresses.extension",
"path": "CarePlan.addresses.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.addresses.extension:addresses",
"path": "CarePlan.addresses.extension",
"sliceName": "addresses",
"short": "R4B: addresses additional types",
"definition": "R4B: `CarePlan.addresses` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.addresses` is mapped to FHIR STU3 element `CarePlan.addresses` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.addresses` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.addresses` with unmapped reference targets: Condition.\nWhen the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.addresses.reference",
"path": "CarePlan.addresses.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.addresses.identifier",
"path": "CarePlan.addresses.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.addresses.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.addresses.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.supportingInfo",
"path": "CarePlan.supportingInfo",
"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.",
"comment": "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": "*",
"base": {
"path": "CarePlan.supportingInfo",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInfo"
}
]
},
{
"id": "CarePlan.supportingInfo.id",
"path": "CarePlan.supportingInfo.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.supportingInfo.extension",
"path": "CarePlan.supportingInfo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.supportingInfo.extension:supportingInfo",
"path": "CarePlan.supportingInfo.extension",
"sliceName": "supportingInfo",
"short": "R4B: supportingInfo additional types",
"definition": "R4B: `CarePlan.supportingInfo` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.supportingInfo` is mapped to FHIR STU3 element `CarePlan.supportingInfo` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.supportingInfo` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.supportingInfo` with unmapped reference targets: Resource.\nUse \"concern\" to identify specific conditions addressed by the care plan.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.supportingInfo.reference",
"path": "CarePlan.supportingInfo.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.supportingInfo.identifier",
"path": "CarePlan.supportingInfo.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.supportingInfo.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.supportingInfo.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.goal",
"path": "CarePlan.goal",
"short": "Desired outcome of plan",
"definition": "Describes the intended objective(s) of carrying out the care plan.",
"comment": "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": "*",
"base": {
"path": "CarePlan.goal",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.goal.id",
"path": "CarePlan.goal.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.goal.extension",
"path": "CarePlan.goal.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.goal.extension:goal",
"path": "CarePlan.goal.extension",
"sliceName": "goal",
"short": "R4B: goal additional types",
"definition": "R4B: `CarePlan.goal` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.goal` is mapped to FHIR STU3 element `CarePlan.goal` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.goal` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.goal` with unmapped reference targets: Goal.\nGoal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.goal.reference",
"path": "CarePlan.goal.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.goal.identifier",
"path": "CarePlan.goal.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.goal.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.goal.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"base": {
"path": "CarePlan.activity",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "cpl-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))",
"source": "http://hl7.org/fhir/StructureDefinition/CarePlan"
}
],
"mapping": [
{
"identity": "workflow",
"map": "no mapping\nNOTE: This is a list of contained Request-Event tuples!"
},
{
"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": "1"
},
"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.",
"comment": "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.",
"comment": "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.outcomeCodeableConcept",
"path": "CarePlan.activity.outcomeCodeableConcept",
"short": "Results of the activity",
"definition": "Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).",
"comment": "Note that this should not duplicate the activity status (e.g. completed or in progress).",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.activity.outcomeCodeableConcept",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityOutcome"
}
],
"strength": "example",
"description": "Identifies the results of the activity",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/care-plan-activity-outcome|3.0.2"
}
}
},
{
"id": "CarePlan.activity.outcomeReference",
"path": "CarePlan.activity.outcomeReference",
"short": "Appointment, Encounter, Procedure, etc.",
"definition": "Details of the outcome or action resulting from the activity. The reference to an \"event\" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).",
"comment": "The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lb and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"requirements": "Links plan to resulting actions.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.activity.outcomeReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event that is outcome of Request in activity.reference"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=FLFS].source"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.id",
"path": "CarePlan.activity.outcomeReference.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.extension",
"path": "CarePlan.activity.outcomeReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.extension:outcomeReference",
"path": "CarePlan.activity.outcomeReference.extension",
"sliceName": "outcomeReference",
"short": "R4B: outcomeReference additional types",
"definition": "R4B: `CarePlan.activity.outcomeReference` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.outcomeReference` is mapped to FHIR STU3 element `CarePlan.activity.outcomeReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.outcomeReference` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.outcomeReference` with unmapped reference targets: Resource.\nThe activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.reference",
"path": "CarePlan.activity.outcomeReference.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.identifier",
"path": "CarePlan.activity.outcomeReference.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.outcomeReference.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "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": "*",
"base": {
"path": "CarePlan.activity.progress",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.status (Annotation instead of CodableConcept)"
},
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"id": "CarePlan.activity.progress.id",
"path": "CarePlan.activity.progress.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.progress.extension",
"path": "CarePlan.activity.progress.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.progress.extension:progress",
"path": "CarePlan.activity.progress.extension",
"sliceName": "progress",
"short": "R4B: progress additional types",
"definition": "R4B: `CarePlan.activity.progress` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `CarePlan.activity.progress` is mapped to FHIR STU3 element `CarePlan.activity.progress` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.progress` do not cover the following types: Annotation.\nThe mappings for `CarePlan.activity.progress` do not cover the following types based on type expansion: author[x], text, time.\nThis 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.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.progress|0.1.0"
}
]
},
{
"id": "CarePlan.activity.progress.author[x]",
"path": "CarePlan.activity.progress.author[x]",
"short": "Individual responsible for the annotation",
"definition": "The individual responsible for making the annotation.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.author[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.participant[typeCode=AUT].role"
}
]
},
{
"id": "CarePlan.activity.progress.time",
"path": "CarePlan.activity.progress.time",
"short": "When the annotation was made",
"definition": "Indicates when this particular annotation was made.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.effectiveTime"
}
]
},
{
"id": "CarePlan.activity.progress.text",
"path": "CarePlan.activity.progress.text",
"short": "The annotation - text content",
"definition": "The text of the annotation.",
"min": 1,
"max": "1",
"base": {
"path": "Annotation.text",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text"
}
]
},
{
"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.",
"comment": "Standard extension exists ([goal-pertainstogoal](http://hl7.org/fhir/STU3/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. 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.",
"requirements": "Details in a form consistent with other applications and contexts of use.",
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.activity.reference",
"min": 0,
"max": "1"
},
"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/DeviceRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/MedicationRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/NutritionOrder"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Task"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ProcedureRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ReferralRequest"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/VisionPrescription"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RequestGroup"
}
],
"condition": [
"cpl-3"
],
"mapping": [
{
"identity": "workflow",
"map": "Request that resulted in Event in activity.actionResulting"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=COMP].target"
}
]
},
{
"id": "CarePlan.activity.reference.id",
"path": "CarePlan.activity.reference.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.reference.extension",
"path": "CarePlan.activity.reference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.reference.extension:reference",
"path": "CarePlan.activity.reference.extension",
"sliceName": "reference",
"short": "R4B: reference",
"definition": "R4B: `CarePlan.activity.reference`",
"comment": "Element `CarePlan.activity.reference` is mapped to FHIR STU3 element `CarePlan.activity.reference` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.reference` with unmapped reference targets: Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, RequestGroup, ServiceRequest, Task, VisionPrescription.\nStandard extension exists ([resource-pertainsToGoal](https://hl7.org/fhir/extension-resource-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 independently 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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.reference.reference",
"path": "CarePlan.activity.reference.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.reference.identifier",
"path": "CarePlan.activity.reference.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.reference.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.reference.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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",
"base": {
"path": "CarePlan.activity.detail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"cpl-3"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.extension",
"path": "CarePlan.activity.detail.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.extension:instantiatesUri",
"path": "CarePlan.activity.detail.extension",
"sliceName": "instantiatesUri",
"short": "R4B: Instantiates external protocol or definition (new)",
"definition": "R4B: `CarePlan.activity.detail.instantiatesUri` (new:uri)",
"comment": "Element `CarePlan.activity.detail.instantiatesUri` has a context of CarePlan.activity.detail based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.activity.detail.instantiatesUri` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "CarePlan.activity.detail.extension:scheduled",
"path": "CarePlan.activity.detail.extension",
"sliceName": "scheduled",
"short": "R4B: scheduled additional types",
"definition": "R4B: `CarePlan.activity.detail.scheduled[x]` additional types (Timing, Period)",
"comment": "Element `CarePlan.activity.detail.scheduled[x]` is mapped to FHIR STU3 element `CarePlan.activity.detail.scheduled[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.scheduled[x]` do not cover the following types: Period, Timing.\nThe target context `CarePlan.activity.detail.scheduled[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `CarePlan.activity.detail`.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.scheduled|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"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.",
"comment": "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",
"base": {
"path": "CarePlan.activity.detail.category",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityCategory"
}
],
"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|1.0.0"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.supportingInformation"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=COMP].source[classCode=LIST].code"
}
]
},
{
"id": "CarePlan.activity.detail.category.id",
"path": "CarePlan.activity.detail.category.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.category.extension",
"path": "CarePlan.activity.detail.category.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.category.extension:kind",
"path": "CarePlan.activity.detail.category.extension",
"sliceName": "kind",
"short": "R4B: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription",
"definition": "R4B: `CarePlan.activity.detail.kind`",
"comment": "Element `CarePlan.activity.detail.kind` is mapped to FHIR STU3 element `CarePlan.activity.detail.category` as `SourceIsNarrowerThanTarget`.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.kind|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.category.coding",
"path": "CarePlan.activity.detail.category.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comment": "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 labeled as UserSelected = true.",
"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,
"max": "*",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id": "CarePlan.activity.detail.category.text",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.category.text",
"short": "Plain text representation of the concept",
"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.",
"comment": "Very often the text is the same as a displayName of one of the codings.",
"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,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity": "rim",
"map": "./originalText[mediaType/code=\"text/plain\"]/data"
},
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"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.",
"requirements": "Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.",
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.activity.detail.definition",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/PlanDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Questionnaire"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.definition"
}
]
},
{
"id": "CarePlan.activity.detail.definition.id",
"path": "CarePlan.activity.detail.definition.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.definition.extension",
"path": "CarePlan.activity.detail.definition.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.definition.extension:instantiatesCanonical",
"path": "CarePlan.activity.detail.definition.extension",
"sliceName": "instantiatesCanonical",
"short": "R4B: Instantiates FHIR protocol or definition additional types",
"definition": "R4B: `CarePlan.activity.detail.instantiatesCanonical` additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))",
"comment": "Element `CarePlan.activity.detail.instantiatesCanonical` is mapped to FHIR STU3 element `CarePlan.activity.detail.definition` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.instantiatesCanonical` do not cover the following types: canonical.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.definition.reference",
"path": "CarePlan.activity.detail.definition.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.definition.identifier",
"path": "CarePlan.activity.detail.definition.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.detail.definition.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.definition.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "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",
"base": {
"path": "CarePlan.activity.detail.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityType"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.code"
},
{
"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 or why activity was prohibited",
"definition": "Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.",
"comment": "This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.activity.detail.reasonCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityReason"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonCode"
}
]
},
{
"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.",
"comment": "Conditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.activity.detail.reasonReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Condition"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.reasonReference"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.id",
"path": "CarePlan.activity.detail.reasonReference.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.extension",
"path": "CarePlan.activity.detail.reasonReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.extension:reasonReference",
"path": "CarePlan.activity.detail.reasonReference.extension",
"sliceName": "reasonReference",
"short": "R4B: Why activity is needed",
"definition": "R4B: `CarePlan.activity.detail.reasonReference`",
"comment": "Element `CarePlan.activity.detail.reasonReference` is mapped to FHIR STU3 element `CarePlan.activity.detail.reasonReference` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.reasonReference` with unmapped reference targets: Condition, DiagnosticReport, DocumentReference, Observation.\nConditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.reference",
"path": "CarePlan.activity.detail.reasonReference.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.identifier",
"path": "CarePlan.activity.detail.reasonReference.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.reasonReference.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": "*",
"base": {
"path": "CarePlan.activity.detail.goal",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Goal"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.goal"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "CarePlan.activity.detail.goal.id",
"path": "CarePlan.activity.detail.goal.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.goal.extension",
"path": "CarePlan.activity.detail.goal.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.goal.extension:goal",
"path": "CarePlan.activity.detail.goal.extension",
"sliceName": "goal",
"short": "R4B: goal additional types",
"definition": "R4B: `CarePlan.activity.detail.goal` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.detail.goal` is mapped to FHIR STU3 element `CarePlan.activity.detail.goal` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.goal` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.goal` with unmapped reference targets: Goal.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.goal.reference",
"path": "CarePlan.activity.detail.goal.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.goal.identifier",
"path": "CarePlan.activity.detail.goal.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.detail.goal.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.goal.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.status",
"path": "CarePlan.activity.detail.status",
"short": "not-started | scheduled | in-progress | on-hold | completed | cancelled | unknown",
"definition": "Identifies what progress is being made for the specific activity.",
"comment": "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. \nThe 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.",
"requirements": "Indicates progress against the plan, whether the activity is still relevant for the plan.",
"min": 1,
"max": "1",
"base": {
"path": "CarePlan.activity.detail.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanActivityStatus"
}
],
"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|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Request.status (uses different ValueSet)"
},
{
"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.status.id",
"path": "CarePlan.activity.detail.status.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CarePlan.activity.detail.status.extension",
"path": "CarePlan.activity.detail.status.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.status.extension:status",
"path": "CarePlan.activity.detail.status.extension",
"sliceName": "status",
"short": "R4B: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes",
"definition": "R4B: `CarePlan.activity.detail.status` additional codes",
"comment": "Element `CarePlan.activity.detail.status` is mapped to FHIR STU3 element `CarePlan.activity.detail.status` as `RelatedTo`.\nThe mappings for `CarePlan.activity.detail.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nThe target context `CarePlan.activity.detail.status` is a modifier element, so this extension does not need to be defined as a modifier.\nSome 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. \nThe 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.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.status|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "CarePlan.activity.detail.status.value",
"path": "CarePlan.activity.detail.status.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for code",
"definition": "Primitive value for code",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-regex",
"valueString": "[^\\s]+([\\s]?[^\\s]+)*"
}
],
"_code": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:token"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:token"
}
]
}
}
]
},
{
"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.",
"comment": "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",
"base": {
"path": "CarePlan.activity.detail.statusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason.id",
"path": "CarePlan.activity.detail.statusReason.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references)",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason.extension",
"path": "CarePlan.activity.detail.statusReason.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason.extension:statusReason",
"path": "CarePlan.activity.detail.statusReason.extension",
"sliceName": "statusReason",
"short": "R4B: statusReason additional types",
"definition": "R4B: `CarePlan.activity.detail.statusReason` additional types (CodeableConcept) additional types from child elements (coding)",
"comment": "Element `CarePlan.activity.detail.statusReason` is mapped to FHIR STU3 element `CarePlan.activity.detail.statusReason` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.statusReason` do not cover the following types: CodeableConcept.\nThe mappings for `CarePlan.activity.detail.statusReason` do not cover the following types based on type expansion: coding.\nWill 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",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.statusReason|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "CarePlan.activity.detail.statusReason.value",
"path": "CarePlan.activity.detail.statusReason.value",
"representation": [
"xmlAttr"
],
"short": "Primitive value for string",
"definition": "The actual value",
"min": 0,
"max": "1",
"base": {
"path": "string.value",
"min": 0,
"max": "1"
},
"type": [
{
"_code": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-json-type",
"valueString": "string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-xml-type",
"valueString": "xsd:string"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-rdf-type",
"valueString": "xsd:string"
}
]
}
}
],
"maxLength": 1048576
},
{
"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. If false, indicates that the described activity is one that should be engaged in when following the plan.",
"comment": "This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.",
"requirements": "Captures intention to not do something that may have been previously typical.",
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.activity.detail.prohibited",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": false,
"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",
"base": {
"path": "CarePlan.activity.detail.scheduled[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Timing"
},
{
"code": "Period"
},
{
"code": "string"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.occurrence"
},
{
"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.",
"comment": "May reference a specific clinical location or may identify a type of location.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "1",
"base": {
"path": "CarePlan.activity.detail.location",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBR-24(???!!)"
},
{
"identity": "rim",
"map": ".participation[typeCode=LOC].role"
}
]
},
{
"id": "CarePlan.activity.detail.location.id",
"path": "CarePlan.activity.detail.location.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.location.extension",
"path": "CarePlan.activity.detail.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.location.extension:location",
"path": "CarePlan.activity.detail.location.extension",
"sliceName": "location",
"short": "R4B: location additional types",
"definition": "R4B: `CarePlan.activity.detail.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.detail.location` is mapped to FHIR STU3 element `CarePlan.activity.detail.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.location` with unmapped reference targets: Location.\nMay reference a specific clinical location or may identify a type of location.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.location.reference",
"path": "CarePlan.activity.detail.location.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.location.identifier",
"path": "CarePlan.activity.detail.location.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.detail.location.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.location.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comment": "A performer MAY also be a participant in the care plan.",
"requirements": "Helps in planning of activity.",
"min": 0,
"max": "*",
"base": {
"path": "CarePlan.activity.detail.performer",
"min": 0,
"max": "*"
},
"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"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/CareTeam"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.performer"
},
{
"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.performer.id",
"path": "CarePlan.activity.detail.performer.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.performer.extension",
"path": "CarePlan.activity.detail.performer.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.performer.extension:performer",
"path": "CarePlan.activity.detail.performer.extension",
"sliceName": "performer",
"short": "R4B: performer",
"definition": "R4B: `CarePlan.activity.detail.performer`",
"comment": "Element `CarePlan.activity.detail.performer` is mapped to FHIR STU3 element `CarePlan.activity.detail.performer` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.performer` with unmapped reference targets: CareTeam, Device, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nA performer MAY also be a participant in the care plan.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.performer.reference",
"path": "CarePlan.activity.detail.performer.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "CarePlan.activity.detail.performer.identifier",
"path": "CarePlan.activity.detail.performer.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "CarePlan.activity.detail.performer.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "CarePlan.activity.detail.performer.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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",
"base": {
"path": "CarePlan.activity.detail.product[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Medication"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Substance"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "CarePlanProduct"
}
],
"strength": "example",
"description": "A product supplied or administered as part of a care plan activity.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/medication-codes|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "RXE-2 / RXO-1 / RXD-2"
},
{
"identity": "rim",
"map": ".participation[typeCode=PRD].role"
}
]
},
{
"id": "CarePlan.activity.detail.product[x].id",
"path": "CarePlan.activity.detail.product[x].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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.activity.detail.product[x].extension",
"path": "CarePlan.activity.detail.product[x].extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.activity.detail.product[x].extension:alternateReference",
"path": "CarePlan.activity.detail.product[x].extension",
"sliceName": "alternateReference",
"short": "R4B: product",
"definition": "R4B: `CarePlan.activity.detail.product[x]`",
"comment": "Element `CarePlan.activity.detail.product[x]` is mapped to FHIR STU3 element `CarePlan.activity.detail.product[x]` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.product[x]` with unmapped reference targets: Medication, Substance.\nSource element `CarePlan.activity.detail.product[x]` has unmapped reference types. While the target element `CarePlan.activity.detail.product[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"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",
"base": {
"path": "CarePlan.activity.detail.dailyAmount",
"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",
"base": {
"path": "CarePlan.activity.detail.quantity",
"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",
"base": {
"path": "CarePlan.activity.detail.description",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.note"
},
{
"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": "*",
"base": {
"path": "CarePlan.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Request.note"
},
{
"identity": "v2",
"map": "NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"id": "CarePlan.note.id",
"path": "CarePlan.note.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": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "CarePlan.note.extension",
"path": "CarePlan.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "CarePlan.note.extension:note",
"path": "CarePlan.note.extension",
"sliceName": "note",
"short": "R4B: note additional types",
"definition": "R4B: `CarePlan.note` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `CarePlan.note` is mapped to FHIR STU3 element `CarePlan.note` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.note` do not cover the following types: Annotation.\nThe mappings for `CarePlan.note` do not cover the following types based on type expansion: author[x], text, time.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.note|0.1.0"
}
]
},
{
"id": "CarePlan.note.author[x]",
"path": "CarePlan.note.author[x]",
"short": "Individual responsible for the annotation",
"definition": "The individual responsible for making the annotation.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.author[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
},
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.participant[typeCode=AUT].role"
}
]
},
{
"id": "CarePlan.note.time",
"path": "CarePlan.note.time",
"short": "When the annotation was made",
"definition": "Indicates when this particular annotation was made.",
"min": 0,
"max": "1",
"base": {
"path": "Annotation.time",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.effectiveTime"
}
]
},
{
"id": "CarePlan.note.text",
"path": "CarePlan.note.text",
"short": "The annotation - text content",
"definition": "The text of the annotation.",
"min": 1,
"max": "1",
"base": {
"path": "Annotation.text",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Act.text"
}
]
}
]
},
"differential": {
"element": [
{
"id": "CarePlan",
"path": "CarePlan"
},
{
"id": "CarePlan.meta.extension",
"path": "CarePlan.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.meta.extension:meta",
"path": "CarePlan.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `CarePlan.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `CarePlan.meta` is mapped to FHIR STU3 element `CarePlan.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.meta` do not cover the following types: Meta.\nThe mappings for `CarePlan.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.meta|0.1.0"
}
]
},
{
"id": "CarePlan.text.extension",
"path": "CarePlan.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.text.extension:text",
"path": "CarePlan.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `CarePlan.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `CarePlan.text` is mapped to FHIR STU3 element `CarePlan.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.text` do not cover the following types: Narrative.\nThe mappings for `CarePlan.text` do not cover the following types based on type expansion: div, status.\nContained 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 information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.text|0.1.0"
}
]
},
{
"id": "CarePlan.extension",
"path": "CarePlan.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.extension:instantiatesUri",
"path": "CarePlan.extension",
"sliceName": "instantiatesUri",
"short": "R4B: Instantiates external protocol or definition (new)",
"definition": "R4B: `CarePlan.instantiatesUri` (new:uri)",
"comment": "Element `CarePlan.instantiatesUri` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.instantiatesUri` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesUri|0.1.0"
}
]
},
{
"id": "CarePlan.extension:created",
"path": "CarePlan.extension",
"sliceName": "created",
"short": "R4B: Date record was first recorded (new)",
"definition": "R4B: `CarePlan.created` (new:dateTime)",
"comment": "Element `CarePlan.created` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.created` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.created|0.1.0"
}
]
},
{
"id": "CarePlan.extension:contributor",
"path": "CarePlan.extension",
"sliceName": "contributor",
"short": "R4B: Who provided the content of the care plan (new)",
"definition": "R4B: `CarePlan.contributor` (new:Reference(Patient,Practitioner,PractitionerRole,Device,RelatedPerson,Organization,CareTeam))",
"comment": "Element `CarePlan.contributor` has a context of CarePlan based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.contributor` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nCollaborative care plans may have multiple contributors.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.contributor|0.1.0"
}
]
},
{
"id": "CarePlan.identifier.extension",
"path": "CarePlan.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.identifier.extension:identifier",
"path": "CarePlan.identifier.extension",
"sliceName": "identifier",
"short": "R4B: identifier additional types",
"definition": "R4B: `CarePlan.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `CarePlan.identifier` is mapped to FHIR STU3 element `CarePlan.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.identifier` do not cover the following types: Identifier.\nThe mappings for `CarePlan.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.\nThis is a business identifier, not a resource identifier (see [discussion](https://hl7.org/fhir/resource.htm#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.identifier|0.1.0"
}
]
},
{
"id": "CarePlan.definition.extension",
"path": "CarePlan.definition.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.definition.extension:instantiatesCanonical",
"path": "CarePlan.definition.extension",
"sliceName": "instantiatesCanonical",
"short": "R4B: Instantiates FHIR protocol or definition additional types",
"definition": "R4B: `CarePlan.instantiatesCanonical` additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))",
"comment": "Element `CarePlan.instantiatesCanonical` is mapped to FHIR STU3 element `CarePlan.definition` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.instantiatesCanonical` do not cover the following types: canonical.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.instantiatesCanonical|0.1.0"
}
]
},
{
"id": "CarePlan.basedOn.extension",
"path": "CarePlan.basedOn.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.basedOn.extension:basedOn",
"path": "CarePlan.basedOn.extension",
"sliceName": "basedOn",
"short": "R4B: Fulfills CarePlan additional types",
"definition": "R4B: `CarePlan.basedOn` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.basedOn` is mapped to FHIR STU3 element `CarePlan.basedOn` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.basedOn` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.basedOn` with unmapped reference targets: CarePlan.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.replaces.extension",
"path": "CarePlan.replaces.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.replaces.extension:replaces",
"path": "CarePlan.replaces.extension",
"sliceName": "replaces",
"short": "R4B: replaces additional types",
"definition": "R4B: `CarePlan.replaces` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.replaces` is mapped to FHIR STU3 element `CarePlan.replaces` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.replaces` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.replaces` with unmapped reference targets: CarePlan.\nThe replacement could be because the initial care plan was immediately rejected (due to an issue) or because the previous care plan was completed, but the need for the action described by the care plan remains ongoing.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.partOf.extension",
"path": "CarePlan.partOf.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.partOf.extension:partOf",
"path": "CarePlan.partOf.extension",
"sliceName": "partOf",
"short": "R4B: partOf additional types",
"definition": "R4B: `CarePlan.partOf` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.partOf` is mapped to FHIR STU3 element `CarePlan.partOf` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.partOf` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.partOf` with unmapped reference targets: CarePlan.\nEach care plan is an independent request, such that having a care plan be part of another care plan can cause issues with cascading statuses. As such, this element is still being discussed.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.subject.extension",
"path": "CarePlan.subject.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.subject.extension:subject",
"path": "CarePlan.subject.extension",
"sliceName": "subject",
"short": "R4B: Who the care plan is for additional types",
"definition": "R4B: `CarePlan.subject` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.subject` is mapped to FHIR STU3 element `CarePlan.subject` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.subject` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.subject` with unmapped reference targets: Group, Patient.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.context.extension",
"path": "CarePlan.context.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.context.extension:encounter",
"path": "CarePlan.context.extension",
"sliceName": "encounter",
"short": "R4B: Encounter created as part of additional types",
"definition": "R4B: `CarePlan.encounter` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.encounter` is mapped to FHIR STU3 element `CarePlan.context` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.encounter` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.encounter` with unmapped reference targets: Encounter.\nThis will typically be the encounter the event occurred within, but some activities may be initiated prior to or after the official completion of an encounter but still be tied to the context of the encounter. CarePlan activities conducted as a result of the care plan may well occur as part of other encounters.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.period.extension",
"path": "CarePlan.period.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.period.extension:period",
"path": "CarePlan.period.extension",
"sliceName": "period",
"short": "R4B: period additional types",
"definition": "R4B: `CarePlan.period` additional types (Period) additional types from child elements (end, start)",
"comment": "Element `CarePlan.period` is mapped to FHIR STU3 element `CarePlan.period` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.period` do not cover the following types: Period.\nThe mappings for `CarePlan.period` do not cover the following types based on type expansion: end, start.\nAny 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).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.period|0.1.0"
}
]
},
{
"id": "CarePlan.author.extension",
"path": "CarePlan.author.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.author.extension:author",
"path": "CarePlan.author.extension",
"sliceName": "author",
"short": "R4B: Who is the designated responsible party",
"definition": "R4B: `CarePlan.author`",
"comment": "Element `CarePlan.author` is mapped to FHIR STU3 element `CarePlan.author` as `RelatedTo`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.author` with unmapped reference targets: CareTeam, Device, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nThe author may also be a contributor. For example, an organization can be an author, but not listed as a contributor.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.careTeam.extension",
"path": "CarePlan.careTeam.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.careTeam.extension:careTeam",
"path": "CarePlan.careTeam.extension",
"sliceName": "careTeam",
"short": "R4B: careTeam additional types",
"definition": "R4B: `CarePlan.careTeam` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.careTeam` is mapped to FHIR STU3 element `CarePlan.careTeam` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.careTeam` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.careTeam` with unmapped reference targets: CareTeam.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.addresses.extension",
"path": "CarePlan.addresses.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.addresses.extension:addresses",
"path": "CarePlan.addresses.extension",
"sliceName": "addresses",
"short": "R4B: addresses additional types",
"definition": "R4B: `CarePlan.addresses` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.addresses` is mapped to FHIR STU3 element `CarePlan.addresses` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.addresses` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.addresses` with unmapped reference targets: Condition.\nWhen the diagnosis is related to an allergy or intolerance, the Condition and AllergyIntolerance resources can both be used. However, to be actionable for decision support, using Condition alone is not sufficient as the allergy or intolerance condition needs to be represented as an AllergyIntolerance.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.supportingInfo.extension",
"path": "CarePlan.supportingInfo.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.supportingInfo.extension:supportingInfo",
"path": "CarePlan.supportingInfo.extension",
"sliceName": "supportingInfo",
"short": "R4B: supportingInfo additional types",
"definition": "R4B: `CarePlan.supportingInfo` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.supportingInfo` is mapped to FHIR STU3 element `CarePlan.supportingInfo` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.supportingInfo` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.supportingInfo` with unmapped reference targets: Resource.\nUse \"concern\" to identify specific conditions addressed by the care plan.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.goal.extension",
"path": "CarePlan.goal.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.goal.extension:goal",
"path": "CarePlan.goal.extension",
"sliceName": "goal",
"short": "R4B: goal additional types",
"definition": "R4B: `CarePlan.goal` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.goal` is mapped to FHIR STU3 element `CarePlan.goal` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.goal` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.goal` with unmapped reference targets: Goal.\nGoal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.outcomeReference.extension",
"path": "CarePlan.activity.outcomeReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.outcomeReference.extension:outcomeReference",
"path": "CarePlan.activity.outcomeReference.extension",
"sliceName": "outcomeReference",
"short": "R4B: outcomeReference additional types",
"definition": "R4B: `CarePlan.activity.outcomeReference` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.outcomeReference` is mapped to FHIR STU3 element `CarePlan.activity.outcomeReference` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.outcomeReference` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.outcomeReference` with unmapped reference targets: Resource.\nThe activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lbs and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.progress.extension",
"path": "CarePlan.activity.progress.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.progress.extension:progress",
"path": "CarePlan.activity.progress.extension",
"sliceName": "progress",
"short": "R4B: progress additional types",
"definition": "R4B: `CarePlan.activity.progress` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `CarePlan.activity.progress` is mapped to FHIR STU3 element `CarePlan.activity.progress` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.progress` do not cover the following types: Annotation.\nThe mappings for `CarePlan.activity.progress` do not cover the following types based on type expansion: author[x], text, time.\nThis 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.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.progress|0.1.0"
}
]
},
{
"id": "CarePlan.activity.reference.extension",
"path": "CarePlan.activity.reference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.reference.extension:reference",
"path": "CarePlan.activity.reference.extension",
"sliceName": "reference",
"short": "R4B: reference",
"definition": "R4B: `CarePlan.activity.reference`",
"comment": "Element `CarePlan.activity.reference` is mapped to FHIR STU3 element `CarePlan.activity.reference` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.reference` with unmapped reference targets: Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, RequestGroup, ServiceRequest, Task, VisionPrescription.\nStandard extension exists ([resource-pertainsToGoal](https://hl7.org/fhir/extension-resource-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 independently 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.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.extension",
"path": "CarePlan.activity.detail.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.extension:instantiatesUri",
"path": "CarePlan.activity.detail.extension",
"sliceName": "instantiatesUri",
"short": "R4B: Instantiates external protocol or definition (new)",
"definition": "R4B: `CarePlan.activity.detail.instantiatesUri` (new:uri)",
"comment": "Element `CarePlan.activity.detail.instantiatesUri` has a context of CarePlan.activity.detail based on following the parent source element upwards and mapping to `CarePlan`.\nElement `CarePlan.activity.detail.instantiatesUri` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).\nThis might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesUri|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.extension:scheduled",
"path": "CarePlan.activity.detail.extension",
"sliceName": "scheduled",
"short": "R4B: scheduled additional types",
"definition": "R4B: `CarePlan.activity.detail.scheduled[x]` additional types (Timing, Period)",
"comment": "Element `CarePlan.activity.detail.scheduled[x]` is mapped to FHIR STU3 element `CarePlan.activity.detail.scheduled[x]` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.scheduled[x]` do not cover the following types: Period, Timing.\nThe target context `CarePlan.activity.detail.scheduled[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `CarePlan.activity.detail`.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.scheduled|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.category.extension",
"path": "CarePlan.activity.detail.category.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.category.extension:kind",
"path": "CarePlan.activity.detail.category.extension",
"sliceName": "kind",
"short": "R4B: Appointment | CommunicationRequest | DeviceRequest | MedicationRequest | NutritionOrder | Task | ServiceRequest | VisionPrescription",
"definition": "R4B: `CarePlan.activity.detail.kind`",
"comment": "Element `CarePlan.activity.detail.kind` is mapped to FHIR STU3 element `CarePlan.activity.detail.category` as `SourceIsNarrowerThanTarget`.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.kind|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.definition.extension",
"path": "CarePlan.activity.detail.definition.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.definition.extension:instantiatesCanonical",
"path": "CarePlan.activity.detail.definition.extension",
"sliceName": "instantiatesCanonical",
"short": "R4B: Instantiates FHIR protocol or definition additional types",
"definition": "R4B: `CarePlan.activity.detail.instantiatesCanonical` additional types (canonical(http://hl7.org/fhir/StructureDefinition/PlanDefinition), canonical(http://hl7.org/fhir/StructureDefinition/ActivityDefinition), canonical(http://hl7.org/fhir/StructureDefinition/Questionnaire), canonical(http://hl7.org/fhir/StructureDefinition/Measure), canonical(http://hl7.org/fhir/StructureDefinition/OperationDefinition))",
"comment": "Element `CarePlan.activity.detail.instantiatesCanonical` is mapped to FHIR STU3 element `CarePlan.activity.detail.definition` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.instantiatesCanonical` do not cover the following types: canonical.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.instantiatesCanonical|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.reasonReference.extension",
"path": "CarePlan.activity.detail.reasonReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.reasonReference.extension:reasonReference",
"path": "CarePlan.activity.detail.reasonReference.extension",
"sliceName": "reasonReference",
"short": "R4B: Why activity is needed",
"definition": "R4B: `CarePlan.activity.detail.reasonReference`",
"comment": "Element `CarePlan.activity.detail.reasonReference` is mapped to FHIR STU3 element `CarePlan.activity.detail.reasonReference` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.reasonReference` with unmapped reference targets: Condition, DiagnosticReport, DocumentReference, Observation.\nConditions can be identified at the activity level that are not identified as reasons for the overall plan.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.goal.extension",
"path": "CarePlan.activity.detail.goal.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.goal.extension:goal",
"path": "CarePlan.activity.detail.goal.extension",
"sliceName": "goal",
"short": "R4B: goal additional types",
"definition": "R4B: `CarePlan.activity.detail.goal` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.detail.goal` is mapped to FHIR STU3 element `CarePlan.activity.detail.goal` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.goal` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.goal` with unmapped reference targets: Goal.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.status.extension",
"path": "CarePlan.activity.detail.status.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.status.extension:status",
"path": "CarePlan.activity.detail.status.extension",
"sliceName": "status",
"short": "R4B: not-started | scheduled | in-progress | on-hold | completed | cancelled | stopped | unknown | entered-in-error additional codes",
"definition": "R4B: `CarePlan.activity.detail.status` additional codes",
"comment": "Element `CarePlan.activity.detail.status` is mapped to FHIR STU3 element `CarePlan.activity.detail.status` as `RelatedTo`.\nThe mappings for `CarePlan.activity.detail.status` do not allow expression of the necessary codes, per the bindings on the source and target.\nThe target context `CarePlan.activity.detail.status` is a modifier element, so this extension does not need to be defined as a modifier.\nSome 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. \nThe 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.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.status|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.statusReason.extension",
"path": "CarePlan.activity.detail.statusReason.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.statusReason.extension:statusReason",
"path": "CarePlan.activity.detail.statusReason.extension",
"sliceName": "statusReason",
"short": "R4B: statusReason additional types",
"definition": "R4B: `CarePlan.activity.detail.statusReason` additional types (CodeableConcept) additional types from child elements (coding)",
"comment": "Element `CarePlan.activity.detail.statusReason` is mapped to FHIR STU3 element `CarePlan.activity.detail.statusReason` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.statusReason` do not cover the following types: CodeableConcept.\nThe mappings for `CarePlan.activity.detail.statusReason` do not cover the following types based on type expansion: coding.\nWill 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",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.activity.detail.statusReason|0.1.0"
}
]
},
{
"id": "CarePlan.activity.detail.location.extension",
"path": "CarePlan.activity.detail.location.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.location.extension:location",
"path": "CarePlan.activity.detail.location.extension",
"sliceName": "location",
"short": "R4B: location additional types",
"definition": "R4B: `CarePlan.activity.detail.location` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `CarePlan.activity.detail.location` is mapped to FHIR STU3 element `CarePlan.activity.detail.location` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.activity.detail.location` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.location` with unmapped reference targets: Location.\nMay reference a specific clinical location or may identify a type of location.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.performer.extension",
"path": "CarePlan.activity.detail.performer.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.performer.extension:performer",
"path": "CarePlan.activity.detail.performer.extension",
"sliceName": "performer",
"short": "R4B: performer",
"definition": "R4B: `CarePlan.activity.detail.performer`",
"comment": "Element `CarePlan.activity.detail.performer` is mapped to FHIR STU3 element `CarePlan.activity.detail.performer` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.performer` with unmapped reference targets: CareTeam, Device, HealthcareService, Organization, Patient, Practitioner, PractitionerRole, RelatedPerson.\nA performer MAY also be a participant in the care plan.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.activity.detail.productReference.extension",
"path": "CarePlan.activity.detail.productReference.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.activity.detail.productReference.extension:alternateReference",
"path": "CarePlan.activity.detail.productReference.extension",
"sliceName": "alternateReference",
"short": "R4B: product",
"definition": "R4B: `CarePlan.activity.detail.product[x]`",
"comment": "Element `CarePlan.activity.detail.product[x]` is mapped to FHIR STU3 element `CarePlan.activity.detail.product[x]` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `CarePlan.activity.detail.product[x]` with unmapped reference targets: Medication, Substance.\nSource element `CarePlan.activity.detail.product[x]` has unmapped reference types. While the target element `CarePlan.activity.detail.product[x]` is a choice type and does not allow extensions, the `alternate-reference` extension can be applied to Reference values within it.",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "CarePlan.note.extension",
"path": "CarePlan.note.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "CarePlan.note.extension:note",
"path": "CarePlan.note.extension",
"sliceName": "note",
"short": "R4B: note additional types",
"definition": "R4B: `CarePlan.note` additional types (Annotation) additional types from child elements (author[x], text, time)",
"comment": "Element `CarePlan.note` is mapped to FHIR STU3 element `CarePlan.note` as `SourceIsBroaderThanTarget`.\nThe mappings for `CarePlan.note` do not cover the following types: Annotation.\nThe mappings for `CarePlan.note` do not cover the following types based on type expansion: author[x], text, time.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-CarePlan.note|0.1.0"
}
]
}
]
}
}