FHIR Release 3 (STU) 4

This page is part of the FHIR Specification (v3.0.2: (v4.0.1: R4 - Mixed Normative and STU 3). ) in it's permanent home (it will always be available at this URL). 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 R4 R3 R2

Extension: permitted-value-conceptmap

FHIR Infrastructure Work Group   Maturity Level : 1 Informative Use Context : Any

URL for this extension: 


http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap

Status: draft. Extension maintained by: Health Level Seven International (Orders and Observations)

Expresses the linkage between the internal codes used for storage and the codes used for exchange.

Context of Use: Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options Comment :

usage info: insert The permitted value set must have a list 1..1 set of places where this codes for each code in the value meaning value set. The source for the concept map is the value set the extension appears on. The target is used the permitted-value-valueset.

Context of Use: Use on Element ID StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.answerValueSet

Extension Content

Summary

Name Flags Card. Type Description & Constraints doco
. . extension permitted-value-conceptmap 0..1 Reference canonical ( ConceptMap ) URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
permitted-value-conceptmap: Expresses the linkage between the internal codes used for storage and the codes used for exchange.


Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options Element ID StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.answerValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
permitted-value-conceptmap: Expresses the linkage between the internal codes used for storage and the codes used for exchange.


Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options Element ID StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.answerValueSet
... extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap"
. . valueReference . value[x] I 0..1 1..1 Reference canonical ( ConceptMap ) Value of extension

doco Documentation for this format

XML Template 

<!-- permitted-value-conceptmap -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" >
  <!-- from Element: extension -->
 <</valueReference>

 <valueCanonical value="[canonical]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // permitted-value-conceptmap
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", // R! 
    "

    "valueCanonical" : "<canonical>" // C? R! Value of extension

  }

Summary

Name Flags Card. Type Description & Constraints doco
. . extension permitted-value-conceptmap 0..1 Reference canonical ( ConceptMap ) URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
permitted-value-conceptmap: Expresses the linkage between the internal codes used for storage and the codes used for exchange.


Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options Element ID StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.answerValueSet

doco Documentation for this format

Full Structure

Name Flags Card. Type Description & Constraints doco
. . extension 0..1 Extension URL = http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap
permitted-value-conceptmap: Expresses the linkage between the internal codes used for storage and the codes used for exchange.


Use on element: StructureDefinition.snapshot.element.binding.valueSetReference, StructureDefinition.differential.element.binding.valueSetReference, DataElement.element.binding.valueSetReference, Questionnaire.item.options Element ID StructureDefinition.snapshot.element.binding.valueSet, Element ID StructureDefinition.differential.element.binding.valueSet or Element ID Questionnaire.item.answerValueSet
... extension I 0..0
. . . url 1..1 uri "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap"
. . valueReference . value[x] I 0..1 1..1 Reference canonical ( ConceptMap ) Value of extension

doco Documentation for this format

XML Template 

<!-- permitted-value-conceptmap -->doco

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap" >
  <!-- from Element: extension -->
 <</valueReference>

 <valueCanonical value="[canonical]"/><!-- ?? 1..1 Value of extension -->

</extension>

JSON Template 

{ // permitted-value-conceptmap
  // from Element: extension
    "
    ],

    "extension" : [ //  sliced by value:url  in the specified order, Open ]

    "url" : "http://hl7.org/fhir/StructureDefinition/11179-permitted-value-conceptmap", // R! 
    "

    "valueCanonical" : "<canonical>" // C? R! Value of extension

  }

 

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.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div )