Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release Denmark flag

This page is part of the KLFFBMessaging (v1.0.0: Release) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: InterventionPurpose

Official URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-interventionPurpose Version: 1.0.0
Active as of 2023-08-27 Computable Name: KLMessagingFFBInterventionPurpose

Purpose of an intervention for a citizen

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from KLCommonCareSocialPurpose

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
... description S1..1CodeableConcept[DK] målbeskrivelse
... subject S1..1Reference(Citizen)[DK] målSubjekt

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... goalRelationship 0..1(Complex)Goals related to this Goal
URL: http://hl7.org/fhir/StructureDefinition/goal-relationship
.... extension:type 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1CodeableConcept[DK] delmålBaseretPå
Binding: GoalRelationshipType (extensible): Types of relationships between two goals.

.... extension:target 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"target"
..... value[x] 1..1Reference(Goal)[DK] delmålBaseretPå
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... category Σ1..1CodeableConcept[DK] målkategori
Binding: KLMålKategoriKoder (required)

Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 424827b1-23aa-4848-962b-56ee47def560
... description SΣ1..1CodeableConcept[DK] målbeskrivelse
Binding: SNOMEDCTClinicalFindings (example): 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.

... subject SΣ1..1Reference(Citizen)[DK] målSubjekt
... Slices for target C0..*BackboneElementTarget outcome for the goal
Slice: Unordered, Open by value:measure
.... target:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... target:severitySlice C0..1BackboneElement[DK] målSværhedsgrad
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa
.... target:changeValueSlice C0..1BackboneElement[DK] måltype
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Goal.extension:goalRelationship.extension:type.value[x]extensibleGoalRelationshipType
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.categoryrequiredPattern: 424827b1-23aa-4848-962b-56ee47def560
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.target:severitySlice.measureexamplePattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa
Goal.target:changeValueSlice.measureexamplePattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.target, Goal.target:severitySlice, Goal.target:changeValueSliceGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... goalRelationship 0..1(Complex)Goals related to this Goal
URL: http://hl7.org/fhir/StructureDefinition/goal-relationship
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:type 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1CodeableConcept[DK] delmålBaseretPå
Binding: GoalRelationshipType (extensible): Types of relationships between two goals.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Required Pattern: based-on
.... extension:target 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"target"
..... value[x] 1..1Reference(Goal)[DK] delmålBaseretPå
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted.

... achievementStatus Σ0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target.

... category Σ1..1CodeableConcept[DK] målkategori
Binding: KLMålKategoriKoder (required)

Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 424827b1-23aa-4848-962b-56ee47def560
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.

... description SΣ1..1CodeableConcept[DK] målbeskrivelse
Binding: SNOMEDCTClinicalFindings (example): 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.

... subject SΣ1..1Reference(Citizen)[DK] målSubjekt
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDatedate
.... startCodeableConceptCodeableConcept
... Slices for target C0..*BackboneElementTarget outcome for the goal
Slice: Unordered, Open by value:measure
.... target:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC0..1CodeableConcept[DK] målemetode
Binding: KLTypeAfObservationPåMål (extensible)
..... detail[x] ΣC0..1The target value to be achieved
Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal.

...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
...... detailStringstring
...... detailBooleanboolean
...... detailIntegerinteger
...... detailRatioRatio
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
.... target:severitySlice C0..1BackboneElement[DK] målSværhedsgrad
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... detail[x] ΣC0..1CodeableConceptThe target value to be achieved
Binding: KLSværhedgrader (required)
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
.... target:changeValueSlice C0..1BackboneElement[DK] måltype
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... detail[x] ΣC0..1CodeableConceptThe target value to be achieved
Binding: KLMåltypeKoder (required)
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(Practioner | Citizen)[DK] målAnsvarlig
... addresses 0..*Reference(Condition | MatterOfInterest)[DK] målrelateret
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... conditionRank 0..1positiveInt[DK] målrelateretRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationComments about the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdown[DK] målnotat
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months".


