Standard Health Record FHIR Implementation Guide

SHR Goal Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-Goal

A broad statement about what should be accomplished for or by a patient or other subject. It represents the intended long-term outcome toward which an individual or a group aspires, and toward which, effort is directed, in the form of activities.

This profile builds on Basic.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (3 nested mandatory elements)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.careplan.Goal maps to Basic:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR Goal Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-careplan-Goal"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-core-Title-extension 0..1stringSHR Title Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Title-extension
... shr-core-Details-extension 1..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept Binding: GoalCategory (extensible)
... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
... shr-core-OccurrenceTimeOrPeriod-extension 0..1date, dateTime, PeriodSHR OccurrenceTimeOrPeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-OccurrenceTimeOrPeriod-extension
... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
.... value[x] Binding: GoalStatus (required)
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-careplan-PlannedActivities-extension 0..*(Complex)SHR PlannedActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-PlannedActivities-extension
... shr-careplan-ActualActivities-extension 0..*(Complex)SHR ActualActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-ActualActivities-extension
... shr-careplan-Goal-extension 0..*Reference(SHR Goal Profile)SHR Goal Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-Goal-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR Goal Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-core-Title-extension 0..1stringSHR Title Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Title-extension
... shr-core-Details-extension 1..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GoalCategory (extensible)
... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
... shr-core-OccurrenceTimeOrPeriod-extension 0..1date, dateTime, PeriodSHR OccurrenceTimeOrPeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-OccurrenceTimeOrPeriod-extension
... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
.... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: GoalStatus (required)
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-careplan-PlannedActivities-extension 0..*(Complex)SHR PlannedActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-PlannedActivities-extension
... shr-careplan-ActualActivities-extension 0..*(Complex)SHR ActualActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-ActualActivities-extension
... shr-careplan-Goal-extension 0..*Reference(SHR Goal Profile)SHR Goal Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-Goal-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-careplan-Goal"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Summary

Mandatory: 0 element (3 nested mandatory elements)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.careplan.Goal maps to Basic:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR Goal Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-careplan-Goal"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-core-Title-extension 0..1stringSHR Title Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Title-extension
... shr-core-Details-extension 1..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... valueCodeableConcept Binding: GoalCategory (extensible)
... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
... shr-core-OccurrenceTimeOrPeriod-extension 0..1date, dateTime, PeriodSHR OccurrenceTimeOrPeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-OccurrenceTimeOrPeriod-extension
... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
.... value[x] Binding: GoalStatus (required)
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-careplan-PlannedActivities-extension 0..*(Complex)SHR PlannedActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-PlannedActivities-extension
... shr-careplan-ActualActivities-extension 0..*(Complex)SHR ActualActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-ActualActivities-extension
... shr-careplan-Goal-extension 0..*Reference(SHR Goal Profile)SHR Goal Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-Goal-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR Goal Profile
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-base-Subject-extension 1..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-core-Title-extension 0..1stringSHR Title Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Title-extension
... shr-core-Details-extension 1..1stringSHR Details Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Details-extension
... shr-core-Reason-extension 0..*(Complex)SHR Reason Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Reason-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: GoalCategory (extensible)
... shr-action-ExpectedPerformanceTime-extension 0..1dateTime, date, Period, SHR Timing ProfileSHR ExpectedPerformanceTime Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ExpectedPerformanceTime-extension
... shr-core-OccurrenceTimeOrPeriod-extension 0..1date, dateTime, PeriodSHR OccurrenceTimeOrPeriod Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-OccurrenceTimeOrPeriod-extension
... shr-action-Status-extension 1..1code, Coding, CodeableConceptSHR Status Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-Status-extension"
.... value[x] 1..1code, Coding, CodeableConceptValue of extension
Binding: GoalStatus (required)
... shr-core-Annotation-extension 0..*SHR Annotation ProfileSHR Annotation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Annotation-extension
... shr-careplan-PlannedActivities-extension 0..*(Complex)SHR PlannedActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-PlannedActivities-extension
... shr-careplan-ActualActivities-extension 0..*(Complex)SHR ActualActivities Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-ActualActivities-extension
... shr-careplan-Goal-extension 0..*Reference(SHR Goal Profile)SHR Goal Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-careplan-Goal-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-careplan-Goal"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.extension.valueCodeableConceptGoalCategoryextensibleGoalCategory
Basic.extension.value[x]GoalStatusrequiredGoalStatus
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf 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-3BasicIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()