Extensions for Using Data Elements from FHIR R4 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_Goal_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-Goal Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_Goal_R4B

This cross-version profile allows R4 Goal content to be represented via FHIR R4B Goal resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... lifecycleStatus ?!Σ 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.
... subject Σ 1..1 Reference(Patient | Group | Organization) Who this goal is intended for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.lifecycleStatus Base required GoalLifecycleStatus 📍4.3.0 FHIR Std.
Goal.description Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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 Goal.implicitRules, Goal.modifierExtension, Goal.lifecycleStatus, Goal.description, Goal.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) Describes the intended objective(s) for a patient, group or organization

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier External Ids for this goal
... lifecycleStatus ?!Σ 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 Σ 0..* CodeableConcept E.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.
... priority Σ 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.
... description Σ 1..1 CodeableConcept Code or text describing goal
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 Σ 1..1 Reference(Patient | Group | Organization) Who this goal is intended for
... 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
... target C 0..* BackboneElement Target outcome for the goal
Constraints: gol-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... measure ΣC 0..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.
.... detail[x] ΣC 0..1 The target value to be achieved
Binding Description: (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
... statusDate Σ 0..1 date When goal status took effect
... statusReason 0..1 string Reason for current status
... expressedBy Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who's responsible for creating Goal?
... addresses 0..* Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) Issues addressed by this goal
... note 0..* Annotation Comments about the goal
... 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".
... outcomeReference 0..* Reference(Observation) Observation that resulted from goal

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Goal.lifecycleStatus Base required GoalLifecycleStatus 📍4.3.0 FHIR Std.
Goal.achievementStatus Base preferred GoalAchievementStatus 📍4.3.0 FHIR Std.
Goal.category Base example GoalCategory 📍4.3.0 FHIR Std.
Goal.priority Base preferred GoalPriority 📍4.3.0 FHIR Std.
Goal.description Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Goal.start[x] Base example GoalStartEvent 📍4.3.0 FHIR Std.
Goal.target.measure Base example LOINC Codes 📍4.3.0 FHIR Std.
Goal.target.detail[x] Base example Not State Unknown
Goal.outcomeCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Goal.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Goal.meta, Goal.implicitRules, Goal.language, Goal.text, Goal.extension, Goal.modifierExtension, Goal.identifier, Goal.lifecycleStatus, Goal.achievementStatus, Goal.category, Goal.priority, Goal.description, Goal.subject, Goal.start[x], Goal.target, Goal.target.extension, Goal.target.modifierExtension, Goal.target.measure, Goal.target.detail[x], Goal.target.due[x], Goal.statusDate, Goal.statusReason, Goal.expressedBy, Goal.addresses, Goal.note, Goal.outcomeCode, Goal.outcomeReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.extension, Goal.modifierExtension, Goal.target.extension, Goal.target.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
gol-1 error Goal.target 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 Goal

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... lifecycleStatus ?!Σ 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.
... subject Σ 1..1 Reference(Patient | Group | Organization) Who this goal is intended for

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.lifecycleStatus Base required GoalLifecycleStatus 📍4.3.0 FHIR Std.
Goal.description Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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 Goal.implicitRules, Goal.modifierExtension, Goal.lifecycleStatus, Goal.description, Goal.subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Goal

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) Describes the intended objective(s) for a patient, group or organization

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Goal 0..* Goal(4.3.0) 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier External Ids for this goal
... lifecycleStatus ?!Σ 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 Σ 0..* CodeableConcept E.g. Treatment, dietary, behavioral, etc.
Binding: GoalCategory (example): Codes for grouping and sorting goals.
... priority Σ 0..1 CodeableConcept high-priority | medium-priority | low-priority
Binding: GoalPriority (preferred): The level of importance associated with a goal.
... description Σ 1..1 CodeableConcept Code or text describing goal
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 Σ 1..1 Reference(Patient | Group | Organization) Who this goal is intended for
... 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
... target C 0..* BackboneElement Target outcome for the goal
Constraints: gol-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... measure ΣC 0..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.
.... detail[x] ΣC 0..1 The target value to be achieved
Binding Description: (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
... statusDate Σ 0..1 date When goal status took effect
... statusReason 0..1 string Reason for current status
... expressedBy Σ 0..1 Reference(Patient | Practitioner | PractitionerRole | RelatedPerson) Who's responsible for creating Goal?
... addresses 0..* Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) Issues addressed by this goal
... note 0..* Annotation Comments about the goal
... 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".
... outcomeReference 0..* Reference(Observation) Observation that resulted from goal

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Goal.lifecycleStatus Base required GoalLifecycleStatus 📍4.3.0 FHIR Std.
Goal.achievementStatus Base preferred GoalAchievementStatus 📍4.3.0 FHIR Std.
Goal.category Base example GoalCategory 📍4.3.0 FHIR Std.
Goal.priority Base preferred GoalPriority 📍4.3.0 FHIR Std.
Goal.description Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Goal.start[x] Base example GoalStartEvent 📍4.3.0 FHIR Std.
Goal.target.measure Base example LOINC Codes 📍4.3.0 FHIR Std.
Goal.target.detail[x] Base example Not State Unknown
Goal.outcomeCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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.exists() and ('#'+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(uri) = '#').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()
dom-r4b warning Goal.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error Goal.meta, Goal.implicitRules, Goal.language, Goal.text, Goal.extension, Goal.modifierExtension, Goal.identifier, Goal.lifecycleStatus, Goal.achievementStatus, Goal.category, Goal.priority, Goal.description, Goal.subject, Goal.start[x], Goal.target, Goal.target.extension, Goal.target.modifierExtension, Goal.target.measure, Goal.target.detail[x], Goal.target.due[x], Goal.statusDate, Goal.statusReason, Goal.expressedBy, Goal.addresses, Goal.note, Goal.outcomeCode, Goal.outcomeReference All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.extension, Goal.modifierExtension, Goal.target.extension, Goal.target.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
gol-1 error Goal.target 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 Goal

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron