FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Extension: relationship

Patient Care Work Group Maturity Level: 1InformativeUse Context: Any

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/goal-relationship

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR WG

Establishes a relationship between this goal and other goals.

Context of Use: Use on element: Goal

usage info: insert a list of places where this extension is used

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.
Use on element: Goal
... type1..1CodeableConceptIdentifies what kind of relationship exists between source and target goal.
... target1..1Reference(Goal)The goal the relationship exists with.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.
Use on element: Goal
... extension 1..1Extensionpredecessor | successor | replacement | other
.... url 1..1uri"type"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GoalRelationshipType (extensible)
... extension 1..1ExtensionRelated goal
.... url 1..1uri"target"
.... valueReference 0..1Reference(Goal)Value of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- relationship -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-relationship" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 predecessor | successor | replacement | other -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target"> 1..1 Extension  <!-- 1..1 Related goal -->
  <valueReference><!-- 0..1 Reference(Goal) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // relationship
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // predecessor | successor | replacement | other // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Related goal // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "target", // R! 
        "valueReference" : { Reference(Goal) } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-relationship", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.
Use on element: Goal
... type1..1CodeableConceptIdentifies what kind of relationship exists between source and target goal.
... target1..1Reference(Goal)The goal the relationship exists with.

doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.
Use on element: Goal
... extension 1..1Extensionpredecessor | successor | replacement | other
.... url 1..1uri"type"
.... valueCodeableConcept 0..1CodeableConceptValue of extension
Binding: GoalRelationshipType (extensible)
... extension 1..1ExtensionRelated goal
.... url 1..1uri"target"
.... valueReference 0..1Reference(Goal)Value of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/goal-relationship"
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- relationship -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/goal-relationship" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="type"> 1..1 Extension  <!-- 1..1 predecessor | successor | replacement | other -->
  <valueCodeableConcept><!-- 0..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target"> 1..1 Extension  <!-- 1..1 Related goal -->
  <valueReference><!-- 0..1 Reference(Goal) 
      Value of extension --></valueReference>
 </extension>
</extension>

JSON Template

{ // relationship
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // predecessor | successor | replacement | other // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Related goal // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "target", // R! 
        "valueReference" : { Reference(Goal) } //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-relationship", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

Constraints

  • ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
  • ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))