Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release
Implementation Guide for FFB messaging (FFB udvekslingsdatasæt)
1.0.0 - release
This page is part of the KLFFBMessaging (v1.0.0: Release) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://fhir.kl.dk/ffbmessaging/StructureDefinition/kl-messaging-ffb-interventionGoal | Version: 1.0.0 | |||
| Active as of 2023-08-27 | Computable Name: KLMessagingFFBInterventionGoal | |||
Goal related to an intervention for a citizen
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from KLCommonCareSocialFFBGoal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |
  lifecycleStatus | S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| category | S | 1..1 | CodeableConcept | [DK] målkategori |
| description | S | 1..1 | CodeableConcept | [DK] målbeskrivelse |
 subject | S | 1..1 | Reference(Citizen) | [DK] målSubjekt |
| target | S | 0..* | BackboneElement | Target outcome for the goal |
  target:severitySlice | S | 0..1 | BackboneElement | [DK] målSværhedsgrad |
  detail[x] | S | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) |
| target:changeValueSlice | S | 0..1 | BackboneElement | [DK] måltype |
| detail[x] | S | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) |
 addresses | S | 0..* | Reference(Condition) | [DK] målrelateret |
  extension:conditionRank | S | 0..1 | ConditionRank | ConditionRank |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB |
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |
 implicitRules | ?!Σ | 0..1 | uri | A 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..1 | Extension | Extension | |
   extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
 value[x] | 1..1 | CodeableConcept | [DK] delmålBaseretPå Binding: GoalRelationshipType (extensible): Types of relationships between two goals. | |
| extension:target | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "target" | |
| value[x] | 1..1 | Reference(Goal) | [DK] delmålBaseretPå | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-relationship" | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | 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. |
| category | SΣ | 1..1 | CodeableConcept | [DK] målkategori Binding: KLMålKategoriKoder (required) Required Pattern: At least the following |
 coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 0bb3daef-538d-45dc-b444-abdbcb63f6bc | |
| display | 1..1 | string | Representation defined by the system Fixed Value: FFB indsatsmål | |
| description | SΣ | 1..1 | CodeableConcept | [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..1 | Reference(Citizen) | [DK] målSubjekt |
 Slices for target | SC | 0..* | BackboneElement | Target outcome for the goal Slice: Unordered, Open by value:measure |
 target:All Slices | Content/Rules for all slices | |||
  modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| target:severitySlice | SC | 0..1 | BackboneElement | [DK] målSværhedsgrad |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure | ΣC | 1..1 | CodeableConcept | The 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa | |
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) |
 target:changeValueSlice | SC | 0..1 | BackboneElement | [DK] måltype |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure | ΣC | 1..1 | CodeableConcept | The 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | |
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) |
| addresses | S | 0..* | Reference(Condition) | [DK] målrelateret |
| conditionRank | S | 0..1 | positiveInt | ConditionRank URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Goal.extension:goalRelationship.extension:type.value[x] | extensible | GoalRelationshipType |
| Goal.lifecycleStatus | required | GoalLifecycleStatus |
| Goal.category | required | Pattern: 0bb3daef-538d-45dc-b444-abdbcb63f6bc("FFB indsatsmål") |
| Goal.description | example | SNOMEDCTClinicalFindings |
| Goal.target:severitySlice.measure | example | Pattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa |
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB |
| Goal.target:changeValueSlice.measure | example | Pattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 |
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Goal | 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 | error | Goal | 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 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| gol-1 | error | Goal.target, Goal.target:severitySlice, Goal.target:changeValueSlice | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension 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..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:type | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "type" | |||||
 value[x] | 1..1 | CodeableConcept | [DK] delmålBaseretPå Binding: GoalRelationshipType (extensible): Types of relationships between two goals. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: based-on | ||||
