HL7 Belgium Patient Care
1.0.0 - R4 Belgium flag

This page is part of the eHealth FHIR Patient Care Profiles for Belgium (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: BeGoal - Detailed Descriptions

Active as of 2021-01-18

Definitions for the be-goal resource profile.

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

0. Goal
Definition

Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

ShortDescribes the intended objective(s) for a patient, group or organization
Comments

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

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

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

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

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

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and 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.

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

ShortExtensions that cannot be ignored
Comments

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

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

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

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

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

ShortExternal Ids for this goal
Comments

This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.

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

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

Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Goal.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ system
  • 8. Goal.lifecycleStatus
    Definition

    The state of the goal throughout its lifecycle.

    Shortproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
    Comments

    This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.

    Control1..1
    BindingThe codes SHALL be taken from GoalLifecycleStatushttp://hl7.org/fhir/ValueSet/goal-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/goal-status|4.0.1)

    Codes that reflect the current state of a goal and whether the goal is still being targeted.

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

    Allows knowing whether goal needs to be further tracked.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Goal.category
    Definition

    Indicates a category the goal falls within.

    ShortE.g. Treatment, dietary, behavioral, etc.
    Control0..*
    BindingFor example codes, see GoalCategoryhttp://hl7.org/fhir/ValueSet/goal-category
    (example to http://hl7.org/fhir/ValueSet/goal-category)

    Codes for grouping and sorting goals.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows goals to be filtered and sorted.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Goal.description
    Definition

    Human-readable and/or coded description of a specific desired objective of care, such as "control blood pressure" or "negotiate an obstacle course" or "dance with child at wedding".

    ShortCode or text describing goal
    Comments

    If no code is available, use CodeableConcept.text.

    Control1..1
    BindingFor example codes, see SNOMEDCTClinicalFindingshttp://hl7.org/fhir/ValueSet/clinical-findings
    (example to http://hl7.org/fhir/ValueSet/clinical-findings)

    Codes providing the details of a particular goal. This will generally be system or implementation guide-specific. In many systems, only the text element will be used.

    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Without a description of what's trying to be achieved, element has no purpose.

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

    Identifies the patient, group or organization for whom the goal is being established.

    ShortWho this goal is intended for
    Control1..1
    TypeReference(BePatient, Group, Patient, Organization)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Requirements

    Subject is optional to support annonymized reporting.

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

    Indicates whose goal this is - patient goal, practitioner goal, etc.

    ShortWho's responsible for creating Goal?
    Comments

    This is the individual responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).

    Control10..1
    TypeReference(BePatient, BePractitionerRole, BePatient, RelatedPerson, Patient, Practitioner, PractitionerRole)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))