Extension: Terminology Resource Identifier Metadata

Vocabulary Work Group

Maturity Level: 0

Trial Use

Use Context: Any

Official URL: `http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata`				Version: 5.0.0-snapshot3
draft as of 2022-08-28				Computable Name: TxResourceIdentifierMetadata
Flags: Non-Modifier				OID: 2.16.840.1.113883.4.642.5.1141

Context of Use: Use on Element ID CodeSystem.identifier, Element ID ValueSet.identifier or Element ID ConceptMap.identifier

Definition

Additional metadata in identifier elements for terminology resources.

Comment:

This represents additional metadata values which apply the identifier values in FHIR terminology resources.

Summary

Name	Card.	Type	Description & Constraints
TxResourceIdentifierMetadata	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata TxResourceIdentifierMetadata: Additional metadata in identifier elements for terminology resources. Use on Element ID CodeSystem.identifier, Element ID ValueSet.identifier or Element ID ConceptMap.identifier
preferred	0..1	boolean	Whether this an identifier that should be used
authoritative	0..1	boolean	Whether this identifier is considered to be authoritative
comment	0..1	string	Text to explain the use of the additional metadata values.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata TxResourceIdentifierMetadata: Additional metadata in identifier elements for terminology resources. Use on Element ID CodeSystem.identifier, Element ID ValueSet.identifier or Element ID ConceptMap.identifier
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:preferred	0..1	Extension	Whether this an identifier that should be used
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"preferred"
value[x]	1..1	boolean	Value of extension
extension:authoritative	0..1	Extension	Whether this identifier is considered to be authoritative
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"authoritative"
value[x]	1..1	boolean	Value of extension
extension:comment	0..1	Extension	Text to explain the use of the additional metadata values.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"comment"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"
value[x]	0..0
Documentation for this format

XML Template

<!-- TxResourceIdentifierMetadata -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="preferred"> I 0..1 Extension  <!-- I 0..1 Whether this an identifier that should be used -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="authoritative"> I 0..1 Extension  <!-- I 0..1 Whether this identifier is considered to be authoritative -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="comment"> I 0..1 Extension  <!-- I 0..1 Text to explain the use of the additional metadata values. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // TxResourceIdentifierMetadata
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Whether this an identifier that should be used // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // Whether this identifier is considered to be authoritative // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "authoritative", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // Text to explain the use of the additional metadata values. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "comment", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IWhether this an identifier that should be used
    "extension" : { Extension }, // IWhether this identifier is considered to be authoritative
    "extension" : { Extension }, // IText to explain the use of the additional metadata values.
    "url" : "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name	Card.	Type	Description & Constraints
TxResourceIdentifierMetadata	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata TxResourceIdentifierMetadata: Additional metadata in identifier elements for terminology resources. Use on Element ID CodeSystem.identifier, Element ID ValueSet.identifier or Element ID ConceptMap.identifier
preferred	0..1	boolean	Whether this an identifier that should be used
authoritative	0..1	boolean	Whether this identifier is considered to be authoritative
comment	0..1	string	Text to explain the use of the additional metadata values.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata TxResourceIdentifierMetadata: Additional metadata in identifier elements for terminology resources. Use on Element ID CodeSystem.identifier, Element ID ValueSet.identifier or Element ID ConceptMap.identifier
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:preferred	0..1	Extension	Whether this an identifier that should be used
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"preferred"
value[x]	1..1	boolean	Value of extension
extension:authoritative	0..1	Extension	Whether this identifier is considered to be authoritative
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"authoritative"
value[x]	1..1	boolean	Value of extension
extension:comment	0..1	Extension	Text to explain the use of the additional metadata values.
id	0..1	id	Unique id for inter-element referencing
extension	0..0
url	1..1	uri	"comment"
value[x]	1..1	string	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata"
value[x]	0..0
Documentation for this format

XML Template

<!-- TxResourceIdentifierMetadata -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="preferred"> I 0..1 Extension  <!-- I 0..1 Whether this an identifier that should be used -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="authoritative"> I 0..1 Extension  <!-- I 0..1 Whether this identifier is considered to be authoritative -->
  <valueBoolean value="[boolean]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="comment"> I 0..1 Extension  <!-- I 0..1 Text to explain the use of the additional metadata values. -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // TxResourceIdentifierMetadata
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Whether this an identifier that should be used // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "preferred", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // Whether this identifier is considered to be authoritative // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "authoritative", // R! 
        "valueBoolean" : <boolean> // I R! Value of extension
      },
      { // Text to explain the use of the additional metadata values. // I
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "comment", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // IWhether this an identifier that should be used
    "extension" : { Extension }, // IWhether this identifier is considered to be authoritative
    "extension" : { Extension }, // IText to explain the use of the additional metadata values.
    "url" : "http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata" // R! 
  // value[x]: Value of extension: Prohibited
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (xpath: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: hasValue() or (children().count() > id.count()))
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: extension.exists() != value.exists())
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: hasValue() or (children().count() > id.count()))
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: hasValue() or (children().count() > id.count()))

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.