R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #2). 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 : 1 Informative Use 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 ID Goal

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

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension relationship 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.


Use on Element ID Goal
. . . type 1..1 CodeableConcept Identifies what kind of relationship exists between source and target goal.

. . . target 1..1 Reference ( Goal ) The goal the relationship exists with.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.


Use on Element ID Goal
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension predecessor | successor | replacement | other
. . . . extension 0..0
. . . . url 1..1 uri "type"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GoalRelationshipType ( extensible )
. . . extension 1..1 Extension Related goal
. . . . extension 0..0
. . . . url 1..1 uri "target"
. . . . valueReference 0..1 Reference ( Goal ) Value of extension
. . . url 1..1 uri "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 order, Open 
      { // predecessor | successor | replacement | other // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Related goal // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "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 49:
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension relationship 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.


Use on Element ID Goal
. . . type 1..1 CodeableConcept Identifies what kind of relationship exists between source and target goal.

. . . target 1..1 Reference ( Goal ) The goal the relationship exists with.


doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/goal-relationship
relationship: Establishes a relationship between this goal and other goals.


Use on Element ID Goal
. . . extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension 1..1 Extension predecessor | successor | replacement | other
. . . . extension 0..0
. . . . url 1..1 uri "type"
. . . . valueCodeableConcept 0..1 CodeableConcept Value of extension
Binding: GoalRelationshipType ( extensible )
. . . extension 1..1 Extension Related goal
. . . . extension 0..0
. . . . url 1..1 uri "target"
. . . . valueReference 0..1 Reference ( Goal ) Value of extension
. . . url 1..1 uri "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 order, Open 
      { // predecessor | successor | replacement | other // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } //Value of extension
      },
      { // Related goal // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "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 49:
  }

 

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')]) )