ElementDefinition
Data typeNormative
Captures constraints on each element within the resource, profile, or extension.
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
modifierExtension?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
pathRequiredΣ | 1..1 | string | Path of the element in the hierarchy of elements |
representationΣ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtmlBinding (required): property-representation |
sliceNameΣ | 0..1 | string | Name for this particular element (in a set of slices) |
sliceIsConstrainingΣ | 0..1 | boolean | If this slice definition constrains an inherited slice definition (or not) |
labelΣ | 0..1 | string | Name for element to display with or prompt for element |
codeΣ | 0..* | Coding | Corresponding codes in terminologiesBinding (example): observation-codes |
slicingΣ | 0..1 | Element | This element is sliced - slices follow |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
discriminatorΣ | 0..* | Element | Element values that are used to distinguish the slices |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
typeRequiredΣ | 1..1 | code | value | exists | pattern | type | profileBinding (required): discriminator-type |
pathRequiredΣ | 1..1 | string | Path to element value |
descriptionΣ | 0..1 | string | Text description of how slicing works (or not) |
orderedΣ | 0..1 | boolean | If elements must be in same order as slices |
rulesRequiredΣ | 1..1 | code | closed | open | openAtEndBinding (required): resource-slicing-rules |
shortΣ | 0..1 | string | Concise definition for space-constrained presentation |
definitionΣ | 0..1 | markdown | Full formal definition as narrative text |
commentΣ | 0..1 | markdown | Comments about the use of this element |
requirementsΣ | 0..1 | markdown | Why this resource has been created |
aliasΣ | 0..* | string | Other names |
minΣ | 0..1 | unsignedInt | Minimum Cardinality |
maxΣ | 0..1 | string | Maximum Cardinality (a number or *) |
baseΣ | 0..1 | Element | Base definition information for tools |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
pathRequiredΣ | 1..1 | string | Path that identifies the base element |
minRequiredΣ | 1..1 | unsignedInt | Min cardinality of the base element |
maxRequiredΣ | 1..1 | string | Max cardinality of the base element |
contentReferenceΣ | 0..1 | uri | Reference to definition of content for the element |
typeΣ | 0..* | Element | Data type and Profile for this element |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
codeRequiredΣ | 1..1 | uri | Data type or Resource (reference to definition)Binding (extensible): defined-types |
profileΣ | 0..* | canonical(StructureDefinition | ImplementationGuide) | Profiles (StructureDefinition or IG) - one must apply |
targetProfileΣ | 0..* | canonical(StructureDefinition | ImplementationGuide) | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply |
aggregationΣ | 0..* | code | contained | referenced | bundled - how aggregatedBinding (required): resource-aggregation-mode |
versioningΣ | 0..1 | code | either | independent | specificBinding (required): reference-version-rules |
defaultValue[x]Σ | 0..1 | base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | time | unsignedInt | uri | url | uuid | Address | Age | Annotation | Attachment | CodeableConcept | Coding | ContactPoint | Count | Distance | Duration | HumanName | Identifier | Money | Period | Quantity | Range | Ratio | Reference | SampledData | Signature | Timing | ContactDetail | Contributor | DataRequirement | Expression | ParameterDefinition | RelatedArtifact | TriggerDefinition | UsageContext | Dosage | Meta | Specified value if missing from instance |
meaningWhenMissingΣ | 0..1 | markdown | Implicit meaning when this element is missing |
orderMeaningΣ | 0..1 | string | What the order of the elements means |
fixed[x]Σ | 0..1 | base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | time | unsignedInt | uri | url | uuid | Address | Age | Annotation | Attachment | CodeableConcept | Coding | ContactPoint | Count | Distance | Duration | HumanName | Identifier | Money | Period | Quantity | Range | Ratio | Reference | SampledData | Signature | Timing | ContactDetail | Contributor | DataRequirement | Expression | ParameterDefinition | RelatedArtifact | TriggerDefinition | UsageContext | Dosage | Meta | Value must be exactly this |
pattern[x]Σ | 0..1 | base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | time | unsignedInt | uri | url | uuid | Address | Age | Annotation | Attachment | CodeableConcept | Coding | ContactPoint | Count | Distance | Duration | HumanName | Identifier | Money | Period | Quantity | Range | Ratio | Reference | SampledData | Signature | Timing | ContactDetail | Contributor | DataRequirement | Expression | ParameterDefinition | RelatedArtifact | TriggerDefinition | UsageContext | Dosage | Meta | Value must have at least these property values |
exampleΣ | 0..* | Element | Example value (as defined for type) |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
labelRequiredΣ | 1..1 | string | Describes the purpose of this example |
value[x]RequiredΣ | 1..1 | base64Binary | boolean | canonical | code | date | dateTime | decimal | id | instant | integer | markdown | oid | positiveInt | string | time | unsignedInt | uri | url | uuid | Address | Age | Annotation | Attachment | CodeableConcept | Coding | ContactPoint | Count | Distance | Duration | HumanName | Identifier | Money | Period | Quantity | Range | Ratio | Reference | SampledData | Signature | Timing | ContactDetail | Contributor | DataRequirement | Expression | ParameterDefinition | RelatedArtifact | TriggerDefinition | UsageContext | Dosage | Meta | Value of Example (one of allowed types) |
minValue[x]Σ | 0..1 | date | dateTime | instant | time | decimal | integer | positiveInt | unsignedInt | Quantity | Minimum Allowed Value (for some types) |
maxValue[x]Σ | 0..1 | date | dateTime | instant | time | decimal | integer | positiveInt | unsignedInt | Quantity | Maximum Allowed Value (for some types) |
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 |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
keyRequiredΣ | 1..1 | id | Target of 'condition' reference above |
requirementsΣ | 0..1 | string | Why this constraint is necessary or appropriate |
severityRequiredΣ | 1..1 | code | error | warningBinding (required): constraint-severity |
humanRequiredΣ | 1..1 | string | Human description of constraint |
expressionΣ | 0..1 | string | FHIRPath expression of constraint |
xpathΣ | 0..1 | string | XPath expression of constraint |
sourceΣ | 0..1 | canonical(StructureDefinition) | Reference to original source of constraint |
mustSupportΣ | 0..1 | boolean | If the element must be supported |
isModifierΣ | 0..1 | boolean | If this modifies the meaning of other elements |
isModifierReasonΣ | 0..1 | string | Reason that this element is marked as a modifier |
isSummaryΣ | 0..1 | boolean | Include when _summary = true? |
bindingΣ | 0..1 | Element | ValueSet details if this is coded |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
strengthRequiredΣ | 1..1 | code | required | extensible | preferred | exampleBinding (required): binding-strength |
descriptionΣ | 0..1 | string | Human explanation of the value set |
valueSetΣ | 0..1 | canonical(ValueSet) | Source of value set |
mappingΣ | 0..* | Element | Map element to another set of definitions |
id | 0..1 | string | Unique id for inter-element referencing |
extension | 0..* | Extension | Additional content defined by implementations |
identityRequiredΣ | 1..1 | id | Reference to mapping declaration |
languageΣ | 0..1 | code | Computable language of mappingBinding (required): mimetypes |
mapRequiredΣ | 1..1 | string | Details of the mapping |
commentΣ | 0..1 | string | Comments about the mapping or its use |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey