FHIR IG Statistics: StructureDefinition/il-core-goal
Resources that use this resource
Resources that this resource uses
Narrative
No narrative content found in resource
Source
{
"resourceType": "StructureDefinition",
"id": "il-core-goal",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
}
],
"url": "http://fhir.health.gov.il/StructureDefinition/il-core-goal",
"version": "0.17.0",
"name": "ILCoreGoal",
"title": "ILCore Goal Profile",
"status": "draft",
"date": "2025-03-27",
"publisher": "Israel Core Team",
"contact": [
{
"telecom": [
{
"system": "email",
"value": "tal.primak@moh.gov.il"
}
]
}
],
"description": "Israel Core proposed constraints and extensions on the Goal Resource",
"fhirVersion": "4.0.1",
"mapping": [
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "Goal",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Goal",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "Goal",
"path": "Goal",
"short": "ILCore Goal Profile",
"definition": "Israel Core proposed constraints and extensions on the Goal resource profile.",
"comment": "Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline.",
"min": 0,
"max": "*",
"base": {
"path": "Goal",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "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()",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "v2",
"map": "GOL.1"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode<=OBJ]."
}
]
},
{
"id": "Goal.id",
"path": "Goal.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhirpath/System.String",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
]
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Goal.meta",
"path": "Goal.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true
},
{
"id": "Goal.implicitRules",
"path": "Goal.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
},
{
"id": "Goal.language",
"path": "Goal.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
}
],
"strength": "preferred",
"description": "A human language.",
"valueSet": "http://hl7.org/fhir/ValueSet/languages"
}
},
{
"id": "Goal.text",
"path": "Goal.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "Goal.contained",
"path": "Goal.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Goal.extension",
"path": "Goal.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Goal.modifierExtension",
"path": "Goal.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Goal.identifier",
"path": "Goal.identifier",
"short": "External Ids for this goal",
"definition": "Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.",
"comment": "This is a business identifier, not a resource identifier (see [discussion](resource.html#identifiers)). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number.",
"requirements": "Allows identification of the goal as it is known by various participating systems and in a way that remains consistent across servers.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "Goal.lifecycleStatus",
"path": "Goal.lifecycleStatus",
"short": "proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected",
"definition": "The state of the goal throughout its lifecycle.",
"comment": "This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.",
"requirements": "Allows knowing whether goal needs to be further tracked.",
"min": 1,
"max": "1",
"base": {
"path": "Goal.lifecycleStatus",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalLifecycleStatus"
}
],
"strength": "required",
"description": "Codes that reflect the current state of a goal and whether the goal is still being targeted.",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-status|4.0.1"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.status"
},
{
"identity": "v2",
"map": "GOL-18-goal life cycle status"
},
{
"identity": "rim",
"map": ".statusCode in-progress = active (classCode = OBJ) cancelled = aborted"
}
]
},
{
"id": "Goal.achievementStatus",
"path": "Goal.achievementStatus",
"short": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable",
"definition": "Describes the progression, or lack thereof, towards the goal against the target.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.achievementStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalAchievementStatus"
}
],
"strength": "preferred",
"description": "Indicates the progression, or lack thereof, towards the goal against the target.",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-achievement"
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode achieved = complete sustaining = active"
}
]
},
{
"id": "Goal.category",
"path": "Goal.category",
"short": "E.g. Treatment, dietary, behavioral, etc.",
"definition": "Indicates a category the goal falls within.",
"requirements": "Allows goals to be filtered and sorted.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalCategory"
}
],
"strength": "example",
"description": "Codes for grouping and sorting goals.",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-category"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.class"
}
]
},
{
"id": "Goal.priority",
"path": "Goal.priority",
"short": "high-priority | medium-priority | low-priority",
"definition": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.",
"comment": "Extensions are available to track priorities as established by each participant (i.e. Priority from the patient's perspective, different practitioners' perspectives, family member's perspectives)\r\rThe ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a \"low value=important\".",
"requirements": "Used for sorting and presenting goals.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.priority",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalPriority"
}
],
"strength": "preferred",
"description": "The level of importance associated with a goal.",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-priority"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.grade"
},
{
"identity": "rim",
"map": ".priorityCode"
}
]
},
{
"id": "Goal.description",
"path": "Goal.description",
"short": "Code or text describing goal",
"definition": "Human-readable and/or coded description of a specific desired objective of care, such as \"control blood pressure\" or \"negotiate an obstacle course\" or \"dance with child at wedding\".",
"comment": "If no code is available, use CodeableConcept.text.",
"requirements": "Without a description of what's trying to be achieved, element has no purpose.",
"min": 1,
"max": "1",
"base": {
"path": "Goal.description",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalDescription"
}
],
"strength": "example",
"description": "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.",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.what[x]"
},
{
"identity": "v2",
"map": "GOL-3.2-goal ID.text"
},
{
"identity": "rim",
"map": ".text"
}
]
},
{
"id": "Goal.subject",
"path": "Goal.subject",
"short": "Who this goal is intended for",
"definition": "Identifies the patient, group or organization for whom the goal is being established.",
"requirements": "Subject is optional to support annonymized reporting.",
"min": 1,
"max": "1",
"base": {
"path": "Goal.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-group",
"http://fhir.health.gov.il/StructureDefinition/il-core-organization"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.subject[x]"
},
{
"identity": "v2",
"map": "PID-3-patient ID list"
},
{
"identity": "rim",
"map": ".participation[typeCode=PAT].role[classCode=PAT]"
},
{
"identity": "w5",
"map": "FiveWs.subject"
}
]
},
{
"id": "Goal.start[x]",
"path": "Goal.start[x]",
"short": "When goal pursuit begins",
"definition": "The date or event after which the goal should begin being pursued.",
"requirements": "Goals can be established prior to there being an intention to start pursuing them; e.g. Goals for post-surgical recovery established prior to surgery.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.start[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
},
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalStartEvent"
}
],
"strength": "example",
"description": "Codes describing events that can trigger the initiation of a goal.",
"valueSet": "http://hl7.org/fhir/ValueSet/goal-start-event"
},
"mapping": [
{
"identity": "w5",
"map": "FiveWs.planned"
}
]
},
{
"id": "Goal.target",
"path": "Goal.target",
"short": "Target outcome for the goal",
"definition": "Indicates what should be done by when.",
"comment": "When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.",
"requirements": "Allows the progress of the goal to be monitored against an observation or due date. Target is 0..* to support Observations with multiple components, such as blood pressure goals with both a systolic and diastolic target.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.target",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"condition": [
"gol-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "gol-1",
"severity": "error",
"human": "Goal.target.measure is required if Goal.target.detail is populated",
"expression": "(detail.exists() and measure.exists()) or detail.exists().not()",
"xpath": "(exists(f:*[starts-with(local-name(.), 'detail')]) and exists(f:measure)) or not(exists(f:*[starts-with(local-name(.), 'detail')]))"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Goal.target.id",
"path": "Goal.target.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/fhirpath/System.String",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
}
]
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Goal.target.extension",
"path": "Goal.target.extension",
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Goal.target.modifierExtension",
"path": "Goal.target.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "Goal.target.measure",
"path": "Goal.target.measure",
"short": "The parameter whose value is being tracked",
"definition": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.target.measure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"condition": [
"gol-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalTargetMeasure"
}
],
"strength": "example",
"description": "Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.",
"valueSet": "http://hl7.org/fhir/ValueSet/observation-codes"
}
},
{
"id": "Goal.target.detail[x]",
"path": "Goal.target.detail[x]",
"short": "The target value to be achieved",
"definition": "The target value of the focus to be achieved to signify the fulfillment of the goal, e.g. 150 pounds, 7.0%. Either the high or low or both values of the range can be specified. When a low value is missing, it indicates that the goal is achieved at any focus value at or below the high value. Similarly, if the high value is missing, it indicates that the goal is achieved at any focus value at or above the low value.",
"comment": "A CodeableConcept with just a text would be used instead of a string if the field was usually coded, or if the type associated with the Goal.target.measure defines a coded value.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.target.detail[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "CodeableConcept"
},
{
"code": "string"
},
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "Ratio"
}
],
"condition": [
"gol-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalTargetDetail"
}
],
"strength": "example",
"description": "Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal."
}
},
{
"id": "Goal.target.due[x]",
"path": "Goal.target.due[x]",
"short": "Reach goal on or before",
"definition": "Indicates either the date or the duration after start by which the goal should be met.",
"requirements": "Identifies when the goal should be evaluated.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.target.due[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
},
{
"code": "Duration"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.done[x]"
}
]
},
{
"id": "Goal.statusDate",
"path": "Goal.statusDate",
"short": "When goal status took effect",
"definition": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.",
"comment": "To see the date for past statuses, query history.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.statusDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.recorded"
}
]
},
{
"id": "Goal.statusReason",
"path": "Goal.statusReason",
"short": "Reason for current status",
"definition": "Captures the reason for the current status.",
"comment": "This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.",
"min": 0,
"max": "1",
"base": {
"path": "Goal.statusReason",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false
},
{
"id": "Goal.expressedBy",
"path": "Goal.expressedBy",
"short": "Who's responsible for creating Goal?",
"definition": "Indicates whose goal this is - patient goal, practitioner goal, etc.",
"comment": "This is the individual responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).",
"min": 0,
"max": "1",
"base": {
"path": "Goal.expressedBy",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner",
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner-role",
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-related-person"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.source"
}
]
},
{
"id": "Goal.addresses",
"path": "Goal.addresses",
"short": "Issues addressed by this goal",
"definition": "The identified conditions and other health record elements that are intended to be addressed by the goal.",
"requirements": "Allows specific goals to explicitly linked to the concerns they're dealing with - makes the goal more understandable.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.addresses",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-condition",
"http://fhir.health.gov.il/StructureDefinition/il-core-observation",
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-statement",
"http://fhir.health.gov.il/StructureDefinition/il-core-nutrition-order",
"http://fhir.health.gov.il/StructureDefinition/il-core-service-request",
"http://fhir.health.gov.il/StructureDefinition/il-core-risk-assessment"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.why[x]"
},
{
"identity": "rim",
"map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"
}
]
},
{
"id": "Goal.note",
"path": "Goal.note",
"short": "Comments about the goal",
"definition": "Any comments related to the goal.",
"comment": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.",
"requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.note",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Annotation"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "v2",
"map": "GOL-16-goal evaluation + NTE?"
},
{
"identity": "rim",
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value"
}
]
},
{
"id": "Goal.outcomeCode",
"path": "Goal.outcomeCode",
"short": "What result was achieved regarding the goal?",
"definition": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.",
"comment": "Note that this should not duplicate the goal status.",
"requirements": "Outcome tracking is a key aspect of care planning.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.outcomeCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "GoalOutcome"
}
],
"strength": "example",
"description": "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\".",
"valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings"
}
},
{
"id": "Goal.outcomeReference",
"path": "Goal.outcomeReference",
"short": "Observation that resulted from goal",
"definition": "Details of what's changed (or not changed).",
"comment": "The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan’s activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured.",
"requirements": "Outcome tracking is a key aspect of care planning.",
"min": 0,
"max": "*",
"base": {
"path": "Goal.outcomeReference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-observation"
]
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false
}
]
},
"differential": {
"element": [
{
"id": "Goal",
"path": "Goal",
"short": "ILCore Goal Profile",
"definition": "Israel Core proposed constraints and extensions on the Goal resource profile."
},
{
"id": "Goal.subject",
"path": "Goal.subject",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-group",
"http://fhir.health.gov.il/StructureDefinition/il-core-organization"
]
}
]
},
{
"id": "Goal.expressedBy",
"path": "Goal.expressedBy",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner",
"http://fhir.health.gov.il/StructureDefinition/il-core-practitioner-role",
"http://fhir.health.gov.il/StructureDefinition/il-core-patient",
"http://fhir.health.gov.il/StructureDefinition/il-core-related-person"
]
}
]
},
{
"id": "Goal.addresses",
"path": "Goal.addresses",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-condition",
"http://fhir.health.gov.il/StructureDefinition/il-core-observation",
"http://fhir.health.gov.il/StructureDefinition/il-core-medication-statement",
"http://fhir.health.gov.il/StructureDefinition/il-core-nutrition-order",
"http://fhir.health.gov.il/StructureDefinition/il-core-service-request",
"http://fhir.health.gov.il/StructureDefinition/il-core-risk-assessment"
]
}
]
},
{
"id": "Goal.outcomeReference",
"path": "Goal.outcomeReference",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://fhir.health.gov.il/StructureDefinition/il-core-observation"
]
}
]
}
]
}
}
FHIR