This page is part of the FHIR Specification (v0.4.0: DSTU 2 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: R5 R4B R4 R3 R2
Introduction
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ElementDefinition | I | 0..* | Element | Definition of an elements in a resource or extension Types must be unique by the combination of code and profile Constraints must be unique by key Binding can only be present for coded elements Pattern and value are mutually exclusive Constraint names must be unique. default value and meaningWhenMissing are mutually exclusive Min <= Max Pattern may only be specified if there is one type Fixed value may only be specified if there is one type Either a namereference or a fixed value (but not both) is permitted |
path | 1..1 | string | The path of the element (see the Detailed Descriptions) | |
representation | 0..* | code | How this element is represented in instances PropertyRepresentation (Required) | |
name | 0..1 | string | Name for this particular element definition (reference target) | |
slicing | I | 0..1 | Element | This element is sliced - slices follow If there are no discriminators, there must be a definition |
discriminator | 0..* | string | Element values that used to distinguish the slices | |
description | I | 0..1 | string | Text description of how slicing works (or not) |
ordered | 0..1 | boolean | If elements must be in same order as slices | |
rules | 1..1 | code | closed | open | openAtEnd SlicingRules (Required) | |
short | 0..1 | string | Concise definition for xml presentation | |
definition | 0..1 | string | Full formal definition in human language | |
comments | 0..1 | string | Comments about the use of this element | |
requirements | 0..1 | string | Why is this needed? | |
synonym | 0..* | string | Other names | |
min | I | 0..1 | integer | Minimum Cardinality |
max | I | 0..1 | string | Maximum Cardinality (a number or *) Max SHALL be a number or "*" |
type | I | 0..* | Element | Data type and Profile for this element Aggregation may only be specified if one of the allowed types for the element is a resource |
code | 1..1 | code | Name of Data type or Resource DataType (Required) | |
profile | 0..1 | uri | Profile.structure to apply | |
aggregation | I | 0..* | code | contained | referenced | bundled - how aggregated AggregationMode (Required) |
nameReference | I | 0..1 | string | To another element constraint (by element.name) |
defaultValue[x] | I | 0..1 | * | Specified value it missing from instance |
meaningWhenMissing | I | 0..1 | string | Implicit meaning when this element is missing |
fixed[x] | I | 0..1 | * | Value must be exactly this |
pattern[x] | I | 0..1 | * | Value must have at least these property values |
example[x] | 0..1 | * | Example value: [as defined for type] | |
maxLength | 0..1 | integer | Max length for strings | |
condition | 0..* | id | Reference to invariant about presence | |
constraint | 0..* | Element | Condition that must evaluate to true | |
key | I | 1..1 | id | Target of 'condition' reference above |
name | I | 0..1 | string | Short human label |
severity | 1..1 | code | error | warning ConstraintSeverity (Required) | |
human | 1..1 | string | Human description of constraint | |
xpath | 1..1 | string | XPath expression of constraint | |
mustSupport | 0..1 | boolean | If the element must supported | |
isModifier | 0..1 | boolean | If this modifies the meaning of other elements | |
isSummary | 0..1 | boolean | Include when _summary = true? | |
binding | I | 0..1 | Element | ValueSet details if this is coded Example value sets are always extensible provide either a reference or a description (or both) |
name | 1..1 | string | Descriptive Name | |
isExtensible | I | 1..1 | boolean | Can additional codes be used? |
conformance | I | 0..1 | code | required | preferred | example BindingConformance (Required) |
description | I | 0..1 | string | Human explanation of the value set |
reference[x] | I | Source of value set uri SHALL start with http:// or https:// | ||
referenceUri | 0..1 | uri | ||
referenceReference | 0..1 | ValueSet | ||
mapping | 0..* | Element | Map element to another set of definitions | |
identity | 1..1 | id | Reference to mapping declaration | |
map | 1..1 | string | Details of the mapping |
UML Diagram
to do
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <path value="[string]"/><!-- 1..1 The path of the element (see the Detailed Descriptions) --> <representation value="[code]"/><!-- 0..* How this element is represented in instances --> <name value="[string]"/><!-- 0..1 Name for this particular element definition (reference target) --> <slicing> <!-- 0..1 This element is sliced - slices follow --> <discriminator value="[string]"/><!-- 0..* Element values that used to distinguish the slices --> <description value="[string]"/><!-- 0..1 Text description of how slicing works (or not) --> <ordered value="[boolean]"/><!-- 0..1 If elements must be in same order as slices --> <rules value="[code]"/><!-- 1..1 closed | open | openAtEnd --> </slicing> <short value="[string]"/><!-- 0..1 Concise definition for xml presentation --> <definition value="[string]"/><!-- 0..1 Full formal definition in human language --> <comments value="[string]"/><!-- 0..1 Comments about the use of this element --> <requirements value="[string]"/><!-- 0..1 Why is this needed? --> <synonym value="[string]"/><!-- 0..* Other names --> <min value="[integer]"/><!-- 0..1 Minimum Cardinality --> <max value="[string]"/><!-- 0..1 Maximum Cardinality (a number or *) --> <type> <!-- 0..* Data type and Profile for this element --> <code value="[code]"/><!-- 1..1 Name of Data type or Resource --> <profile value="[uri]"/><!-- 0..1 Profile.structure to apply --> <aggregation value="[code]"/><!-- 0..* contained | referenced | bundled - how aggregated --> </type> <nameReference value="[string]"/><!-- 0..1 To another element constraint (by element.name) --> <defaultValue[x]><!-- 0..1 * Specified value it missing from instance --></defaultValue[x]> <meaningWhenMissing value="[string]"/><!-- 0..1 Implicit meaning when this element is missing --> <fixed[x]><!-- 0..1 * Value must be exactly this --></fixed[x]> <pattern[x]><!-- 0..1 * Value must have at least these property values --></pattern[x]> <example[x]><!-- 0..1 * Example value: [as defined for type] --></example[x]> <maxLength value="[integer]"/><!-- 0..1 Max length for strings --> <condition value="[id]"/><!-- 0..* Reference to invariant about presence --> <constraint> <!-- 0..* Condition that must evaluate to true --> <key value="[id]"/><!-- 1..1 Target of 'condition' reference above --> <name value="[string]"/><!-- 0..1 Short human label --> <severity value="[code]"/><!-- 1..1 error | warning --> <human value="[string]"/><!-- 1..1 Human description of constraint --> <xpath value="[string]"/><!-- 1..1 XPath expression of constraint --> </constraint> <mustSupport value="[boolean]"/><!-- 0..1 If the element must supported --> <isModifier value="[boolean]"/><!-- 0..1 If this modifies the meaning of other elements --> <isSummary value="[boolean]"/><!-- 0..1 Include when _summary = true? --> <binding> <!-- 0..1 ValueSet details if this is coded --> <name value="[string]"/><!-- 1..1 Descriptive Name --> <isExtensible value="[boolean]"/><!-- 1..1 Can additional codes be used? --> <conformance value="[code]"/><!-- 0..1 required | preferred | example --> <description value="[string]"/><!-- 0..1 Human explanation of the value set --> <reference[x]><!-- 0..1 uri|Reference(ValueSet) Source of value set --></reference[x]> </binding> <mapping> <!-- 0..* Map element to another set of definitions --> <identity value="[id]"/><!-- 1..1 Reference to mapping declaration --> <map value="[string]"/><!-- 1..1 Details of the mapping --> </mapping> </[name]>
JSON Template
{ // from Element: extension "path" : "<string>", // R! The path of the element (see the Detailed Descriptions) "representation" : ["<code>"], // How this element is represented in instances "name" : "<string>", // Name for this particular element definition (reference target) "slicing" : { // This element is sliced - slices follow "discriminator" : ["<string>"], // Element values that used to distinguish the slices "description" : "<string>", // C? Text description of how slicing works (or not) "ordered" : <boolean>, // If elements must be in same order as slices "rules" : "<code>" // R! closed | open | openAtEnd }, "short" : "<string>", // Concise definition for xml presentation "definition" : "<string>", // Full formal definition in human language "comments" : "<string>", // Comments about the use of this element "requirements" : "<string>", // Why is this needed? "synonym" : ["<string>"], // Other names "min" : <integer>, // C? Minimum Cardinality "max" : "<string>", // C? Maximum Cardinality (a number or *) "type" : [{ // C? Data type and Profile for this element "code" : "<code>", // R! Name of Data type or Resource "profile" : "<uri>", // Profile.structure to apply "aggregation" : ["<code>"] // C? contained | referenced | bundled - how aggregated }], "nameReference" : "<string>", // C? To another element constraint (by element.name) // defaultValue[x]: Specified value it missing from instance. One of these 23: "defaultValueInteger" : <integer>, "defaultValueDecimal" : <decimal>, "defaultValueDateTime" : "<dateTime>", "defaultValueDate" : "<date>", "defaultValueInstant" : "<instant>", "defaultValueString" : "<string>", "defaultValueUri" : "<uri>", "defaultValueBoolean" : <boolean>, "defaultValueCode" : "<code>", "defaultValueBase64Binary" : "<base64Binary>", "defaultValueCoding" : { Coding }, "defaultValueCodeableConcept" : { CodeableConcept }, "defaultValueAttachment" : { Attachment }, "defaultValueIdentifier" : { Identifier }, "defaultValueQuantity" : { Quantity }, "defaultValueRange" : { Range }, "defaultValuePeriod" : { Period }, "defaultValueRatio" : { Ratio }, "defaultValueHumanName" : { HumanName }, "defaultValueAddress" : { Address }, "defaultValueContact" : { Contact }, "defaultValueSchedule" : { Schedule }, "defaultValueReference" : { Reference }, "meaningWhenMissing" : "<string>", // C? Implicit meaning when this element is missing // fixed[x]: Value must be exactly this. One of these 23: "fixedInteger" : <integer>, "fixedDecimal" : <decimal>, "fixedDateTime" : "<dateTime>", "fixedDate" : "<date>", "fixedInstant" : "<instant>", "fixedString" : "<string>", "fixedUri" : "<uri>", "fixedBoolean" : <boolean>, "fixedCode" : "<code>", "fixedBase64Binary" : "<base64Binary>", "fixedCoding" : { Coding }, "fixedCodeableConcept" : { CodeableConcept }, "fixedAttachment" : { Attachment }, "fixedIdentifier" : { Identifier }, "fixedQuantity" : { Quantity }, "fixedRange" : { Range }, "fixedPeriod" : { Period }, "fixedRatio" : { Ratio }, "fixedHumanName" : { HumanName }, "fixedAddress" : { Address }, "fixedContact" : { Contact }, "fixedSchedule" : { Schedule }, "fixedReference" : { Reference }, // pattern[x]: Value must have at least these property values. One of these 23: "patternInteger" : <integer>, "patternDecimal" : <decimal>, "patternDateTime" : "<dateTime>", "patternDate" : "<date>", "patternInstant" : "<instant>", "patternString" : "<string>", "patternUri" : "<uri>", "patternBoolean" : <boolean>, "patternCode" : "<code>", "patternBase64Binary" : "<base64Binary>", "patternCoding" : { Coding }, "patternCodeableConcept" : { CodeableConcept }, "patternAttachment" : { Attachment }, "patternIdentifier" : { Identifier }, "patternQuantity" : { Quantity }, "patternRange" : { Range }, "patternPeriod" : { Period }, "patternRatio" : { Ratio }, "patternHumanName" : { HumanName }, "patternAddress" : { Address }, "patternContact" : { Contact }, "patternSchedule" : { Schedule }, "patternReference" : { Reference }, // example[x]: Example value: [as defined for type]. One of these 23: "exampleInteger" : <integer>, "exampleDecimal" : <decimal>, "exampleDateTime" : "<dateTime>", "exampleDate" : "<date>", "exampleInstant" : "<instant>", "exampleString" : "<string>", "exampleUri" : "<uri>", "exampleBoolean" : <boolean>, "exampleCode" : "<code>", "exampleBase64Binary" : "<base64Binary>", "exampleCoding" : { Coding }, "exampleCodeableConcept" : { CodeableConcept }, "exampleAttachment" : { Attachment }, "exampleIdentifier" : { Identifier }, "exampleQuantity" : { Quantity }, "exampleRange" : { Range }, "examplePeriod" : { Period }, "exampleRatio" : { Ratio }, "exampleHumanName" : { HumanName }, "exampleAddress" : { Address }, "exampleContact" : { Contact }, "exampleSchedule" : { Schedule }, "exampleReference" : { Reference }, "maxLength" : <integer>, // Max length for strings "condition" : ["<id>"], // Reference to invariant about presence "constraint" : [{ // Condition that must evaluate to true "key" : "<id>", // C? R! Target of 'condition' reference above "name" : "<string>", // C? Short human label "severity" : "<code>", // R! error | warning "human" : "<string>", // R! Human description of constraint "xpath" : "<string>" // R! XPath expression of constraint }], "mustSupport" : <boolean>, // If the element must supported "isModifier" : <boolean>, // If this modifies the meaning of other elements "isSummary" : <boolean>, // Include when _summary = true? "binding" : { // C? ValueSet details if this is coded "name" : "<string>", // R! Descriptive Name "isExtensible" : <boolean>, // C? R! Can additional codes be used? "conformance" : "<code>", // C? required | preferred | example "description" : "<string>", // C? Human explanation of the value set // reference[x]: Source of value set. One of these 2: "referenceUri" : "<uri>" "referenceReference" : { Reference(ValueSet) } }, "mapping" : [{ // Map element to another set of definitions "identity" : "<id>", // R! Reference to mapping declaration "map" : "<string>" // R! Details of the mapping }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ElementDefinition | I | 0..* | Element | Definition of an elements in a resource or extension Types must be unique by the combination of code and profile Constraints must be unique by key Binding can only be present for coded elements Pattern and value are mutually exclusive Constraint names must be unique. default value and meaningWhenMissing are mutually exclusive Min <= Max Pattern may only be specified if there is one type Fixed value may only be specified if there is one type Either a namereference or a fixed value (but not both) is permitted |
path | 1..1 | string | The path of the element (see the Detailed Descriptions) | |
representation | 0..* | code | How this element is represented in instances PropertyRepresentation (Required) | |
name | 0..1 | string | Name for this particular element definition (reference target) | |
slicing | I | 0..1 | Element | This element is sliced - slices follow If there are no discriminators, there must be a definition |
discriminator | 0..* | string | Element values that used to distinguish the slices | |
description | I | 0..1 | string | Text description of how slicing works (or not) |
ordered | 0..1 | boolean | If elements must be in same order as slices | |
rules | 1..1 | code | closed | open | openAtEnd SlicingRules (Required) | |
short | 0..1 | string | Concise definition for xml presentation | |
definition | 0..1 | string | Full formal definition in human language | |
comments | 0..1 | string | Comments about the use of this element | |
requirements | 0..1 | string | Why is this needed? | |
synonym | 0..* | string | Other names | |
min | I | 0..1 | integer | Minimum Cardinality |
max | I | 0..1 | string | Maximum Cardinality (a number or *) Max SHALL be a number or "*" |
type | I | 0..* | Element | Data type and Profile for this element Aggregation may only be specified if one of the allowed types for the element is a resource |
code | 1..1 | code | Name of Data type or Resource DataType (Required) | |
profile | 0..1 | uri | Profile.structure to apply | |
aggregation | I | 0..* | code | contained | referenced | bundled - how aggregated AggregationMode (Required) |
nameReference | I | 0..1 | string | To another element constraint (by element.name) |
defaultValue[x] | I | 0..1 | * | Specified value it missing from instance |
meaningWhenMissing | I | 0..1 | string | Implicit meaning when this element is missing |
fixed[x] | I | 0..1 | * | Value must be exactly this |
pattern[x] | I | 0..1 | * | Value must have at least these property values |
example[x] | 0..1 | * | Example value: [as defined for type] | |
maxLength | 0..1 | integer | Max length for strings | |
condition | 0..* | id | Reference to invariant about presence | |
constraint | 0..* | Element | Condition that must evaluate to true | |
key | I | 1..1 | id | Target of 'condition' reference above |
name | I | 0..1 | string | Short human label |
severity | 1..1 | code | error | warning ConstraintSeverity (Required) | |
human | 1..1 | string | Human description of constraint | |
xpath | 1..1 | string | XPath expression of constraint | |
mustSupport | 0..1 | boolean | If the element must supported | |
isModifier | 0..1 | boolean | If this modifies the meaning of other elements | |
isSummary | 0..1 | boolean | Include when _summary = true? | |
binding | I | 0..1 | Element | ValueSet details if this is coded Example value sets are always extensible provide either a reference or a description (or both) |
name | 1..1 | string | Descriptive Name | |
isExtensible | I | 1..1 | boolean | Can additional codes be used? |
conformance | I | 0..1 | code | required | preferred | example BindingConformance (Required) |
description | I | 0..1 | string | Human explanation of the value set |
reference[x] | I | Source of value set uri SHALL start with http:// or https:// | ||
referenceUri | 0..1 | uri | ||
referenceReference | 0..1 | ValueSet | ||
mapping | 0..* | Element | Map element to another set of definitions | |
identity | 1..1 | id | Reference to mapping declaration | |
map | 1..1 | string | Details of the mapping |
XML Template
<[name] xmlns="http://hl7.org/fhir"> <!-- from Element: extension --> <path value="[string]"/><!-- 1..1 The path of the element (see the Detailed Descriptions) --> <representation value="[code]"/><!-- 0..* How this element is represented in instances --> <name value="[string]"/><!-- 0..1 Name for this particular element definition (reference target) --> <slicing> <!-- 0..1 This element is sliced - slices follow --> <discriminator value="[string]"/><!-- 0..* Element values that used to distinguish the slices --> <description value="[string]"/><!-- 0..1 Text description of how slicing works (or not) --> <ordered value="[boolean]"/><!-- 0..1 If elements must be in same order as slices --> <rules value="[code]"/><!-- 1..1 closed | open | openAtEnd --> </slicing> <short value="[string]"/><!-- 0..1 Concise definition for xml presentation --> <definition value="[string]"/><!-- 0..1 Full formal definition in human language --> <comments value="[string]"/><!-- 0..1 Comments about the use of this element --> <requirements value="[string]"/><!-- 0..1 Why is this needed? --> <synonym value="[string]"/><!-- 0..* Other names --> <min value="[integer]"/><!-- 0..1 Minimum Cardinality --> <max value="[string]"/><!-- 0..1 Maximum Cardinality (a number or *) --> <type> <!-- 0..* Data type and Profile for this element --> <code value="[code]"/><!-- 1..1 Name of Data type or Resource --> <profile value="[uri]"/><!-- 0..1 Profile.structure to apply --> <aggregation value="[code]"/><!-- 0..* contained | referenced | bundled - how aggregated --> </type> <nameReference value="[string]"/><!-- 0..1 To another element constraint (by element.name) --> <defaultValue[x]><!-- 0..1 * Specified value it missing from instance --></defaultValue[x]> <meaningWhenMissing value="[string]"/><!-- 0..1 Implicit meaning when this element is missing --> <fixed[x]><!-- 0..1 * Value must be exactly this --></fixed[x]> <pattern[x]><!-- 0..1 * Value must have at least these property values --></pattern[x]> <example[x]><!-- 0..1 * Example value: [as defined for type] --></example[x]> <maxLength value="[integer]"/><!-- 0..1 Max length for strings --> <condition value="[id]"/><!-- 0..* Reference to invariant about presence --> <constraint> <!-- 0..* Condition that must evaluate to true --> <key value="[id]"/><!-- 1..1 Target of 'condition' reference above --> <name value="[string]"/><!-- 0..1 Short human label --> <severity value="[code]"/><!-- 1..1 error | warning --> <human value="[string]"/><!-- 1..1 Human description of constraint --> <xpath value="[string]"/><!-- 1..1 XPath expression of constraint --> </constraint> <mustSupport value="[boolean]"/><!-- 0..1 If the element must supported --> <isModifier value="[boolean]"/><!-- 0..1 If this modifies the meaning of other elements --> <isSummary value="[boolean]"/><!-- 0..1 Include when _summary = true? --> <binding> <!-- 0..1 ValueSet details if this is coded --> <name value="[string]"/><!-- 1..1 Descriptive Name --> <isExtensible value="[boolean]"/><!-- 1..1 Can additional codes be used? --> <conformance value="[code]"/><!-- 0..1 required | preferred | example --> <description value="[string]"/><!-- 0..1 Human explanation of the value set --> <reference[x]><!-- 0..1 uri|Reference(ValueSet) Source of value set --></reference[x]> </binding> <mapping> <!-- 0..* Map element to another set of definitions --> <identity value="[id]"/><!-- 1..1 Reference to mapping declaration --> <map value="[string]"/><!-- 1..1 Details of the mapping --> </mapping> </[name]>
JSON Template
{ // from Element: extension "path" : "<string>", // R! The path of the element (see the Detailed Descriptions) "representation" : ["<code>"], // How this element is represented in instances "name" : "<string>", // Name for this particular element definition (reference target) "slicing" : { // This element is sliced - slices follow "discriminator" : ["<string>"], // Element values that used to distinguish the slices "description" : "<string>", // C? Text description of how slicing works (or not) "ordered" : <boolean>, // If elements must be in same order as slices "rules" : "<code>" // R! closed | open | openAtEnd }, "short" : "<string>", // Concise definition for xml presentation "definition" : "<string>", // Full formal definition in human language "comments" : "<string>", // Comments about the use of this element "requirements" : "<string>", // Why is this needed? "synonym" : ["<string>"], // Other names "min" : <integer>, // C? Minimum Cardinality "max" : "<string>", // C? Maximum Cardinality (a number or *) "type" : [{ // C? Data type and Profile for this element "code" : "<code>", // R! Name of Data type or Resource "profile" : "<uri>", // Profile.structure to apply "aggregation" : ["<code>"] // C? contained | referenced | bundled - how aggregated }], "nameReference" : "<string>", // C? To another element constraint (by element.name) // defaultValue[x]: Specified value it missing from instance. One of these 23: "defaultValueInteger" : <integer>, "defaultValueDecimal" : <decimal>, "defaultValueDateTime" : "<dateTime>", "defaultValueDate" : "<date>", "defaultValueInstant" : "<instant>", "defaultValueString" : "<string>", "defaultValueUri" : "<uri>", "defaultValueBoolean" : <boolean>, "defaultValueCode" : "<code>", "defaultValueBase64Binary" : "<base64Binary>", "defaultValueCoding" : { Coding }, "defaultValueCodeableConcept" : { CodeableConcept }, "defaultValueAttachment" : { Attachment }, "defaultValueIdentifier" : { Identifier }, "defaultValueQuantity" : { Quantity }, "defaultValueRange" : { Range }, "defaultValuePeriod" : { Period }, "defaultValueRatio" : { Ratio }, "defaultValueHumanName" : { HumanName }, "defaultValueAddress" : { Address }, "defaultValueContact" : { Contact }, "defaultValueSchedule" : { Schedule }, "defaultValueReference" : { Reference }, "meaningWhenMissing" : "<string>", // C? Implicit meaning when this element is missing // fixed[x]: Value must be exactly this. One of these 23: "fixedInteger" : <integer>, "fixedDecimal" : <decimal>, "fixedDateTime" : "<dateTime>", "fixedDate" : "<date>", "fixedInstant" : "<instant>", "fixedString" : "<string>", "fixedUri" : "<uri>", "fixedBoolean" : <boolean>, "fixedCode" : "<code>", "fixedBase64Binary" : "<base64Binary>", "fixedCoding" : { Coding }, "fixedCodeableConcept" : { CodeableConcept }, "fixedAttachment" : { Attachment }, "fixedIdentifier" : { Identifier }, "fixedQuantity" : { Quantity }, "fixedRange" : { Range }, "fixedPeriod" : { Period }, "fixedRatio" : { Ratio }, "fixedHumanName" : { HumanName }, "fixedAddress" : { Address }, "fixedContact" : { Contact }, "fixedSchedule" : { Schedule }, "fixedReference" : { Reference }, // pattern[x]: Value must have at least these property values. One of these 23: "patternInteger" : <integer>, "patternDecimal" : <decimal>, "patternDateTime" : "<dateTime>", "patternDate" : "<date>", "patternInstant" : "<instant>", "patternString" : "<string>", "patternUri" : "<uri>", "patternBoolean" : <boolean>, "patternCode" : "<code>", "patternBase64Binary" : "<base64Binary>", "patternCoding" : { Coding }, "patternCodeableConcept" : { CodeableConcept }, "patternAttachment" : { Attachment }, "patternIdentifier" : { Identifier }, "patternQuantity" : { Quantity }, "patternRange" : { Range }, "patternPeriod" : { Period }, "patternRatio" : { Ratio }, "patternHumanName" : { HumanName }, "patternAddress" : { Address }, "patternContact" : { Contact }, "patternSchedule" : { Schedule }, "patternReference" : { Reference }, // example[x]: Example value: [as defined for type]. One of these 23: "exampleInteger" : <integer>, "exampleDecimal" : <decimal>, "exampleDateTime" : "<dateTime>", "exampleDate" : "<date>", "exampleInstant" : "<instant>", "exampleString" : "<string>", "exampleUri" : "<uri>", "exampleBoolean" : <boolean>, "exampleCode" : "<code>", "exampleBase64Binary" : "<base64Binary>", "exampleCoding" : { Coding }, "exampleCodeableConcept" : { CodeableConcept }, "exampleAttachment" : { Attachment }, "exampleIdentifier" : { Identifier }, "exampleQuantity" : { Quantity }, "exampleRange" : { Range }, "examplePeriod" : { Period }, "exampleRatio" : { Ratio }, "exampleHumanName" : { HumanName }, "exampleAddress" : { Address }, "exampleContact" : { Contact }, "exampleSchedule" : { Schedule }, "exampleReference" : { Reference }, "maxLength" : <integer>, // Max length for strings "condition" : ["<id>"], // Reference to invariant about presence "constraint" : [{ // Condition that must evaluate to true "key" : "<id>", // C? R! Target of 'condition' reference above "name" : "<string>", // C? Short human label "severity" : "<code>", // R! error | warning "human" : "<string>", // R! Human description of constraint "xpath" : "<string>" // R! XPath expression of constraint }], "mustSupport" : <boolean>, // If the element must supported "isModifier" : <boolean>, // If this modifies the meaning of other elements "isSummary" : <boolean>, // Include when _summary = true? "binding" : { // C? ValueSet details if this is coded "name" : "<string>", // R! Descriptive Name "isExtensible" : <boolean>, // C? R! Can additional codes be used? "conformance" : "<code>", // C? required | preferred | example "description" : "<string>", // C? Human explanation of the value set // reference[x]: Source of value set. One of these 2: "referenceUri" : "<uri>" "referenceReference" : { Reference(ValueSet) } }, "mapping" : [{ // Map element to another set of definitions "identity" : "<id>", // R! Reference to mapping declaration "map" : "<string>" // R! Details of the mapping }] }
Commentary
Constraints
Further Commentary
The pseudo-data type ElementDefinition
is used both in Profile and ExtensionDefinition, and even within those resources, the way its elements are to be used and interpreted depend on the context where ElementDefinition
used.
path
is equal to the name of the type indicated in Structure.typename
associates a name slicing
, nameReference
, fixed
, mustSupport
, isSummary
type
is set to "DomainResource" or (rarely) "Resource" for constraints on Resources, "Element" for constraints on data typespattern
indicates a value that an instance of a while complex type constrained by this structure must match. May be used instead of applying constraints to the nested elements of the data type.example
example value for a complex type in an instance that complies to the structuremin
and max
are prohibited unless defining an extension, in which case they set outer bounds on how the element can appear when referenced in a profileisModifier
is prohibited when defining resources or data types. When defining extensions, this indicates whether the extension is a modifier extensionisSummary
is prohibited when defining resources or data types. When defining extensions, this indicates whether the extension is a modifier extensionslicing
can only be used on the first repeat of an element, this element is considered the slicing entryThe ElementDefinition
is understood to be the set of constraints to be used for the "open" slice, i.e. when the slice is open, this definition is used as a constraint on elements in the instance that are not part of a slice and belong to the open portion of the slice. Its use follows the "normal case", except:
slicing
must be presentmin
and max
govern the number of total occurrences of the sliced element including the number of occurrences in the open portion of the slice. name
slicing
is only supported when slicing based on type (to assert different rules/guidance for resources with multiple types, e.g. "code|integer" or "Reference(Foo|Bar)"path
is equal to ExtensionmustSupport
may be used, but if it is not present it defaults to "false"path
is equal to Extensiontype
is set to Extension
representation
may not be usedslicing
may be used to express constraints on the use of specific types when the element allows a choice of type (name ends in [x])mustSupport
may be used, but if it is not present it defaults to "false"isModifier
may be used, but if it is not present it defaults to "false"representation
is prohibitedmaxLength
may not be usedbinding
may only be used on elements which allow a type of code, Coding or CodeableConcept (this includes *)short
, formal
, comments
, requirements
, synonym
, mapping
can be replaced with content that provides more contextual guidance.
However, the new text must still be aligned with the base element. I.e. An instance that is created based on the definition, usage notes, etc. of the profiled element must still also be valid
against the definition, usage notes, etc. of the base element.comments
, requirements
and synonym
condition
, constraint
and mapping
elements may be addedMapping
elements can be removed if they do not apply within the new contextisModifier
and isSummary
must be the same as the base definition for the data type or ResourceElementDefinition is used in the following places: Profile, ExtensionDefinition and StructureDefinition