.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... matterOfInterestInformer 0..1CodeableConcept[DK] målvurderingsInformant
URL: http://fhir.kl.dk/core/StructureDefinition/MatterOfInterestInformer
Binding: KLKildeTilOplysningFFB (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1string[DK] målvurdering
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Goal.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Goal.extension:goalRelationship.extension:type.value[x]extensibleGoalRelationshipType
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.achievementStatuspreferredGoalAchievementStatus
Goal.categoryrequiredPattern: 424827b1-23aa-4848-962b-56ee47def560
Goal.prioritypreferredGoalPriority
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.start[x]exampleGoalStartEvent
Goal.target.measureextensibleKLTargetMeasureCodes
Goal.target.detail[x]example
Goal.target:severitySlice.measureexamplePattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa
Goal.target:severitySlice.detail[x]requiredKLSeverities
Goal.target:changeValueSlice.measureexamplePattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48
Goal.target:changeValueSlice.detail[x]requiredKLChangeValueCodes
Goal.addresses.typeextensibleResourceType
Goal.outcomeCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.target, Goal.target:severitySlice, Goal.target:changeValueSliceGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

This structure is derived from KLCommonCareSocialPurpose

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

Differential View

This structure is derived from KLCommonCareSocialPurpose

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... lifecycleStatus S1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
... description S1..1CodeableConcept[DK] målbeskrivelse
... subject S1..1Reference(Citizen)[DK] målSubjekt

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... goalRelationship 0..1(Complex)Goals related to this Goal
URL: http://hl7.org/fhir/StructureDefinition/goal-relationship
.... extension:type 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1CodeableConcept[DK] delmålBaseretPå
Binding: GoalRelationshipType (extensible): Types of relationships between two goals.

.... extension:target 1..1ExtensionExtension
..... extension 0..0
..... url 1..1uri"target"
..... value[x] 1..1Reference(Goal)[DK] delmålBaseretPå
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... category Σ1..1CodeableConcept[DK] målkategori
Binding: KLMålKategoriKoder (required)

Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 424827b1-23aa-4848-962b-56ee47def560
... description SΣ1..1CodeableConcept[DK] målbeskrivelse
Binding: SNOMEDCTClinicalFindings (example): 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.

... subject SΣ1..1Reference(Citizen)[DK] målSubjekt
... Slices for target C0..*BackboneElementTarget outcome for the goal
Slice: Unordered, Open by value:measure
.... target:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... target:severitySlice C0..1BackboneElement[DK] målSværhedsgrad
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa
.... target:changeValueSlice C0..1BackboneElement[DK] måltype
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Goal.extension:goalRelationship.extension:type.value[x]extensibleGoalRelationshipType
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.categoryrequiredPattern: 424827b1-23aa-4848-962b-56ee47def560
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.target:severitySlice.measureexamplePattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa
Goal.target:changeValueSlice.measureexamplePattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.target, Goal.target:severitySlice, Goal.target:changeValueSliceGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Goal 0..*KLCommonCareSocialPurposeDescribes the intended objective(s) for a patient, group or organization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... goalRelationship 0..1(Complex)Goals related to this Goal
URL: http://hl7.org/fhir/StructureDefinition/goal-relationship
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:type 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"type"
..... value[x] 1..1CodeableConcept[DK] delmålBaseretPå
Binding: GoalRelationshipType (extensible): Types of relationships between two goals.

...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
...... text Σ0..1stringPlain text representation of the concept
Required Pattern: based-on
.... extension:target 1..1ExtensionExtension
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"target"
..... value[x] 1..1Reference(Goal)[DK] delmålBaseretPå
.... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal Ids for this goal
... lifecycleStatus ?!SΣ1..1codeproposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
Binding: GoalLifecycleStatus (required): Codes that reflect the current state of a goal and whether the goal is still being targeted.

... achievementStatus Σ0..1CodeableConceptin-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Binding: GoalAchievementStatus (preferred): Indicates the progression, or lack thereof, towards the goal against the target.

... category Σ1..1CodeableConcept[DK] målkategori
Binding: KLMålKategoriKoder (required)

Required Pattern: At least the following
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: 424827b1-23aa-4848-962b-56ee47def560
..... display0..1stringRepresentation defined by the system
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... priority Σ0..1CodeableConcepthigh-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.

... description SΣ1..1CodeableConcept[DK] målbeskrivelse
Binding: SNOMEDCTClinicalFindings (example): 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.

... subject SΣ1..1Reference(Citizen)[DK] målSubjekt
... start[x] Σ0..1When goal pursuit begins
Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal.

.... startDatedate
.... startCodeableConceptCodeableConcept
... Slices for target C0..*BackboneElementTarget outcome for the goal
Slice: Unordered, Open by value:measure
.... target:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC0..1CodeableConcept[DK] målemetode
Binding: KLTypeAfObservationPåMål (extensible)
..... detail[x] ΣC0..1The target value to be achieved
Binding: (unbound) (example): Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal.

...... detailQuantityQuantity
...... detailRangeRange
...... detailCodeableConceptCodeableConcept
...... detailStringstring
...... detailBooleanboolean
...... detailIntegerinteger
...... detailRatioRatio
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
.... target:severitySlice C0..1BackboneElement[DK] målSværhedsgrad
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... detail[x] ΣC0..1CodeableConceptThe target value to be achieved
Binding: KLSværhedgrader (required)
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
.... target:changeValueSlice C0..1BackboneElement[DK] måltype
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... measure ΣC1..1CodeableConceptThe parameter whose value is being tracked
Binding: LOINCCodes (example): Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... detail[x] ΣC0..1CodeableConceptThe target value to be achieved
Binding: KLMåltypeKoder (required)
..... due[x] Σ0..1Reach goal on or before
...... dueDatedate
...... dueDurationDuration
... statusDate Σ0..1dateWhen goal status took effect
... statusReason 0..1stringReason for current status
... expressedBy Σ0..1Reference(Practioner | Citizen)[DK] målAnsvarlig
... addresses 0..*Reference(Condition | MatterOfInterest)[DK] målrelateret
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... conditionRank 0..1positiveInt[DK] målrelateretRang
URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... note 0..*AnnotationComments about the goal
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... author[x] Σ0..1Individual responsible for the annotation
..... authorReferenceReference(Practitioner | Patient | RelatedPerson | Organization)
..... authorStringstring
.... time Σ0..1dateTimeWhen the annotation was made
.... text Σ1..1markdown[DK] målnotat
... outcomeCode 0..*CodeableConceptWhat result was achieved regarding the goal?
Binding: SNOMEDCTClinicalFindings (example): The result of the goal; e.g. "25% increase in shoulder mobility", "Anxiety reduced to moderate levels". "15 kg weight loss sustained over 6 months".


.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... matterOfInterestInformer 0..1CodeableConcept[DK] målvurderingsInformant
URL: http://fhir.kl.dk/core/StructureDefinition/MatterOfInterestInformer
Binding: KLKildeTilOplysningFFB (required)
.... coding Σ0..*CodingCode defined by a terminology system
.... text Σ0..1string[DK] målvurdering
... outcomeReference 0..*Reference(Observation)Observation that resulted from goal

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Goal.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Goal.extension:goalRelationship.extension:type.value[x]extensibleGoalRelationshipType
Goal.lifecycleStatusrequiredGoalLifecycleStatus
Goal.achievementStatuspreferredGoalAchievementStatus
Goal.categoryrequiredPattern: 424827b1-23aa-4848-962b-56ee47def560
Goal.prioritypreferredGoalPriority
Goal.descriptionexampleSNOMEDCTClinicalFindings
Goal.start[x]exampleGoalStartEvent
Goal.target.measureextensibleKLTargetMeasureCodes
Goal.target.detail[x]example
Goal.target:severitySlice.measureexamplePattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa
Goal.target:severitySlice.detail[x]requiredKLSeverities
Goal.target:changeValueSlice.measureexamplePattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48
Goal.target:changeValueSlice.detail[x]requiredKLChangeValueCodes
Goal.addresses.typeextensibleResourceType
Goal.outcomeCodeexampleSNOMEDCTClinicalFindings

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorGoalIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorGoalIf 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-4errorGoalIf 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-5errorGoalIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceGoalA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
gol-1errorGoal.target, Goal.target:severitySlice, Goal.target:changeValueSliceGoal.target.measure is required if Goal.target.detail is populated
: (detail.exists() and measure.exists()) or detail.exists().not()

This structure is derived from KLCommonCareSocialPurpose

Summary

Must-Support: 3 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron