Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Zib HelpFromOthers - Detailed Descriptions

Active as of 2024-04-09

Definitions for the zib-HelpFromOthers resource profile.

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

0. CarePlan
2. CarePlan.identifier
NoteThis is a business identifier, not a resource identifier (see discussion)
4. CarePlan.intent
Shortplan
Comments

Although the Zib is not really a (care)plan, this resources falls almost completly inline with the Zib. From the 4 possible codes here plan comes closest. Therefore this element is fixed to plan.

Fixed Valueplan
6. CarePlan.category
Control1..1
8. CarePlan.category.coding
Control1..?
SlicingThis element introduces a set of slices on CarePlan.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code
  • 10. CarePlan.category.coding:helpFromOthersCode
    Slice NamehelpFromOthersCode
    Control1..1
    12. CarePlan.category.coding:helpFromOthersCode.system
    Control1..?
    Fixed Valuehttp://snomed.info/sct
    14. CarePlan.category.coding:helpFromOthersCode.code
    Control1..?
    Fixed Value243114000
    16. CarePlan.category.coding:helpFromOthersCode.display
    Default ValueSupportive care
    18. CarePlan.subject
    TypeReference(nl-core-patient, Group)
    20. CarePlan.context
    TypeReference(HCIM Encounter, nl-core-episodeofcare)
    22. CarePlan.author
    TypeReference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, nl-core-organization, nl-core-careteam)
    24. CarePlan.author.extension
    SlicingThis element introduces a set of slices on CarePlan.author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 26. CarePlan.author.extension:practitionerRole
      Slice NamepractitionerRole
      Control0..1
      TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
      28. CarePlan.careTeam
      TypeReference(nl-core-careteam)
      30. CarePlan.activity
      ShortHelpFromOthers
      Alternate NamesHulpVanAnderen
      32. CarePlan.activity.detail
      34. CarePlan.activity.detail.category
      Definition

      The type of help offered by the person in question.

      ShortTypeOfHelp
      BindingUnless not suitable, these codes SHALL be taken from SoortHulpCodelijst
      (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.2.1--20171231000000)

      SoortHulpCodelijst

      Alternate NamesSoortHulp
      36. CarePlan.activity.detail.code
      Definition

      The nature of the help/support provided to the patient.

      ShortNature
      Alternate NamesAard
      38. CarePlan.activity.detail.code.text
      40. CarePlan.activity.detail.scheduledString:scheduledString
      Slice NamescheduledString
      Definition

      The frequency of the provided support, e.g. daily/weekly.

      ShortFrequency
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Alternate NamesFrequentie
      42. CarePlan.activity.detail.performer
      Definition

      An aid can be a health professional such as nurses, carers and helpers but also a caregiver or healthcare provider such as a home care organization. Either a reference to details of the health professional involved in the patient’s care, the details of the caregiver involved in the patient’s support or the details of the organization the health professional/aid works for in the event that it is not entered as a person.

      ShortAid
      Control0..1
      TypeReference(nl-core-practitioner, nl-core-organization, nl-core-relatedperson)
      Alternate NamesHulpverlener, Zorgverlener, Mantelzorger, Zorgaanbieder
      44. CarePlan.activity.detail.performer.extension
      SlicingThis element introduces a set of slices on CarePlan.activity.detail.performer.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 46. CarePlan.activity.detail.performer.extension:practitionerRole
        Slice NamepractitionerRole
        Control0..1
        TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
        48. CarePlan.activity.detail.description
        Definition

        A comment on the help/support the patient receives from others.

        ShortComment
        Alternate NamesToelichting

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

        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..*
        Alternate NamesCare Team
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
        dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
        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.

        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.

        This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

        Control0..1
        Typeuri
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        4. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        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 No Modifier Reason provideed in previous versions of FHIR
        Alternate Namesextensions, user content
        6. CarePlan.identifier
        Definition

        This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

        ShortExternal Ids for this plan
        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..*
        TypeIdentifier
        Summarytrue
        Requirements

        Need to allow connection to a wider workflow.

        8. CarePlan.status
        Definition

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

        Shortdraft | active | suspended | completed | entered-in-error | cancelled | unknown
        Comments

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

        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 CarePlanStatushttp://hl7.org/fhir/ValueSet/care-plan-status
        (required to http://hl7.org/fhir/ValueSet/care-plan-status)

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

        Typecode
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        10. CarePlan.intent
        Definition

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

        Shortplanproposal | plan | order | option
        Comments

        Although the Zib is not really a (care)plan, this resources falls almost completly inline with the Zib. From the 4 possible codes here plan comes closest. Therefore this element is fixed to plan.


        This element is labeled as a modifier because the intent alters when and how the resource is actually applicable.

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

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

        Typecode
        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Summarytrue
        Requirements

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

        Fixed Valueplan
        12. 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 axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

        Control10..1*
        BindingFor example codes, see Care Plan Categoryhttp://hl7.org/fhir/ValueSet/care-plan-category
        (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
        Summarytrue
        Requirements

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

        14. CarePlan.category.coding
        Definition

        A reference to a code defined by a terminology system.

        ShortCode defined by a terminology system
        Comments

        Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

        Control10..*
        TypeCoding
        Summarytrue
        Requirements

        Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

        SlicingThis element introduces a set of slices on CarePlan.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ code
        • 16. CarePlan.category.coding:helpFromOthersCode
          Slice NamehelpFromOthersCode
          Definition

          A reference to a code defined by a terminology system.

          ShortCode defined by a terminology system
          Comments

          Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

          Control10..1*
          TypeCoding
          Summarytrue
          Requirements

          Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

          18. CarePlan.category.coding:helpFromOthersCode.system
          Definition

          The identification of the code system that defines the meaning of the symbol in the code.

          ShortIdentity of the terminology system
          Comments

          The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

          Control10..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need to be unambiguous about the source of the definition of the symbol.

          Fixed Valuehttp://snomed.info/sct
          20. CarePlan.category.coding:helpFromOthersCode.code
          Definition

          A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

          ShortSymbol in syntax defined by the system
          Control10..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need to refer to a particular code in the system.

          Fixed Value243114000
          22. CarePlan.category.coding:helpFromOthersCode.display
          Definition

          A representation of the meaning of the code in the system, following the rules of the system.

          ShortRepresentation defined by the system
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

          24. CarePlan.subject
          Definition

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

          ShortWho care plan is for
          Control1..1
          TypeReference(nl-core-patient, Group, Patient)
          Summarytrue
          Alternate Namespatient
          26. CarePlan.context
          Definition

          Identifies the original context in which this particular CarePlan was created.

          ShortCreated in context of
          Comments

          Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

          Control0..1
          TypeReference(HCIM Encounter, nl-core-episodeofcare, Encounter, EpisodeOfCare)
          Summarytrue
          Alternate Namesencounter
          28. CarePlan.author
          Definition

          Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

          ShortWho is responsible for contents of the plan
          Comments

          Collaborative care plans may have multiple authors.

          Control0..*
          TypeReference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, nl-core-organization, nl-core-careteam, Patient, Practitioner, RelatedPerson, Organization, CareTeam)
          Summarytrue
          30. CarePlan.author.extension
          Definition

          An Extension


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

          ShortExtensionAdditional Content defined by implementations
          Comments

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

          Control0..*
          TypeExtension
          Alternate Namesextensions, user content
          SlicingThis element introduces a set of slices on CarePlan.author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 32. CarePlan.author.extension:practitionerRole
            Slice NamepractitionerRole
            Definition

            Optional Extension Element - found in all resources.

            ShortOptional Extensions Element
            Control0..1
            TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
            34. 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(nl-core-careteam, CareTeam)
            Requirements

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

            36. CarePlan.activity
            Definition

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

            ShortHelpFromOthersAction to occur as part of plan
            Control0..*
            TypeBackboneElement
            Requirements

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

            Alternate NamesHulpVanAnderen
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty())
            ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
            cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty())
            38. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            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 No Modifier Reason provideed in previous versions of FHIR
            Summarytrue
            Alternate Namesextensions, user content, modifiers

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

            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..*
            Alternate NamesCare Team
            Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
            dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
            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

            The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

            Control0..1
            Typeid
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            4. CarePlan.meta
            Definition

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

            ShortMetadata about the resource
            Control0..1
            TypeMeta
            Summarytrue
            6. 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.

            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.

            This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

            Control0..1
            Typeuri
            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            8. 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
            BindingUnless not suitable, these codes SHALL be taken from Common Languages
            (extensible to http://hl7.org/fhir/ValueSet/languages)

            A human language.

            Additional BindingsPurpose
            AllLanguagesMax Binding
            Typecode
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            10. CarePlan.text
            Definition

            A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

            ShortText summary of the resource, for human interpretation
            Comments

            Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

            Control0..1
            This element is affected by the following invariants: dom-1
            TypeNarrative
            Alternate Namesnarrative, html, xhtml, display
            12. CarePlan.contained
            Definition

            These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

            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.

            Control0..*
            TypeResource
            Alternate Namesinline resources, anonymous resources, contained resources
            14. CarePlan.extension
            Definition

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

            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
            Alternate Namesextensions, user content
            16. 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. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

            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 No Modifier Reason provideed in previous versions of FHIR
            Alternate Namesextensions, user content
            18. CarePlan.identifier
            Definition

            This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

            ShortExternal Ids for this plan
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..*
            TypeIdentifier
            Summarytrue
            Requirements

            Need to allow connection to a wider workflow.

            20. CarePlan.definition
            Definition

            Identifies the protocol, questionnaire, guideline or other specification the care plan should be conducted in accordance with.

            ShortProtocol or definition
            Control0..*
            TypeReference(PlanDefinition, Questionnaire)
            Summarytrue
            22. CarePlan.basedOn
            Definition

            A care plan that is fulfilled in whole or in part by this care plan.

            ShortFulfills care plan
            Control0..*
            TypeReference(CarePlan)
            Summarytrue
            Requirements

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

            Alternate Namesfulfills
            24. 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)
            Summarytrue
            Requirements

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

            Alternate Namessupersedes
            26. 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)
            Summarytrue
            28. CarePlan.status
            Definition

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

            Shortdraft | active | suspended | completed | entered-in-error | cancelled | unknown
            Comments

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

            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 CarePlanStatus
            (required to http://hl7.org/fhir/ValueSet/care-plan-status)

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

            Typecode
            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

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

            30. CarePlan.intent
            Definition

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

            Shortplan
            Comments

            Although the Zib is not really a (care)plan, this resources falls almost completly inline with the Zib. From the 4 possible codes here plan comes closest. Therefore this element is fixed to plan.

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

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

            Typecode
            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

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

            Fixed Valueplan
            32. 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 axis of categorization and one plan may serve multiple purposes. In some cases, this may be redundant with references to CarePlan.concern.

            Control1..1
            BindingFor example codes, see Care Plan Category
            (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
            Summarytrue
            Requirements

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

            34. CarePlan.category.id
            Definition

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

            Shortxml:id (or equivalent in JSON)
            Control0..1
            Typestring
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            XML FormatIn the XML format, this property is represented as an attribute.
            36. CarePlan.category.extension
            Definition

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

            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
            Alternate Namesextensions, user content
            SlicingThis element introduces a set of slices on CarePlan.category.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 38. CarePlan.category.coding
              Definition

              A reference to a code defined by a terminology system.

              ShortCode defined by a terminology system
              Comments

              Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

              Control1..*
              TypeCoding
              Summarytrue
              Requirements

              Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

              SlicingThis element introduces a set of slices on CarePlan.category.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
              • value @ code
              • 40. CarePlan.category.coding:helpFromOthersCode
                Slice NamehelpFromOthersCode
                Definition

                A reference to a code defined by a terminology system.

                ShortCode defined by a terminology system
                Comments

                Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                Control1..1
                TypeCoding
                Summarytrue
                Requirements

                Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                42. CarePlan.category.coding:helpFromOthersCode.id
                Definition

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

                Shortxml:id (or equivalent in JSON)
                Control0..1
                Typestring
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                XML FormatIn the XML format, this property is represented as an attribute.
                44. CarePlan.category.coding:helpFromOthersCode.extension
                Definition

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

                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
                Alternate Namesextensions, user content
                SlicingThis element introduces a set of slices on CarePlan.category.coding.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 46. CarePlan.category.coding:helpFromOthersCode.system
                  Definition

                  The identification of the code system that defines the meaning of the symbol in the code.

                  ShortIdentity of the terminology system
                  Comments

                  The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

                  Control1..1
                  Typeuri
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be unambiguous about the source of the definition of the symbol.

                  Fixed Valuehttp://snomed.info/sct
                  48. CarePlan.category.coding:helpFromOthersCode.version
                  Definition

                  The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

                  ShortVersion of the system - if relevant
                  Comments

                  Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

                  NoteThis is a business versionId, not a resource version id (see discussion)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  50. CarePlan.category.coding:helpFromOthersCode.code
                  Definition

                  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

                  ShortSymbol in syntax defined by the system
                  Control1..1
                  Typecode
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to refer to a particular code in the system.

                  Fixed Value243114000
                  52. CarePlan.category.coding:helpFromOthersCode.display
                  Definition

                  A representation of the meaning of the code in the system, following the rules of the system.

                  ShortRepresentation defined by the system
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

                  54. CarePlan.category.coding:helpFromOthersCode.userSelected
                  Definition

                  Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

                  ShortIf this coding was chosen directly by the user
                  Comments

                  Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

                  Control0..1
                  Typeboolean
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

                  56. CarePlan.category.text
                  Definition

                  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                  ShortPlain text representation of the concept
                  Comments

                  Very often the text is the same as a displayName of one of the codings.

                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  Requirements

                  The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                  58. CarePlan.title
                  Definition

                  Human-friendly name for the CarePlan.

                  ShortHuman-friendly name for the CarePlan
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summarytrue
                  60. CarePlan.description
                  Definition

                  A description of the scope and nature of the plan.

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

                  Provides more detail than conveyed by category.

                  62. CarePlan.subject
                  Definition

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

                  ShortWho care plan is for
                  Control1..1
                  TypeReference(nl-core-patient, Group)
                  Summarytrue
                  Alternate Namespatient
                  64. CarePlan.context
                  Definition

                  Identifies the original context in which this particular CarePlan was created.

                  ShortCreated in context of
                  Comments

                  Activities conducted as a result of the care plan may well occur as part of other encounters/episodes.

                  Control0..1
                  TypeReference(HCIM Encounter, nl-core-episodeofcare)
                  Summarytrue
                  Alternate Namesencounter
                  66. 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
                  Summarytrue
                  Requirements

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

                  Alternate Namestiming
                  68. CarePlan.author
                  Definition

                  Identifies the individual(s) or ogranization who is responsible for the content of the care plan.

                  ShortWho is responsible for contents of the plan
                  Comments

                  Collaborative care plans may have multiple authors.

                  Control0..*
                  TypeReference(nl-core-patient, nl-core-practitioner, nl-core-relatedperson, nl-core-organization, nl-core-careteam)
                  Summarytrue
                  70. CarePlan.author.id
                  Definition

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

                  Shortxml:id (or equivalent in JSON)
                  Control0..1
                  Typestring
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  XML FormatIn the XML format, this property is represented as an attribute.
                  72. CarePlan.author.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control0..*
                  TypeExtension
                  SlicingThis element introduces a set of slices on CarePlan.author.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 74. CarePlan.author.extension:practitionerRole
                    Slice NamepractitionerRole
                    Definition

                    Optional Extension Element - found in all resources.

                    ShortOptional Extensions Element
                    Control0..1
                    TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
                    76. CarePlan.author.reference
                    Definition

                    A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                    ShortLiteral reference, Relative, internal or absolute URL
                    Comments

                    Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                    Control0..1
                    This element is affected by the following invariants: ref-1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    78. CarePlan.author.identifier
                    Definition

                    An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                    ShortLogical reference, when literal reference is not known
                    Comments

                    When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                    When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Summarytrue
                    80. CarePlan.author.display
                    Definition

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

                    ShortText alternative for the resource
                    Comments

                    This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    82. 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(nl-core-careteam)
                    Requirements

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

                    84. 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
                    Control0..*
                    TypeReference(Condition)
                    Summarytrue
                    Requirements

                    Links plan to the conditions it manages. The element can identify risks addressed by the plan as well as active conditions. (The Condition resource can include things like "at risk for hypertension" or "fall risk".) Also scopes plans - multiple plans may exist addressing different concerns.

                    86. CarePlan.supportingInfo
                    Definition

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

                    ShortInformation considered as part of plan
                    Comments

                    Use "concern" to identify specific conditions addressed by the care plan.

                    Control0..*
                    TypeReference(Resource)
                    Requirements

                    Identifies barriers and other considerations associated with the care plan.

                    88. 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)
                    Requirements

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

                    90. CarePlan.activity
                    Definition

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

                    ShortHelpFromOthers
                    Control0..*
                    TypeBackboneElement
                    Requirements

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

                    Alternate NamesHulpVanAnderen
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                    cpl-3: Provide a reference or detail, not both (detail.empty() or reference.empty())
                    92. 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.

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    94. CarePlan.activity.extension
                    Definition

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

                    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
                    Alternate Namesextensions, user content
                    96. 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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    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 No Modifier Reason provideed in previous versions of FHIR
                    Summarytrue
                    Alternate Namesextensions, user content, modifiers
                    98. CarePlan.activity.outcomeCodeableConcept
                    Definition

                    Identifies the outcome at the point when the status of the activity is assessed. For example, the outcome of an education activity could be patient understands (or not).

                    ShortResults of the activity
                    Comments

                    Note that this should not duplicate the activity status (e.g. completed or in progress).

                    Control0..*
                    BindingFor example codes, see Care Plan Activity Outcome
                    (example to http://hl7.org/fhir/ValueSet/care-plan-activity-outcome)

                    Identifies the results of the activity

                    TypeCodeableConcept
                    100. CarePlan.activity.outcomeReference
                    Definition

                    Details of the outcome or action resulting from the activity. The reference to an "event" resource, such as Procedure or Encounter or Observation, is the result/outcome of the activity itself. The activity can be conveyed using CarePlan.activity.detail OR using the CarePlan.activity.reference (a reference to a “request” resource).

                    ShortAppointment, Encounter, Procedure, etc.
                    Comments

                    The activity outcome is independent of the outcome of the related goal(s). For example, if the goal is to achieve a target body weight of 150 lb and an activity is defined to diet, then the activity outcome could be calories consumed whereas the goal outcome is an observation for the actual body weight measured.

                    Control0..*
                    TypeReference(Resource)
                    Requirements

                    Links plan to resulting actions.

                    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
                    Requirements

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

                    104. CarePlan.activity.reference
                    Definition

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

                    ShortActivity details defined in specific resource
                    Comments

                    Standard extension exists (goal-pertainstogoal) that allows goals to be referenced from any of the referenced resources in CarePlan.activity.reference.
                    The goal should be visible when the resource referenced by CarePlan.activity.reference is viewed indepedently from the CarePlan. Requests that are pointed to by a CarePlan using this element should not point to this CarePlan using the "basedOn" element. i.e. Requests that are part of a CarePlan are not "based on" the CarePlan.

                    Control0..1
                    This element is affected by the following invariants: cpl-3
                    TypeReference(Appointment, CommunicationRequest, DeviceRequest, MedicationRequest, NutritionOrder, Task, ProcedureRequest, ReferralRequest, VisionPrescription, RequestGroup)
                    Requirements

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

                    106. CarePlan.activity.detail
                    Definition

                    A simple summary of a planned activity suitable for a general care plan system (e.g. form driven) that doesn't know about specific resources such as procedure etc.

                    ShortIn-line definition of activity
                    Control0..1
                    This element is affected by the following invariants: cpl-3
                    TypeBackboneElement
                    Requirements

                    Details in a simple form for generic care plan systems.

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

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

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    110. CarePlan.activity.detail.extension
                    Definition

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

                    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
                    Alternate Namesextensions, user content
                    112. CarePlan.activity.detail.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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    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 No Modifier Reason provideed in previous versions of FHIR
                    Summarytrue
                    Alternate Namesextensions, user content, modifiers
                    114. CarePlan.activity.detail.category
                    Definition

                    The type of help offered by the person in question.

                    ShortTypeOfHelp
                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from SoortHulpCodelijst
                    (extensible to http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.3.2.1--20171231000000)

                    SoortHulpCodelijst

                    TypeCodeableConcept
                    Requirements

                    May determine what types of extensions are permitted.

                    Alternate NamesSoortHulp
                    116. CarePlan.activity.detail.definition
                    Definition

                    Identifies the protocol, questionnaire, guideline or other specification the planned activity should be conducted in accordance with.

                    ShortProtocol or definition
                    Control0..1
                    TypeReference(PlanDefinition, ActivityDefinition, Questionnaire)
                    Requirements

                    Allows Questionnaires that the patient (or practitioner) should fill in to fulfill the care plan activity.

                    118. CarePlan.activity.detail.code
                    Definition

                    The nature of the help/support provided to the patient.

                    ShortNature
                    Comments

                    Tends to be less relevant for activities involving particular products. Codes should not convey negation - use "prohibited" instead.

                    Control0..1
                    BindingFor example codes, see Care Plan Activity
                    (example to http://hl7.org/fhir/ValueSet/care-plan-activity)

                    Detailed description of the type of activity; e.g. What lab test, what procedure, what kind of encounter.

                    TypeCodeableConcept
                    Requirements

                    Allows matching performed to planned as well as validation against protocols.

                    Alternate NamesAard
                    120. CarePlan.activity.detail.code.id
                    Definition

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

                    Shortxml:id (or equivalent in JSON)
                    Control0..1
                    Typestring
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    XML FormatIn the XML format, this property is represented as an attribute.
                    122. CarePlan.activity.detail.code.extension
                    Definition

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

                    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
                    Alternate Namesextensions, user content
                    SlicingThis element introduces a set of slices on CarePlan.activity.detail.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 124. CarePlan.activity.detail.code.coding
                      Definition

                      A reference to a code defined by a terminology system.

                      ShortCode defined by a terminology system
                      Comments

                      Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

                      Control0..*
                      TypeCoding
                      Summarytrue
                      Requirements

                      Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

                      126. CarePlan.activity.detail.code.text
                      Definition

                      A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

                      ShortPlain text representation of the concept
                      Comments

                      Very often the text is the same as a displayName of one of the codings.

                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

                      128. CarePlan.activity.detail.reasonCode
                      Definition

                      Provides the rationale that drove the inclusion of this particular activity as part of the plan or the reason why the activity was prohibited.

                      ShortWhy activity should be done or why activity was prohibited
                      Comments

                      This could be a diagnosis code. If a full condition record exists or additional detail is needed, use reasonCondition instead.

                      Control0..*
                      BindingFor example codes, see Activity Reason
                      (example to http://hl7.org/fhir/ValueSet/activity-reason)

                      Identifies why a care plan activity is needed. Can include any health condition codes as well as such concepts as "general wellness", prophylaxis, surgical preparation, etc.

                      TypeCodeableConcept
                      130. CarePlan.activity.detail.reasonReference
                      Definition

                      Provides the health condition(s) that drove the inclusion of this particular activity as part of the plan.

                      ShortCondition triggering need for activity
                      Comments

                      Conditions can be identified at the activity level that are not identified as reasons for the overall plan.

                      Control0..*
                      TypeReference(Condition)
                      132. CarePlan.activity.detail.goal
                      Definition

                      Internal reference that identifies the goals that this activity is intended to contribute towards meeting.

                      ShortGoals this activity relates to
                      Control0..*
                      TypeReference(Goal)
                      Requirements

                      So that participants know the link explicitly.

                      134. CarePlan.activity.detail.status
                      Definition

                      Identifies what progress is being made for the specific activity.

                      Shortnot-started | scheduled | in-progress | on-hold | completed | cancelled | unknown
                      Comments

                      Some aspects of status can be inferred based on the resources linked in actionTaken. Note that "status" is only as current as the plan was most recently updated.
                      The unknown code is not to be used to convey other statuses. The unknown code should be used when one of the statuses applies, but the authoring system doesn't know the current state of the activity.

                      Control1..1
                      BindingThe codes SHALL be taken from CarePlanActivityStatus
                      (required to http://hl7.org/fhir/ValueSet/care-plan-activity-status)

                      Indicates where the activity is at in its overall life cycle.

                      Typecode
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Requirements

                      Indicates progress against the plan, whether the activity is still relevant for the plan.

                      136. CarePlan.activity.detail.statusReason
                      Definition

                      Provides reason why the activity isn't yet started, is on hold, was cancelled, etc.

                      ShortReason for current status
                      Comments

                      Will generally not be present if status is "complete". Be sure to prompt to update this (or at least remove the existing value) if the status is changed.

                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      138. CarePlan.activity.detail.prohibited
                      Definition

                      If true, indicates that the described activity is one that must NOT be engaged in when following the plan. If false, indicates that the described activity is one that should be engaged in when following the plan.

                      ShortDo NOT do
                      Comments

                      This element is labeled as a modifier because it marks an activity as an activity that is not to be performed.

                      Control0..1
                      Typeboolean
                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Requirements

                      Captures intention to not do something that may have been previously typical.

                      Default Valuefalse
                      140. CarePlan.activity.detail.scheduled[x]
                      Definition

                      The period, timing or frequency upon which the described activity is to occur.

                      ShortWhen activity is to occur
                      Control0..1
                      Typestring
                      [x] NoteSee Choice of Data Types for further information about how to use [x]
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Requirements

                      Allows prompting for activities and detection of missed planned activities.

                      SlicingThis element introduces a set of slices on CarePlan.activity.detail.scheduled[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
                      • type @ $this
                      • 142. CarePlan.activity.detail.scheduled[x]:scheduledString
                        Slice NamescheduledString
                        Definition

                        The frequency of the provided support, e.g. daily/weekly.

                        ShortFrequency
                        Control0..1
                        Typestring
                        [x] NoteSee Choice of Data Types for further information about how to use [x]
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Requirements

                        Allows prompting for activities and detection of missed planned activities.

                        Alternate NamesFrequentie
                        144. CarePlan.activity.detail.location
                        Definition

                        Identifies the facility where the activity will occur; e.g. home, hospital, specific clinic, etc.

                        ShortWhere it should happen
                        Comments

                        May reference a specific clinical location or may identify a type of location.

                        Control0..1
                        TypeReference(Location)
                        Requirements

                        Helps in planning of activity.

                        146. CarePlan.activity.detail.performer
                        Definition

                        An aid can be a health professional such as nurses, carers and helpers but also a caregiver or healthcare provider such as a home care organization. Either a reference to details of the health professional involved in the patient’s care, the details of the caregiver involved in the patient’s support or the details of the organization the health professional/aid works for in the event that it is not entered as a person.

                        ShortAid
                        Comments

                        A performer MAY also be a participant in the care plan.

                        Control0..1
                        TypeReference(nl-core-practitioner, nl-core-organization, nl-core-relatedperson)
                        Requirements

                        Helps in planning of activity.

                        Alternate NamesHulpverlener, Zorgverlener, Mantelzorger, Zorgaanbieder
                        148. CarePlan.activity.detail.performer.id
                        Definition

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

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        150. CarePlan.activity.detail.performer.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        SlicingThis element introduces a set of slices on CarePlan.activity.detail.performer.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 152. CarePlan.activity.detail.performer.extension:practitionerRole
                          Slice NamepractitionerRole
                          Definition

                          Optional Extension Element - found in all resources.

                          ShortOptional Extensions Element
                          Control0..1
                          TypeExtension(PractitionerRole Reference) (Extension Type: Reference)
                          154. CarePlan.activity.detail.performer.reference
                          Definition

                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                          ShortLiteral reference, Relative, internal or absolute URL
                          Comments

                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                          Control0..1
                          This element is affected by the following invariants: ref-1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          156. CarePlan.activity.detail.performer.identifier
                          Definition

                          An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                          ShortLogical reference, when literal reference is not known
                          Comments

                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

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

                          NoteThis is a business identifier, not a resource identifier (see discussion)
                          Control0..1
                          TypeIdentifier
                          Summarytrue
                          158. CarePlan.activity.detail.performer.display
                          Definition

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

                          ShortText alternative for the resource
                          Comments

                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Summarytrue
                          160. CarePlan.activity.detail.product[x]
                          Definition

                          Identifies the food, drug or other product to be consumed or supplied in the activity.

                          ShortWhat is to be administered/supplied
                          Control0..1
                          BindingFor example codes, see SNOMED CT Medication Codes
                          (example to http://hl7.org/fhir/ValueSet/medication-codes)

                          A product supplied or administered as part of a care plan activity.

                          TypeChoice of: CodeableConcept, Reference(Medication, Substance)
                          [x] NoteSee Choice of Data Types for further information about how to use [x]
                          162. CarePlan.activity.detail.dailyAmount
                          Definition

                          Identifies the quantity expected to be consumed in a given day.

                          ShortHow to consume/day?
                          Control0..1
                          TypeQuantity(SimpleQuantity)
                          Requirements

                          Allows rough dose checking.

                          Alternate Namesdaily dose
                          164. CarePlan.activity.detail.quantity
                          Definition

                          Identifies the quantity expected to be supplied, administered or consumed by the subject.

                          ShortHow much to administer/supply/consume
                          Control0..1
                          TypeQuantity(SimpleQuantity)
                          166. CarePlan.activity.detail.description
                          Definition

                          A comment on the help/support the patient receives from others.

                          ShortComment
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Alternate NamesToelichting
                          168. CarePlan.note
                          Definition

                          General notes about the care plan not covered elsewhere.

                          ShortComments about the plan
                          Control0..*
                          TypeAnnotation
                          Requirements

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