HL7 Europe Imaging Study Report
0.1.0-build - ci-build 150

HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging/ and changes regularly. See the Directory of published versions

Resource Profile: Report_EuCarePlan - Detailed Descriptions

Draft as of 2025-09-03

Definitions for the Report-EuCarePlan 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())
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()))
4. 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 AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0
(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
Obligations
    ObligationsActorDocumentation
    SHALL:populate-if-knownImaging study report provider

    EHDSCarePlan.header.language

    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    6. 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
    Obligations
      ObligationsActorDocumentation
      SHALL:populate-if-knownImaging study report provider

      EHDSCarePlan.presentedForm

      Summaryfalse
      Alternate Namesnarrative, html, xhtml, display
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      8. 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
      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())
      12. 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
      Obligations
        ObligationsActorDocumentation
        SHALL:populate-if-knownImaging study report provider

        EHDSCarePlan.header.identifier

        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()))
        14. 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
        Obligations
          ObligationsActorDocumentation
          SHALL:populate-if-knownImaging study report provider

          EHDSCarePlan.header.status

          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()))
          16. 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()))
          18. 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
          Obligations
            ObligationsActorDocumentation
            SHALL:populate-if-knownImaging study report provider

            EHDSCarePlan.title

            Summarytrue
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            20. CarePlan.title.extension:xthml
            Slice Namexthml
            Definition

            This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display.

            ShortString equivalent with html markup
            Comments

            For questionnaires, see additional guidance and examples in the SDC implementation guide.

            Control0..1
            TypeExtension(XHTML Representation) (Extension Type: string)
            Is Modifierfalse
            Obligations
              ObligationsActorDocumentation
              SHALL:populate-if-knownImaging study report provider

              EHDSCarePlan.title

              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())
              22. 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
              Obligations
                ObligationsActorDocumentation
                SHALL:populate-if-knownImaging study report provider

                EHDSCarePlan.description, EHDSImagingReport.body.recommendation.description

                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()))
                24. CarePlan.description.extension:xthml
                Slice Namexthml
                Definition

                This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display.

                ShortString equivalent with html markup
                Comments

                For questionnaires, see additional guidance and examples in the SDC implementation guide.

                Control0..1
                TypeExtension(XHTML Representation) (Extension Type: string)
                Is Modifierfalse
                Obligations
                  ObligationsActorDocumentation
                  SHALL:populate-if-knownImaging study report provider

                  EHDSCarePlan.description

                  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())
                  26. 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 (EU base), Group, Patient)
                  Is Modifierfalse
                  Must Supportfalse
                  Obligations
                    ObligationsActorDocumentation
                    SHALL:populate-if-knownImaging study report provider

                    EHDSCarePlan.header.subject, EHDSCarePlan.period

                    Summarytrue
                    Alternate Namespatient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    28. 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
                    Obligations
                      ObligationsActorDocumentation
                      SHALL:populate-if-knownImaging study report provider

                      EHDSCarePlan.header.authorship.datetime

                      Summarytrue
                      Alternate NamesauthoredOn
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      30. 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(PractitionerRole (EU base), Patient (EU base), Device, RelatedPerson, Organization (EU base), CareTeam, Patient, Practitioner, PractitionerRole, Organization)
                      Is Modifierfalse
                      Must Supportfalse
                      Obligations
                        ObligationsActorDocumentation
                        SHALL:populate-if-knownImaging study report provider

                        EHDSCarePlan.header.authorship

                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        32. 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
                        Obligations
                          ObligationsActorDocumentation
                          SHALL:populate-if-knownImaging study report provider

                          EHDSCarePlan.activity[x]

                          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()))
                          34. 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())

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

                          0. CarePlan
                          2. CarePlan.meta
                          4. CarePlan.meta.versionId
                          Obligations
                            ObligationsActorDocumentation
                            SHALL:populate-if-knownImaging study report provider

                            EHDSCarePlan.header.version

                            6. CarePlan.meta.lastUpdated
                            Obligations
                              ObligationsActorDocumentation
                              SHALL:populate-if-knownImaging study report provider

                              EHDSCarePlan.header.lastUpdate

                              8. CarePlan.language
                              Obligations
                                ObligationsActorDocumentation
                                SHALL:populate-if-knownImaging study report provider

                                EHDSCarePlan.header.language

                                10. CarePlan.text
                                Obligations
                                  ObligationsActorDocumentation
                                  SHALL:populate-if-knownImaging study report provider

                                  EHDSCarePlan.presentedForm

                                  12. CarePlan.identifier
                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Obligations
                                    ObligationsActorDocumentation
                                    SHALL:populate-if-knownImaging study report provider

                                    EHDSCarePlan.header.identifier

                                    14. CarePlan.status
                                    Obligations
                                      ObligationsActorDocumentation
                                      SHALL:populate-if-knownImaging study report provider

                                      EHDSCarePlan.header.status

                                      16. CarePlan.title
                                      Obligations
                                        ObligationsActorDocumentation
                                        SHALL:populate-if-knownImaging study report provider

                                        EHDSCarePlan.title

                                        18. CarePlan.title.extension:xthml
                                        Slice Namexthml
                                        Obligations
                                          ObligationsActorDocumentation
                                          SHALL:populate-if-knownImaging study report provider

                                          EHDSCarePlan.title

                                          20. CarePlan.description
                                          Obligations
                                            ObligationsActorDocumentation
                                            SHALL:populate-if-knownImaging study report provider

                                            EHDSCarePlan.description, EHDSImagingReport.body.recommendation.description

                                            22. CarePlan.description.extension:xthml
                                            Slice Namexthml
                                            Obligations
                                              ObligationsActorDocumentation
                                              SHALL:populate-if-knownImaging study report provider

                                              EHDSCarePlan.description

                                              24. CarePlan.subject
                                              Obligations
                                                ObligationsActorDocumentation
                                                SHALL:populate-if-knownImaging study report provider

                                                EHDSCarePlan.header.subject, EHDSCarePlan.period

                                                26. CarePlan.created
                                                Obligations
                                                  ObligationsActorDocumentation
                                                  SHALL:populate-if-knownImaging study report provider

                                                  EHDSCarePlan.header.authorship.datetime

                                                  28. CarePlan.contributor
                                                  Obligations
                                                    ObligationsActorDocumentation
                                                    SHALL:populate-if-knownImaging study report provider

                                                    EHDSCarePlan.header.authorship

                                                    30. CarePlan.activity
                                                    Obligations
                                                      ObligationsActorDocumentation
                                                      SHALL:populate-if-knownImaging study report provider

                                                      EHDSCarePlan.activity[x]

                                                      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

                                                      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.

                                                      ShortAdditional 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())
                                                      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.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
                                                        Obligations
                                                          ObligationsActorDocumentation
                                                          SHALL:populate-if-knownImaging study report provider

                                                          EHDSCarePlan.header.version

                                                          Summarytrue
                                                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                          12. 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
                                                          Obligations
                                                            ObligationsActorDocumentation
                                                            SHALL:populate-if-knownImaging study report provider

                                                            EHDSCarePlan.header.lastUpdate

                                                            Summarytrue
                                                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                            14. 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()))
                                                            16. 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()))
                                                            18. 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)

                                                            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()))
                                                            20. 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)

                                                            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()))
                                                            22. 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()))
                                                            24. 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
                                                            Obligations
                                                              ObligationsActorDocumentation
                                                              SHALL:populate-if-knownImaging study report provider

                                                              EHDSCarePlan.header.language

                                                              Summaryfalse
                                                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                              26. 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
                                                              Obligations
                                                                ObligationsActorDocumentation
                                                                SHALL:populate-if-knownImaging study report provider

                                                                EHDSCarePlan.presentedForm

                                                                Summaryfalse
                                                                Alternate Namesnarrative, html, xhtml, display
                                                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                28. 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
                                                                30. CarePlan.extension
                                                                Definition

                                                                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.

                                                                ShortAdditional 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())
                                                                32. 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())
                                                                34. 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
                                                                Obligations
                                                                  ObligationsActorDocumentation
                                                                  SHALL:populate-if-knownImaging study report provider

                                                                  EHDSCarePlan.header.identifier

                                                                  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()))
                                                                  36. 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()))
                                                                  38. 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()))
                                                                  40. 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()))
                                                                  42. 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()))
                                                                  44. 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()))
                                                                  46. 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
                                                                  Obligations
                                                                    ObligationsActorDocumentation
                                                                    SHALL:populate-if-knownImaging study report provider

                                                                    EHDSCarePlan.header.status

                                                                    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()))
                                                                    48. 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()))
                                                                    50. 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)

                                                                    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()))
                                                                    52. 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
                                                                    Obligations
                                                                      ObligationsActorDocumentation
                                                                      SHALL:populate-if-knownImaging study report provider

                                                                      EHDSCarePlan.title

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

                                                                      unique id for the element within a resource (for internal references)

                                                                      Shortxml:id (or equivalent in JSON)
                                                                      Control0..1
                                                                      Typestring
                                                                      Is Modifierfalse
                                                                      XML FormatIn the XML format, this property is represented as an attribute.
                                                                      Summaryfalse
                                                                      56. CarePlan.title.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.title.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                      • value @ url
                                                                      • 58. CarePlan.title.extension:xthml
                                                                        Slice Namexthml
                                                                        Definition

                                                                        This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display.

                                                                        ShortString equivalent with html markup
                                                                        Comments

                                                                        For questionnaires, see additional guidance and examples in the SDC implementation guide.

                                                                        Control0..1
                                                                        TypeExtension(XHTML Representation) (Extension Type: string)
                                                                        Is Modifierfalse
                                                                        Obligations
                                                                          ObligationsActorDocumentation
                                                                          SHALL:populate-if-knownImaging study report provider

                                                                          EHDSCarePlan.title

                                                                          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())
                                                                          60. CarePlan.title.value
                                                                          Definition

                                                                          The actual value

                                                                          ShortPrimitive value for string
                                                                          Control0..1
                                                                          Typestring
                                                                          Is Modifierfalse
                                                                          XML FormatIn the XML format, this property is represented as an attribute.
                                                                          Summaryfalse
                                                                          Max Length:1048576
                                                                          62. 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
                                                                          Obligations
                                                                            ObligationsActorDocumentation
                                                                            SHALL:populate-if-knownImaging study report provider

                                                                            EHDSCarePlan.description, EHDSImagingReport.body.recommendation.description

                                                                            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()))
                                                                            64. CarePlan.description.id
                                                                            Definition

                                                                            unique id for the element within a resource (for internal references)

                                                                            Shortxml:id (or equivalent in JSON)
                                                                            Control0..1
                                                                            Typestring
                                                                            Is Modifierfalse
                                                                            XML FormatIn the XML format, this property is represented as an attribute.
                                                                            Summaryfalse
                                                                            66. CarePlan.description.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.description.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                                                            • value @ url
                                                                            • 68. CarePlan.description.extension:xthml
                                                                              Slice Namexthml
                                                                              Definition

                                                                              This is an equivalent of the string on which the extension is sent, but includes additional XHTML markup, such as bold, italics, styles, tables, etc. Existing restrictions on XHTML content apply. Note that using markdown allows for greater flexibility of display.

                                                                              ShortString equivalent with html markup
                                                                              Comments

                                                                              For questionnaires, see additional guidance and examples in the SDC implementation guide.

                                                                              Control0..1
                                                                              TypeExtension(XHTML Representation) (Extension Type: string)
                                                                              Is Modifierfalse
                                                                              Obligations
                                                                                ObligationsActorDocumentation
                                                                                SHALL:populate-if-knownImaging study report provider

                                                                                EHDSCarePlan.description

                                                                                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())
                                                                                70. CarePlan.description.value
                                                                                Definition

                                                                                The actual value

                                                                                ShortPrimitive value for string
                                                                                Control0..1
                                                                                Typestring
                                                                                Is Modifierfalse
                                                                                XML FormatIn the XML format, this property is represented as an attribute.
                                                                                Summaryfalse
                                                                                Max Length:1048576
                                                                                72. 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 (EU base), Group)
                                                                                Is Modifierfalse
                                                                                Must Supportfalse
                                                                                Obligations
                                                                                  ObligationsActorDocumentation
                                                                                  SHALL:populate-if-knownImaging study report provider

                                                                                  EHDSCarePlan.header.subject, EHDSCarePlan.period

                                                                                  Summarytrue
                                                                                  Alternate Namespatient
                                                                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                  74. 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()))
                                                                                  76. 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()))
                                                                                  78. 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
                                                                                  Obligations
                                                                                    ObligationsActorDocumentation
                                                                                    SHALL:populate-if-knownImaging study report provider

                                                                                    EHDSCarePlan.header.authorship.datetime

                                                                                    Summarytrue
                                                                                    Alternate NamesauthoredOn
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    80. 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(PractitionerRole (EU base), Patient (EU base), Device, RelatedPerson, Organization (EU base), CareTeam)
                                                                                    Is Modifierfalse
                                                                                    Must Supportfalse
                                                                                    Summarytrue
                                                                                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                                                                    82. 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(PractitionerRole (EU base), Patient (EU base), Device, RelatedPerson, Organization (EU base), CareTeam)
                                                                                    Is Modifierfalse
                                                                                    Must Supportfalse
                                                                                    Obligations
                                                                                      ObligationsActorDocumentation
                                                                                      SHALL:populate-if-knownImaging study report provider

                                                                                      EHDSCarePlan.header.authorship

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

                                                                                      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()))
                                                                                      88. 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()))
                                                                                      90. 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()))
                                                                                      92. 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
                                                                                      Obligations
                                                                                        ObligationsActorDocumentation
                                                                                        SHALL:populate-if-knownImaging study report provider

                                                                                        EHDSCarePlan.activity[x]

                                                                                        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()))
                                                                                        94. 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
                                                                                        96. CarePlan.activity.extension
                                                                                        Definition

                                                                                        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.

                                                                                        ShortAdditional 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())
                                                                                        98. 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())
                                                                                        100. 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)

                                                                                        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()))
                                                                                        102. 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()))
                                                                                        104. 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()))
                                                                                        106. 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()))