Generated Narrative: StructureDefinition GoalObservation Name Flags Card. Type Description & Constraints Observation <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( should-text-ref-value, should-effectiveTime, should-author )">C 1..1 Observation XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value, should-effectiveTime, should-author #xD; Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension #xD; templateId:goal-obs 1..1 II #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.121 #xD; @extension 1..1 st Required Pattern: 2022-06-01 #xD; @classCode 1..1 cs Fixed Value: OBS #xD; @moodCode 1..1 cs Fixed Value: GOL #xD; id 1..* II #xD; code 1..1 CD When the Goal is Social Determinant of Health Goal, the observation/code SHOULD contain exactly one [1..1] code, which SHOULD contain exactly one [1..1] @code="8689-2 "History of Social function #xD; text <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( should-text-ref-value )">C 0..1 ED SHOULD reference the portion of section narrative text corresponding to this entry #xD; reference <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( value-starts-octothorpe )">C 0..1 TEL Constraints: value-starts-octothorpe #xD; statusCode 1..1 CS #xD; @nullFlavor 0..0 #xD; @code 1..1 cs Binding: ActStatus (required) #xD; effectiveTime <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( should-effectiveTime )">C 0..1 IVL_TS effectiveTime/low represents when to start working on the goal. effectiveTime/high or effectiveTime/value represents when the goal should be met (i.e. a due date) #xD; Slices for value 0..1 CD, PQ, ST, AD, BL, CE, CO, CS, CV, ED, EN, II, INT, INT_POS, MO, ON, PN, REAL, SC, TEL, TN, TS, IVL_INT, IVL_PQ, IVL_TS, PIVL_TS, EIVL_TS, SXPR_TS, RTO_PQ_PQ Slice: Unordered, Open by type:$this #xD; value:coded 0..1 CD Binding Description: (example): See additional binding Additional Bindings Purpose Documentation Social Determinants of Health Goals Preferred Social Determinant of Health Goals #xD; author C 0..* AuthorParticipation If the author is the recordTarget (patient), this is a patient goal. If the author is a provider, this is a provider goal. If both patient and provider are authors, this is a negotiated goal. If no author is present, it is assumed the document or section author(s) is the author of this goal. #xD; Slices for entryRelationship 0..* EntryRelationship Slice: Unordered, Open by profile:act, profile:observation, value:typeCode #xD; entryRelationship:refersTo 0..* EntryRelationship The following entryRelationship represents the relationship between a Goal Observation and another entry (usually a Health Concern Act) (Goal Observation REFERS TO Health Concern Act) already described in the CDA document instance. Rather than clone the whole entry, an Entry Reference may be used in this entryRelationship to reference this entry. #xD; @typeCode 1..1 cs Fixed Value: REFR #xD; act 1..1 EntryReference #xD; entryRelationship:componentEntry 0..* EntryRelationship The following entryRelationship represents a planned component of the goal such as Planned Encounter (V2), Planned Procedure (V2), Planned Medication Activity (V2), Planned Supply (V2), Planned Act (V2) or Planned Immunization Activity. Because these entries are already described in the Interventions Section of the CDA document instance, rather than repeating the full content of the entries, the Entry Reference template may be used to reference the entries. #xD; @typeCode 1..1 cs Fixed Value: COMP #xD; act 1..1 EntryReference #xD; entryRelationship:priorityPreference 0..* EntryRelationship The following entryRelationship represents the priority that the patient or a provider puts on the goal. #xD; @typeCode 1..1 cs Fixed Value: REFR #xD; observation 1..1 PriorityPreference #xD; entryRelationship:goal 0..* EntryRelationship The following entryRelationship represents the relationship between two Goal Observations where the target is a component of the source (Goal Observation HAS COMPONENT Goal Observation). The component goal (target) is a Milestone. #xD; @typeCode 1..1 cs Fixed Value: COMP #xD; observation 1..1 GoalObservation #xD; entryRelationship:progressTowardGoal 0..* EntryRelationship entryRelationship #xD; @typeCode 1..1 cs Fixed Value: REFR #xD; observation 1..1 ProgressTowardGoalObservation act #xD; reference 0..* Reference Where it is necessary to reference an external clinical document such a Referral document, Discharge Summary document etc., the External Document Reference template can be used to reference this document. However, if this Care Plan document is replacing or appending another Care Plan document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument. #xD; @typeCode 1..1 cs Fixed Value: REFR #xD; externalDocument 1..1 ExternalDocumentReference #xD; Documentation for this format
HL7 International - Structured Documents
This template represents a patient health goal. A Goal Observation template may have related components that are acts, encounters, observations, procedures, substance administrations, or supplies. A goal identifies a future desired condition or state. Goals are often related to physical or mental health conditions or diseases, but also may be related to a Social Determinant of Health (SDOH) risks or states. For example, to have adequate quality meals and snacks, gain transportation security - able to access health and social needs). SDOH data relate to conditions in which people live, learn, work, and play and their effects on health risks and outcomes. A Goal is established by the patient or provider or both. A goal may be a patient or provider goal. If the author is set to the recordTarget (patient), this is a patient goal. If the author is set to a provider, this is a provider goal. If both patient and provider are set as authors, this is called a negotiated or shared goal. A goal usually has a related health concern and/or risk. A goal may have components consisting of other goals (milestones). These milestones are related to the overall goal through entryRelationships. #### Templates Used Although open templates may contain any valid CDA content, the following templates are specifically called out by this template: **Optional EntryRelationships**: [EntryReference](StructureDefinition-EntryReference.html), [GoalObservation](StructureDefinition-GoalObservation.html), [PriorityPreference](StructureDefinition-PriorityPreference.html), [ProgressTowardGoalObservation](StructureDefinition-ProgressTowardGoalObservation.html)
Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
An II instance must have either a root or an nullFlavor.
A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Identifies the type as an HL7 Registered model
A character string as a unique identifier within the scope of the identifier root.
When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
SHALL contain exactly one [1..1] @classCode="OBS" Observation (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:4515-30418).
SHALL contain exactly one [1..1] @moodCode="GOL" Goal (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:4515-30419).
SHALL contain at least one [1..*] id (CONF:4515-32332).
When the Goal is Social Determinant of Health Goal, the observation/code SHOULD contain exactly one [1..1] code, which SHOULD contain exactly one [1..1] @code="8689-2 "History of Social function
SHOULD reference the portion of section narrative text corresponding to this entry
Indicates whether the raw byte data is compressed, and what compression algorithm was used.
The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.
Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.
For character based information the language property specifies the human language of the text.
Identifies the type of the encapsulated data and identifies a method to interpret or render the data.
Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.
Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)
This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.
If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative
value.exists() implies value.startsWith('#')
An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.
Thumbnails cannot contain their own thumbnails
SHALL contain exactly one [1..1] statusCode (CONF:4515-32333).
The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
Specifies the code system that defines the code.
If applicable, a version descriptor defined specifically for the given code system.
A name or title for the code, under which the sending system shows the code value to its users.
The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
The text or phrase used as the basis for the coding.
Specifies additional codes that increase the specificity of the the primary code.
A set of other concept descriptors that translate this concept descriptor into other code systems.
effectiveTime/low represents when to start working on the goal. effectiveTime/high or effectiveTime/value represents when the goal should be met (i.e. a due date)
SHOULD contain zero or one [0..1] effectiveTime (CONF:4515-32335).
When the Goal is Social Determinant of Health Goal, the observation/value **SHOULD** be selected from ValueSet [Social Determinant of Health Goals 2.16.840.1.113762.1.4.1247.71](https://vsac.nlm.nih.gov/valueset/2.16.840.1.113762.1.4.1247.71/expansion) **DYNAMIC**.
If the author is the recordTarget (patient), this is a patient goal. If the author is a provider, this is a provider goal. If both patient and provider are authors, this is a negotiated goal. If no author is present, it is assumed the document or section author(s) is the author of this goal.
SHOULD contain zero or more [0..*] Author Participation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.119) (CONF:4515-30995).
MAY contain zero or more [0..*] entryRelationship (CONF:4515-31559) such that it
The following entryRelationship represents the relationship between a Goal Observation and another entry (usually a Health Concern Act) (Goal Observation REFERS TO Health Concern Act) already described in the CDA document instance. Rather than clone the whole entry, an Entry Reference may be used in this entryRelationship to reference this entry.
MAY contain zero or more [0..*] entryRelationship (CONF:4515-30701) such that it
SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-30702).
The entryRelationship.inversionInd can be set to "true" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.
The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at "true", whereas here the value is defaulted to "true", and can be changed to "false" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.
The following entryRelationship represents a planned component of the goal such as Planned Encounter (V2), Planned Procedure (V2), Planned Medication Activity (V2), Planned Supply (V2), Planned Act (V2) or Planned Immunization Activity. Because these entries are already described in the Interventions Section of the CDA document instance, rather than repeating the full content of the entries, the Entry Reference template may be used to reference the entries.
MAY contain zero or more [0..*] entryRelationship (CONF:4515-30704) such that it
SHALL contain exactly one [1..1] @typeCode="COMP" Has component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-30705).
The following entryRelationship represents the priority that the patient or a provider puts on the goal.
SHOULD contain zero or one [0..1] entryRelationship (CONF:4515-30785) such that it
SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-30786).
SHALL contain exactly one [1..1] Priority Preference (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.143) (CONF:4515-30787).
The following entryRelationship represents the relationship between two Goal Observations where the target is a component of the source (Goal Observation HAS COMPONENT Goal Observation). The component goal (target) is a Milestone.
MAY contain zero or more [0..*] entryRelationship (CONF:4515-31448) such that it
SHALL contain exactly one [1..1] @typeCode="COMP" Has component (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31449).
SHALL contain exactly one [1..1] Goal Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.121) (CONF:4515-32880).
MAY contain zero or more [0..*] entryRelationship such that it
SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-31560).
SHALL contain exactly one [1..1] Progress Toward Goal Observation (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.110).
Where it is necessary to reference an external clinical document such a Referral document, Discharge Summary document etc., the External Document Reference template can be used to reference this document. However, if this Care Plan document is replacing or appending another Care Plan document in the same set, that relationship is set in the header, using ClinicalDocument/relatedDocument.
MAY contain zero or more [0..*] reference (CONF:4515-32754).
The reference, if present, SHALL contain exactly one [1..1] @typeCode="REFR" Refers to (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002) (CONF:4515-32755).
The reference, if present, SHALL contain exactly one [1..1] External Document Reference (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.115:2014-06-09) (CONF:4515-32756).
Relates an Observation to the ObservationRange class, where the expected range of values for a particular observation can be specified.