US Core Implementation Guide (Release 1.1.0 Ballot )
This page is part of the US Core (v1.1.0: STU2 Ballot 1) based on FHIR R3. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
Formats: Narrative, XML, JSON, Turtle
Raw xml
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="us-core-goal"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-us-core-goal-definitions.html#Goal" title="The US Core Goal Profile is based upon the core FHIR Goal Resource and created to meet the 2015 Edition Common Clinical Data Set 'Goals' requirements.">Goal</a><a name="Goal"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">0</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">*</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">US Core Goal Profile</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_primitive.png" alt="." style="background-color: white; background-color: inherit" title="Primitive Data Type" class="hierarchy"/> <a href="StructureDefinition-us-core-goal-definitions.html#Goal.status" title="Type of plan.">status</a><a name="Goal.status"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#code">code</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="font-weight:bold">Binding: </span><a href="http://hl7.org/fhir/STU3/valueset-goal-status.html">GoalStatus</a> (<a href="http://hl7.org/fhir/STU3/terminologies.html#required" title="To be conformant, the concept in this element SHALL be from the specified value set">required</a>)</td></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_datatype.gif" alt="." style="background-color: white; background-color: inherit" title="Data Type" class="hierarchy"/> <a href="StructureDefinition-us-core-goal-definitions.html#Goal.description" title="proposed | draft | active | completed | cancelled.">description</a><a name="Goal.description"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="opacity: 0.4">1</span><span style="opacity: 0.5">..</span><span style="opacity: 0.4">1</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a style="opacity: 0.4" href="http://hl7.org/fhir/STU3/datatypes.html#CodeableConcept">CodeableConcept</a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_reference.png" alt="." style="background-color: white; background-color: inherit" title="Reference to another Resource" class="hierarchy"/> <a href="StructureDefinition-us-core-goal-definitions.html#Goal.subject" title="Who care plan is for.">subject</a><a name="Goal.subject"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/STU3/references.html">Reference</a>(<a href="StructureDefinition-us-core-patient.html">US Core Patient Profile</a>)</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr> <tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/STU3/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/STU3/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div> </text> <url value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-goal"/> <version value="1.1.0"/> <name value="US Core Goal Profile"/> <status value="draft"/> <date value="2016-08-01T00:00:00+10:00"/> <publisher value="HL7 US Realm Steering Committee"/> <contact> <telecom> <system value="url"/> <value value="http://www.healthit.gov"/> </telecom> </contact> <description value="Defines constraints and extensions on the Goal resource for the minimal set of data to query and retrieve a patient's goal(s)."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> <display value="United States Minor Outlying Islands (the)"/> </coding> </jurisdiction> <fhirVersion value="3.0.1"/> <mapping> <identity value="argonaut-dq-dstu2"/> <uri value="http://unknown.org/Argonaut-DQ-DSTU2"/> <name value="Argonaut-DQ-DSTU2"/> </mapping> <mapping> <identity value="v2"/> <uri value="http://hl7.org/v2"/> <name value="HL7 v2 Mapping"/> </mapping> <mapping> <identity value="rim"/> <uri value="http://hl7.org/v3"/> <name value="RIM Mapping"/> </mapping> <mapping> <identity value="w5"/> <uri value="http://hl7.org/fhir/w5"/> <name value="W5 Mapping"/> </mapping> <kind value="resource"/> <abstract value="false"/> <type value="Goal"/> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Goal"/> <derivation value="constraint"/> <snapshot> <element id="Goal"> <path value="Goal"/> <short value="US Core Goal Profile"/> <definition value="The US Core Goal Profile is based upon the core FHIR Goal Resource and created to meet the 2015 Edition Common Clinical Data Set 'Goals' requirements."/> <comment value="Goal can be achieving a particular change or merely maintaining a current state or even slowing a decline."/> <min value="0"/> <max value="*"/> <base> <path value="Goal"/> <min value="0"/> <max value="*"/> </base> <constraint> <key value="dom-2"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources"/> <expression value="contained.contained.empty()"/> <xpath value="not(parent::f:contained and f:contained)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-1"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL NOT contain any narrative"/> <expression value="contained.text.empty()"/> <xpath value="not(parent::f:contained and f:text)"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-4"/> <severity value="error"/> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated"/> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"/> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))"/> <source value="DomainResource"/> </constraint> <constraint> <key value="dom-3"/> <severity value="error"/> <human value="If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource"/> <expression value="contained.where(('#'+id in %resource.descendants().reference).not()).empty()"/> <xpath value="not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))"/> <source value="DomainResource"/> </constraint> <mustSupport value="false"/> <mapping> <identity value="rim"/> <map value="Entity. Role, or Act"/> </mapping> <mapping> <identity value="v2"/> <map value="GOL.1"/> </mapping> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode<=OBJ]."/> </mapping> <mapping> <identity value="w5"/> <map value="clinical.careprovision"/> </mapping> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal"/> </mapping> </element> <element id="Goal.id"> <path value="Goal.id"/> <short value="Logical id of this artifact"/> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <isSummary value="true"/> </element> <element id="Goal.meta"> <path value="Goal.meta"/> <short value="Metadata about the resource"/> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.meta"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Meta"/> </type> <isSummary value="true"/> </element> <element id="Goal.implicitRules"> <path value="Goal.implicitRules"/> <short value="A set of rules under which this content was created"/> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content."/> <comment value="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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation."/> <min value="0"/> <max value="1"/> <base> <path value="Resource.implicitRules"/> <min value="0"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <isModifier value="true"/> <isSummary value="true"/> </element> <element id="Goal.language"> <path value="Goal.language"/> <short value="Language of the resource content"/> <definition value="The base language in which the resource is written."/> <comment value="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 value="0"/> <max value="1"/> <base> <path value="Resource.language"/> <min value="0"/> <max value="1"/> </base> <type> <code value="code"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueReference> <reference value="http://hl7.org/fhir/ValueSet/all-languages"/> </valueReference> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language"/> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true"/> </extension> <strength value="extensible"/> <description value="A human language."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/languages"/> </valueSetReference> </binding> </element> <element id="Goal.text"> <path value="Goal.text"/> <short value="Text summary of the resource, for human interpretation"/> <definition value="A human-readable narrative that contains a summary of the resource, and may 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 value="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 in formation is added later."/> <alias value="narrative"/> <alias value="html"/> <alias value="xhtml"/> <alias value="display"/> <min value="0"/> <max value="1"/> <base> <path value="DomainResource.text"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Narrative"/> </type> <condition value="dom-1"/> <mapping> <identity value="rim"/> <map value="Act.text?"/> </mapping> </element> <element id="Goal.contained"> <path value="Goal.contained"/> <short value="Contained, inline Resources"/> <definition value="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 value="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."/> <alias value="inline resources"/> <alias value="anonymous resources"/> <alias value="contained resources"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.contained"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Resource"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Goal.extension"> <path value="Goal.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the resource. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Goal.modifierExtension"> <path value="Goal.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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. Usually modifier elements provide negation or qualification. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="DomainResource.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Goal.identifier"> <path value="Goal.identifier"/> <short value="External Ids for this goal"/> <definition value="This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)."/> <requirements value="Need to allow connection to a wider workflow."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.identifier"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Identifier"/> </type> <mapping> <identity value="rim"/> <map value=".id"/> </mapping> <mapping> <identity value="w5"/> <map value="id"/> </mapping> </element> <element id="Goal.status"> <path value="Goal.status"/> <short value="proposed | accepted | planned | in-progress | on-target | ahead-of-target | behind-target | sustaining | achieved | on-hold | cancelled | entered-in-error | rejected"/> <definition value="Type of plan."/> <comment value="This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid."/> <requirements value="Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc."/> <min value="1"/> <max value="1"/> <base> <path value="Goal.status"/> <min value="1"/> <max value="1"/> </base> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="true"/> <isSummary value="true"/> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/goal-status"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="GOL-18-goal life cycle status"/> </mapping> <mapping> <identity value="rim"/> <map value=".statusCode in-progress = active (classCode = OBJ) achieved = complete sustaining = active (classCode=OBJC) cancelled = aborted"/> </mapping> <mapping> <identity value="w5"/> <map value="status"/> </mapping> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.status"/> </mapping> </element> <element id="Goal.category"> <path value="Goal.category"/> <short value="E.g. Treatment, dietary, behavioral, etc."/> <definition value="Indicates a category the goal falls within."/> <requirements value="Allows goals to be filtered and sorted."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.category"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalCategory"/> </extension> <strength value="example"/> <description value="Codes for grouping and sorting goals"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/goal-category"/> </valueSetReference> </binding> <mapping> <identity value="w5"/> <map value="class"/> </mapping> </element> <element id="Goal.priority"> <path value="Goal.priority"/> <short value="high-priority | medium-priority | low-priority"/> <definition value="Identifies the mutually agreed level of importance associated with reaching/sustaining the goal."/> <comment value="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) The 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 value="Used for sorting and presenting goals."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.priority"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalPriority"/> </extension> <strength value="preferred"/> <description value="The level of importance associated with a goal"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/goal-priority"/> </valueSetReference> </binding> <mapping> <identity value="rim"/> <map value=".priorityCode"/> </mapping> <mapping> <identity value="w5"/> <map value="grade"/> </mapping> </element> <element id="Goal.description"> <path value="Goal.description"/> <short value="Code or text describing goal"/> <definition value="proposed | draft | active | completed | cancelled."/> <comment value="If no code is available, use CodeableConcept.text."/> <requirements value="Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record."/> <min value="1"/> <max value="1"/> <base> <path value="Goal.description"/> <min value="1"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalDescription"/> </extension> <strength value="example"/> <description value="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."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/clinical-findings"/> </valueSetReference> </binding> <mapping> <identity value="v2"/> <map value="GOL-3.2-goal ID.text"/> </mapping> <mapping> <identity value="rim"/> <map value=".text"/> </mapping> <mapping> <identity value="w5"/> <map value="what"/> </mapping> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.description"/> </mapping> </element> <element id="Goal.subject"> <path value="Goal.subject"/> <short value="Who this goal is intended for"/> <definition value="Who care plan is for."/> <requirements value="Identifies the patient or group whose intended care is described by the plan."/> <min value="1"/> <max value="1"/> <base> <path value="Goal.subject"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <mustSupport value="true"/> <isSummary value="true"/> <mapping> <identity value="v2"/> <map value="PID-3-patient ID list"/> </mapping> <mapping> <identity value="rim"/> <map value=".participation[typeCode=PAT].role[classCode=PAT]"/> </mapping> <mapping> <identity value="w5"/> <map value="who.focus"/> </mapping> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.subject"/> </mapping> </element> <element id="Goal.start[x]"> <path value="Goal.start[x]"/> <short value="When goal pursuit begins"/> <definition value="The date or event after which the goal should begin being pursued."/> <requirements value="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 value="0"/> <max value="1"/> <base> <path value="Goal.start[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <type> <code value="CodeableConcept"/> </type> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalStartEvent"/> </extension> <strength value="example"/> <description value="Codes describing events that can trigger the initiation of a goal"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/goal-start-event"/> </valueSetReference> </binding> <mapping> <identity value="w5"/> <map value="when.planned"/> </mapping> </element> <element id="Goal.target"> <path value="Goal.target"/> <short value="Target outcome for the goal"/> <definition value="Indicates what should be done by when."/> <requirements value="Allows the progress of the goal to be monitored against an observation or due date."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.target"/> <min value="0"/> <max value="1"/> </base> <type> <code value="BackboneElement"/> </type> <condition value="gol-1"/> <constraint> <key value="ele-1"/> <severity value="error"/> <human value="All FHIR elements must have a @value or children"/> <expression value="hasValue() | (children().count() > id.count())"/> <xpath value="@value|f:*|h:div"/> <source value="Element"/> </constraint> <constraint> <key value="gol-1"/> <severity value="error"/> <human value="Goal.target.measure is required if Goal.target.detail is populated"/> <expression value="(detail.exists() and measure.exists()) or detail.exists().not()"/> <xpath value="(exists(f:*[starts-with(local-name(.), 'detail')]) and exists(f:measure)) or not(exists(f:*[starts-with(local-name(.), 'detail')]))"/> </constraint> </element> <element id="Goal.target.id"> <path value="Goal.target.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."/> <min value="0"/> <max value="1"/> <base> <path value="Element.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Goal.target.extension"> <path value="Goal.target.extension"/> <short value="Additional Content defined by implementations"/> <definition value="May be used to represent additional information that is not part of the basic definition of the element. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <min value="0"/> <max value="*"/> <base> <path value="Element.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element id="Goal.target.modifierExtension"> <path value="Goal.target.modifierExtension"/> <short value="Extensions that cannot be ignored"/> <definition value="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 that contains it. Usually modifier elements provide negation or qualification. In order 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."/> <comment value="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 value="extensions"/> <alias value="user content"/> <alias value="modifiers"/> <min value="0"/> <max value="*"/> <base> <path value="BackboneElement.modifierExtension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <isModifier value="true"/> <isSummary value="true"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element id="Goal.target.measure"> <path value="Goal.target.measure"/> <short value="The parameter whose value is being tracked"/> <definition value="The parameter whose value is being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.target.measure"/> <min value="0"/> <max value="1"/> </base> <type> <code value="CodeableConcept"/> </type> <condition value="gol-1"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalTargetMeasure"/> </extension> <strength value="example"/> <description value="Codes to identify the value being tracked, e.g. body weight, blood pressure, or hemoglobin A1c level."/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/observation-codes"/> </valueSetReference> </binding> </element> <element id="Goal.target.detail[x]"> <path value="Goal.target.detail[x]"/> <short value="The target value to be achieved"/> <definition value="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."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.target.detail[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="CodeableConcept"/> </type> <condition value="gol-1"/> <isSummary value="true"/> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalTargetDetail"/> </extension> <strength value="example"/> <description value="Codes to identify the target value of the focus to be achieved to signify the fulfillment of the goal."/> </binding> </element> <element id="Goal.target.due[x]"> <path value="Goal.target.due[x]"/> <short value="Reach goal on or before"/> <definition value="Indicates either the date or the duration after start by which the goal should be met."/> <requirements value="Identifies when the goal should be evaluated."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.target.due[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <type> <code value="Duration"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="when.done"/> </mapping> </element> <element id="Goal.statusDate"> <path value="Goal.statusDate"/> <short value="When goal status took effect"/> <definition value="Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc."/> <comment value="To see the date for past statuses, query history."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.statusDate"/> <min value="0"/> <max value="1"/> </base> <type> <code value="date"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="when.recorded"/> </mapping> </element> <element id="Goal.statusReason"> <path value="Goal.statusReason"/> <short value="Reason for current status"/> <definition value="Captures the reason for the current status."/> <comment value="This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.statusReason"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> </element> <element id="Goal.expressedBy"> <path value="Goal.expressedBy"/> <short value="Who's responsible for creating Goal?"/> <definition value="Indicates whose goal this is - patient goal, practitioner goal, etc."/> <comment value="This is the individual reponsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.)."/> <min value="0"/> <max value="1"/> <base> <path value="Goal.expressedBy"/> <min value="0"/> <max value="1"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson"/> </type> <isSummary value="true"/> <mapping> <identity value="w5"/> <map value="who.source"/> </mapping> </element> <element id="Goal.addresses"> <path value="Goal.addresses"/> <short value="Issues addressed by this goal"/> <definition value="The identified conditions and other health record elements that are intended to be addressed by the goal."/> <requirements value="Allows specific goals to explicitly linked to the concerns they're dealing with - makes the goal more understandable."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.addresses"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Condition"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/MedicationStatement"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/NutritionOrder"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/ProcedureRequest"/> </type> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RiskAssessment"/> </type> <mapping> <identity value="rim"/> <map value=".outboundRelationship[typeCode=SUBJ].target[classCode=CONC]"/> </mapping> <mapping> <identity value="w5"/> <map value="why"/> </mapping> </element> <element id="Goal.note"> <path value="Goal.note"/> <short value="Comments about the goal"/> <definition value="Any comments related to the goal."/> <comment value="May be used for progress notes, concerns or other related information that doesn't actually describe the goal itself."/> <requirements value="There's a need to capture information about the goal that doesn't actually describe the goal."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.note"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Annotation"/> </type> <mapping> <identity value="v2"/> <map value="GOL-16-goal evaluation + NTE?"/> </mapping> <mapping> <identity value="rim"/> <map value=".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value"/> </mapping> </element> <element id="Goal.outcomeCode"> <path value="Goal.outcomeCode"/> <short value="What result was achieved regarding the goal?"/> <definition value="Identifies the change (or lack of change) at the point when the status of the goal is assessed."/> <comment value="Note that this should not duplicate the goal status."/> <requirements value="Outcome tracking is a key aspect of care planning."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.outcomeCode"/> <min value="0"/> <max value="*"/> </base> <type> <code value="CodeableConcept"/> </type> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="GoalOutcome"/> </extension> <strength value="example"/> <description value="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""/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/clinical-findings"/> </valueSetReference> </binding> </element> <element id="Goal.outcomeReference"> <path value="Goal.outcomeReference"/> <short value="Observation that resulted from goal"/> <definition value="Details of what's changed (or not changed)."/> <comment value="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 value="Outcome tracking is a key aspect of care planning."/> <min value="0"/> <max value="*"/> <base> <path value="Goal.outcomeReference"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Observation"/> </type> </element> </snapshot> <differential> <element id="Goal"> <path value="Goal"/> <short value="US Core Goal Profile"/> <definition value="The US Core Goal Profile is based upon the core FHIR Goal Resource and created to meet the 2015 Edition Common Clinical Data Set 'Goals' requirements."/> <mustSupport value="false"/> <isModifier value="false"/> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal"/> </mapping> </element> <element id="Goal.status"> <path value="Goal.status"/> <definition value="Type of plan."/> <requirements value="Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc."/> <min value="1"/> <max value="1"/> <type> <code value="code"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <binding> <strength value="required"/> <valueSetReference> <reference value="http://hl7.org/fhir/ValueSet/goal-status"/> </valueSetReference> </binding> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.status"/> </mapping> </element> <element id="Goal.description"> <path value="Goal.description"/> <definition value="proposed | draft | active | completed | cancelled."/> <requirements value="Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record."/> <min value="1"/> <max value="1"/> <type> <code value="CodeableConcept"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.description"/> </mapping> </element> <element id="Goal.subject"> <path value="Goal.subject"/> <definition value="Who care plan is for."/> <requirements value="Identifies the patient or group whose intended care is described by the plan."/> <min value="1"/> <max value="1"/> <type> <code value="Reference"/> <targetProfile value="http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"/> </type> <mustSupport value="true"/> <isModifier value="false"/> <mapping> <identity value="argonaut-dq-dstu2"/> <map value="Goal.subject"/> </mapping> </element> </differential> </StructureDefinition>
US Core Version: 1.1.0 ®© FHIR Version: 3.0.1 (IG Publisher v3.0.1-11917) generated on Wed, Dec 20, 2017 12:39+1100. |
