Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Summary

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

Version: 5.0.0-ballot

Name: relationship

Title: related goal

Modifier: This extension is not a modifier extension

Status: draft

Definition: Establishes a relationship between this goal and other goals.

Committee: Patient Care Work Group

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

Summary

Name	Card.	Type	Description & Constraints
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	predecessor \| successor \| replacement \| other Binding: GoalRelationshipType (extensible): Types of relationships between two goals.
target	1..1	Reference(Goal)	Related goal
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type	1..1	Extension	predecessor \| successor \| replacement \| other
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"type"
value[x]	1..1	CodeableConcept	Value of extension Binding: GoalRelationshipType (extensible): Types of relationships between two goals.
extension:target	1..1	Extension	Related goal
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"target"
value[x]	1..1	Reference(Goal)	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/goal-relationship"
value[x]	0..0
Documentation for this format

XML Template

<!-- relationship -->

<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"> I 1..1 Extension  <!-- I 1..1 predecessor | successor | replacement | other -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Related goal -->
  <valueReference><!-- I 1..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 // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Related goal // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueReference" : { Reference(Goal) } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! predecessor | successor | replacement | other
    "extension" : { Extension }, // I R! Related goal
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-relationship" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
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	predecessor \| successor \| replacement \| other Binding: GoalRelationshipType (extensible): Types of relationships between two goals.
target	1..1	Reference(Goal)	Related goal
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
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
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:type	1..1	Extension	predecessor \| successor \| replacement \| other
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"type"
value[x]	1..1	CodeableConcept	Value of extension Binding: GoalRelationshipType (extensible): Types of relationships between two goals.
extension:target	1..1	Extension	Related goal
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"target"
value[x]	1..1	Reference(Goal)	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/goal-relationship"
value[x]	0..0
Documentation for this format

XML Template

<!-- relationship -->

<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"> I 1..1 Extension  <!-- I 1..1 predecessor | successor | replacement | other -->
  <valueCodeableConcept><!-- I 1..1 CodeableConcept Value of extension --></valueCodeableConcept>
 </extension>
 <extension url="target"> I 1..1 Extension  <!-- I 1..1 Related goal -->
  <valueReference><!-- I 1..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 // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "type", // R! 
        "valueCodeableConcept" : { CodeableConcept } // I R! Value of extension
      },
      { // Related goal // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "target", // R! 
        "valueReference" : { Reference(Goal) } // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! predecessor | successor | replacement | other
    "extension" : { Extension }, // I R! Related goal
    "url" : "http://hl7.org/fhir/StructureDefinition/goal-relationship" // R! 
  // value[x]: Value of extension: Prohibited
  }

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')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.