FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

URL for this extension: 

http://hl7.org/fhir/StructureDefinition/codesystem-usage

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.

Context of Use: Use on element: CodeSystem

usage info: insert a list of places where this extension is used

Extension Content

Summary

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: CodeSystem
... user1..1stringThis is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
... use1..1stringA descriptive name of the project or standard in which the value set is used.

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: CodeSystem
... extension 1..1ExtensionA consumer of or client for the value set
.... url 1..1uri"user"
.... valueString 0..1stringValue of extension
... extension 1..1ExtensionImplementation/project/standard that uses value set
.... url 1..1uri"use"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-usage"
... 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"> 1..1 Extension  <!-- 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // A consumer of or client for the value set // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "user", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Implementation/project/standard that uses value set // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "use", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-usage", // R! 
// value[x]: Value of extension. One of these 38:
  }

Summary

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: CodeSystem
... user1..1stringThis is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in the usage.use.
... use1..1stringA descriptive name of the project or standard in which the value set is used.

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: CodeSystem
... extension 1..1ExtensionA consumer of or client for the value set
.... url 1..1uri"user"
.... valueString 0..1stringValue of extension
... extension 1..1ExtensionImplementation/project/standard that uses value set
.... url 1..1uri"use"
.... valueString 0..1stringValue of extension
... url 1..1uri"http://hl7.org/fhir/StructureDefinition/codesystem-usage"
... 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"> 1..1 Extension  <!-- 1..1 A consumer of or client for the value set -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
 <extension url="use"> 1..1 Extension  <!-- 1..1 Implementation/project/standard that uses value set -->
  <valueString value="[string]"/><!-- 0..1 Value of extension -->
 </extension>
</extension>

JSON Template

{ // usage
    "extension" : [ //  sliced by value:url  in the specified orderOpen
      { // A consumer of or client for the value set // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "user", // R! 
        "valueString" : "<string>" //Value of extension
      },
      { // Implementation/project/standard that uses value set // R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified orderOpen
        ],
        "url" : "use", // R! 
        "valueString" : "<string>" //Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/codesystem-usage", // R! 
// value[x]: Value of extension. One of these 38:
  }

 

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')]))