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

Extension: usage

Vocabulary Work Group Maturity Level: 1InformativeUse Context: Any

Summary

Defining URL:http://hl7.org/fhir/StructureDefinition/codesystem-usage
Version:5.0.0-ballot
Name:usage
Title:null
Modifier:This extension is not a modifier extension
Status:draft
Definition:Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.
Committee:Vocabulary Work Group

Status: draft. Extension maintained by: HL7

Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.

Comment:

This is likely to be a ???point in time??? view and should not be considered an authoritative listing of all uses of the value set.

Context of Use: Use on Element ID CodeSystem

Extension Content

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. usage0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-usage
usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.


Use on Element ID CodeSystem
... user1..1stringA consumer of or client for the value set

... use1..1stringImplementation/project/standard that uses value set


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-usage
usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.


Use on Element ID CodeSystem
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:user 1..1ExtensionA consumer of or client for the value set
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:use 1..1ExtensionImplementation/project/standard that uses value set
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"use"
.... value[x] 1..1stringValue of extension
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- usage -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-usage" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="user"> I 1..1 Extension  <!-- I 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Implementation/project/standard that uses value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! A consumer of or client for the value set
    "extension" : { Extension }, // I R! Implementation/project/standard that uses value set
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-usage" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

NameFlagsCard.TypeDescription & Constraintsdoco
.. usage0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-usage
usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.


Use on Element ID CodeSystem
... user1..1stringA consumer of or client for the value set

... use1..1stringImplementation/project/standard that uses value set


doco Documentation for this format

Full Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. extension0..*ExtensionURL = http://hl7.org/fhir/StructureDefinition/codesystem-usage
usage: Consumers of the value set and the implementations, projects or standards that the author has utilized the value set in.


Use on Element ID CodeSystem
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... extension:user 1..1ExtensionA consumer of or client for the value set
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"user"
.... value[x] 1..1stringValue of extension
... extension:use 1..1ExtensionImplementation/project/standard that uses value set
.... id 0..1idUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"use"
.... value[x] 1..1stringValue of extension
... value[x] 0..0

doco Documentation for this format

XML Template

<!-- usage -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/codesystem-usage" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="user"> I 1..1 Extension  <!-- I 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
 <extension url="use"> I 1..1 Extension  <!-- I 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- I 1..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // A consumer of or client for the value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "user", // R! 
        "valueString" : "<string>" // I R! Value of extension
      },
      { // Implementation/project/standard that uses value set // I R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "use", // R! 
        "valueString" : "<string>" // I R! Value of extension
      }
    ],
    "extension" : [{ Extension }], // IAdditional content defined by implementations
    "extension" : { Extension }, // I R! A consumer of or client for the value set
    "extension" : { Extension }, // I R! Implementation/project/standard that uses value set
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-usage" // 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.