Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: alternate-reference

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/alternate-reference

Version: 5.0.0-ballot

Name: alternate-reference

Title: null

Modifier: This extension is not a modifier extension

Status: draft

Definition: Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions.

Committee: FHIR Infrastructure Work Group

Status: draft. Extension maintained by: Health Level Seven International (FHIR Infrastructure)

Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions.

Comment:

Given that a reference SHALL have a display or reference, using this extension implies that there's a display present.

Context of Use: Use on Element ID Reference

Summary

Name	Flags	Card.	Type	Description & Constraints
alternate-reference		0..1	Reference(Resource)	URL = http://hl7.org/fhir/StructureDefinition/alternate-reference alternate-reference: Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions. Use on Element ID Reference
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/alternate-reference alternate-reference: Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions. Use on Element ID Reference
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	1..1	Reference(Resource)	Value of extension
Documentation for this format

XML Template

<!-- alternate-reference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/alternate-reference" >
  <!-- from Element: extension -->
 <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>
</extension>

JSON Template

{ // alternate-reference
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/alternate-reference", // R! 
    "valueReference" : { Reference(Resource) } // I R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
alternate-reference		0..1	Reference(Resource)	URL = http://hl7.org/fhir/StructureDefinition/alternate-reference alternate-reference: Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions. Use on Element ID Reference
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/alternate-reference alternate-reference: Used when the target of the reference has a type that is not allowed by the definition of the element. In general, this should only arise when wrangling between versions using cross-version extensions. Use on Element ID Reference
extension	0..0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/alternate-reference"
value[x]	1..1	Reference(Resource)	Value of extension
Documentation for this format

XML Template

<!-- alternate-reference -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/alternate-reference" >
  <!-- from Element: extension -->
 <valueReference><!-- I 1..1 Reference(Resource) Value of extension --></valueReference>
</extension>

JSON Template

{ // alternate-reference
  // from Element: extension
    "extension" : [ //  sliced by value:url  in the specified order, Open ]
  // extension: Extension: Prohibited
    "url" : "http://hl7.org/fhir/StructureDefinition/alternate-reference", // R! 
    "valueReference" : { Reference(Resource) } // I R! Value of extension
  }

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.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.