| extension:target | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "target" | |||||
| value[x] | 1..1 | Reference(Goal) | [DK] delmålBaseretPå | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-relationship" | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External Ids for this goal | |||||
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | 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..1 | CodeableConcept | in-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 | SΣ | 1..1 | CodeableConcept | [DK] målkategori Binding: KLMålKategoriKoder (required) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 0bb3daef-538d-45dc-b444-abdbcb63f6bc | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: FFB indsatsmål | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
| description | SΣ | 1..1 | CodeableConcept | [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..1 | Reference(Citizen) | [DK] målSubjekt | ||||
 start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
| startDate | date | |||||||
| startCodeableConcept | CodeableConcept | |||||||
| Slices for target | SC | 0..* | BackboneElement | Target outcome for the goal Slice: Unordered, Open by value:measure | ||||
| target:All Slices | Content/Rules for all slices | |||||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 0..1 | CodeableConcept | [DK] målemetode Binding: KLTypeAfObservationPåMål (extensible) | ||||
| detail[x] | ΣC | 0..1 | The 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. | |||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| detailString | string | |||||||
| detailBoolean | boolean | |||||||
| detailInteger | integer | |||||||
| detailRatio | Ratio | |||||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| target:severitySlice | SC | 0..1 | BackboneElement | [DK] målSværhedsgrad | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 1..1 | CodeableConcept | The 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) | ||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| target:changeValueSlice | SC | 0..1 | BackboneElement | [DK] måltype | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 1..1 | CodeableConcept | The 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) | ||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| statusDate | Σ | 0..1 | date | When goal status took effect | ||||
| statusReason | 0..1 | string | Reason for current status | |||||
| expressedBy | Σ | 0..1 | Reference(Practioner | Citizen) | [DK] målAnsvarlig | ||||
| addresses | S | 0..* | Reference(Condition) | [DK] målrelateret | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| conditionRank | S | 0..1 | positiveInt | ConditionRank URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| note | 0..* | Annotation | Comments about the goal | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | [DK] målnotat | ||||
| outcomeCode | 0..* | CodeableConcept | What 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..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| matterOfInterestInformer | 0..1 | CodeableConcept | [DK] målvurderingsInformant URL: http://fhir.kl.dk/core/StructureDefinition/MatterOfInterestInformer Binding: KLKildeTilOplysningFFB (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | [DK] målvurdering | ||||
| outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Goal.language | preferred | CommonLanguages
| ||||
| Goal.extension:goalRelationship.extension:type.value[x] | extensible | GoalRelationshipType | ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
| Goal.category | required | Pattern: 0bb3daef-538d-45dc-b444-abdbcb63f6bc("FFB indsatsmål") | ||||
| Goal.priority | preferred | GoalPriority | ||||
| Goal.description | example | SNOMEDCTClinicalFindings | ||||
| Goal.start[x] | example | GoalStartEvent | ||||
| Goal.target.measure | extensible | KLTargetMeasureCodes | ||||
| Goal.target.detail[x] | example | |||||
| Goal.target:severitySlice.measure | example | Pattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa | ||||
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB | ||||
| Goal.target:changeValueSlice.measure | example | Pattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | ||||
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB | ||||
| Goal.addresses.type | extensible | ResourceType | ||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Goal | 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 | error | Goal | 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 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| gol-1 | error | Goal.target, Goal.target:severitySlice, Goal.target:changeValueSlice | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() |
This structure is derived from KLCommonCareSocialFFBGoal
Differential View
This structure is derived from KLCommonCareSocialFFBGoal
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |
| lifecycleStatus | S | 1..1 | code | proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected |
| category | S | 1..1 | CodeableConcept | [DK] målkategori |
| description | S | 1..1 | CodeableConcept | [DK] målbeskrivelse |
| subject | S | 1..1 | Reference(Citizen) | [DK] målSubjekt |
| target | S | 0..* | BackboneElement | Target outcome for the goal |
| target:severitySlice | S | 0..1 | BackboneElement | [DK] målSværhedsgrad |
| detail[x] | S | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) |
| target:changeValueSlice | S | 0..1 | BackboneElement | [DK] måltype |
| detail[x] | S | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) |
| addresses | S | 0..* | Reference(Condition) | [DK] målrelateret |
| extension:conditionRank | S | 0..1 | ConditionRank | ConditionRank |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB |
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |
| implicitRules | ?!Σ | 0..1 | uri | A 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..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "type" | |
| value[x] | 1..1 | CodeableConcept | [DK] delmålBaseretPå Binding: GoalRelationshipType (extensible): Types of relationships between two goals. | |
| extension:target | 1..1 | Extension | Extension | |
| extension | 0..0 | |||
| url | 1..1 | uri | "target" | |
| value[x] | 1..1 | Reference(Goal) | [DK] delmålBaseretPå | |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-relationship" | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | 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. |
| category | SΣ | 1..1 | CodeableConcept | [DK] målkategori Binding: KLMålKategoriKoder (required) Required Pattern: At least the following |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 0bb3daef-538d-45dc-b444-abdbcb63f6bc | |
| display | 1..1 | string | Representation defined by the system Fixed Value: FFB indsatsmål | |
| description | SΣ | 1..1 | CodeableConcept | [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..1 | Reference(Citizen) | [DK] målSubjekt |
| Slices for target | SC | 0..* | BackboneElement | Target outcome for the goal Slice: Unordered, Open by value:measure |
| target:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| target:severitySlice | SC | 0..1 | BackboneElement | [DK] målSværhedsgrad |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure | ΣC | 1..1 | CodeableConcept | The 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa | |
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) |
| target:changeValueSlice | SC | 0..1 | BackboneElement | [DK] måltype |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| measure | ΣC | 1..1 | CodeableConcept | The 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 |
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | |
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) |
| addresses | S | 0..* | Reference(Condition) | [DK] målrelateret |
| conditionRank | S | 0..1 | positiveInt | ConditionRank URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Goal.extension:goalRelationship.extension:type.value[x] | extensible | GoalRelationshipType |
| Goal.lifecycleStatus | required | GoalLifecycleStatus |
| Goal.category | required | Pattern: 0bb3daef-538d-45dc-b444-abdbcb63f6bc("FFB indsatsmål") |
| Goal.description | example | SNOMEDCTClinicalFindings |
| Goal.target:severitySlice.measure | example | Pattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa |
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB |
| Goal.target:changeValueSlice.measure | example | Pattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 |
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Goal | 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 | error | Goal | 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 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| gol-1 | error | Goal.target, Goal.target:severitySlice, Goal.target:changeValueSlice | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Goal | 0..* | KLCommonCareSocialFFBGoal | Describes the intended objective(s) for a patient, group or organization | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension 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..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| extension:type | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "type" | |||||
| value[x] | 1..1 | CodeableConcept | [DK] delmålBaseretPå Binding: GoalRelationshipType (extensible): Types of relationships between two goals. | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept Required Pattern: based-on | ||||
| extension:target | 1..1 | Extension | Extension | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "target" | |||||
| value[x] | 1..1 | Reference(Goal) | [DK] delmålBaseretPå | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/goal-relationship" | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | External Ids for this goal | |||||
| lifecycleStatus | ?!SΣ | 1..1 | code | proposed | 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..1 | CodeableConcept | in-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 | SΣ | 1..1 | CodeableConcept | [DK] målkategori Binding: KLMålKategoriKoder (required) Required Pattern: At least the following | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 0bb3daef-538d-45dc-b444-abdbcb63f6bc | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: FFB indsatsmål | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| priority | Σ | 0..1 | CodeableConcept | high-priority | medium-priority | low-priority Binding: GoalPriority (preferred): The level of importance associated with a goal. | ||||
| description | SΣ | 1..1 | CodeableConcept | [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..1 | Reference(Citizen) | [DK] målSubjekt | ||||
| start[x] | Σ | 0..1 | When goal pursuit begins Binding: GoalStartEvent (example): Codes describing events that can trigger the initiation of a goal. | |||||
| startDate | date | |||||||
| startCodeableConcept | CodeableConcept | |||||||
| Slices for target | SC | 0..* | BackboneElement | Target outcome for the goal Slice: Unordered, Open by value:measure | ||||
| target:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 0..1 | CodeableConcept | [DK] målemetode Binding: KLTypeAfObservationPåMål (extensible) | ||||
| detail[x] | ΣC | 0..1 | The 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. | |||||
| detailQuantity | Quantity | |||||||
| detailRange | Range | |||||||
| detailCodeableConcept | CodeableConcept | |||||||
| detailString | string | |||||||
| detailBoolean | boolean | |||||||
| detailInteger | integer | |||||||
| detailRatio | Ratio | |||||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| target:severitySlice | SC | 0..1 | BackboneElement | [DK] målSværhedsgrad | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 1..1 | CodeableConcept | The 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 66959f77-6e2a-4574-8423-3ff097f8b9fa | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLFunktionsevneniveauFFB (required) | ||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| target:changeValueSlice | SC | 0..1 | BackboneElement | [DK] måltype | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| measure | ΣC | 1..1 | CodeableConcept | The 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 | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| system | 1..1 | uri | Identity of the terminology system Fixed Value: http://fhir.kl.dk/term/CodeSystem/CareSocialCodes | |||||
| version | 0..1 | string | Version of the system - if relevant | |||||
| code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | |||||
| display | 0..1 | string | Representation defined by the system | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| detail[x] | SΣC | 0..1 | CodeableConcept | The target value to be achieved Binding: KLMåltypekoderFFB (required) | ||||
| due[x] | Σ | 0..1 | Reach goal on or before | |||||
| dueDate | date | |||||||
| dueDuration | Duration | |||||||
| statusDate | Σ | 0..1 | date | When goal status took effect | ||||
| statusReason | 0..1 | string | Reason for current status | |||||
| expressedBy | Σ | 0..1 | Reference(Practioner | Citizen) | [DK] målAnsvarlig | ||||
| addresses | S | 0..* | Reference(Condition) | [DK] målrelateret | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| conditionRank | S | 0..1 | positiveInt | ConditionRank URL: http://fhir.kl.dk/core/StructureDefinition/ConditionRank | ||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| note | 0..* | Annotation | Comments about the goal | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
| authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
| authorString | string | |||||||
| time | Σ | 0..1 | dateTime | When the annotation was made | ||||
| text | Σ | 1..1 | markdown | [DK] målnotat | ||||
| outcomeCode | 0..* | CodeableConcept | What 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..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| matterOfInterestInformer | 0..1 | CodeableConcept | [DK] målvurderingsInformant URL: http://fhir.kl.dk/core/StructureDefinition/MatterOfInterestInformer Binding: KLKildeTilOplysningFFB (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | [DK] målvurdering | ||||
| outcomeReference | 0..* | Reference(Observation) | Observation that resulted from goal | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Goal.language | preferred | CommonLanguages
| ||||
| Goal.extension:goalRelationship.extension:type.value[x] | extensible | GoalRelationshipType | ||||
| Goal.lifecycleStatus | required | GoalLifecycleStatus | ||||
| Goal.achievementStatus | preferred | GoalAchievementStatus | ||||
| Goal.category | required | Pattern: 0bb3daef-538d-45dc-b444-abdbcb63f6bc("FFB indsatsmål") | ||||
| Goal.priority | preferred | GoalPriority | ||||
| Goal.description | example | SNOMEDCTClinicalFindings | ||||
| Goal.start[x] | example | GoalStartEvent | ||||
| Goal.target.measure | extensible | KLTargetMeasureCodes | ||||
| Goal.target.detail[x] | example | |||||
| Goal.target:severitySlice.measure | example | Pattern: 66959f77-6e2a-4574-8423-3ff097f8b9fa | ||||
| Goal.target:severitySlice.detail[x] | required | KLSeveritiesFFB | ||||
| Goal.target:changeValueSlice.measure | example | Pattern: 90c48f03-f194-4b2f-ad7d-6cba1069ae48 | ||||
| Goal.target:changeValueSlice.detail[x] | required | KLChangeValueCodesFFB | ||||
| Goal.addresses.type | extensible | ResourceType | ||||
| Goal.outcomeCode | example | SNOMEDCTClinicalFindings |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Goal | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Goal | 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 | error | Goal | 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 | error | Goal | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Goal | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| gol-1 | error | Goal.target, Goal.target:severitySlice, Goal.target:changeValueSlice | Goal.target.measure is required if Goal.target.detail is populated : (detail.exists() and measure.exists()) or detail.exists().not() |
This structure is derived from KLCommonCareSocialFFBGoal
Other representations of profile: CSV, Excel, Schematron