Extensions for Using Data Elements from FHIR STU3 in FHIR R5
0.1.0 - STU International flag

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

Resource Profile: Profile_R3_CarePlan_R5 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-CarePlan resource profile.

Guidance on how to interpret the contents of this table can be foundhere

0. CarePlan
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.

ShortHealthcare plan for patient or group
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate NamesCare Team
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. CarePlan.implicitRules
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. CarePlan.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. CarePlan.extension
Definition

An Extension


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

ShortExtensionAdditional content defined by implementations
Comments

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

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on CarePlan.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. CarePlan.extension:definition
    Slice Namedefinition
    Definition

    STU3: CarePlan.definition (new:Reference(PlanDefinition,Questionnaire))

    ShortSTU3: Protocol or definition (new)
    Comments

    Element CarePlan.definition has a context of CarePlan based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.definition has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

    Control0..*
    TypeExtension(STU3: Protocol or definition (new)) (Extension Type: Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R5, PlanDefinition, Cross-version Profile for STU3.Questionnaire for use in FHIR R5, Questionnaire))
    Is Modifierfalse
    Must Supportfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. CarePlan.modifierExtension
    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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. CarePlan.status
    Definition

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

    Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
    Comments

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

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

    Control1..1
    BindingThe codes SHALL be taken from RequestStatushttp://hl7.org/fhir/ValueSet/request-status|5.0.0
    (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)

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

    Typecode
    Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    14. CarePlan.intent
    Definition

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

    Shortproposal | plan | order | option | directive
    Comments

    This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.

    Control1..1
    BindingThe codes SHALL be taken from CarePlanIntenthttp://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0
    (required to http://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0)

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

    Typecode
    Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request"
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supportfalse
    Summarytrue
    Requirements

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

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    16. CarePlan.subject
    Definition

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

    ShortWho the care plan is for
    Control1..1
    TypeReference(Patient, Group)
    Is Modifierfalse
    Must Supportfalse
    Summarytrue
    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. CarePlan.subject.extension
    Definition

    An Extension


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

    ShortExtensionAdditional content defined by implementations
    Comments

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

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    SlicingThis element introduces a set of slices on CarePlan.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 20. CarePlan.subject.extension:subject
      Slice Namesubject
      Definition

      STU3: CarePlan.subject additional types from child elements (display, identifier, reference)

      ShortSTU3: Who care plan is for additional types
      Comments

      Element CarePlan.subject is mapped to FHIR R5 element CarePlan.subject as SourceIsBroaderThanTarget. The mappings for CarePlan.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.subject with unmapped reference targets: Group, Patient.

      Control0..1
      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      22. CarePlan.subject.reference
      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.

      ShortLiteral reference, Relative, internal or absolute URL
      Comments

      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.

      Control0..1
      This element is affected by the following invariants: ref-2, ref-1
      Typestring
      Is Modifierfalse
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

      Guidance on how to interpret the contents of this table can be foundhere

      0. CarePlan
      2. CarePlan.meta
      4. CarePlan.meta.extension
      Control0..*
      SlicingThis element introduces a set of slices on CarePlan.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 6. CarePlan.meta.extension:meta
        Slice Namemeta
        Definition

        STU3: CarePlan.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

        ShortSTU3: meta additional types
        Comments

        Element CarePlan.meta is mapped to FHIR R5 element CarePlan.meta as SourceIsBroaderThanTarget. The mappings for CarePlan.meta do not cover the following types: Meta. The mappings for CarePlan.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

        Control0..1
        TypeExtension(STU3: meta additional types) (Extension Type: Meta)
        8. CarePlan.text
        10. CarePlan.text.extension
        Control0..*
        SlicingThis element introduces a set of slices on CarePlan.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. CarePlan.text.extension:text
          Slice Nametext
          Definition

          STU3: CarePlan.text additional types (Narrative) additional types from child elements (div, status)

          ShortSTU3: text additional types
          Comments

          Element CarePlan.text is mapped to FHIR R5 element CarePlan.text as SourceIsBroaderThanTarget. The mappings for CarePlan.text do not cover the following types: Narrative. The mappings for CarePlan.text do not cover the following types based on type expansion: div, status. 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.

          Control0..1
          TypeExtension(STU3: text additional types) (Complex Extension)
          14. CarePlan.extension
          Control0..*
          SlicingThis element introduces a set of slices on CarePlan.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. CarePlan.extension:definition
            Slice Namedefinition
            Definition

            STU3: CarePlan.definition (new:Reference(PlanDefinition,Questionnaire))

            ShortSTU3: Protocol or definition (new)
            Comments

            Element CarePlan.definition has a context of CarePlan based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.definition has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

            Control0..*
            TypeExtension(STU3: Protocol or definition (new)) (Extension Type: Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R5, PlanDefinition, Cross-version Profile for STU3.Questionnaire for use in FHIR R5, Questionnaire))
            18. CarePlan.identifier
            NoteThis is a business identifier, not a resource identifier (see discussion)
            20. CarePlan.identifier.extension
            Control0..*
            SlicingThis element introduces a set of slices on CarePlan.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 22. CarePlan.identifier.extension:identifier
              Slice Nameidentifier
              Definition

              STU3: CarePlan.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

              ShortSTU3: identifier additional types
              Comments

              Element CarePlan.identifier is mapped to FHIR R5 element CarePlan.identifier as SourceIsBroaderThanTarget. The mappings for CarePlan.identifier do not cover the following types: Identifier. The mappings for CarePlan.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

              Control0..*
              TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
              24. CarePlan.basedOn
              26. CarePlan.basedOn.extension
              Control0..*
              SlicingThis element introduces a set of slices on CarePlan.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 28. CarePlan.basedOn.extension:basedOn
                Slice NamebasedOn
                Definition

                STU3: CarePlan.basedOn additional types from child elements (display, identifier, reference)

                ShortSTU3: Fulfills care plan additional types
                Comments

                Element CarePlan.basedOn is mapped to FHIR R5 element CarePlan.basedOn as SourceIsBroaderThanTarget. The mappings for CarePlan.basedOn do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.basedOn with unmapped reference targets: CarePlan.

                Control0..*
                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                30. CarePlan.replaces
                32. CarePlan.replaces.extension
                Control0..*
                SlicingThis element introduces a set of slices on CarePlan.replaces.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 34. CarePlan.replaces.extension:replaces
                  Slice Namereplaces
                  Definition

                  STU3: CarePlan.replaces additional types from child elements (display, identifier, reference)

                  ShortSTU3: replaces additional types
                  Comments

                  Element CarePlan.replaces is mapped to FHIR R5 element CarePlan.replaces as SourceIsBroaderThanTarget. The mappings for CarePlan.replaces do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.replaces with unmapped reference targets: CarePlan. 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.

                  Control0..*
                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                  36. CarePlan.partOf
                  38. CarePlan.partOf.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on CarePlan.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 40. CarePlan.partOf.extension:partOf
                    Slice NamepartOf
                    Definition

                    STU3: CarePlan.partOf additional types from child elements (display, identifier, reference)

                    ShortSTU3: partOf additional types
                    Comments

                    Element CarePlan.partOf is mapped to FHIR R5 element CarePlan.partOf as SourceIsBroaderThanTarget. The mappings for CarePlan.partOf do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.partOf with unmapped reference targets: CarePlan. 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.

                    Control0..*
                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                    42. CarePlan.subject
                    44. CarePlan.subject.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on CarePlan.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 46. CarePlan.subject.extension:subject
                      Slice Namesubject
                      Definition

                      STU3: CarePlan.subject additional types from child elements (display, identifier, reference)

                      ShortSTU3: Who care plan is for additional types
                      Comments

                      Element CarePlan.subject is mapped to FHIR R5 element CarePlan.subject as SourceIsBroaderThanTarget. The mappings for CarePlan.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.subject with unmapped reference targets: Group, Patient.

                      Control0..1
                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                      48. CarePlan.encounter
                      50. CarePlan.encounter.extension
                      Control0..*
                      SlicingThis element introduces a set of slices on CarePlan.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 52. CarePlan.encounter.extension:context
                        Slice Namecontext
                        Definition

                        STU3: CarePlan.context additional types from child elements (display, identifier, reference)

                        ShortSTU3: Created in context of additional types
                        Comments

                        Element CarePlan.context is mapped to FHIR R5 element CarePlan.encounter as SourceIsBroaderThanTarget. The mappings for CarePlan.context do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.context with unmapped reference targets: Encounter, EpisodeOfCare. Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

                        Control0..1
                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                        54. CarePlan.period
                        56. CarePlan.period.extension
                        Control0..*
                        SlicingThis element introduces a set of slices on CarePlan.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 58. CarePlan.period.extension:period
                          Slice Nameperiod
                          Definition

                          STU3: CarePlan.period additional types (Period) additional types from child elements (end, start)

                          ShortSTU3: period additional types
                          Comments

                          Element CarePlan.period is mapped to FHIR R5 element CarePlan.period as SourceIsBroaderThanTarget. The mappings for CarePlan.period do not cover the following types: Period. The mappings for CarePlan.period do not cover the following types based on type expansion: end, start. 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).

                          Control0..1
                          TypeExtension(STU3: period additional types) (Extension Type: Period)
                          60. CarePlan.custodian
                          62. CarePlan.custodian.extension
                          Control0..*
                          SlicingThis element introduces a set of slices on CarePlan.custodian.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 64. CarePlan.custodian.extension:author
                            Slice Nameauthor
                            Definition

                            STU3: CarePlan.author

                            ShortSTU3: Who is responsible for contents of the plan
                            Comments

                            Element CarePlan.author is mapped to FHIR R5 element CarePlan.custodian as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.author with unmapped reference targets: CareTeam, Organization, Patient, Practitioner, RelatedPerson. Collaborative care plans may have multiple authors.

                            Control0..*
                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                            66. CarePlan.careTeam
                            68. CarePlan.careTeam.extension
                            Control0..*
                            SlicingThis element introduces a set of slices on CarePlan.careTeam.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 70. CarePlan.careTeam.extension:careTeam
                              Slice NamecareTeam
                              Definition

                              STU3: CarePlan.careTeam additional types from child elements (display, identifier, reference)

                              ShortSTU3: careTeam additional types
                              Comments

                              Element CarePlan.careTeam is mapped to FHIR R5 element CarePlan.careTeam as SourceIsBroaderThanTarget. The mappings for CarePlan.careTeam do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.careTeam with unmapped reference targets: CareTeam.

                              Control0..*
                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                              72. CarePlan.addresses
                              74. CarePlan.addresses.extension
                              Control0..*
                              SlicingThis element introduces a set of slices on CarePlan.addresses.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 76. CarePlan.addresses.extension:addresses
                                Slice Nameaddresses
                                Definition

                                STU3: CarePlan.addresses additional types (Reference(http://hl7.org/fhir/StructureDefinition/Condition)) additional types from child elements (display, identifier, reference)

                                ShortSTU3: addresses additional types
                                Comments

                                Element CarePlan.addresses is mapped to FHIR R5 element CarePlan.addresses as RelatedTo. The mappings for CarePlan.addresses do not cover the following types: Reference. The mappings for CarePlan.addresses do not cover the following types based on type expansion: display, identifier, reference.

                                Control0..*
                                TypeExtension(STU3: addresses additional types) (Extension Type: Reference(Cross-version Profile for STU3.Condition for use in FHIR R5, Condition))
                                78. CarePlan.supportingInfo
                                80. CarePlan.supportingInfo.extension
                                Control0..*
                                SlicingThis element introduces a set of slices on CarePlan.supportingInfo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 82. CarePlan.supportingInfo.extension:supportingInfo
                                  Slice NamesupportingInfo
                                  Definition

                                  STU3: CarePlan.supportingInfo additional types from child elements (display, identifier, reference)

                                  ShortSTU3: supportingInfo additional types
                                  Comments

                                  Element CarePlan.supportingInfo is mapped to FHIR R5 element CarePlan.supportingInfo as SourceIsBroaderThanTarget. The mappings for CarePlan.supportingInfo do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.supportingInfo with unmapped reference targets: Resource. Use "concern" to identify specific conditions addressed by the care plan.

                                  Control0..*
                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                  84. CarePlan.goal
                                  86. CarePlan.goal.extension
                                  Control0..*
                                  SlicingThis element introduces a set of slices on CarePlan.goal.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 88. CarePlan.goal.extension:goal
                                    Slice Namegoal
                                    Definition

                                    STU3: CarePlan.goal additional types from child elements (display, identifier, reference)

                                    ShortSTU3: goal additional types
                                    Comments

                                    Element CarePlan.goal is mapped to FHIR R5 element CarePlan.goal as SourceIsBroaderThanTarget. The mappings for CarePlan.goal do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.goal with unmapped reference targets: Goal. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

                                    Control0..*
                                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                    90. CarePlan.activity
                                    92. CarePlan.activity.extension
                                    Control0..*
                                    SlicingThis element introduces a set of slices on CarePlan.activity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                    • value @ url
                                    • 94. CarePlan.activity.extension:outcomeCodeableConcept
                                      Slice NameoutcomeCodeableConcept
                                      Definition

                                      STU3: CarePlan.activity.outcomeCodeableConcept (new:CodeableConcept)

                                      ShortSTU3: Results of the activity (new)
                                      Comments

                                      Element CarePlan.activity.outcomeCodeableConcept has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.outcomeCodeableConcept has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Note that this should not duplicate the activity status (e.g. completed or in progress).

                                      Control0..*
                                      TypeExtension(STU3: Results of the activity (new)) (Extension Type: CodeableConcept)
                                      96. CarePlan.activity.extension:outcomeReference
                                      Slice NameoutcomeReference
                                      Definition

                                      STU3: CarePlan.activity.outcomeReference (new:Reference(Resource))

                                      ShortSTU3: Appointment, Encounter, Procedure, etc. (new)
                                      Comments

                                      Element CarePlan.activity.outcomeReference has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.outcomeReference has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

                                      Control0..*
                                      TypeExtension(STU3: Appointment, Encounter, Procedure, etc. (new)) (Extension Type: Reference(Cross-version Profile for STU3.Resource for use in FHIR R5, Resource))
                                      98. CarePlan.activity.extension:detail
                                      Slice Namedetail
                                      Definition

                                      STU3: CarePlan.activity.detail (new:BackboneElement)

                                      ShortSTU3: In-line definition of activity (new)
                                      Comments

                                      Element CarePlan.activity.detail has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.detail has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

                                      Control0..1
                                      TypeExtension(STU3: In-line definition of activity (new)) (Complex Extension)
                                      100. CarePlan.activity.progress
                                      102. CarePlan.activity.progress.extension
                                      Control0..*
                                      SlicingThis element introduces a set of slices on CarePlan.activity.progress.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 104. CarePlan.activity.progress.extension:progress
                                        Slice Nameprogress
                                        Definition

                                        STU3: CarePlan.activity.progress additional types (Annotation) additional types from child elements (author[x], text, time)

                                        ShortSTU3: progress additional types
                                        Comments

                                        Element CarePlan.activity.progress is mapped to FHIR R5 element CarePlan.activity.progress as SourceIsBroaderThanTarget. The mappings for CarePlan.activity.progress do not cover the following types: Annotation. The mappings for CarePlan.activity.progress do not cover the following types based on type expansion: author[x], text, time. 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.

                                        Control0..*
                                        TypeExtension(STU3: progress additional types) (Extension Type: Annotation)
                                        106. CarePlan.activity.plannedActivityReference
                                        108. CarePlan.activity.plannedActivityReference.extension
                                        Control0..*
                                        SlicingThis element introduces a set of slices on CarePlan.activity.plannedActivityReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 110. CarePlan.activity.plannedActivityReference.extension:reference
                                          Slice Namereference
                                          Definition

                                          STU3: CarePlan.activity.reference

                                          ShortSTU3: Activity details defined in specific resource
                                          Comments

                                          Element CarePlan.activity.reference is mapped to FHIR R5 element CarePlan.activity.plannedActivityReference as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.activity.reference with unmapped reference targets: Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest, RequestGroup, Task, VisionPrescription. Standard extension exists (goal-pertainstogoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
                                          The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

                                          Control0..1
                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                          112. CarePlan.note
                                          114. CarePlan.note.extension
                                          Control0..*
                                          SlicingThis element introduces a set of slices on CarePlan.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                          • value @ url
                                          • 116. CarePlan.note.extension:note
                                            Slice Namenote
                                            Definition

                                            STU3: CarePlan.note additional types (Annotation) additional types from child elements (author[x], text, time)

                                            ShortSTU3: note additional types
                                            Comments

                                            Element CarePlan.note is mapped to FHIR R5 element CarePlan.note as SourceIsBroaderThanTarget. The mappings for CarePlan.note do not cover the following types: Annotation. The mappings for CarePlan.note do not cover the following types based on type expansion: author[x], text, time.

                                            Control0..*
                                            TypeExtension(STU3: note additional types) (Extension Type: Annotation)

                                            Guidance on how to interpret the contents of this table can be foundhere

                                            0. CarePlan
                                            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.

                                            ShortHealthcare plan for patient or group
                                            Control0..*
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summaryfalse
                                            Alternate NamesCare Team
                                            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                                            dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
                                            dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
                                            dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
                                            dom-6: A resource should have narrative for robust management (text.`div`.exists())
                                            2. CarePlan.id
                                            Definition

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

                                            ShortLogical id of this artifact
                                            Comments

                                            Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                                            Control0..1
                                            Typeid
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            4. CarePlan.meta
                                            Definition

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

                                            ShortMetadata about the resource
                                            Control0..1
                                            TypeMeta
                                            Is Modifierfalse
                                            Must Supportfalse
                                            Summarytrue
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            6. CarePlan.meta.id
                                            Definition

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

                                            ShortUnique id for inter-element referencing
                                            Control0..1
                                            This element is affected by the following invariants: ele-1
                                            Typeid
                                            Is Modifierfalse
                                            XML FormatIn the XML format, this property is represented as an attribute.
                                            Summaryfalse
                                            8. CarePlan.meta.extension
                                            Definition

                                            An Extension

                                            ShortExtension
                                            Control0..*
                                            TypeExtension
                                            Is Modifierfalse
                                            Summaryfalse
                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                            SlicingThis element introduces a set of slices on CarePlan.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                            • value @ url
                                            • 10. CarePlan.meta.extension:meta
                                              Slice Namemeta
                                              Definition

                                              STU3: CarePlan.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                                              ShortSTU3: meta additional types
                                              Comments

                                              Element CarePlan.meta is mapped to FHIR R5 element CarePlan.meta as SourceIsBroaderThanTarget. The mappings for CarePlan.meta do not cover the following types: Meta. The mappings for CarePlan.meta do not cover the following types based on type expansion: lastUpdated, profile, security, tag, versionId.

                                              Control0..1
                                              TypeExtension(STU3: meta additional types) (Extension Type: Meta)
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              12. CarePlan.meta.versionId
                                              Definition

                                              The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

                                              ShortVersion specific identifier
                                              Comments

                                              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.

                                              Control0..1
                                              Typeid
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              14. CarePlan.meta.lastUpdated
                                              Definition

                                              When the resource last changed - e.g. when the version changed.

                                              ShortWhen the resource version last changed
                                              Comments

                                              This element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                                              Control0..1
                                              Typeinstant
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              16. CarePlan.meta.source
                                              Definition

                                              A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                                              ShortIdentifies where the resource comes from
                                              Comments

                                              The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

                                              This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                                              Control0..1
                                              Typeuri
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              18. CarePlan.meta.profile
                                              Definition

                                              A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                                              ShortProfiles this resource claims to conform to
                                              Comments

                                              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.

                                              Control0..*
                                              Typecanonical(StructureDefinition)
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              20. CarePlan.meta.security
                                              Definition

                                              Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                                              ShortSecurity Labels applied to this resource
                                              Comments

                                              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.

                                              Control0..*
                                              BindingUnless not suitable, these codes SHALL be taken from AllSecurityLabels .
                                              (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)

                                              Security Labels from the Healthcare Privacy and Security Classification System.

                                              TypeCoding
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              22. CarePlan.meta.tag
                                              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.

                                              ShortTags applied to this resource
                                              Comments

                                              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.

                                              Control0..*
                                              BindingFor example codes, see CommonTags
                                              (example to http://hl7.org/fhir/ValueSet/common-tags|5.0.0)

                                              Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

                                              TypeCoding
                                              Is Modifierfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              24. CarePlan.implicitRules
                                              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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                                              ShortA set of rules under which this content was created
                                              Comments

                                              Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

                                              Control0..1
                                              Typeuri
                                              Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summarytrue
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              26. CarePlan.language
                                              Definition

                                              The base language in which the resource is written.

                                              ShortLanguage of the resource content
                                              Comments

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

                                              Control0..1
                                              BindingThe codes SHALL be taken from AllLanguages
                                              (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                                              IETF language tag for a human language

                                              Typecode
                                              Is Modifierfalse
                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                              Must Supportfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              28. CarePlan.text
                                              Definition

                                              A human-readable narrative that contains a summary of the resource and can 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.

                                              ShortText summary of the resource, for human interpretation
                                              Comments

                                              Contained resources do not have a 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.

                                              Control0..1
                                              This element is affected by the following invariants: dom-6
                                              TypeNarrative
                                              Is Modifierfalse
                                              Must Supportfalse
                                              Summaryfalse
                                              Alternate Namesnarrative, html, xhtml, display
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              30. CarePlan.text.id
                                              Definition

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

                                              ShortUnique id for inter-element referencing
                                              Control0..1
                                              This element is affected by the following invariants: ele-1
                                              Typeid
                                              Is Modifierfalse
                                              XML FormatIn the XML format, this property is represented as an attribute.
                                              Summaryfalse
                                              32. CarePlan.text.extension
                                              Definition

                                              An Extension

                                              ShortExtension
                                              Control0..*
                                              TypeExtension
                                              Is Modifierfalse
                                              Summaryfalse
                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                              SlicingThis element introduces a set of slices on CarePlan.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                              • value @ url
                                              • 34. CarePlan.text.extension:text
                                                Slice Nametext
                                                Definition

                                                STU3: CarePlan.text additional types (Narrative) additional types from child elements (div, status)

                                                ShortSTU3: text additional types
                                                Comments

                                                Element CarePlan.text is mapped to FHIR R5 element CarePlan.text as SourceIsBroaderThanTarget. The mappings for CarePlan.text do not cover the following types: Narrative. The mappings for CarePlan.text do not cover the following types based on type expansion: div, status. 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.

                                                Control0..1
                                                TypeExtension(STU3: text additional types) (Complex Extension)
                                                Is Modifierfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                36. CarePlan.text.status
                                                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.

                                                Shortgenerated | extensions | additional | empty
                                                Control1..1
                                                BindingThe codes SHALL be taken from NarrativeStatus
                                                (required to http://hl7.org/fhir/ValueSet/narrative-status|5.0.0)

                                                The status of a resource narrative.

                                                Typecode
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                38. CarePlan.text.div
                                                Definition

                                                The actual narrative content, a stripped down version of XHTML.

                                                ShortLimited xhtml content
                                                Comments

                                                The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                                                Control1..1
                                                Typexhtml
                                                Is Modifierfalse
                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlChecks())
                                                txt-2: The narrative SHALL have some non-whitespace content (htmlChecks())
                                                40. CarePlan.contained
                                                Definition

                                                These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                                                ShortContained, inline Resources
                                                Comments

                                                This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

                                                Control0..*
                                                This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                                                TypeResource
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Alternate Namesinline resources, anonymous resources, contained resources
                                                42. CarePlan.extension
                                                Definition

                                                An Extension

                                                ShortExtension
                                                Control0..*
                                                TypeExtension
                                                Is Modifierfalse
                                                Must Supportfalse
                                                Summaryfalse
                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                SlicingThis element introduces a set of slices on CarePlan.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                • value @ url
                                                • 44. CarePlan.extension:definition
                                                  Slice Namedefinition
                                                  Definition

                                                  STU3: CarePlan.definition (new:Reference(PlanDefinition,Questionnaire))

                                                  ShortSTU3: Protocol or definition (new)
                                                  Comments

                                                  Element CarePlan.definition has a context of CarePlan based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.definition has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

                                                  Control0..*
                                                  TypeExtension(STU3: Protocol or definition (new)) (Extension Type: Reference(Cross-version Profile for STU3.PlanDefinition for use in FHIR R5, PlanDefinition, Cross-version Profile for STU3.Questionnaire for use in FHIR R5, Questionnaire))
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  46. CarePlan.modifierExtension
                                                  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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, 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.

                                                  Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                  ShortExtensions that cannot be ignored
                                                  Comments

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

                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                                                  Must Supportfalse
                                                  Summarytrue
                                                  Requirements

                                                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                  Alternate Namesextensions, user content
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  48. CarePlan.identifier
                                                  Definition

                                                  Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.

                                                  ShortExternal Ids for this plan
                                                  Comments

                                                  This is a business identifier, not a resource identifier (see discussion). 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.

                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                  Control0..*
                                                  TypeIdentifier
                                                  Is Modifierfalse
                                                  Must Supportfalse
                                                  Summarytrue
                                                  Requirements

                                                  Allows identification of the care plan as it is known by various participating systems and in a way that remains consistent across servers.

                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  50. CarePlan.identifier.id
                                                  Definition

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

                                                  ShortUnique id for inter-element referencing
                                                  Control0..1
                                                  This element is affected by the following invariants: ele-1
                                                  Typeid
                                                  Is Modifierfalse
                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                  Summaryfalse
                                                  52. CarePlan.identifier.extension
                                                  Definition

                                                  An Extension

                                                  ShortExtension
                                                  Control0..*
                                                  TypeExtension
                                                  Is Modifierfalse
                                                  Summaryfalse
                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                  SlicingThis element introduces a set of slices on CarePlan.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                  • value @ url
                                                  • 54. CarePlan.identifier.extension:identifier
                                                    Slice Nameidentifier
                                                    Definition

                                                    STU3: CarePlan.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                                                    ShortSTU3: identifier additional types
                                                    Comments

                                                    Element CarePlan.identifier is mapped to FHIR R5 element CarePlan.identifier as SourceIsBroaderThanTarget. The mappings for CarePlan.identifier do not cover the following types: Identifier. The mappings for CarePlan.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                                                    Control0..*
                                                    TypeExtension(STU3: identifier additional types) (Extension Type: Identifier)
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    56. CarePlan.identifier.use
                                                    Definition

                                                    The purpose of this identifier.

                                                    Shortusual | official | temp | secondary | old (If known)
                                                    Comments

                                                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                                                    Control0..1
                                                    BindingThe codes SHALL be taken from IdentifierUse
                                                    (required to http://hl7.org/fhir/ValueSet/identifier-use|5.0.0)

                                                    Identifies the purpose for this identifier, if known .

                                                    Typecode
                                                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    Requirements

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

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    58. CarePlan.identifier.type
                                                    Definition

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

                                                    ShortDescription of identifier
                                                    Comments

                                                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                                                    Control0..1
                                                    BindingUnless not suitable, these codes SHALL be taken from IdentifierTypeCodes
                                                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

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

                                                    TypeCodeableConcept
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Requirements

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

                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    60. CarePlan.identifier.system
                                                    Definition

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

                                                    ShortThe namespace for the identifier value
                                                    Comments

                                                    Identifier.system is always case sensitive.

                                                    Control0..1
                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    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.

                                                    ExampleGeneral: http://www.acme.com/identifiers/patient
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    62. CarePlan.identifier.value
                                                    Definition

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

                                                    ShortThe value that is unique
                                                    Comments

                                                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the http://hl7.org/fhir/StructureDefinition/rendered-value). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                                                    Control0..1
                                                    This element is affected by the following invariants: ident-1
                                                    Typestring
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Summarytrue
                                                    ExampleGeneral: 123456
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    64. CarePlan.identifier.period
                                                    Definition

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

                                                    ShortTime period when id is/was valid for use
                                                    Control0..1
                                                    TypePeriod
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    66. CarePlan.identifier.assigner
                                                    Definition

                                                    Organization that issued/manages the identifier.

                                                    ShortOrganization that issued id (may be just text)
                                                    Comments

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

                                                    Control0..1
                                                    TypeReference(Organization)
                                                    Is Modifierfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    68. CarePlan.instantiatesCanonical
                                                    Definition

                                                    The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

                                                    ShortInstantiates FHIR protocol or definition
                                                    Control0..*
                                                    Typecanonical(PlanDefinition, Questionnaire, Measure, ActivityDefinition, OperationDefinition)
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    70. CarePlan.instantiatesUri
                                                    Definition

                                                    The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.

                                                    ShortInstantiates external protocol or definition
                                                    Comments

                                                    This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

                                                    Control0..*
                                                    Typeuri
                                                    Is Modifierfalse
                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    72. CarePlan.basedOn
                                                    Definition

                                                    A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.

                                                    ShortFulfills plan, proposal or order
                                                    Control0..*
                                                    TypeReference(CarePlan, ServiceRequest, RequestOrchestration, NutritionOrder)
                                                    Is Modifierfalse
                                                    Must Supportfalse
                                                    Summarytrue
                                                    Requirements

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

                                                    Alternate Namesfulfills
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    74. CarePlan.basedOn.id
                                                    Definition

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

                                                    ShortUnique id for inter-element referencing
                                                    Control0..1
                                                    This element is affected by the following invariants: ele-1
                                                    Typeid
                                                    Is Modifierfalse
                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                    Summaryfalse
                                                    76. CarePlan.basedOn.extension
                                                    Definition

                                                    An Extension

                                                    ShortExtension
                                                    Control0..*
                                                    TypeExtension
                                                    Is Modifierfalse
                                                    Summaryfalse
                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                    SlicingThis element introduces a set of slices on CarePlan.basedOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                    • value @ url
                                                    • 78. CarePlan.basedOn.extension:basedOn
                                                      Slice NamebasedOn
                                                      Definition

                                                      STU3: CarePlan.basedOn additional types from child elements (display, identifier, reference)

                                                      ShortSTU3: Fulfills care plan additional types
                                                      Comments

                                                      Element CarePlan.basedOn is mapped to FHIR R5 element CarePlan.basedOn as SourceIsBroaderThanTarget. The mappings for CarePlan.basedOn do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.basedOn with unmapped reference targets: CarePlan.

                                                      Control0..1
                                                      TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      80. CarePlan.basedOn.reference
                                                      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.

                                                      ShortLiteral reference, Relative, internal or absolute URL
                                                      Comments

                                                      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.

                                                      Control0..1
                                                      This element is affected by the following invariants: ref-2, ref-1
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      82. CarePlan.basedOn.type
                                                      Definition

                                                      The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                      The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                      ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                      Comments

                                                      This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                      Control0..1
                                                      BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                      (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                      Aa resource (or, for logical models, the URI of the logical model).

                                                      Typeuri
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      84. CarePlan.basedOn.identifier
                                                      Definition

                                                      An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                      ShortLogical reference, when literal reference is not known
                                                      Comments

                                                      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.

                                                      When 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

                                                      Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                      Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                      This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                      NoteThis is a business identifier, not a resource identifier (see discussion)
                                                      Control0..1
                                                      This element is affected by the following invariants: ref-2
                                                      TypeIdentifier
                                                      Is Modifierfalse
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      86. CarePlan.basedOn.display
                                                      Definition

                                                      Plain text narrative that identifies the resource in addition to the resource reference.

                                                      ShortText alternative for the resource
                                                      Comments

                                                      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.

                                                      Control0..1
                                                      This element is affected by the following invariants: ref-2
                                                      Typestring
                                                      Is Modifierfalse
                                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                      Summarytrue
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      88. CarePlan.replaces
                                                      Definition

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

                                                      ShortCarePlan replaced by this CarePlan
                                                      Comments

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

                                                      Control0..*
                                                      TypeReference(CarePlan)
                                                      Is Modifierfalse
                                                      Must Supportfalse
                                                      Summarytrue
                                                      Requirements

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

                                                      Alternate Namessupersedes
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      90. CarePlan.replaces.id
                                                      Definition

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

                                                      ShortUnique id for inter-element referencing
                                                      Control0..1
                                                      This element is affected by the following invariants: ele-1
                                                      Typeid
                                                      Is Modifierfalse
                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                      Summaryfalse
                                                      92. CarePlan.replaces.extension
                                                      Definition

                                                      An Extension

                                                      ShortExtension
                                                      Control0..*
                                                      TypeExtension
                                                      Is Modifierfalse
                                                      Summaryfalse
                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                      SlicingThis element introduces a set of slices on CarePlan.replaces.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                      • value @ url
                                                      • 94. CarePlan.replaces.extension:replaces
                                                        Slice Namereplaces
                                                        Definition

                                                        STU3: CarePlan.replaces additional types from child elements (display, identifier, reference)

                                                        ShortSTU3: replaces additional types
                                                        Comments

                                                        Element CarePlan.replaces is mapped to FHIR R5 element CarePlan.replaces as SourceIsBroaderThanTarget. The mappings for CarePlan.replaces do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.replaces with unmapped reference targets: CarePlan. 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.

                                                        Control0..1
                                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        96. CarePlan.replaces.reference
                                                        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.

                                                        ShortLiteral reference, Relative, internal or absolute URL
                                                        Comments

                                                        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.

                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2, ref-1
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        98. CarePlan.replaces.type
                                                        Definition

                                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                        ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                        Comments

                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                        Control0..1
                                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                        Aa resource (or, for logical models, the URI of the logical model).

                                                        Typeuri
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        100. CarePlan.replaces.identifier
                                                        Definition

                                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                        ShortLogical reference, when literal reference is not known
                                                        Comments

                                                        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.

                                                        When 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

                                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                        This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2
                                                        TypeIdentifier
                                                        Is Modifierfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        102. CarePlan.replaces.display
                                                        Definition

                                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                                        ShortText alternative for the resource
                                                        Comments

                                                        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.

                                                        Control0..1
                                                        This element is affected by the following invariants: ref-2
                                                        Typestring
                                                        Is Modifierfalse
                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        104. CarePlan.partOf
                                                        Definition

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

                                                        ShortPart of referenced CarePlan
                                                        Comments

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

                                                        Control0..*
                                                        TypeReference(CarePlan)
                                                        Is Modifierfalse
                                                        Must Supportfalse
                                                        Summarytrue
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        106. CarePlan.partOf.id
                                                        Definition

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

                                                        ShortUnique id for inter-element referencing
                                                        Control0..1
                                                        This element is affected by the following invariants: ele-1
                                                        Typeid
                                                        Is Modifierfalse
                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                        Summaryfalse
                                                        108. CarePlan.partOf.extension
                                                        Definition

                                                        An Extension

                                                        ShortExtension
                                                        Control0..*
                                                        TypeExtension
                                                        Is Modifierfalse
                                                        Summaryfalse
                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                        SlicingThis element introduces a set of slices on CarePlan.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                        • value @ url
                                                        • 110. CarePlan.partOf.extension:partOf
                                                          Slice NamepartOf
                                                          Definition

                                                          STU3: CarePlan.partOf additional types from child elements (display, identifier, reference)

                                                          ShortSTU3: partOf additional types
                                                          Comments

                                                          Element CarePlan.partOf is mapped to FHIR R5 element CarePlan.partOf as SourceIsBroaderThanTarget. The mappings for CarePlan.partOf do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.partOf with unmapped reference targets: CarePlan. 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.

                                                          Control0..1
                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          112. CarePlan.partOf.reference
                                                          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.

                                                          ShortLiteral reference, Relative, internal or absolute URL
                                                          Comments

                                                          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.

                                                          Control0..1
                                                          This element is affected by the following invariants: ref-2, ref-1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          114. CarePlan.partOf.type
                                                          Definition

                                                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                          ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                          Comments

                                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                          Control0..1
                                                          BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                          Aa resource (or, for logical models, the URI of the logical model).

                                                          Typeuri
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          116. CarePlan.partOf.identifier
                                                          Definition

                                                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                          ShortLogical reference, when literal reference is not known
                                                          Comments

                                                          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.

                                                          When 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

                                                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                          This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                          Control0..1
                                                          This element is affected by the following invariants: ref-2
                                                          TypeIdentifier
                                                          Is Modifierfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          118. CarePlan.partOf.display
                                                          Definition

                                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                                          ShortText alternative for the resource
                                                          Comments

                                                          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.

                                                          Control0..1
                                                          This element is affected by the following invariants: ref-2
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          120. CarePlan.status
                                                          Definition

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

                                                          Shortdraft | active | on-hold | revoked | completed | entered-in-error | unknown
                                                          Comments

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

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

                                                          Control1..1
                                                          BindingThe codes SHALL be taken from RequestStatus
                                                          (required to http://hl7.org/fhir/ValueSet/request-status|5.0.0)

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

                                                          Typecode
                                                          Is Modifiertrue because This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

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

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          122. CarePlan.intent
                                                          Definition

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

                                                          Shortproposal | plan | order | option | directive
                                                          Comments

                                                          This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. This element is expected to be immutable. E.g. A "proposal" instance should never change to be a "plan" instance or "order" instance. Instead, a new instance 'basedOn' the prior instance should be created with the new 'intent' value.

                                                          Control1..1
                                                          BindingThe codes SHALL be taken from CarePlanIntent
                                                          (required to http://hl7.org/fhir/ValueSet/care-plan-intent|5.0.0)

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

                                                          Typecode
                                                          Is Modifiertrue because This element changes the interpretation of all descriptive attributes. For example "the time the request is recommended to occur" vs. "the time the request is authorized to occur" or "who is recommended to perform the request" vs. "who is authorized to perform the request"
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

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

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          124. CarePlan.category
                                                          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.

                                                          ShortType of plan
                                                          Comments

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

                                                          Control0..*
                                                          BindingFor example codes, see CarePlanCategory
                                                          (example to http://hl7.org/fhir/ValueSet/care-plan-category|5.0.0)

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

                                                          TypeCodeableConcept
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

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

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          126. CarePlan.title
                                                          Definition

                                                          Human-friendly name for the care plan.

                                                          ShortHuman-friendly name for the care plan
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          128. CarePlan.description
                                                          Definition

                                                          A description of the scope and nature of the plan.

                                                          ShortSummary of nature of plan
                                                          Control0..1
                                                          Typestring
                                                          Is Modifierfalse
                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Requirements

                                                          Provides more detail than conveyed by category.

                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          130. CarePlan.subject
                                                          Definition

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

                                                          ShortWho the care plan is for
                                                          Control1..1
                                                          TypeReference(Patient, Group)
                                                          Is Modifierfalse
                                                          Must Supportfalse
                                                          Summarytrue
                                                          Alternate Namespatient
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          132. CarePlan.subject.id
                                                          Definition

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

                                                          ShortUnique id for inter-element referencing
                                                          Control0..1
                                                          This element is affected by the following invariants: ele-1
                                                          Typeid
                                                          Is Modifierfalse
                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                          Summaryfalse
                                                          134. CarePlan.subject.extension
                                                          Definition

                                                          An Extension

                                                          ShortExtension
                                                          Control0..*
                                                          TypeExtension
                                                          Is Modifierfalse
                                                          Summaryfalse
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                          SlicingThis element introduces a set of slices on CarePlan.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                          • value @ url
                                                          • 136. CarePlan.subject.extension:subject
                                                            Slice Namesubject
                                                            Definition

                                                            STU3: CarePlan.subject additional types from child elements (display, identifier, reference)

                                                            ShortSTU3: Who care plan is for additional types
                                                            Comments

                                                            Element CarePlan.subject is mapped to FHIR R5 element CarePlan.subject as SourceIsBroaderThanTarget. The mappings for CarePlan.subject do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.subject with unmapped reference targets: Group, Patient.

                                                            Control0..1
                                                            TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            138. CarePlan.subject.reference
                                                            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.

                                                            ShortLiteral reference, Relative, internal or absolute URL
                                                            Comments

                                                            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.

                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2, ref-1
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            140. CarePlan.subject.type
                                                            Definition

                                                            The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                            The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                            ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                            Comments

                                                            This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                            Control0..1
                                                            BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                            (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                            Aa resource (or, for logical models, the URI of the logical model).

                                                            Typeuri
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            142. CarePlan.subject.identifier
                                                            Definition

                                                            An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                            ShortLogical reference, when literal reference is not known
                                                            Comments

                                                            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.

                                                            When 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

                                                            Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                            Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                            This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                            NoteThis is a business identifier, not a resource identifier (see discussion)
                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            TypeIdentifier
                                                            Is Modifierfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            144. CarePlan.subject.display
                                                            Definition

                                                            Plain text narrative that identifies the resource in addition to the resource reference.

                                                            ShortText alternative for the resource
                                                            Comments

                                                            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.

                                                            Control0..1
                                                            This element is affected by the following invariants: ref-2
                                                            Typestring
                                                            Is Modifierfalse
                                                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            146. CarePlan.encounter
                                                            Definition

                                                            The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.

                                                            ShortThe Encounter during which this CarePlan was created
                                                            Comments

                                                            This 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.

                                                            Control0..1
                                                            TypeReference(Encounter)
                                                            Is Modifierfalse
                                                            Must Supportfalse
                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            148. CarePlan.encounter.id
                                                            Definition

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

                                                            ShortUnique id for inter-element referencing
                                                            Control0..1
                                                            This element is affected by the following invariants: ele-1
                                                            Typeid
                                                            Is Modifierfalse
                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                            Summaryfalse
                                                            150. CarePlan.encounter.extension
                                                            Definition

                                                            An Extension

                                                            ShortExtension
                                                            Control0..*
                                                            TypeExtension
                                                            Is Modifierfalse
                                                            Summaryfalse
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                            SlicingThis element introduces a set of slices on CarePlan.encounter.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                            • value @ url
                                                            • 152. CarePlan.encounter.extension:context
                                                              Slice Namecontext
                                                              Definition

                                                              STU3: CarePlan.context additional types from child elements (display, identifier, reference)

                                                              ShortSTU3: Created in context of additional types
                                                              Comments

                                                              Element CarePlan.context is mapped to FHIR R5 element CarePlan.encounter as SourceIsBroaderThanTarget. The mappings for CarePlan.context do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.context with unmapped reference targets: Encounter, EpisodeOfCare. Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

                                                              Control0..1
                                                              TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              154. CarePlan.encounter.reference
                                                              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.

                                                              ShortLiteral reference, Relative, internal or absolute URL
                                                              Comments

                                                              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.

                                                              Control0..1
                                                              This element is affected by the following invariants: ref-2, ref-1
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              156. CarePlan.encounter.type
                                                              Definition

                                                              The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                              The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                              ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                              Comments

                                                              This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                              Control0..1
                                                              BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                              (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                              Aa resource (or, for logical models, the URI of the logical model).

                                                              Typeuri
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              158. CarePlan.encounter.identifier
                                                              Definition

                                                              An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                              ShortLogical reference, when literal reference is not known
                                                              Comments

                                                              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.

                                                              When 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

                                                              Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                              Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                              This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                              NoteThis is a business identifier, not a resource identifier (see discussion)
                                                              Control0..1
                                                              This element is affected by the following invariants: ref-2
                                                              TypeIdentifier
                                                              Is Modifierfalse
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              160. CarePlan.encounter.display
                                                              Definition

                                                              Plain text narrative that identifies the resource in addition to the resource reference.

                                                              ShortText alternative for the resource
                                                              Comments

                                                              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.

                                                              Control0..1
                                                              This element is affected by the following invariants: ref-2
                                                              Typestring
                                                              Is Modifierfalse
                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                              Summarytrue
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              162. CarePlan.period
                                                              Definition

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

                                                              ShortTime period plan covers
                                                              Comments

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

                                                              Control0..1
                                                              TypePeriod
                                                              Is Modifierfalse
                                                              Must Supportfalse
                                                              Summarytrue
                                                              Requirements

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

                                                              Alternate Namestiming
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              164. CarePlan.period.id
                                                              Definition

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

                                                              ShortUnique id for inter-element referencing
                                                              Control0..1
                                                              This element is affected by the following invariants: ele-1
                                                              Typeid
                                                              Is Modifierfalse
                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                              Summaryfalse
                                                              166. CarePlan.period.extension
                                                              Definition

                                                              An Extension

                                                              ShortExtension
                                                              Control0..*
                                                              TypeExtension
                                                              Is Modifierfalse
                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                              SlicingThis element introduces a set of slices on CarePlan.period.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                              • value @ url
                                                              • 168. CarePlan.period.extension:period
                                                                Slice Nameperiod
                                                                Definition

                                                                STU3: CarePlan.period additional types (Period) additional types from child elements (end, start)

                                                                ShortSTU3: period additional types
                                                                Comments

                                                                Element CarePlan.period is mapped to FHIR R5 element CarePlan.period as SourceIsBroaderThanTarget. The mappings for CarePlan.period do not cover the following types: Period. The mappings for CarePlan.period do not cover the following types based on type expansion: end, start. 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).

                                                                Control0..1
                                                                TypeExtension(STU3: period additional types) (Extension Type: Period)
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                170. CarePlan.period.start
                                                                Definition

                                                                The start of the period. The boundary is inclusive.

                                                                ShortStarting time with inclusive boundary
                                                                Comments

                                                                If the low element is missing, the meaning is that the low boundary is not known.

                                                                Control0..1
                                                                This element is affected by the following invariants: per-1
                                                                TypedateTime
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                172. CarePlan.period.end
                                                                Definition

                                                                The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. 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.

                                                                ShortEnd time with inclusive boundary, if not ongoing
                                                                Comments

                                                                The end value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03.

                                                                Control0..1
                                                                This element is affected by the following invariants: per-1
                                                                TypedateTime
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Summarytrue
                                                                Meaning if MissingIf the end of the period is missing, it means that the period is ongoing
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                174. CarePlan.created
                                                                Definition

                                                                Represents when this particular CarePlan record was created in the system, which is often a system-generated date.

                                                                ShortDate record was first recorded
                                                                Control0..1
                                                                TypedateTime
                                                                Is Modifierfalse
                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Alternate NamesauthoredOn
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                176. CarePlan.custodian
                                                                Definition

                                                                When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.

                                                                ShortWho is the designated responsible party
                                                                Comments

                                                                The custodian might or might not be a contributor.

                                                                Control0..1
                                                                TypeReference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
                                                                Is Modifierfalse
                                                                Must Supportfalse
                                                                Summarytrue
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                178. CarePlan.custodian.id
                                                                Definition

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

                                                                ShortUnique id for inter-element referencing
                                                                Control0..1
                                                                This element is affected by the following invariants: ele-1
                                                                Typeid
                                                                Is Modifierfalse
                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                Summaryfalse
                                                                180. CarePlan.custodian.extension
                                                                Definition

                                                                An Extension

                                                                ShortExtension
                                                                Control0..*
                                                                TypeExtension
                                                                Is Modifierfalse
                                                                Summaryfalse
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                SlicingThis element introduces a set of slices on CarePlan.custodian.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                • value @ url
                                                                • 182. CarePlan.custodian.extension:author
                                                                  Slice Nameauthor
                                                                  Definition

                                                                  STU3: CarePlan.author

                                                                  ShortSTU3: Who is responsible for contents of the plan
                                                                  Comments

                                                                  Element CarePlan.author is mapped to FHIR R5 element CarePlan.custodian as SourceIsBroaderThanTarget. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.author with unmapped reference targets: CareTeam, Organization, Patient, Practitioner, RelatedPerson. Collaborative care plans may have multiple authors.

                                                                  Control0..1
                                                                  TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  184. CarePlan.custodian.reference
                                                                  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.

                                                                  ShortLiteral reference, Relative, internal or absolute URL
                                                                  Comments

                                                                  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.

                                                                  Control0..1
                                                                  This element is affected by the following invariants: ref-2, ref-1
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  186. CarePlan.custodian.type
                                                                  Definition

                                                                  The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                  The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                  ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                  Comments

                                                                  This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                                  Control0..1
                                                                  BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                  (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                                  Aa resource (or, for logical models, the URI of the logical model).

                                                                  Typeuri
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  188. CarePlan.custodian.identifier
                                                                  Definition

                                                                  An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                  ShortLogical reference, when literal reference is not known
                                                                  Comments

                                                                  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.

                                                                  When 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

                                                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                  Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                  This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ref-2
                                                                  TypeIdentifier
                                                                  Is Modifierfalse
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  190. CarePlan.custodian.display
                                                                  Definition

                                                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                                                  ShortText alternative for the resource
                                                                  Comments

                                                                  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.

                                                                  Control0..1
                                                                  This element is affected by the following invariants: ref-2
                                                                  Typestring
                                                                  Is Modifierfalse
                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                  Summarytrue
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  192. CarePlan.contributor
                                                                  Definition

                                                                  Identifies the individual(s), organization or device who provided the contents of the care plan.

                                                                  ShortWho provided the content of the care plan
                                                                  Comments

                                                                  Collaborative care plans may have multiple contributors.

                                                                  Control0..*
                                                                  TypeReference(Patient, Practitioner, PractitionerRole, Device, RelatedPerson, Organization, CareTeam)
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  194. CarePlan.careTeam
                                                                  Definition

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

                                                                  ShortWho's involved in plan?
                                                                  Control0..*
                                                                  TypeReference(CareTeam)
                                                                  Is Modifierfalse
                                                                  Must Supportfalse
                                                                  Summaryfalse
                                                                  Requirements

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

                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  196. CarePlan.careTeam.id
                                                                  Definition

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

                                                                  ShortUnique id for inter-element referencing
                                                                  Control0..1
                                                                  This element is affected by the following invariants: ele-1
                                                                  Typeid
                                                                  Is Modifierfalse
                                                                  XML FormatIn the XML format, this property is represented as an attribute.
                                                                  Summaryfalse
                                                                  198. CarePlan.careTeam.extension
                                                                  Definition

                                                                  An Extension

                                                                  ShortExtension
                                                                  Control0..*
                                                                  TypeExtension
                                                                  Is Modifierfalse
                                                                  Summaryfalse
                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                  SlicingThis element introduces a set of slices on CarePlan.careTeam.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                  • value @ url
                                                                  • 200. CarePlan.careTeam.extension:careTeam
                                                                    Slice NamecareTeam
                                                                    Definition

                                                                    STU3: CarePlan.careTeam additional types from child elements (display, identifier, reference)

                                                                    ShortSTU3: careTeam additional types
                                                                    Comments

                                                                    Element CarePlan.careTeam is mapped to FHIR R5 element CarePlan.careTeam as SourceIsBroaderThanTarget. The mappings for CarePlan.careTeam do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.careTeam with unmapped reference targets: CareTeam.

                                                                    Control0..1
                                                                    TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    202. CarePlan.careTeam.reference
                                                                    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.

                                                                    ShortLiteral reference, Relative, internal or absolute URL
                                                                    Comments

                                                                    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.

                                                                    Control0..1
                                                                    This element is affected by the following invariants: ref-2, ref-1
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    204. CarePlan.careTeam.type
                                                                    Definition

                                                                    The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                    The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                    ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                    Comments

                                                                    This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                                    Control0..1
                                                                    BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                    (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                                    Aa resource (or, for logical models, the URI of the logical model).

                                                                    Typeuri
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    206. CarePlan.careTeam.identifier
                                                                    Definition

                                                                    An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                    ShortLogical reference, when literal reference is not known
                                                                    Comments

                                                                    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.

                                                                    When 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

                                                                    Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                    Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                    This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                                    NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ref-2
                                                                    TypeIdentifier
                                                                    Is Modifierfalse
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    208. CarePlan.careTeam.display
                                                                    Definition

                                                                    Plain text narrative that identifies the resource in addition to the resource reference.

                                                                    ShortText alternative for the resource
                                                                    Comments

                                                                    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.

                                                                    Control0..1
                                                                    This element is affected by the following invariants: ref-2
                                                                    Typestring
                                                                    Is Modifierfalse
                                                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                    Summarytrue
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    210. CarePlan.addresses
                                                                    Definition

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

                                                                    ShortHealth issues this plan addresses
                                                                    Comments

                                                                    Use CarePlan.addresses.concept when a code sufficiently describes the concern (e.g. condition, problem, diagnosis, risk). Use CarePlan.addresses.reference when referencing a resource, which allows more information to be conveyed, such as onset date. CarePlan.addresses.concept and CarePlan.addresses.reference are not meant to be duplicative. For a single concern, either CarePlan.addresses.concept or CarePlan.addresses.reference can be used. CarePlan.addresses.concept may be a summary code, or CarePlan.addresses.reference may be used to reference a very precise definition of the concern using Condition. Both CarePlan.addresses.concept and CarePlan.addresses.reference can be used if they are describing different concerns for the care plan.

                                                                    Control0..*
                                                                    BindingFor example codes, see SNOMEDCTClinicalFindings
                                                                    (example to http://hl7.org/fhir/ValueSet/clinical-findings|5.0.0)

                                                                    Codes that describe the health issues this plan addresses.

                                                                    TypeCodeableReference(Condition)
                                                                    Is Modifierfalse
                                                                    Must Supportfalse
                                                                    Summarytrue
                                                                    Requirements

                                                                    The element can identify risks addressed by the plan as well as concerns. Also scopes plans - multiple plans may exist addressing different concerns.

                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    212. CarePlan.addresses.id
                                                                    Definition

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

                                                                    ShortUnique id for inter-element referencing
                                                                    Control0..1
                                                                    This element is affected by the following invariants: ele-1
                                                                    Typeid
                                                                    Is Modifierfalse
                                                                    XML FormatIn the XML format, this property is represented as an attribute.
                                                                    Summaryfalse
                                                                    214. CarePlan.addresses.extension
                                                                    Definition

                                                                    An Extension

                                                                    ShortExtension
                                                                    Control0..*
                                                                    TypeExtension
                                                                    Is Modifierfalse
                                                                    Summaryfalse
                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                    SlicingThis element introduces a set of slices on CarePlan.addresses.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                    • value @ url
                                                                    • 216. CarePlan.addresses.extension:addresses
                                                                      Slice Nameaddresses
                                                                      Definition

                                                                      STU3: CarePlan.addresses additional types (Reference(http://hl7.org/fhir/StructureDefinition/Condition)) additional types from child elements (display, identifier, reference)

                                                                      ShortSTU3: addresses additional types
                                                                      Comments

                                                                      Element CarePlan.addresses is mapped to FHIR R5 element CarePlan.addresses as RelatedTo. The mappings for CarePlan.addresses do not cover the following types: Reference. The mappings for CarePlan.addresses do not cover the following types based on type expansion: display, identifier, reference.

                                                                      Control0..*
                                                                      TypeExtension(STU3: addresses additional types) (Extension Type: Reference(Cross-version Profile for STU3.Condition for use in FHIR R5, Condition))
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      218. CarePlan.addresses.concept
                                                                      Definition

                                                                      A reference to a concept - e.g. the information is identified by its general class to the degree of precision found in the terminology.

                                                                      ShortReference to a concept (by class)
                                                                      Control0..1
                                                                      TypeCodeableConcept
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      220. CarePlan.addresses.reference
                                                                      Definition

                                                                      A reference to a resource the provides exact details about the information being referenced.

                                                                      ShortReference to a resource (by instance)
                                                                      Control0..1
                                                                      TypeReference
                                                                      Is Modifierfalse
                                                                      Summarytrue
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      222. CarePlan.supportingInfo
                                                                      Definition

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

                                                                      ShortInformation considered as part of plan
                                                                      Comments

                                                                      Use "concern" to identify specific conditions addressed by the care plan. supportingInfo can be used to convey one or more Advance Directives or Medical Treatment Consent Directives by referencing Consent or any other request resource with intent = directive.

                                                                      Control0..*
                                                                      TypeReference(Resource)
                                                                      Is Modifierfalse
                                                                      Must Supportfalse
                                                                      Summaryfalse
                                                                      Requirements

                                                                      Identifies barriers and other considerations associated with the care plan.

                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      224. CarePlan.supportingInfo.id
                                                                      Definition

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

                                                                      ShortUnique id for inter-element referencing
                                                                      Control0..1
                                                                      This element is affected by the following invariants: ele-1
                                                                      Typeid
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      226. CarePlan.supportingInfo.extension
                                                                      Definition

                                                                      An Extension

                                                                      ShortExtension
                                                                      Control0..*
                                                                      TypeExtension
                                                                      Is Modifierfalse
                                                                      Summaryfalse
                                                                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                      SlicingThis element introduces a set of slices on CarePlan.supportingInfo.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 228. CarePlan.supportingInfo.extension:supportingInfo
                                                                        Slice NamesupportingInfo
                                                                        Definition

                                                                        STU3: CarePlan.supportingInfo additional types from child elements (display, identifier, reference)

                                                                        ShortSTU3: supportingInfo additional types
                                                                        Comments

                                                                        Element CarePlan.supportingInfo is mapped to FHIR R5 element CarePlan.supportingInfo as SourceIsBroaderThanTarget. The mappings for CarePlan.supportingInfo do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.supportingInfo with unmapped reference targets: Resource. Use "concern" to identify specific conditions addressed by the care plan.

                                                                        Control0..1
                                                                        TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        230. CarePlan.supportingInfo.reference
                                                                        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.

                                                                        ShortLiteral reference, Relative, internal or absolute URL
                                                                        Comments

                                                                        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.

                                                                        Control0..1
                                                                        This element is affected by the following invariants: ref-2, ref-1
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        232. CarePlan.supportingInfo.type
                                                                        Definition

                                                                        The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                        The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                        ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                        Comments

                                                                        This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                                        Control0..1
                                                                        BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                        (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                                        Aa resource (or, for logical models, the URI of the logical model).

                                                                        Typeuri
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        234. CarePlan.supportingInfo.identifier
                                                                        Definition

                                                                        An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                        ShortLogical reference, when literal reference is not known
                                                                        Comments

                                                                        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.

                                                                        When 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

                                                                        Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                        Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                        This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                                        NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                        Control0..1
                                                                        This element is affected by the following invariants: ref-2
                                                                        TypeIdentifier
                                                                        Is Modifierfalse
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        236. CarePlan.supportingInfo.display
                                                                        Definition

                                                                        Plain text narrative that identifies the resource in addition to the resource reference.

                                                                        ShortText alternative for the resource
                                                                        Comments

                                                                        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.

                                                                        Control0..1
                                                                        This element is affected by the following invariants: ref-2
                                                                        Typestring
                                                                        Is Modifierfalse
                                                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                        Summarytrue
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        238. CarePlan.goal
                                                                        Definition

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

                                                                        ShortDesired outcome of plan
                                                                        Comments

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

                                                                        Control0..*
                                                                        TypeReference(Goal)
                                                                        Is Modifierfalse
                                                                        Must Supportfalse
                                                                        Summaryfalse
                                                                        Requirements

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

                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        240. CarePlan.goal.id
                                                                        Definition

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

                                                                        ShortUnique id for inter-element referencing
                                                                        Control0..1
                                                                        This element is affected by the following invariants: ele-1
                                                                        Typeid
                                                                        Is Modifierfalse
                                                                        XML FormatIn the XML format, this property is represented as an attribute.
                                                                        Summaryfalse
                                                                        242. CarePlan.goal.extension
                                                                        Definition

                                                                        An Extension

                                                                        ShortExtension
                                                                        Control0..*
                                                                        TypeExtension
                                                                        Is Modifierfalse
                                                                        Summaryfalse
                                                                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                        SlicingThis element introduces a set of slices on CarePlan.goal.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                        • value @ url
                                                                        • 244. CarePlan.goal.extension:goal
                                                                          Slice Namegoal
                                                                          Definition

                                                                          STU3: CarePlan.goal additional types from child elements (display, identifier, reference)

                                                                          ShortSTU3: goal additional types
                                                                          Comments

                                                                          Element CarePlan.goal is mapped to FHIR R5 element CarePlan.goal as SourceIsBroaderThanTarget. The mappings for CarePlan.goal do not cover the following types based on type expansion: display, identifier, reference. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.goal with unmapped reference targets: Goal. Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.

                                                                          Control0..1
                                                                          TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          246. CarePlan.goal.reference
                                                                          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.

                                                                          ShortLiteral reference, Relative, internal or absolute URL
                                                                          Comments

                                                                          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.

                                                                          Control0..1
                                                                          This element is affected by the following invariants: ref-2, ref-1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          248. CarePlan.goal.type
                                                                          Definition

                                                                          The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                          The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                          ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                          Comments

                                                                          This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                                          Control0..1
                                                                          BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                          (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                                          Aa resource (or, for logical models, the URI of the logical model).

                                                                          Typeuri
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          250. CarePlan.goal.identifier
                                                                          Definition

                                                                          An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                          ShortLogical reference, when literal reference is not known
                                                                          Comments

                                                                          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.

                                                                          When 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

                                                                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                          Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                          This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ref-2
                                                                          TypeIdentifier
                                                                          Is Modifierfalse
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          252. CarePlan.goal.display
                                                                          Definition

                                                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                                                          ShortText alternative for the resource
                                                                          Comments

                                                                          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.

                                                                          Control0..1
                                                                          This element is affected by the following invariants: ref-2
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                          Summarytrue
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          254. CarePlan.activity
                                                                          Definition

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

                                                                          ShortAction to occur or has occurred as part of plan
                                                                          Control0..*
                                                                          TypeBackboneElement
                                                                          Is Modifierfalse
                                                                          Must Supportfalse
                                                                          Summaryfalse
                                                                          Requirements

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

                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          256. CarePlan.activity.id
                                                                          Definition

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

                                                                          ShortUnique id for inter-element referencing
                                                                          Control0..1
                                                                          This element is affected by the following invariants: ele-1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          258. CarePlan.activity.extension
                                                                          Definition

                                                                          An Extension

                                                                          ShortExtension
                                                                          Control0..*
                                                                          TypeExtension
                                                                          Is Modifierfalse
                                                                          Summaryfalse
                                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                          SlicingThis element introduces a set of slices on CarePlan.activity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                          • value @ url
                                                                          • 260. CarePlan.activity.extension:outcomeCodeableConcept
                                                                            Slice NameoutcomeCodeableConcept
                                                                            Definition

                                                                            STU3: CarePlan.activity.outcomeCodeableConcept (new:CodeableConcept)

                                                                            ShortSTU3: Results of the activity (new)
                                                                            Comments

                                                                            Element CarePlan.activity.outcomeCodeableConcept has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.outcomeCodeableConcept has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Note that this should not duplicate the activity status (e.g. completed or in progress).

                                                                            Control0..*
                                                                            TypeExtension(STU3: Results of the activity (new)) (Extension Type: CodeableConcept)
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            262. CarePlan.activity.extension:outcomeReference
                                                                            Slice NameoutcomeReference
                                                                            Definition

                                                                            STU3: CarePlan.activity.outcomeReference (new:Reference(Resource))

                                                                            ShortSTU3: Appointment, Encounter, Procedure, etc. (new)
                                                                            Comments

                                                                            Element CarePlan.activity.outcomeReference has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.outcomeReference has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). 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.

                                                                            Control0..*
                                                                            TypeExtension(STU3: Appointment, Encounter, Procedure, etc. (new)) (Extension Type: Reference(Cross-version Profile for STU3.Resource for use in FHIR R5, Resource))
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            264. CarePlan.activity.extension:detail
                                                                            Slice Namedetail
                                                                            Definition

                                                                            STU3: CarePlan.activity.detail (new:BackboneElement)

                                                                            ShortSTU3: In-line definition of activity (new)
                                                                            Comments

                                                                            Element CarePlan.activity.detail has a context of CarePlan.activity based on following the parent source element upwards and mapping to CarePlan. Element CarePlan.activity.detail has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element).

                                                                            Control0..1
                                                                            TypeExtension(STU3: In-line definition of activity (new)) (Complex Extension)
                                                                            Is Modifierfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            266. CarePlan.activity.modifierExtension
                                                                            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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can 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.

                                                                            Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                                                                            ShortExtensions that cannot be ignored even if unrecognized
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                                                                            Summarytrue
                                                                            Requirements

                                                                            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                                                                            Alternate Namesextensions, user content, modifiers
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            268. CarePlan.activity.performedActivity
                                                                            Definition

                                                                            Identifies the activity that was performed. For example, an activity could be patient education, exercise, or a medication administration. The reference to an "event" resource, such as Procedure or Encounter or Observation, represents the activity that was performed. The requested activity can be conveyed using the CarePlan.activity.plannedActivityReference (a reference to a “request” resource).

                                                                            ShortResults of the activity (concept, or Appointment, Encounter, Procedure, etc.)
                                                                            Comments

                                                                            Note that this should not duplicate the activity status (e.g. completed or in progress). The activity performed 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 exercise, then the activity performed could be amount and intensity of exercise performed whereas the goal outcome is an observation for the actual body weight measured.

                                                                            Control0..*
                                                                            BindingFor example codes, see CarePlanActivityPerformed
                                                                            (example to http://hl7.org/fhir/ValueSet/care-plan-activity-performed|5.0.0)

                                                                            Identifies the results of the activity.

                                                                            TypeCodeableReference(Resource)
                                                                            Is Modifierfalse
                                                                            Must Supportfalse
                                                                            Summaryfalse
                                                                            Requirements

                                                                            Links plan to resulting actions.

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            270. CarePlan.activity.progress
                                                                            Definition

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

                                                                            ShortComments about the activity status/progress
                                                                            Comments

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

                                                                            Control0..*
                                                                            TypeAnnotation
                                                                            Is Modifierfalse
                                                                            Must Supportfalse
                                                                            Summaryfalse
                                                                            Requirements

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

                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            272. CarePlan.activity.progress.id
                                                                            Definition

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

                                                                            ShortUnique id for inter-element referencing
                                                                            Control0..1
                                                                            This element is affected by the following invariants: ele-1
                                                                            Typeid
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            274. CarePlan.activity.progress.extension
                                                                            Definition

                                                                            An Extension

                                                                            ShortExtension
                                                                            Control0..*
                                                                            TypeExtension
                                                                            Is Modifierfalse
                                                                            Summaryfalse
                                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                            SlicingThis element introduces a set of slices on CarePlan.activity.progress.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 276. CarePlan.activity.progress.extension:progress
                                                                              Slice Nameprogress
                                                                              Definition

                                                                              STU3: CarePlan.activity.progress additional types (Annotation) additional types from child elements (author[x], text, time)

                                                                              ShortSTU3: progress additional types
                                                                              Comments

                                                                              Element CarePlan.activity.progress is mapped to FHIR R5 element CarePlan.activity.progress as SourceIsBroaderThanTarget. The mappings for CarePlan.activity.progress do not cover the following types: Annotation. The mappings for CarePlan.activity.progress do not cover the following types based on type expansion: author[x], text, time. 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.

                                                                              Control0..*
                                                                              TypeExtension(STU3: progress additional types) (Extension Type: Annotation)
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              278. CarePlan.activity.progress.author[x]
                                                                              Definition

                                                                              The individual responsible for making the annotation.

                                                                              ShortIndividual responsible for the annotation
                                                                              Comments

                                                                              Organization is used when there's no need for specific attribution as to who made the comment.

                                                                              Control0..1
                                                                              TypeChoice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
                                                                              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              280. CarePlan.activity.progress.time
                                                                              Definition

                                                                              Indicates when this particular annotation was made.

                                                                              ShortWhen the annotation was made
                                                                              Control0..1
                                                                              TypedateTime
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              282. CarePlan.activity.progress.text
                                                                              Definition

                                                                              The text of the annotation in markdown format.

                                                                              ShortThe annotation - text content (as markdown)
                                                                              Control1..1
                                                                              Typemarkdown
                                                                              Is Modifierfalse
                                                                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                              Summarytrue
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              284. CarePlan.activity.plannedActivityReference
                                                                              Definition

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

                                                                              ShortActivity that is intended to be part of the care plan
                                                                              Comments

                                                                              Standard extension exists (http://hl7.org/fhir/StructureDefinition/resource-pertainsToGoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.plannedActivityReference.
                                                                              The goal should be visible when the resource referenced by CarePlan.activity.plannedActivityReference 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.

                                                                              Control0..1
                                                                              TypeReference(Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, Task, ServiceRequest, VisionPrescription, RequestOrchestration, ImmunizationRecommendation, SupplyRequest)
                                                                              Is Modifierfalse
                                                                              Must Supportfalse
                                                                              Summaryfalse
                                                                              Requirements

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

                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              286. CarePlan.activity.plannedActivityReference.id
                                                                              Definition

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

                                                                              ShortUnique id for inter-element referencing
                                                                              Control0..1
                                                                              This element is affected by the following invariants: ele-1
                                                                              Typeid
                                                                              Is Modifierfalse
                                                                              XML FormatIn the XML format, this property is represented as an attribute.
                                                                              Summaryfalse
                                                                              288. CarePlan.activity.plannedActivityReference.extension
                                                                              Definition

                                                                              An Extension

                                                                              ShortExtension
                                                                              Control0..*
                                                                              TypeExtension
                                                                              Is Modifierfalse
                                                                              Summaryfalse
                                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                              ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                              SlicingThis element introduces a set of slices on CarePlan.activity.plannedActivityReference.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                              • value @ url
                                                                              • 290. CarePlan.activity.plannedActivityReference.extension:reference
                                                                                Slice Namereference
                                                                                Definition

                                                                                STU3: CarePlan.activity.reference

                                                                                ShortSTU3: Activity details defined in specific resource
                                                                                Comments

                                                                                Element CarePlan.activity.reference is mapped to FHIR R5 element CarePlan.activity.plannedActivityReference as RelatedTo. The standard extension alternate-reference has been mapped as the representation of FHIR STU3 element CarePlan.activity.reference with unmapped reference targets: Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, ProcedureRequest, ReferralRequest, RequestGroup, Task, VisionPrescription. Standard extension exists (goal-pertainstogoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
                                                                                The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

                                                                                Control0..1
                                                                                TypeExtension(Alternate Reference) (Extension Type: Reference(Resource))
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                292. CarePlan.activity.plannedActivityReference.reference
                                                                                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.

                                                                                ShortLiteral reference, Relative, internal or absolute URL
                                                                                Comments

                                                                                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.

                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-2, ref-1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                294. CarePlan.activity.plannedActivityReference.type
                                                                                Definition

                                                                                The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

                                                                                The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

                                                                                ShortType the reference refers to (e.g. "Patient") - must be a resource in resources
                                                                                Comments

                                                                                This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a known RESTful URL) or by resolving the target of the reference.

                                                                                Control0..1
                                                                                BindingUnless not suitable, these codes SHALL be taken from ResourceType .
                                                                                (extensible to http://hl7.org/fhir/ValueSet/resource-types|5.0.0)

                                                                                Aa resource (or, for logical models, the URI of the logical model).

                                                                                Typeuri
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                296. CarePlan.activity.plannedActivityReference.identifier
                                                                                Definition

                                                                                An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents 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.

                                                                                ShortLogical reference, when literal reference is not known
                                                                                Comments

                                                                                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.

                                                                                When 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

                                                                                Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                                                                Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

                                                                                This element only allows for a single identifier. In the case where additional identifers are required, use the http://hl7.org/fhir/StructureDefinition/additionalIdentifier extension.

                                                                                NoteThis is a business identifier, not a resource identifier (see discussion)
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-2
                                                                                TypeIdentifier
                                                                                Is Modifierfalse
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                298. CarePlan.activity.plannedActivityReference.display
                                                                                Definition

                                                                                Plain text narrative that identifies the resource in addition to the resource reference.

                                                                                ShortText alternative for the resource
                                                                                Comments

                                                                                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.

                                                                                Control0..1
                                                                                This element is affected by the following invariants: ref-2
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                Summarytrue
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                300. CarePlan.note
                                                                                Definition

                                                                                General notes about the care plan not covered elsewhere.

                                                                                ShortComments about the plan
                                                                                Control0..*
                                                                                TypeAnnotation
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Summaryfalse
                                                                                Requirements

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

                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                302. CarePlan.note.id
                                                                                Definition

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

                                                                                ShortUnique id for inter-element referencing
                                                                                Control0..1
                                                                                This element is affected by the following invariants: ele-1
                                                                                Typeid
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                304. CarePlan.note.extension
                                                                                Definition

                                                                                An Extension

                                                                                ShortExtension
                                                                                Control0..*
                                                                                TypeExtension
                                                                                Is Modifierfalse
                                                                                Summaryfalse
                                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                SlicingThis element introduces a set of slices on CarePlan.note.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                                • value @ url
                                                                                • 306. CarePlan.note.extension:note
                                                                                  Slice Namenote
                                                                                  Definition

                                                                                  STU3: CarePlan.note additional types (Annotation) additional types from child elements (author[x], text, time)

                                                                                  ShortSTU3: note additional types
                                                                                  Comments

                                                                                  Element CarePlan.note is mapped to FHIR R5 element CarePlan.note as SourceIsBroaderThanTarget. The mappings for CarePlan.note do not cover the following types: Annotation. The mappings for CarePlan.note do not cover the following types based on type expansion: author[x], text, time.

                                                                                  Control0..*
                                                                                  TypeExtension(STU3: note additional types) (Extension Type: Annotation)
                                                                                  Is Modifierfalse
                                                                                  Summaryfalse
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                                                                                  308. CarePlan.note.author[x]
                                                                                  Definition

                                                                                  The individual responsible for making the annotation.

                                                                                  ShortIndividual responsible for the annotation
                                                                                  Comments

                                                                                  Organization is used when there's no need for specific attribution as to who made the comment.

                                                                                  Control0..1
                                                                                  TypeChoice of: Reference(Practitioner, PractitionerRole, Patient, RelatedPerson, Organization), string
                                                                                  [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  310. CarePlan.note.time
                                                                                  Definition

                                                                                  Indicates when this particular annotation was made.

                                                                                  ShortWhen the annotation was made
                                                                                  Control0..1
                                                                                  TypedateTime
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  312. CarePlan.note.text
                                                                                  Definition

                                                                                  The text of the annotation in markdown format.

                                                                                  ShortThe annotation - text content (as markdown)
                                                                                  Control1..1
                                                                                  Typemarkdown
                                                                                  Is Modifierfalse
                                                                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                                                                  Summarytrue
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))