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: terminologyResourceIdentifierMetadata

Vocabulary Work Group

Maturity Level: 0

Informative

Use Context: Any

Summary

Defining URL: http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata

Version: 5.0.0-ballot

Name: terminologyResourceIdentifierMetadata

Title: Terminology Resource Identifier Metadata

Modifier: This extension is not a modifier extension

Status: draft

Definition: Additional metadata in identifier elements for terminology resources.

Committee: Vocabulary Work Group

Status: draft. Extension maintained by: HL7

Additional metadata in identifier elements for terminology resources.

Comment:

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

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

Summary

Name	Card.	Type	Description & Constraints
terminologyResourceIdentifierMetadata	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata terminologyResourceIdentifierMetadata: 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	Indicates whether this identifier is a 'preferred' identifier
authoritative	0..1	boolean	Indicates whether this identifier is an 'authoritative' identifier
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 terminologyResourceIdentifierMetadata: 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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- terminologyResourceIdentifierMetadata -->

<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

{ // terminologyResourceIdentifierMetadata
    "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
terminologyResourceIdentifierMetadata	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/terminology-resource-identifier-metadata terminologyResourceIdentifierMetadata: 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	Indicates whether this identifier is a 'preferred' identifier
authoritative	0..1	boolean	Indicates whether this identifier is an 'authoritative' identifier
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 terminologyResourceIdentifierMetadata: 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
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueAvailability		Availability
valueExtendedContactDetail		ExtendedContactDetail
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- terminologyResourceIdentifierMetadata -->

<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

{ // terminologyResourceIdentifierMetadata
    "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: @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.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.