{ "description": "Goal resource mapping for eLTSS", "_filename": "StructureDefinition-Goal-eltss.json", "package_name": "hl7.fhir.us.eltss", "date": "2019-02-17T00:00:00-05:00", "derivation": "constraint", "publisher": "HL7 International / Human and Social Services", "fhirVersion": "4.0.1", "jurisdiction": [ { "coding": [ { "code": "US", "system": "urn:iso:std:iso:3166" } ] } ], "name": "Goal_eltss", "mapping": [ { "uri": "http://unknown.org/Argonaut-DQ-DSTU2", "name": "Argonaut-DQ-DSTU2", "identity": "argonaut-dq-dstu2" }, { "uri": "http://hl7.org/v2", "name": "HL7 v2 Mapping", "identity": "v2" }, { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" }, { "uri": "http://hl7.org/fhir/fivews", "name": "FiveWs Pattern Mapping", "identity": "w5" } ], "abstract": false, "type": "Goal", "experimental": "false", "resourceType": "StructureDefinition", "title": null, "package_version": "2.0.0", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "hsswg" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 2, "_valueInteger": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/eltss/ImplementationGuide/hl7.fhir.us.eltss" } ] } }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status", "valueCode": "trial-use", "_valueCode": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/eltss/ImplementationGuide/hl7.fhir.us.eltss" } ] } } ], "snapshot": { "element": [ { "constraint": [ { "key": "dom-2", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.contained.empty()" }, { "key": "dom-3", "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", "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", "severity": "error", "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()" }, { "key": "dom-4", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "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", "severity": "error", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" }, { "key": "dom-5", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "error", "expression": "contained.meta.security.empty()" }, { "key": "dom-6", "human": "A resource should have narrative for robust management", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource", "severity": "warning", "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." } ], "expression": "text.`div`.exists()" } ], "path": "Goal", "min": 0, "definition": "The eLTSS Goal Profile is based upon the US Core FHIR Goal Resource and created to meet the 2015 Edition Common Clinical Data Set 'Goals' requirements.", "isModifier": false, "short": "Describes the intended objective(s) for a patient, group or organization", "mapping": [ { "map": "Entity. Role, or Act", "identity": "rim" }, { "map": "GOL.1", "identity": "v2" }, { "map": ".outboundRelationship[typeCode<=OBJ].", "identity": "rim" }, { "map": "Goal", "identity": "argonaut-dq-dstu2" } ], "mustSupport": false, "max": "*", "id": "Goal", "comment": "\\-", "base": { "max": "*", "min": 0, "path": "Goal" }, "isSummary": false }, { "path": "Goal.id", "min": 0, "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "isModifier": false, "short": "Logical id of this artifact", "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "id" } ] } ], "max": "1", "id": "Goal.id", "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.", "base": { "max": "1", "min": 0, "path": "Resource.id" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.meta", "min": 0, "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.", "isModifier": false, "short": "Metadata about the resource", "type": [ { "code": "Meta" } ], "max": "1", "id": "Goal.meta", "base": { "max": "1", "min": 0, "path": "Resource.meta" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.implicitRules", "min": 0, "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.", "isModifier": true, "short": "A set of rules under which this content was created", "type": [ { "code": "uri" } ], "max": "1", "id": "Goal.implicitRules", "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.", "base": { "max": "1", "min": 0, "path": "Resource.implicitRules" }, "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 }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.language", "min": 0, "definition": "The base language in which the resource is written.", "isModifier": false, "short": "Language of the resource content", "type": [ { "code": "code" } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/languages", "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" } ], "description": "A human language." }, "max": "1", "id": "Goal.language", "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).", "base": { "max": "1", "min": 0, "path": "Resource.language" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.text", "min": 0, "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.", "isModifier": false, "short": "Text summary of the resource, for human interpretation", "mapping": [ { "map": "Act.text?", "identity": "rim" } ], "type": [ { "code": "Narrative" } ], "alias": [ "narrative", "html", "xhtml", "display" ], "max": "1", "id": "Goal.text", "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.", "base": { "max": "1", "min": 0, "path": "DomainResource.text" }, "isSummary": false }, { "path": "Goal.contained", "min": 0, "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.", "isModifier": false, "short": "Contained, inline Resources", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Resource" } ], "alias": [ "inline resources", "anonymous resources", "contained resources" ], "max": "*", "id": "Goal.contained", "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.contained" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Goal.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Goal.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.", "base": { "max": "*", "min": 0, "path": "DomainResource.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Goal.modifierExtension", "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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "min": 0, "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).", "isModifier": true, "short": "Extensions that cannot be ignored", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Goal.modifierExtension", "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.", "base": { "max": "*", "min": 0, "path": "DomainResource.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.identifier", "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, "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.", "isModifier": false, "short": "External Ids for this goal", "mapping": [ { "map": "FiveWs.identifier", "identity": "w5" }, { "map": ".id", "identity": "rim" } ], "type": [ { "code": "Identifier" } ], "max": "*", "id": "Goal.identifier", "comment": "This is a business identifier, not a resource identifier (see [discussion](http://hl7.org/fhir/R4/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.", "base": { "max": "*", "min": 0, "path": "Goal.identifier" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.lifecycleStatus", "requirements": "Allows knowing whether goal needs to be further tracked.", "min": 1, "definition": "The state of the goal throughout its lifecycle.", "isModifier": true, "short": "(USCDI) proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected", "mapping": [ { "map": "FiveWs.status", "identity": "w5" }, { "map": "GOL-18-goal life cycle status", "identity": "v2" }, { "map": ".statusCode in-progress = active (classCode = OBJ) cancelled = aborted", "identity": "rim" }, { "map": "Goal.status", "identity": "argonaut-dq-dstu2" } ], "type": [ { "code": "code" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/fhir/ValueSet/goal-status" }, "max": "1", "id": "Goal.lifecycleStatus", "comment": "This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.", "base": { "max": "1", "min": 1, "path": "Goal.lifecycleStatus" }, "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 }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.achievementStatus", "min": 0, "definition": "Describes the progression, or lack thereof, towards the goal against the target.", "isModifier": false, "short": "in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable", "mapping": [ { "map": ".statusCode achieved = complete sustaining = active", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/goal-achievement", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalAchievementStatus" } ], "description": "Indicates the progression, or lack thereof, towards the goal against the target." }, "max": "1", "id": "Goal.achievementStatus", "base": { "max": "1", "min": 0, "path": "Goal.achievementStatus" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.category", "requirements": "Allows goals to be filtered and sorted.", "min": 0, "definition": "Indicates a category the goal falls within.", "isModifier": false, "short": "E.g. Treatment, dietary, behavioral, etc.", "mapping": [ { "map": "FiveWs.class", "identity": "w5" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-category", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalCategory" } ], "description": "Codes for grouping and sorting goals." }, "max": "*", "id": "Goal.category", "base": { "max": "*", "min": 0, "path": "Goal.category" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.priority", "requirements": "Used for sorting and presenting goals.", "min": 0, "definition": "Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.", "isModifier": false, "short": "high-priority | medium-priority | low-priority", "mapping": [ { "map": "FiveWs.grade", "identity": "w5" }, { "map": ".priorityCode", "identity": "rim" } ], "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "preferred", "valueSet": "http://hl7.org/fhir/ValueSet/goal-priority", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalPriority" } ], "description": "The level of importance associated with a goal." }, "max": "1", "id": "Goal.priority", "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\".", "base": { "max": "1", "min": 0, "path": "Goal.priority" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.description", "requirements": "Without a description of what's trying to be achieved, element has no purpose.", "min": 1, "definition": "A statement of a desired result that the person wants to achieve.", "isModifier": false, "short": "Goal", "mapping": [ { "map": "FiveWs.what[x]", "identity": "w5" }, { "map": "GOL-3.2-goal ID.text", "identity": "v2" }, { "map": ".text", "identity": "rim" }, { "map": "Goal.description", "identity": "argonaut-dq-dstu2" } ], "type": [ { "code": "CodeableConcept" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "binding": { "strength": "extensible", "valueSet": "http://hl7.org/fhir/us/core/ValueSet/us-core-goal-description", "description": "Value set to describe the Goal" }, "max": "1", "id": "Goal.description", "comment": "If no code is available, use CodeableConcept.text.", "base": { "max": "1", "min": 1, "path": "Goal.description" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.subject", "requirements": "Subject is optional to support annonymized reporting.", "min": 1, "definition": "Identifies the patient, group or organization for whom the goal is being established.", "isModifier": false, "short": "(USCDI) Who this goal is intended for", "mapping": [ { "map": "FiveWs.subject[x]", "identity": "w5" }, { "map": "PID-3-patient ID list", "identity": "v2" }, { "map": ".participation[typeCode=PAT].role[classCode=PAT]", "identity": "rim" }, { "map": "FiveWs.subject", "identity": "w5" }, { "map": "Goal.subject", "identity": "argonaut-dq-dstu2" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Patient-eltss" ] } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "max": "1", "id": "Goal.subject", "base": { "max": "1", "min": 1, "path": "Goal.subject" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.start[x]", "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, "definition": "The date or event after which the goal should begin being pursued.", "isModifier": false, "short": "(USCDI) When goal pursuit begins", "mapping": [ { "map": "FiveWs.planned", "identity": "w5" } ], "slicing": { "rules": "open", "ordered": false, "discriminator": [ { "path": "$this", "type": "type" } ] }, "type": [ { "code": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", "valueBoolean": true } ] }, { "code": "CodeableConcept" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/goal-start-event", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalStartEvent" } ], "description": "Codes describing events that can trigger the initiation of a goal." }, "max": "1", "id": "Goal.start[x]", "base": { "max": "1", "min": 0, "path": "Goal.start[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.start[x]", "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, "definition": "If applicable, this is the Start-date of the duration of time when the goal is due. End-date is found in dueDate", "isModifier": false, "short": "Start-date of the duration of time when the goal is due. End-date is found in dueDate", "mapping": [ { "map": "FiveWs.planned", "identity": "w5" } ], "type": [ { "code": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", "valueBoolean": true } ] } ], "mustSupport": true, "sliceName": "startDate", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "max": "1", "id": "Goal.start[x]:startDate", "base": { "max": "1", "min": 0, "path": "Goal.start[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "gol-1", "human": "Goal.target.measure is required if Goal.target.detail is populated", "xpath": "(exists(f:*[starts-with(local-name(.), 'detail')]) and exists(f:measure)) or not(exists(f:*[starts-with(local-name(.), 'detail')]))", "source": "http://hl7.org/fhir/StructureDefinition/Goal", "severity": "error", "expression": "(detail.exists() and measure.exists()) or detail.exists().not()" } ], "path": "Goal.target", "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, "definition": "Indicates what should be done by when.", "isModifier": false, "short": "(USCDI) Target outcome for the goal", "type": [ { "code": "BackboneElement" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "max": "*", "id": "Goal.target", "condition": [ "gol-1" ], "comment": "When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.", "base": { "max": "*", "min": 0, "path": "Goal.target" }, "isSummary": false }, { "path": "Goal.target.id", "min": 0, "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "isModifier": false, "short": "Unique id for inter-element referencing", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "http://hl7.org/fhirpath/System.String", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ] } ], "representation": [ "xmlAttr" ], "max": "1", "id": "Goal.target.id", "base": { "max": "1", "min": 0, "path": "Element.id" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Goal.target.extension", "min": 0, "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.", "isModifier": false, "short": "Additional content defined by implementations", "mapping": [ { "map": "n/a", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content" ], "max": "*", "id": "Goal.target.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.", "base": { "max": "*", "min": 0, "path": "Element.extension" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" }, { "key": "ext-1", "human": "Must have either extensions or value[x], not both", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension", "severity": "error", "expression": "extension.exists() != value.exists()" } ], "path": "Goal.target.modifierExtension", "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](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).", "min": 0, "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).", "isModifier": true, "short": "Extensions that cannot be ignored even if unrecognized", "mapping": [ { "map": "N/A", "identity": "rim" } ], "type": [ { "code": "Extension" } ], "alias": [ "extensions", "user content", "modifiers" ], "max": "*", "id": "Goal.target.modifierExtension", "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.", "base": { "max": "*", "min": 0, "path": "BackboneElement.modifierExtension" }, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.target.measure", "min": 0, "definition": "The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level.", "isModifier": false, "short": "The parameter whose value is being tracked", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/observation-codes", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetMeasure" } ], "description": "Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level." }, "max": "1", "id": "Goal.target.measure", "condition": [ "gol-1" ], "base": { "max": "1", "min": 0, "path": "Goal.target.measure" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.target.detail[x]", "min": 0, "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.", "isModifier": false, "short": "The target value to be achieved", "type": [ { "code": "Quantity" }, { "code": "Range" }, { "code": "CodeableConcept" }, { "code": "string" }, { "code": "boolean" }, { "code": "integer" }, { "code": "Ratio" } ], "binding": { "strength": "example", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalTargetDetail" } ], "description": "Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal." }, "max": "1", "id": "Goal.target.detail[x]", "condition": [ "gol-1" ], "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.", "base": { "max": "1", "min": 0, "path": "Goal.target.detail[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.target.due[x]", "requirements": "Identifies when the goal should be evaluated.", "min": 0, "definition": "Indicates either the date or the duration after start by which the goal should be met.", "isModifier": false, "short": "(USCDI) Reach goal on or before", "mapping": [ { "map": "FiveWs.done[x]", "identity": "w5" } ], "type": [ { "code": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", "valueBoolean": true } ] }, { "code": "Duration" } ], "mustSupport": true, "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "max": "1", "id": "Goal.target.due[x]", "base": { "max": "1", "min": 0, "path": "Goal.target.due[x]" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.statusDate", "min": 0, "definition": "Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.", "isModifier": false, "short": "When goal status took effect", "mapping": [ { "map": "FiveWs.recorded", "identity": "w5" } ], "type": [ { "code": "date" } ], "max": "1", "id": "Goal.statusDate", "comment": "To see the date for past statuses, query history.", "base": { "max": "1", "min": 0, "path": "Goal.statusDate" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.statusReason", "min": 0, "definition": "Captures the reason for the current status.", "isModifier": false, "short": "Reason for current status", "type": [ { "code": "string" } ], "max": "1", "id": "Goal.statusReason", "comment": "This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.", "base": { "max": "1", "min": 0, "path": "Goal.statusReason" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.expressedBy", "min": 0, "definition": "Indicates whose goal this is - patient goal, practitioner goal, etc.", "isModifier": false, "short": "Who's responsible for creating Goal?", "mapping": [ { "map": "FiveWs.source", "identity": "w5" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Patient-eltss", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/us/eltss/StructureDefinition/PractitionerRole-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/RelatedPerson-eltss" ] } ], "max": "1", "id": "Goal.expressedBy", "comment": "This is the individual responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).", "base": { "max": "1", "min": 0, "path": "Goal.expressedBy" }, "isSummary": true }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.addresses", "requirements": "Allows specific goals to explicitly linked to the concerns they're dealing with - makes the goal more understandable.", "min": 0, "definition": "The identified conditions and other health record elements that are intended to be addressed by the goal.", "isModifier": false, "short": "Issues addressed by this goal", "mapping": [ { "map": "FiveWs.why[x]", "identity": "w5" }, { "map": ".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]", "identity": "rim" } ], "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Condition-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/Observation-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/ServiceRequest-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/RiskAssessment-eltss", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/MedicationStatement" ] } ], "max": "*", "id": "Goal.addresses", "base": { "max": "*", "min": 0, "path": "Goal.addresses" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.note", "requirements": "There's a need to capture information about the goal that doesn't actually describe the goal.", "min": 0, "definition": "Any comments related to the goal.", "isModifier": false, "short": "Comments about the goal", "mapping": [ { "map": "GOL-16-goal evaluation + NTE?", "identity": "v2" }, { "map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value", "identity": "rim" } ], "type": [ { "code": "Annotation" } ], "max": "*", "id": "Goal.note", "comment": "May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself.", "base": { "max": "*", "min": 0, "path": "Goal.note" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.outcomeCode", "requirements": "Outcome tracking is a key aspect of care planning.", "min": 0, "definition": "Identifies the change (or lack of change) at the point when the status of the goal is assessed.", "isModifier": false, "short": "What result was achieved regarding the goal?", "type": [ { "code": "CodeableConcept" } ], "binding": { "strength": "example", "valueSet": "http://hl7.org/fhir/ValueSet/clinical-findings", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "GoalOutcome" } ], "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\"." }, "max": "*", "id": "Goal.outcomeCode", "comment": "Note that this should not duplicate the goal status.", "base": { "max": "*", "min": 0, "path": "Goal.outcomeCode" }, "isSummary": false }, { "constraint": [ { "key": "ele-1", "human": "All FHIR elements must have a @value or children", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element", "severity": "error", "expression": "hasValue() or (children().count() > id.count())" } ], "path": "Goal.outcomeReference", "requirements": "Outcome tracking is a key aspect of care planning.", "min": 0, "definition": "Details of what's changed (or not changed).", "isModifier": false, "short": "Observation that resulted from goal", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Observation" ] } ], "max": "*", "id": "Goal.outcomeReference", "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.", "base": { "max": "*", "min": 0, "path": "Goal.outcomeReference" }, "isSummary": false } ] }, "status": "active", "id": "8139ed54-d2f3-40ce-9cb1-f956ba949c6b", "kind": "resource", "url": "http://hl7.org/fhir/us/eltss/StructureDefinition/Goal-eltss", "version": "2.0.0", "differential": { "element": [ { "id": "Goal", "path": "Goal", "definition": "The eLTSS Goal Profile is based upon the US Core FHIR Goal Resource and created to meet the 2015 Edition Common Clinical Data Set 'Goals' requirements." }, { "id": "Goal.description", "path": "Goal.description", "short": "Goal", "definition": "A statement of a desired result that the person wants to achieve." }, { "id": "Goal.subject", "path": "Goal.subject", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Patient-eltss" ] } ] }, { "id": "Goal.start[x]", "path": "Goal.start[x]", "slicing": { "rules": "open", "ordered": false, "discriminator": [ { "path": "$this", "type": "type" } ] } }, { "path": "Goal.start[x]", "min": 0, "definition": "If applicable, this is the Start-date of the duration of time when the goal is due. End-date is found in dueDate", "short": "Start-date of the duration of time when the goal is due. End-date is found in dueDate", "type": [ { "code": "date", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-type-must-support", "valueBoolean": true } ] } ], "mustSupport": true, "sliceName": "startDate", "max": "1", "id": "Goal.start[x]:startDate" }, { "id": "Goal.expressedBy", "path": "Goal.expressedBy", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Patient-eltss", "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/us/eltss/StructureDefinition/PractitionerRole-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/RelatedPerson-eltss" ] } ] }, { "id": "Goal.addresses", "path": "Goal.addresses", "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/us/eltss/StructureDefinition/Condition-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/Observation-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/ServiceRequest-eltss", "http://hl7.org/fhir/us/eltss/StructureDefinition/RiskAssessment-eltss", "http://hl7.org/fhir/StructureDefinition/NutritionOrder", "http://hl7.org/fhir/StructureDefinition/MedicationStatement" ] } ] } ] }, "contact": [ { "name": "HL7 International / Human and Social Services", "telecom": [ { "value": "http://www.hl7.org/Special/committees/hsswg", "system": "url" }, { "value": "hhswg@lists.HL7.org", "system": "email" } ] } ], "baseDefinition": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal" }