STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: R3 R2

Extension: Associates the structure definition with a collection of Data Elements

(No assigned work group)

Maturity Level : 0

Context: Any

URL for this extension:


http://hl7.org/fhir/StructureDefinition/datadictionary

Status: draft. Extension maintained by: Health Level Seven, Inc. - FHIR Core WG

This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri that defines a query that identifies the collection of relevant data elements

This extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements.

For Observation: * Observation.code must be associated with a matching Data Element by DataElement.code. * The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower) * the unit and the quantity value should conform to the rules laid down in the matching Data Element

For Questionnaire: * todo.

Context of Use: Use on element: StructureDefinition

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

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/datadictionary Associates the structure definition with a collection of Data Elements: This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri that defines a query that identifies the collection of relevant data elements This extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements. For Observation: * Observation.code must be associated with a matching Data Element by DataElement.code. * The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower) * the unit and the quantity value should conform to the rules laid down in the matching Data Element For Questionnaire: * todo. Use on element: StructureDefinition
Documentation for this format

Fulle Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/datadictionary Associates the structure definition with a collection of Data Elements: This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri that defines a query that identifies the collection of relevant data elements This extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements. For Observation: * Observation.code must be associated with a matching Data Element by DataElement.code. * The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower) * the unit and the quantity value should conform to the rules laid down in the matching Data Element For Questionnaire: * todo. Use on element: StructureDefinition
extension	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/datadictionary"
valueString	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- Associates the structure definition with a collection of Data Elements -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/datadictionary" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // Associates the structure definition with a collection of Data Elements
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/datadictionary", // R! 
    "valueString" : "<string>" // R! Value of extension
  }

Summary

Name	Flags	Card.	Type	Description & Constraints
extension		0..1	string	URL = http://hl7.org/fhir/StructureDefinition/datadictionary Associates the structure definition with a collection of Data Elements: This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri that defines a query that identifies the collection of relevant data elements This extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements. For Observation: * Observation.code must be associated with a matching Data Element by DataElement.code. * The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower) * the unit and the quantity value should conform to the rules laid down in the matching Data Element For Questionnaire: * todo. Use on element: StructureDefinition
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..1	Extension	URL = http://hl7.org/fhir/StructureDefinition/datadictionary Associates the structure definition with a collection of Data Elements: This extension associates a structure definition with a data dictionary - a collection of data elements that any instance of data that conforms to the structure definition must also conform to. The value of the extension is a uri that defines a query that identifies the collection of relevant data elements This extension can be used on any structure definition that is a constraint on the resource types Observation and Questionnaire. THe profile specifies which elements are mandatory etc., but any elements in a resource that conforms to the structure definition must also conform to one of the defined data elements. For Observation: * Observation.code must be associated with a matching Data Element by DataElement.code. * The structure definition should bind Observation.code to a value set that has the same codes as the collection of data elements (though it can be narrower) * the unit and the quantity value should conform to the rules laid down in the matching Data Element For Questionnaire: * todo. Use on element: StructureDefinition
extension	0 .. 0
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/datadictionary"
valueString	1..1	string	Value of extension
Documentation for this format

XML Template

<!-- Associates the structure definition with a collection of Data Elements -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/datadictionary" >
  <!-- from Element: extension -->
 <valueString value="[string]"/><!-- 1..1 Value of extension -->
</extension>

JSON Template

{ // Associates the structure definition with a collection of Data Elements
  // from Element: extension
    "url" : "http://hl7.org/fhir/StructureDefinition/datadictionary", // R! 
    "valueString" : "<string>" // 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')]) )