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

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

Resource Profile: Profile_R3_Goal_R4B

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

This cross-version profile allows STU3 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
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

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.modifierExtension:status, Goal.lifecycleStatus, Goal.description, Goal.subject, Goal.subject.extension, Goal.subject.extension:subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.modifierExtension, Goal.modifierExtension:status, Goal.subject.extension, Goal.subject.extension:subject 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.text
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:status 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:detail 0..1 Range STU3: detail additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.target.detail
... expressedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expressedBy 0..1 Reference(Resource) STU3: expressedBy
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... addresses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addresses 0..* Reference(Resource) STU3: addresses
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.note
... outcomeReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:outcomeReference 0..* Reference(Resource) STU3: outcomeReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
Constraints: ext-1
... identifier 0..* Identifier External Ids for this goal
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:detail 0..1 Range STU3: detail additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.target.detail
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?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:expressedBy 0..1 Reference(Resource) STU3: expressedBy
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... addresses 0..* Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) Issues addressed by this goal
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addresses 0..1 Reference(Resource) STU3: addresses
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... 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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.note
Constraints: ext-1
.... 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 The annotation - text content (as markdown)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:outcomeReference 0..1 Reference(Resource) STU3: outcomeReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Goal.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Goal.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Goal.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Goal.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Goal.identifier.type Base extensible IdentifierType 📍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.subject.type Base extensible ResourceType 📍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.expressedBy.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Goal.addresses.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Goal.outcomeCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Goal.outcomeReference.​type Base extensible ResourceType 📍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.meta.extension, Goal.meta.extension:meta, Goal.meta.versionId, Goal.meta.lastUpdated, Goal.meta.source, Goal.meta.profile, Goal.meta.security, Goal.meta.tag, Goal.implicitRules, Goal.language, Goal.text, Goal.text.extension, Goal.text.extension:text, Goal.text.status, Goal.text.div, Goal.extension, Goal.modifierExtension, Goal.modifierExtension:status, Goal.identifier, Goal.identifier.extension, Goal.identifier.extension:identifier, Goal.identifier.use, Goal.identifier.type, Goal.identifier.system, Goal.identifier.value, Goal.identifier.period, Goal.identifier.assigner, Goal.lifecycleStatus, Goal.achievementStatus, Goal.category, Goal.priority, Goal.description, Goal.subject, Goal.subject.extension, Goal.subject.extension:subject, Goal.subject.reference, Goal.subject.type, Goal.subject.identifier, Goal.subject.display, Goal.start[x], Goal.target, Goal.target.extension, Goal.target.extension:detail, Goal.target.modifierExtension, Goal.target.measure, Goal.target.detail[x], Goal.target.due[x], Goal.statusDate, Goal.statusReason, Goal.expressedBy, Goal.expressedBy.extension, Goal.expressedBy.extension:expressedBy, Goal.expressedBy.reference, Goal.expressedBy.type, Goal.expressedBy.identifier, Goal.expressedBy.display, Goal.addresses, Goal.addresses.extension, Goal.addresses.extension:addresses, Goal.addresses.reference, Goal.addresses.type, Goal.addresses.identifier, Goal.addresses.display, Goal.note, Goal.note.extension, Goal.note.extension:note, Goal.note.author[x], Goal.note.time, Goal.note.text, Goal.outcomeCode, Goal.outcomeReference, Goal.outcomeReference.extension, Goal.outcomeReference.extension:outcomeReference, Goal.outcomeReference.reference, Goal.outcomeReference.type, Goal.outcomeReference.identifier, Goal.outcomeReference.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.meta.extension, Goal.meta.extension:meta, Goal.text.extension, Goal.text.extension:text, Goal.extension, Goal.modifierExtension, Goal.modifierExtension:status, Goal.identifier.extension, Goal.identifier.extension:identifier, Goal.subject.extension, Goal.subject.extension:subject, Goal.target.extension, Goal.target.extension:detail, Goal.target.modifierExtension, Goal.expressedBy.extension, Goal.expressedBy.extension:expressedBy, Goal.addresses.extension, Goal.addresses.extension:addresses, Goal.note.extension, Goal.note.extension:note, Goal.outcomeReference.extension, Goal.outcomeReference.extension:outcomeReference 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()
txt-1 error Goal.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Goal.text.div The narrative SHALL have some non-whitespace content htmlChecks()

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
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1

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.modifierExtension:status, Goal.lifecycleStatus, Goal.description, Goal.subject, Goal.subject.extension, Goal.subject.extension:subject All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.modifierExtension, Goal.modifierExtension:status, Goal.subject.extension, Goal.subject.extension:subject 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
... meta
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.meta
... text
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.text
... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... modifierExtension:status 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.identifier
... subject
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... target
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:detail 0..1 Range STU3: detail additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.target.detail
... expressedBy
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:expressedBy 0..1 Reference(Resource) STU3: expressedBy
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... addresses
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:addresses 0..* Reference(Resource) STU3: addresses
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
... note
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.note
... outcomeReference
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:outcomeReference 0..* Reference(Resource) STU3: outcomeReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:meta 0..1 (Complex) STU3: meta additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.meta
Constraints: ext-1
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile Σ 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:text 0..1 (Complex) STU3: text additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.text
Constraints: ext-1
.... status 1..1 code generated | extensions | additional | empty
Binding: NarrativeStatus (required)
.... div C 1..1 xhtml Limited xhtml content
Constraints: txt-1, txt-2
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... Slices for modifierExtension ?! 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... modifierExtension:status ?! 0..1 code STU3: proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected additional codes
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.status
Binding: R3GoalStatusForR4B (0.1.0) (required): Indicates whether the goal has been met and is still being targeted
Constraints: ext-1
... identifier 0..* Identifier External Ids for this goal
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:identifier 0..* Identifier STU3: identifier additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.identifier
Constraints: ext-1
.... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible)
.... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value Σ 0..1 string The value that is unique
Example General: 123456
.... period Σ 0..1 Period Time period when id is/was valid for use
.... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:subject 0..1 Reference(Resource) STU3: subject
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... 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
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:detail 0..1 Range STU3: detail additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.target.detail
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?
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:expressedBy 0..1 Reference(Resource) STU3: expressedBy
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... addresses 0..* Reference(Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment) Issues addressed by this goal
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:addresses 0..1 Reference(Resource) STU3: addresses
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... 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 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:note 0..* Annotation STU3: note additional types
URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Goal.note
Constraints: ext-1
.... 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 The annotation - text content (as markdown)
... 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
.... id 0..1 id Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:outcomeReference 0..1 Reference(Resource) STU3: outcomeReference additional types
URL: http://hl7.org/fhir/StructureDefinition/alternate-reference
Constraints: ext-1
.... 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)
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Goal.meta.security Base extensible SecurityLabels 📍4.3.0 FHIR Std.
Goal.meta.tag Base example Common Tags 📍4.3.0 FHIR Std.
Goal.language Base preferred Common Languages 📍4.3.0 FHIR Std.
Goal.text.status Base required NarrativeStatus 📍4.3.0 FHIR Std.
Goal.identifier.use Base required IdentifierUse 📍4.3.0 FHIR Std.
Goal.identifier.type Base extensible IdentifierType 📍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.subject.type Base extensible ResourceType 📍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.expressedBy.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Goal.addresses.type Base extensible ResourceType 📍4.3.0 FHIR Std.
Goal.outcomeCode Base example SNOMED CT Clinical Findings 📍4.3.0 FHIR Std.
Goal.outcomeReference.​type Base extensible ResourceType 📍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.meta.extension, Goal.meta.extension:meta, Goal.meta.versionId, Goal.meta.lastUpdated, Goal.meta.source, Goal.meta.profile, Goal.meta.security, Goal.meta.tag, Goal.implicitRules, Goal.language, Goal.text, Goal.text.extension, Goal.text.extension:text, Goal.text.status, Goal.text.div, Goal.extension, Goal.modifierExtension, Goal.modifierExtension:status, Goal.identifier, Goal.identifier.extension, Goal.identifier.extension:identifier, Goal.identifier.use, Goal.identifier.type, Goal.identifier.system, Goal.identifier.value, Goal.identifier.period, Goal.identifier.assigner, Goal.lifecycleStatus, Goal.achievementStatus, Goal.category, Goal.priority, Goal.description, Goal.subject, Goal.subject.extension, Goal.subject.extension:subject, Goal.subject.reference, Goal.subject.type, Goal.subject.identifier, Goal.subject.display, Goal.start[x], Goal.target, Goal.target.extension, Goal.target.extension:detail, Goal.target.modifierExtension, Goal.target.measure, Goal.target.detail[x], Goal.target.due[x], Goal.statusDate, Goal.statusReason, Goal.expressedBy, Goal.expressedBy.extension, Goal.expressedBy.extension:expressedBy, Goal.expressedBy.reference, Goal.expressedBy.type, Goal.expressedBy.identifier, Goal.expressedBy.display, Goal.addresses, Goal.addresses.extension, Goal.addresses.extension:addresses, Goal.addresses.reference, Goal.addresses.type, Goal.addresses.identifier, Goal.addresses.display, Goal.note, Goal.note.extension, Goal.note.extension:note, Goal.note.author[x], Goal.note.time, Goal.note.text, Goal.outcomeCode, Goal.outcomeReference, Goal.outcomeReference.extension, Goal.outcomeReference.extension:outcomeReference, Goal.outcomeReference.reference, Goal.outcomeReference.type, Goal.outcomeReference.identifier, Goal.outcomeReference.display All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Goal.meta.extension, Goal.meta.extension:meta, Goal.text.extension, Goal.text.extension:text, Goal.extension, Goal.modifierExtension, Goal.modifierExtension:status, Goal.identifier.extension, Goal.identifier.extension:identifier, Goal.subject.extension, Goal.subject.extension:subject, Goal.target.extension, Goal.target.extension:detail, Goal.target.modifierExtension, Goal.expressedBy.extension, Goal.expressedBy.extension:expressedBy, Goal.addresses.extension, Goal.addresses.extension:addresses, Goal.note.extension, Goal.note.extension:note, Goal.outcomeReference.extension, Goal.outcomeReference.extension:outcomeReference 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()
txt-1 error Goal.text.div The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes htmlChecks()
txt-2 error Goal.text.div The narrative SHALL have some non-whitespace content htmlChecks()

 

Other representations of profile: CSV, Excel, Schematron