Skip to main content

ElementDefinition

Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.

Complex data type in FHIR R4. Maturity: Not stated.

Elements​

ElementTypeCardinalityDescription
idstring0..1Unique id for inter-element referencing
extensionExtension0..*Additional content defined by implementations
modifierExtensionExtension0..*Extensions that cannot be ignored even if unrecognized
pathstring1..1Path of the element in the hierarchy of elements
representationcode0..*xmlAttr | xmlText | typeAttr | cdaText | xhtml
sliceNamestring0..1Name for this particular element (in a set of slices)
sliceIsConstrainingboolean0..1If this slice definition constrains an inherited slice definition (or not)
labelstring0..1Name for element to display with or prompt for element
codeCoding0..*Corresponding codes in terminologies
slicingElement0..1This element is sliced - slices follow
shortstring0..1Concise definition for space-constrained presentation
definitionmarkdown0..1Full formal definition as narrative text
commentmarkdown0..1Comments about the use of this element
requirementsmarkdown0..1Why this resource has been created
aliasstring0..*Other names
minunsignedInt0..1Minimum Cardinality
maxstring0..1Maximum Cardinality (a number or *)
baseElement0..1Base definition information for tools
contentReferenceuri0..1Reference to definition of content for the element
typeElement0..*Data type and Profile for this element
defaultValue[x]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, Meta0..1Specified value if missing from instance
meaningWhenMissingmarkdown0..1Implicit meaning when this element is missing
orderMeaningstring0..1What the order of the elements means
fixed[x]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, Meta0..1Value must be exactly this
pattern[x]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, Meta0..1Value must have at least these property values
exampleElement0..*Example value (as defined for type)
minValue[x]date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity0..1Minimum Allowed Value (for some types)
maxValue[x]date, dateTime, instant, time, decimal, integer, positiveInt, unsignedInt, Quantity0..1Maximum Allowed Value (for some types)
maxLengthinteger0..1Max length for strings
conditionid0..*Reference to invariant about presence
constraintElement0..*Condition that must evaluate to true
mustSupportboolean0..1If the element must be supported
isModifierboolean0..1If this modifies the meaning of other elements
isModifierReasonstring0..1Reason that this element is marked as a modifier
isSummaryboolean0..1Include when _summary = true?
bindingElement0..1ValueSet details if this is coded
mappingElement0..*Map element to another set of definitions

Reference​

Official FHIR R4 specification: ElementDefinition.