Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.3.0: R4B - STU ). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2

Extension: usage ValueSet Usage

Vocabulary Work Group   Maturity Level : 1 Informative Trial Use Use Context : Any
Official URL for this extension: : http://hl7.org/fhir/StructureDefinition/valueset-usage Version : 5.0.0-snapshot3
draft as of 2020-12-28 Computable Name : VS Usage
Flags : Non-Modifier OID : 2.16.840.1.113883.4.642.5.1184

Status: draft. Extension maintained by: HL7 Context of Use : Use on Element ID ValueSet

Definition

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 ValueSet

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . usage VS Usage 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-usage
usage: VS 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 ValueSet
. . . user 1..1 string This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in A consumer of or client for the usage.use. value set

. . . use 1..1 string A descriptive name of the project or standard in which the Implementation/project/standard that uses value set is used.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer 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 valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-usage
usage: VS 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 ValueSet
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:user 1..1 Extension A consumer of or client for the value set
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "user"
. . . . value[x] 1..1 string Value of extension
. . . extension:use 1..1 Extension Implementation/project/standard that uses value set
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "use"
. . . . value[x] 1..1 string Value of extension
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- usage -->

<!-- VS Usage -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-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 

{ // 

{ // VS 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/valueset-usage" // R! 
  // value[x]: Value of extension: Prohibited
  }

Summary

Name Flags Card. Type Description & Constraints doco
. . usage VS Usage 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-usage
usage: VS 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 ValueSet
. . . user 1..1 string This is most likely to be an organization but can be an individual. It would not be a program, that information should be recorded in A consumer of or client for the usage.use. value set

. . . use 1..1 string A descriptive name of the project or standard in which the Implementation/project/standard that uses value set is used.


doco Documentation for this format

Full Structure

valueBase64Binary base64Binary valueBoolean boolean valueCanonical canonical (Any) valueCode code valueDate date valueDateTime dateTime valueDecimal decimal valueId id valueInstant instant valueInteger integer 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 valueContributor Contributor valueDataRequirement DataRequirement valueExpression Expression valueParameterDefinition ParameterDefinition valueRelatedArtifact RelatedArtifact valueTriggerDefinition TriggerDefinition valueUsageContext UsageContext valueDosage Dosage
Name Flags Card. Type Description & Constraints doco
. . extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/valueset-usage
usage: VS 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 ValueSet
. . . Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
. . . extension:user 1..1 Extension A consumer of or client for the value set
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "user"
. . . . value[x] 1..1 string Value of extension
. . . extension:use 1..1 Extension Implementation/project/standard that uses value set
. . . . id 0..1 id Unique id for inter-element referencing
. . . . extension 0..0
. . . . url 1..1 uri "use"
. . . . value[x] 1..1 string Value of extension
. . . value[x] 0 .. 0

doco Documentation for this format

XML Template 

<!-- usage -->

<!-- VS Usage -->doco


<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/valueset-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 

{ // 

{ // VS 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/valueset-usage" // R! 
  // value[x]: Value of extension: Prohibited
  }

 

Constraints

  • ele-1 : All FHIR elements must have a @value or children unless an empty Parameters resource (xpath: @value|f:*|h:div|self::f:Parameters hasValue() or (children().count() > id.count()) )
  • ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div 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: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) 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]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • ele-1 : On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div hasValue() or (children().count() > id.count()) )
  • 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")]) extension.exists() != value.exists() )
  • ele-1 : On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div 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: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]) 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]: @value|f:*|h:div 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]: @value|f:*|h:div hasValue() or (children().count() > id.count()) )

Search

No Search Extensions defined for this resource

Examples of this extension

No examples found.