Generated Narrative: StructureDefinition ext-R3-DataElement.element Name Flags Card. Type Description & Constraints <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension" title="STU3: `DataElement.element` additional types (ElementDefinition) additional types from child elements (alias, base, max, min, path, binding, description, strength, valueSet[x], code, comment, condition, constraint, expression, human, key, requirements, severity, source, xpath, contentReference, defaultValue[x], definition, example, label, value[x], fixed[x], isModifier, isSummary, mapping, identity, language, map, maxLength, maxValue[x], meaningWhenMissing, minValue[x], mustSupport, orderMeaning, pattern[x], representation, short, sliceName, slicing, discriminator, type, ordered, rules, aggregation, profile, targetProfile, versioning)">Extension 1..* Extension(4.3.0) STU3: Definition of element additional types #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:_datatype 1..1 Extension DataType slice for a FHIR STU3 `ElementDefinition` value #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype" #xD; value[x] 1..1 string Value of extension Fixed Value: ElementDefinition #xD; extension:path 1..1 Extension STU3: path #xD; url 1..1 uri "path" #xD; value[x] 1..1 string Path of the element in the hierarchy of elements #xD; extension:representation 0..* Extension STU3: representation #xD; url 1..1 uri "representation" #xD; value[x] 0..1 code xmlAttr | xmlText | typeAttr | cdaText | xhtml Binding: PropertyRepresentation (required): How a property is represented when serialized. #xD; extension:sliceName 0..1 Extension STU3: sliceName #xD; url 1..1 uri "sliceName" #xD; value[x] 0..1 string Name for this particular element (in a set of slices) #xD; extension:label 0..1 Extension STU3: label #xD; url 1..1 uri "label" #xD; value[x] 0..1 string Name for element to display with or prompt for element #xD; extension:code 0..* Extension STU3: code #xD; url 1..1 uri "code" #xD; value[x] 0..1 Coding Corresponding codes in terminologies #xD; extension:slicing 0..1 Extension STU3: slicing #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:discriminator 0..* Extension STU3: discriminator #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:type 1..1 Extension STU3: type #xD; url 1..1 uri "type" #xD; value[x] 1..1 code value | exists | pattern | type | profile Binding: DiscriminatorType (required): How an element value is interpreted when discrimination is evaluated #xD; extension:path 1..1 Extension STU3: path #xD; url 1..1 uri "path" #xD; value[x] 1..1 string Path to element value #xD; url 1..1 uri "discriminator" #xD; value[x] 0..0 Value of extension #xD; extension:description 0..1 Extension STU3: description #xD; url 1..1 uri "description" #xD; value[x] 0..1 string Text description of how slicing works (or not) #xD; extension:ordered 0..1 Extension STU3: ordered #xD; url 1..1 uri "ordered" #xD; value[x] 0..1 boolean If elements must be in same order as slices #xD; extension:rules 1..1 Extension STU3: rules #xD; url 1..1 uri "rules" #xD; value[x] 1..1 code closed | open | openAtEnd Binding: SlicingRules (required): How slices are interpreted when evaluating an instance. #xD; url 1..1 uri "slicing" #xD; value[x] 0..0 Value of extension #xD; extension:short 0..1 Extension STU3: short #xD; url 1..1 uri "short" #xD; value[x] 0..1 string Concise definition for space-constrained presentation #xD; extension:definition 0..1 Extension STU3: definition #xD; url 1..1 uri "definition" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:definition.value[x]" title="Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.">value[x] 0..1 markdown Full formal definition as narrative text #xD; extension:comment 0..1 Extension STU3: comment #xD; url 1..1 uri "comment" #xD; value[x] 0..1 markdown Comments about the use of this element #xD; extension:requirements 0..1 Extension STU3: requirements #xD; url 1..1 uri "requirements" #xD; value[x] 0..1 markdown Why this resource has been created #xD; extension:alias 0..* Extension STU3: alias #xD; url 1..1 uri "alias" #xD; value[x] 0..1 string Other names #xD; extension:min 0..1 Extension STU3: min #xD; url 1..1 uri "min" #xD; value[x] 0..1 unsignedInt Minimum Cardinality #xD; extension:max 0..1 Extension STU3: max #xD; url 1..1 uri "max" #xD; value[x] 0..1 string Maximum Cardinality (a number or *) #xD; extension:base 0..1 Extension STU3: base #xD; Slices for extension 3..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:path 1..1 Extension STU3: path #xD; url 1..1 uri "path" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:base.extension:path.value[x]" title="The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](https://hl7.org/fhir/s.html#) without a StructureDefinition.base.">value[x] 1..1 string Path that identifies the base element #xD; extension:min 1..1 Extension STU3: min #xD; url 1..1 uri "min" #xD; value[x] 1..1 unsignedInt Min cardinality of the base element #xD; extension:max 1..1 Extension STU3: max #xD; url 1..1 uri "max" #xD; value[x] 1..1 string Max cardinality of the base element #xD; url 1..1 uri "base" #xD; value[x] 0..0 Value of extension #xD; extension:contentReference 0..1 Extension STU3: contentReference #xD; url 1..1 uri "contentReference" #xD; value[x] 0..1 uri Reference to definition of content for the element #xD; extension:type 0..* Extension STU3: type #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:code 1..1 Extension STU3: code #xD; url 1..1 uri "code" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:type.extension:code.value[x]" title="URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.">value[x] 1..1 uri Data type or Resource (reference to definition) Binding: R3DefinedTypesForR4B (0.1.0) (extensible): Either a resource or a data type, including logical model types #xD; extension:profile 0..1 Extension STU3: Profile (StructureDefinition) to apply (or IG) #xD; url 1..1 uri "profile" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:type.extension:profile.value[x]" title="Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.">value[x] 0..1 uri Profile (StructureDefinition) to apply (or IG) #xD; extension:targetProfile 0..1 Extension STU3: Profile (StructureDefinition) to apply to reference target (or IG) #xD; url 1..1 uri "targetProfile" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:type.extension:targetProfile.value[x]" title="Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.">value[x] 0..1 uri Profile (StructureDefinition) to apply to reference target (or IG) #xD; extension:aggregation 0..* Extension STU3: aggregation #xD; url 1..1 uri "aggregation" #xD; value[x] 0..1 code contained | referenced | bundled - how aggregated Binding: AggregationMode (required): How resource references can be aggregated. #xD; extension:versioning 0..1 Extension STU3: versioning #xD; url 1..1 uri "versioning" #xD; value[x] 0..1 code either | independent | specific Binding: ReferenceVersionRules (required): Whether a reference needs to be version specific or version independent, or whether either can be used #xD; url 1..1 uri "type" #xD; value[x] 0..0 Value of extension #xD; extension:defaultValue 0..1 Extension STU3: defaultValue additional types #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:_datatype 1..1 Extension DataType slice for a FHIR STU3 `Meta` value #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype" #xD; value[x] 1..1 string Value of extension Fixed Value: Meta #xD; extension:versionId 0..1 Extension STU3: versionId #xD; url 1..1 uri "versionId" #xD; value[x] 0..1 id Version specific identifier #xD; extension:lastUpdated 0..1 Extension STU3: lastUpdated #xD; url 1..1 uri "lastUpdated" #xD; value[x] 0..1 instant When the resource version last changed #xD; extension:profile 0..* Extension STU3: profile #xD; url 1..1 uri "profile" #xD; value[x] 0..1 uri Profiles this resource claims to conform to #xD; extension:security 0..* Extension STU3: security #xD; url 1..1 uri "security" #xD; value[x] 0..1 Coding Security Labels applied to this resource Binding: R3SecurityLabelsForR4B (0.1.0) (extensible): Security Labels from the Healthcare Privacy and Security Classification System. #xD; extension:tag 0..* Extension STU3: tag #xD; url 1..1 uri "tag" #xD; value[x] 0..1 Coding Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" #xD; url 1..1 uri "defaultValue" #xD; value[x] 0..1 Specified value if missing from instance #xD; valueAddress Address #xD; valueAnnotation Annotation #xD; valueAttachment Attachment #xD; valueContactPoint ContactPoint #xD; valueHumanName HumanName #xD; valueIdentifier Identifier #xD; valuePeriod Period #xD; valueRange Range #xD; valueRatio Ratio #xD; valueSampledData SampledData #xD; valueSignature Signature #xD; <span title="Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.">valueTiming Timing #xD; extension:meaningWhenMissing 0..1 Extension STU3: meaningWhenMissing #xD; url 1..1 uri "meaningWhenMissing" #xD; value[x] 0..1 markdown Implicit meaning when this element is missing #xD; extension:orderMeaning 0..1 Extension STU3: orderMeaning #xD; url 1..1 uri "orderMeaning" #xD; value[x] 0..1 string What the order of the elements means #xD; extension:fixed 0..1 Extension STU3: fixed additional types #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:_datatype 1..1 Extension DataType slice for a FHIR STU3 `Meta` value #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype" #xD; value[x] 1..1 string Value of extension Fixed Value: Meta #xD; extension:versionId 0..1 Extension STU3: versionId #xD; url 1..1 uri "versionId" #xD; value[x] 0..1 id Version specific identifier #xD; extension:lastUpdated 0..1 Extension STU3: lastUpdated #xD; url 1..1 uri "lastUpdated" #xD; value[x] 0..1 instant When the resource version last changed #xD; extension:profile 0..* Extension STU3: profile #xD; url 1..1 uri "profile" #xD; value[x] 0..1 uri Profiles this resource claims to conform to #xD; extension:security 0..* Extension STU3: security #xD; url 1..1 uri "security" #xD; value[x] 0..1 Coding Security Labels applied to this resource Binding: R3SecurityLabelsForR4B (0.1.0) (extensible): Security Labels from the Healthcare Privacy and Security Classification System. #xD; extension:tag 0..* Extension STU3: tag #xD; url 1..1 uri "tag" #xD; value[x] 0..1 Coding Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" #xD; url 1..1 uri "fixed" #xD; value[x] 0..1 Value must be exactly this #xD; valueAddress Address #xD; valueAnnotation Annotation #xD; valueAttachment Attachment #xD; valueContactPoint ContactPoint #xD; valueHumanName HumanName #xD; valueIdentifier Identifier #xD; valuePeriod Period #xD; valueRange Range #xD; valueRatio Ratio #xD; valueSampledData SampledData #xD; valueSignature Signature #xD; <span title="Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.">valueTiming Timing #xD; extension:pattern 0..1 Extension STU3: pattern additional types #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:_datatype 1..1 Extension DataType slice for a FHIR STU3 `Meta` value #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype" #xD; value[x] 1..1 string Value of extension Fixed Value: Meta #xD; extension:versionId 0..1 Extension STU3: versionId #xD; url 1..1 uri "versionId" #xD; value[x] 0..1 id Version specific identifier #xD; extension:lastUpdated 0..1 Extension STU3: lastUpdated #xD; url 1..1 uri "lastUpdated" #xD; value[x] 0..1 instant When the resource version last changed #xD; extension:profile 0..* Extension STU3: profile #xD; url 1..1 uri "profile" #xD; value[x] 0..1 uri Profiles this resource claims to conform to #xD; extension:security 0..* Extension STU3: security #xD; url 1..1 uri "security" #xD; value[x] 0..1 Coding Security Labels applied to this resource Binding: R3SecurityLabelsForR4B (0.1.0) (extensible): Security Labels from the Healthcare Privacy and Security Classification System. #xD; extension:tag 0..* Extension STU3: tag #xD; url 1..1 uri "tag" #xD; value[x] 0..1 Coding Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" #xD; url 1..1 uri "pattern" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:pattern.value[x]" title="Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).">value[x] 0..1 Value must have at least these property values #xD; valueAddress Address #xD; valueAnnotation Annotation #xD; valueAttachment Attachment #xD; valueContactPoint ContactPoint #xD; valueHumanName HumanName #xD; valueIdentifier Identifier #xD; valuePeriod Period #xD; valueRange Range #xD; valueRatio Ratio #xD; valueSampledData SampledData #xD; valueSignature Signature #xD; <span title="Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.">valueTiming Timing #xD; extension:example 0..* Extension STU3: example #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:label 1..1 Extension STU3: label #xD; url 1..1 uri "label" #xD; value[x] 1..1 string Describes the purpose of this example #xD; extension:value 1..1 Extension STU3: value additional types #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:_datatype 1..1 Extension DataType slice for a FHIR STU3 `Meta` value #xD; url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype" #xD; value[x] 1..1 string Value of extension Fixed Value: Meta #xD; extension:versionId 0..1 Extension STU3: versionId #xD; url 1..1 uri "versionId" #xD; value[x] 0..1 id Version specific identifier #xD; extension:lastUpdated 0..1 Extension STU3: lastUpdated #xD; url 1..1 uri "lastUpdated" #xD; value[x] 0..1 instant When the resource version last changed #xD; extension:profile 0..* Extension STU3: profile #xD; url 1..1 uri "profile" #xD; value[x] 0..1 uri Profiles this resource claims to conform to #xD; extension:security 0..* Extension STU3: security #xD; url 1..1 uri "security" #xD; value[x] 0..1 Coding Security Labels applied to this resource Binding: R3SecurityLabelsForR4B (0.1.0) (extensible): Security Labels from the Healthcare Privacy and Security Classification System. #xD; extension:tag 0..* Extension STU3: tag #xD; url 1..1 uri "tag" #xD; value[x] 0..1 Coding Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" #xD; url 1..1 uri "value" #xD; value[x] 0..1 Value of Example (one of allowed types) #xD; valueAddress Address #xD; valueAnnotation Annotation #xD; valueAttachment Attachment #xD; valueContactPoint ContactPoint #xD; valueHumanName HumanName #xD; valueIdentifier Identifier #xD; valuePeriod Period #xD; valueRange Range #xD; valueRatio Ratio #xD; valueSampledData SampledData #xD; valueSignature Signature #xD; <span title="Base StructureDefinition for Timing Type: Specifies an event that may occur multiple times. Timing schedules are used to record when things are planned, expected or requested to occur. The most common usage is in dosage instructions for medications. They are also used when planning care of various kinds, and may be used for reporting the schedule to which past regular activities were carried out.">valueTiming Timing #xD; url 1..1 uri "example" #xD; value[x] 0..0 Value of extension #xD; extension:minValue 0..1 Extension STU3: minValue #xD; url 1..1 uri "minValue" #xD; value[x] 0..1 Minimum Allowed Value (for some types) #xD; valueDate date #xD; valueDateTime dateTime #xD; valueInstant instant #xD; valueTime time #xD; valueDecimal decimal #xD; valueInteger integer #xD; 0)">valuePositiveInt positiveInt #xD; = 0)">valueUnsignedInt unsignedInt #xD; valueQuantity Quantity #xD; extension:maxValue 0..1 Extension STU3: maxValue #xD; url 1..1 uri "maxValue" #xD; value[x] 0..1 Maximum Allowed Value (for some types) #xD; valueDate date #xD; valueDateTime dateTime #xD; valueInstant instant #xD; valueTime time #xD; valueDecimal decimal #xD; valueInteger integer #xD; 0)">valuePositiveInt positiveInt #xD; = 0)">valueUnsignedInt unsignedInt #xD; valueQuantity Quantity #xD; extension:maxLength 0..1 Extension STU3: maxLength #xD; url 1..1 uri "maxLength" #xD; value[x] 0..1 integer Max length for strings #xD; extension:condition 0..* Extension STU3: condition #xD; url 1..1 uri "condition" #xD; value[x] 0..1 id Reference to invariant about presence #xD; extension:constraint 0..* Extension STU3: constraint #xD; Slices for extension 4..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:key 1..1 Extension STU3: key #xD; url 1..1 uri "key" #xD; value[x] 1..1 id Target of 'condition' reference above #xD; extension:requirements 0..1 Extension STU3: requirements #xD; url 1..1 uri "requirements" #xD; value[x] 0..1 string Why this constraint is necessary or appropriate #xD; extension:severity 1..1 Extension STU3: severity #xD; url 1..1 uri "severity" #xD; value[x] 1..1 code error | warning Binding: ConstraintSeverity (required): SHALL applications comply with this constraint? #xD; extension:human 1..1 Extension STU3: human #xD; url 1..1 uri "human" #xD; value[x] 1..1 string Human description of constraint #xD; extension:expression 1..1 Extension STU3: expression #xD; url 1..1 uri "expression" #xD; value[x] 1..1 string FHIRPath expression of constraint #xD; extension:xpath 0..1 Extension STU3: xpath #xD; url 1..1 uri "xpath" #xD; value[x] 0..1 string XPath expression of constraint #xD; extension:source 0..1 Extension STU3: source #xD; url 1..1 uri "source" #xD; value[x] 0..1 uri Reference to original source of constraint #xD; url 1..1 uri "constraint" #xD; value[x] 0..0 Value of extension #xD; extension:mustSupport 0..1 Extension STU3: If the element must supported #xD; url 1..1 uri "mustSupport" #xD; value[x] 0..1 boolean If the element must supported #xD; extension:isModifier 0..1 Extension STU3: isModifier #xD; url 1..1 uri "isModifier" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:isModifier.value[x]" title="If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.">value[x] 0..1 boolean If this modifies the meaning of other elements #xD; extension:isSummary 0..1 Extension STU3: isSummary #xD; url 1..1 uri "isSummary" #xD; value[x] 0..1 boolean Include when _summary = true? #xD; extension:binding 0..1 Extension STU3: binding #xD; Slices for extension 1..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:strength 1..1 Extension STU3: strength #xD; url 1..1 uri "strength" #xD; value[x] 1..1 code required | extensible | preferred | example Binding: BindingStrength (required): Indication of the degree of conformance expectations associated with a binding. #xD; extension:description 0..1 Extension STU3: description #xD; url 1..1 uri "description" #xD; value[x] 0..1 string Human explanation of the value set #xD; extension:valueSet 0..1 Extension STU3: Source of value set additional types #xD; url 1..1 uri "valueSet" #xD; <a href="StructureDefinition-ext-R3-DataElement.element-definitions.html#Extension.extension:binding.extension:valueSet.value[x]" title="Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.">value[x] 0..1 Reference(Cross-version Profile for STU3.ValueSet for use in FHIR R4B(0.1.0) | ValueSet) Source of value set #xD; url 1..1 uri "binding" #xD; value[x] 0..0 Value of extension #xD; extension:mapping 0..* Extension STU3: mapping #xD; Slices for extension 2..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:identity 1..1 Extension STU3: identity #xD; url 1..1 uri "identity" #xD; value[x] 1..1 id Reference to mapping declaration #xD; extension:language 0..1 Extension STU3: language #xD; url 1..1 uri "language" #xD; value[x] 0..1 code Computable language of mapping #xD; extension:map 1..1 Extension STU3: map #xD; url 1..1 uri "map" #xD; value[x] 1..1 string Details of the mapping #xD; extension:comment 0..1 Extension STU3: comment #xD; url 1..1 uri "comment" #xD; value[x] 0..1 string Comments about the mapping or its use #xD; url 1..1 uri "mapping" #xD; value[x] 0..0 Value of extension #xD; url 1..1 uri "http://hl7.org/fhir/3.0/StructureDefinition/extension-DataElement.element" #xD; value[x] 0..0 Value of extension #xD; Documentation for this format
STU3: Definition of element additional types
STU3: `DataElement.element` additional types (ElementDefinition) additional types from child elements (alias, base, max, min, path, binding, description, strength, valueSet[x], code, comment, condition, constraint, expression, human, key, requirements, severity, source, xpath, contentReference, defaultValue[x], definition, example, label, value[x], fixed[x], isModifier, isSummary, mapping, identity, language, map, maxLength, maxValue[x], meaningWhenMissing, minValue[x], mustSupport, orderMeaning, pattern[x], representation, short, sliceName, slicing, discriminator, type, ordered, rules, aggregation, profile, targetProfile, versioning)
This extension is part of the cross-version definitions generated to enable use of the element `DataElement.element` as defined in FHIR STU3 in FHIR R4B. The source element is defined as: `DataElement.element` 1..* `ElementDefinition` Across FHIR versions, the element set has been mapped as: * STU3: `DataElement.element` 1..* `ElementDefinition` * R4: `StructureDefinition.differential.element` 1..* `ElementDefinition` * R4B: `StructureDefinition.differential.element` 1..* `ElementDefinition` Following are the generation technical comments: Element `DataElement.element` is mapped to FHIR R4B element `StructureDefinition.differential.element` as `SourceIsBroaderThanTarget`. The mappings for `DataElement.element` do not cover the following types: ElementDefinition. The mappings for `DataElement.element` do not cover the following types based on type expansion: aggregation, alias, base, binding, code, comment, condition, constraint, contentReference, defaultValue[x], definition, description, discriminator, example, expression, fixed[x], human, identity, isModifier, isSummary, key, label, language, map, mapping, max, maxLength, maxValue[x], meaningWhenMissing, min, minValue[x], mustSupport, ordered, orderMeaning, path, pattern[x], profile, representation, requirements, rules, severity, short, sliceName, slicing, source, strength, targetProfile, type, value[x], valueSet[x], versioning, xpath.
Element `DataElement.element` is mapped to FHIR R4B element `StructureDefinition.differential.element` as `SourceIsBroaderThanTarget`. The mappings for `DataElement.element` do not cover the following types: ElementDefinition. The mappings for `DataElement.element` do not cover the following types based on type expansion: aggregation, alias, base, binding, code, comment, condition, constraint, contentReference, defaultValue[x], definition, description, discriminator, example, expression, fixed[x], human, identity, isModifier, isSummary, key, label, language, map, mapping, max, maxLength, maxValue[x], meaningWhenMissing, min, minValue[x], mustSupport, ordered, orderMeaning, path, pattern[x], profile, representation, requirements, rules, severity, short, sliceName, slicing, source, strength, targetProfile, type, value[x], valueSet[x], versioning, xpath. For simple data types there will only be one repetition. For complex data types, multiple repetitions will be present defining a nested structure using the "path" element.
All FHIR elements must have a @value or children unless an empty Parameters resource
hasValue() or (children().count() > id.count()) or $this is Parameters
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
DataType slice for a FHIR STU3 `ElementDefinition` value
Slice to indicate the presence of a STU3 `ElementDefinition` in FHIR R4B
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4B/extensibility.html) for a list).
Element `ElementDefinition.path` is mapped to FHIR R4B element `ElementDefinition.path` as `Equivalent`.
Path of the element in the hierarchy of elements
The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
STU3: `ElementDefinition.representation`
Element `ElementDefinition.representation` is mapped to FHIR R4B element `ElementDefinition.representation` as `Equivalent`. In resources, this is rarely used except for special cases where the representation deviates from the normal, and can only be done in the base standard (and profiles must reproduce what the base standard does). This element is used quite commonly in Logical models when the logical models represent a specific serialization format (e.g. CDA, v2 etc).
Element `ElementDefinition.representation` is mapped to FHIR R4B element `ElementDefinition.representation` as `Equivalent`.
xmlAttr | xmlText | typeAttr | cdaText | xhtml
Codes that define how this element is represented in instances, when the deviation varies from the normal case.
In resources, this is rarely used except for special cases where the representation deviates from the normal, and can only be done in the base standard (and profiles must reproduce what the base standard does). This element is used quite commonly in Logical models when the logical models represent a specific serialization format (e.g. CDA, v2 etc).
How a property is represented when serialized.
Element `ElementDefinition.sliceName` is mapped to FHIR R4B element `ElementDefinition.sliceName` as `Equivalent`. The name SHALL be unique within the structure within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).
May also be used for code generation purposes. Element `ElementDefinition.sliceName` is mapped to FHIR R4B element `ElementDefinition.sliceName` as `Equivalent`.
Name for this particular element (in a set of slices)
The name of this element definition slice, when slicing is working. The name must be a token with no dots or spaces. This is a unique name referring to a specific set of constraints applied to this element, used to provide a name to different slices of the same element.
The name SHALL be unique within the structure within the context of the constrained resource element. (Though to avoid confusion, uniqueness across all elements is recommended.).
Element `ElementDefinition.label` is mapped to FHIR R4B element `ElementDefinition.label` as `Equivalent`. See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].
Element `ElementDefinition.label` is mapped to FHIR R4B element `ElementDefinition.label` as `Equivalent`.
Name for element to display with or prompt for element
A single preferred label which is the text to display beside the element indicating its meaning or to use to prompt for the element in a user display or form.
See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].
Element `ElementDefinition.code` is mapped to FHIR R4B element `ElementDefinition.code` as `Equivalent`. The concept SHALL be properly aligned with the data element definition and other constraints, as defined in the code system, including relationships, of any code listed here. Where multiple codes exist in a terminology that could correspond to the data element, the most granular code(s) should be selected, so long as they are not more restrictive than the data element itself. The mappings may be used to provide more or less granular or structured equivalences in the code system.
Links the meaning of an element to an external terminology, and is very useful for searching and indexing. Element `ElementDefinition.code` is mapped to FHIR R4B element `ElementDefinition.code` as `Equivalent`.
A code that has the same meaning as the element in a particular terminology.
The concept SHALL be properly aligned with the data element definition and other constraints, as defined in the code system, including relationships, of any code listed here. Where multiple codes exist in a terminology that could correspond to the data element, the most granular code(s) should be selected, so long as they are not more restrictive than the data element itself. The mappings may be used to provide more or less granular or structured equivalences in the code system.
Element `ElementDefinition.slicing` is mapped to FHIR R4B element `ElementDefinition.slicing` as `Equivalent`. The first element in the sequence, the one that carries the slicing, is the definition that applies to all the slices. This is based on the unconstrained element, but can apply any constraints as appropriate. This may include the common constraints on the children of the element.
Element `ElementDefinition.slicing` is mapped to FHIR R4B element `ElementDefinition.slicing` as `Equivalent`.
STU3: `ElementDefinition.slicing.discriminator`
Element `ElementDefinition.slicing.discriminator` is mapped to FHIR R4B element `ElementDefinition.slicing.discriminator` as `Equivalent`. If there is no discriminator, the content is hard to process, so this should be avoided. If the base element has a cardinality of ..1, and there is a choice of types, the discriminator must be "@type".
Element `ElementDefinition.slicing.discriminator` is mapped to FHIR R4B element `ElementDefinition.slicing.discriminator` as `Equivalent`.
STU3: `ElementDefinition.slicing.discriminator.type`
Element `ElementDefinition.slicing.discriminator.type` is mapped to FHIR R4B element `ElementDefinition.slicing.discriminator.type` as `Equivalent`.
value | exists | pattern | type | profile
How the element value is interpreted when discrimination is evaluated.
How an element value is interpreted when discrimination is evaluated
STU3: `ElementDefinition.slicing.discriminator.path`
Element `ElementDefinition.slicing.discriminator.path` is mapped to FHIR R4B element `ElementDefinition.slicing.discriminator.path` as `Equivalent`. The only FHIRPath functions that are allowed are resolve(), and extension(url).
Element `ElementDefinition.slicing.discriminator.path` is mapped to FHIR R4B element `ElementDefinition.slicing.discriminator.path` as `Equivalent`.
A FHIRPath expression, using a restricted subset of FHIRPath, that is used to identify the element on which discrimination is based.
The only FHIRPath functions that are allowed are resolve(), and extension(url).
STU3: `ElementDefinition.slicing.description`
Element `ElementDefinition.slicing.description` is mapped to FHIR R4B element `ElementDefinition.slicing.description` as `Equivalent`. If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.
Element `ElementDefinition.slicing.description` is mapped to FHIR R4B element `ElementDefinition.slicing.description` as `Equivalent`.
Text description of how slicing works (or not)
A human-readable text description of how the slicing works. If there is no discriminator, this is required to be present to provide whatever information is possible about how the slices can be differentiated.
If it's really not possible to differentiate them, the design should be re-evaluated to make the content usable.
STU3: `ElementDefinition.slicing.ordered`
Element `ElementDefinition.slicing.ordered` is mapped to FHIR R4B element `ElementDefinition.slicing.ordered` as `Equivalent`. Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.
Element `ElementDefinition.slicing.ordered` is mapped to FHIR R4B element `ElementDefinition.slicing.ordered` as `Equivalent`.
If elements must be in same order as slices
If the matching elements have to occur in the same order as defined in the profile.
Order should only be required when it is a pressing concern for presentation. Profile authors should consider making the order a feature of the rules about the narrative, not the rules about the data - requiring ordered data makes the profile much less re-usable.
Element `ElementDefinition.slicing.rules` is mapped to FHIR R4B element `ElementDefinition.slicing.rules` as `Equivalent`. Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.
Element `ElementDefinition.slicing.rules` is mapped to FHIR R4B element `ElementDefinition.slicing.rules` as `Equivalent`.
Whether additional slices are allowed or not. When the slices are ordered, profile authors can also say that additional slices are only allowed at the end.
Allowing additional elements makes for a much for flexible template - it's open for use in wider contexts, but also means that the content of the resource is not closed, and applications have to decide how to handle content not described by the profile.
How slices are interpreted when evaluating an instance.
Element `ElementDefinition.short` is mapped to FHIR R4B element `ElementDefinition.short` as `Equivalent`. May change the term to provide language more appropriate to the context of the profile or to reflect slicing.
Element `ElementDefinition.short` is mapped to FHIR R4B element `ElementDefinition.short` as `Equivalent`.
Concise definition for space-constrained presentation
A concise description of what this element means (e.g. for use in autogenerated summaries).
May change the term to provide language more appropriate to the context of the profile or to reflect slicing.
Element `ElementDefinition.definition` is mapped to FHIR R4B element `ElementDefinition.definition` as `Equivalent`. It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.
To allow a user to state the usage of an element in a particular context. Element `ElementDefinition.definition` is mapped to FHIR R4B element `ElementDefinition.definition` as `Equivalent`.
Full formal definition as narrative text
Provides a complete explanation of the meaning of the data element for human readability. For the case of elements derived from existing elements (e.g. constraints), the definition SHALL be consistent with the base definition, but convey the meaning of the element in the particular context of use of the resource.
It is easy for a different definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing definitions.
Element `ElementDefinition.comment` is mapped to FHIR R4B element `ElementDefinition.comment` as `Equivalent`. If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.
Element `ElementDefinition.comment` is mapped to FHIR R4B element `ElementDefinition.comment` as `Equivalent`.
Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc.
If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.
Element `ElementDefinition.requirements` is mapped to FHIR R4B element `ElementDefinition.requirements` as `Equivalent`. This element does not describe the usage of the element (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.
Element `ElementDefinition.requirements` is mapped to FHIR R4B element `ElementDefinition.requirements` as `Equivalent`.
This element is for traceability of why the element was created and why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this element.
This element does not describe the usage of the element (that's done in comments), rather it's for traceability of *why* the element is either needed or why the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.
Element `ElementDefinition.alias` is mapped to FHIR R4B element `ElementDefinition.alias` as `Equivalent`.
Allows for better easier recognition of the element by multiple communities, including international communities. Element `ElementDefinition.alias` is mapped to FHIR R4B element `ElementDefinition.alias` as `Equivalent`.
Identifies additional names by which this element might also be known.
Element `ElementDefinition.min` is mapped to FHIR R4B element `ElementDefinition.min` as `Equivalent`.
The minimum number of times this element SHALL appear in the instance.
Element `ElementDefinition.max` is mapped to FHIR R4B element `ElementDefinition.max` as `Equivalent`.
The maximum number of times this element is permitted to appear in the instance.
Element `ElementDefinition.base` is mapped to FHIR R4B element `ElementDefinition.base` as `Equivalent`. The base information does not carry any information that could not be determined from the path and related profiles, but making this determination requires both that the related profiles are available, and that the algorithm to determine them be available. So they are deformalised into this location for tooling convenience, and to ensure that the base information is available without dependencies.
Element `ElementDefinition.base` is mapped to FHIR R4B element `ElementDefinition.base` as `Equivalent`.
Element `ElementDefinition.base.path` is mapped to FHIR R4B element `ElementDefinition.base.path` as `Equivalent`.
The Path that identifies the base element - this matches the ElementDefinition.path for that element. Across FHIR, there is only one base definition of any element - that is, an element definition on a [StructureDefinition](https://hl7.org/fhir/s.html#) without a StructureDefinition.base.
Element `ElementDefinition.base.min` is mapped to FHIR R4B element `ElementDefinition.base.min` as `Equivalent`. This is provided for consistency with max, and may affect code generation of mandatory elements of the base resource are generated differently (some reference implementations have done this).
Element `ElementDefinition.base.min` is mapped to FHIR R4B element `ElementDefinition.base.min` as `Equivalent`.
Minimum cardinality of the base element identified by the path.
This is provided for consistency with max, and may affect code generation of mandatory elements of the base resource are generated differently (some reference implementations have done this).
Element `ElementDefinition.base.max` is mapped to FHIR R4B element `ElementDefinition.base.max` as `Equivalent`. This is provided to code generation, since the serialization representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.
Element `ElementDefinition.base.max` is mapped to FHIR R4B element `ElementDefinition.base.max` as `Equivalent`.
Maximum cardinality of the base element identified by the path.
This is provided to code generation, since the serialization representation in JSON differs depending on whether the base element has max > 1. Also, some forms of code generation may differ.
STU3: `ElementDefinition.contentReference`
Element `ElementDefinition.contentReference` is mapped to FHIR R4B element `ElementDefinition.contentReference` as `Equivalent`.
Reference to definition of content for the element
Identifies the identity of an element defined elsewhere in the profile whose content rules should be applied to the current element.
Element `ElementDefinition.type` is mapped to FHIR R4B element `ElementDefinition.type` as `Equivalent`. The Type of the element can be left blank in a differential constraint, in which case the type is inherited from the resource. Abstract types are not permitted to appear as a type when multiple types are listed. (I.e. Abstract types cannot be part of a choice).
Element `ElementDefinition.type` is mapped to FHIR R4B element `ElementDefinition.type` as `Equivalent`.
Element `ElementDefinition.type.code` is mapped to FHIR R4B element `ElementDefinition.type.code` as `Equivalent`. If the element is a reference to another resource, this element contains "Reference", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient). There would be one pair of type/code for each allowed target resource type.
Element `ElementDefinition.type.code` is mapped to FHIR R4B element `ElementDefinition.type.code` as `Equivalent`.
Data type or Resource (reference to definition)
URL of Data type or Resource that is a(or the) type used for this element. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition e.g. "string" is a reference to http://hl7.org/fhir/StructureDefinition/string. Absolute URLs are only allowed in logical models.
If the element is a reference to another resource, this element contains "Reference", and the targetProfile element defines what resources can be referenced. The targetProfile may be a reference to the general definition of a resource (e.g. http://hl7.org/fhir/StructureDefinition/Patient). There would be one pair of type/code for each allowed target resource type.
Either a resource or a data type, including logical model types
STU3: Profile (StructureDefinition) to apply (or IG)
Element `ElementDefinition.type.profile` is mapped to FHIR R4B element `ElementDefinition.type.profile` as `SourceIsNarrowerThanTarget`.
Profile (StructureDefinition) to apply (or IG)
Identifies a profile structure or implementation Guide that SHALL hold for the datatype this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
STU3: Profile (StructureDefinition) to apply to reference target (or IG)
STU3: `ElementDefinition.type.targetProfile`
Element `ElementDefinition.type.targetProfile` is mapped to FHIR R4B element `ElementDefinition.type.targetProfile` as `SourceIsNarrowerThanTarget`.
Profile (StructureDefinition) to apply to reference target (or IG)
Identifies a profile structure or implementation Guide that SHALL hold for the target of the reference this element refers to. Can be a local reference - to a contained StructureDefinition, or a reference to another StructureDefinition or Implementation Guide by a canonical URL. When an implementation guide is specified, the resource SHALL conform to at least one profile defined in the implementation guide.
STU3: `ElementDefinition.type.aggregation`
Element `ElementDefinition.type.aggregation` is mapped to FHIR R4B element `ElementDefinition.type.aggregation` as `Equivalent`.
contained | referenced | bundled - how aggregated
If the type is a reference to another resource, how the resource is or can be aggregated - is it a contained resource, or a reference, and if the context is a bundle, is it included in the bundle.
How resource references can be aggregated.
STU3: `ElementDefinition.type.versioning`
Element `ElementDefinition.type.versioning` is mapped to FHIR R4B element `ElementDefinition.type.versioning` as `Equivalent`. The base specification never makes a rule as to which form is allowed, but implementation guides may do this.
Element `ElementDefinition.type.versioning` is mapped to FHIR R4B element `ElementDefinition.type.versioning` as `Equivalent`.
Whether this reference needs to be version specific or version independent, or whether either can be used.
The base specification never makes a rule as to which form is allowed, but implementation guides may do this.
Whether a reference needs to be version specific or version independent, or whether either can be used
STU3: `ElementDefinition.defaultValue[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)
Element `ElementDefinition.defaultValue[x]` is mapped to FHIR R4B element `ElementDefinition.defaultValue[x]` as `RelatedTo`. The mappings for `ElementDefinition.defaultValue[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.defaultValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`. Default values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. Specifying a default value means that the property can never been unknown - it must always have a value. Further, the default value can never be changed. For these reasons, default values are (and should be) used extremely sparingly.
Element `ElementDefinition.defaultValue[x]` is mapped to FHIR R4B element `ElementDefinition.defaultValue[x]` as `RelatedTo`. The mappings for `ElementDefinition.defaultValue[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.defaultValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.
DataType slice for a FHIR STU3 `Meta` value
Slice to indicate the presence of a STU3 `Meta` in FHIR R4B
Element `Meta.versionId` is mapped to FHIR R4B element `Meta.versionId` as `Equivalent`. The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Element `Meta.versionId` is mapped to FHIR R4B element `Meta.versionId` as `Equivalent`.
The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.
The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.
Element `Meta.lastUpdated` is mapped to FHIR R4B element `Meta.lastUpdated` as `Equivalent`. This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.
Element `Meta.lastUpdated` is mapped to FHIR R4B element `Meta.lastUpdated` as `Equivalent`.
When the resource last changed - e.g. when the version changed.
This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.
Element `Meta.profile` is mapped to FHIR R4B element `Meta.profile` as `Equivalent`. It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Element `Meta.profile` is mapped to FHIR R4B element `Meta.profile` as `Equivalent`.
Profiles this resource claims to conform to
A list of profiles (references to [StructureDefinition](https://hl7.org/fhir/s.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url]().
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.
Element `Meta.security` is mapped to FHIR R4B element `Meta.security` as `Equivalent`. The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Element `Meta.security` is mapped to FHIR R4B element `Meta.security` as `Equivalent`.
Security Labels applied to this resource
Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.
The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.
Security Labels from the Healthcare Privacy and Security Classification System.
Element `Meta.tag` is mapped to FHIR R4B element `Meta.tag` as `Equivalent`. The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Element `Meta.tag` is mapped to FHIR R4B element `Meta.tag` as `Equivalent`.
Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.
The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.
Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
Specified value if missing from instance
The value that should be used if there is no value stated in the instance (e.g. 'if not otherwise specified, the abstract is false').
Default values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. Specifying a default value means that the property can never been unknown - it must always have a value. Further, the default value can never be changed. For these reasons, default values are (and should be) used extremely sparingly.
STU3: `ElementDefinition.meaningWhenMissing`
Element `ElementDefinition.meaningWhenMissing` is mapped to FHIR R4B element `ElementDefinition.meaningWhenMissing` as `Equivalent`. Implicit meanings for missing values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. An implicit meaning for a missing value can never be changed, and specifying one has the consequence that constraining its use in profiles eliminates use cases as possibilities, not merely moving them out of scope.
Element `ElementDefinition.meaningWhenMissing` is mapped to FHIR R4B element `ElementDefinition.meaningWhenMissing` as `Equivalent`.
Implicit meaning when this element is missing
The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing'.
Implicit meanings for missing values can only be specified on a resource, data type, or extension definition, and never in a profile that applies to one of these. An implicit meaning for a missing value can never be changed, and specifying one has the consequence that constraining its use in profiles eliminates use cases as possibilities, not merely moving them out of scope.
Element `ElementDefinition.orderMeaning` is mapped to FHIR R4B element `ElementDefinition.orderMeaning` as `Equivalent`. This element can only be asserted on repeating elements and can only be introduced when defining resources or data types. It can be further refined profiled elements but if absent in the base type, a profile cannot assert meaning.
Element `ElementDefinition.orderMeaning` is mapped to FHIR R4B element `ElementDefinition.orderMeaning` as `Equivalent`.
If present, indicates that the order of the repeating element has meaning and describes what that meaning is. If absent, it means that the order of the element has no meaning.
This element can only be asserted on repeating elements and can only be introduced when defining resources or data types. It can be further refined profiled elements but if absent in the base type, a profile cannot assert meaning.
STU3: `ElementDefinition.fixed[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)
Element `ElementDefinition.fixed[x]` is mapped to FHIR R4B element `ElementDefinition.fixed[x]` as `RelatedTo`. The mappings for `ElementDefinition.fixed[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.fixed[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`. This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.
Element `ElementDefinition.fixed[x]` is mapped to FHIR R4B element `ElementDefinition.fixed[x]` as `RelatedTo`. The mappings for `ElementDefinition.fixed[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.fixed[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.
Specifies a value that SHALL be exactly the value for this element in the instance. For purposes of comparison, non-significant whitespace is ignored, and all values must be an exact match (case and accent sensitive). Missing elements/attributes must also be missing.
This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.
STU3: `ElementDefinition.pattern[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)
Element `ElementDefinition.pattern[x]` is mapped to FHIR R4B element `ElementDefinition.pattern[x]` as `RelatedTo`. The mappings for `ElementDefinition.pattern[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.pattern[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`. Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.
Element `ElementDefinition.pattern[x]` is mapped to FHIR R4B element `ElementDefinition.pattern[x]` as `RelatedTo`. The mappings for `ElementDefinition.pattern[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.pattern[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.
Value must have at least these property values
Specifies a value that the value in the instance SHALL follow - that is, any value in the pattern must be found in the instance. Other additional values may be found too. This is effectively constraint by example. The values of elements present in the pattern must match exactly (case-sensitive, accent-sensitive, etc.).
Mostly used for fixing values of CodeableConcept. At present, pattern[x] is not recommended as a basis for slicing while issues related to this are investigated during the STU period.
Element `ElementDefinition.example` is mapped to FHIR R4B element `ElementDefinition.example` as `Equivalent`. Examples will most commonly be present for data where it's not implicitly obvious from either the data type or value set what the values might be. (I.e. Example values for dates or quantities would generally be unnecessary.) If the example value is fully populated, the publication tool can generate an instance automatically.
Element `ElementDefinition.example` is mapped to FHIR R4B element `ElementDefinition.example` as `Equivalent`.
Element `ElementDefinition.example.label` is mapped to FHIR R4B element `ElementDefinition.example.label` as `Equivalent`.
Describes the purpose of this example amoung the set of examples.
STU3: `ElementDefinition.example.value[x]` additional types (Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Period, Range, Ratio, SampledData, Signature, Timing, Meta)
Element `ElementDefinition.example.value[x]` is mapped to FHIR R4B element `ElementDefinition.example.value[x]` as `RelatedTo`. The mappings for `ElementDefinition.example.value[x]` do not cover the following types: Address, Annotation, Attachment, ContactPoint, HumanName, Identifier, Meta, Period, Range, Ratio, SampledData, Signature, Timing. The target context `ElementDefinition.example.value[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition.example`.
The actual value for the element, which must be one of the types allowed for this element.
Element `ElementDefinition.minValue[x]` is mapped to FHIR R4B element `ElementDefinition.minValue[x]` as `RelatedTo`. The target context `ElementDefinition.minValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`. Except for date/date/instant, the type of the minValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of minValue[x] SHALL be either the same, or a a [Duration](https://hl7.org/fhir/datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is subtracted from the current clock to determine the minimum allowable value. A minimum value for a Quantity is interpreted as an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.
Element `ElementDefinition.minValue[x]` is mapped to FHIR R4B element `ElementDefinition.minValue[x]` as `RelatedTo`. The target context `ElementDefinition.minValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.
The minimum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
Except for date/date/instant, the type of the minValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of minValue[x] SHALL be either the same, or a a [Duration](https://hl7.org/fhir/datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is subtracted from the current clock to determine the minimum allowable value. A minimum value for a Quantity is interpreted as an canonical minimum - e.g. you cannot provide 100mg if the minimum value is 10g.
Element `ElementDefinition.maxValue[x]` is mapped to FHIR R4B element `ElementDefinition.maxValue[x]` as `RelatedTo`. The target context `ElementDefinition.maxValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`. Except for date/date/instant, the type of the maxValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of maxValue[x] SHALL be either the same, or a a [Duration](https://hl7.org/fhir/datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is added to the current clock to determine the maximum allowable value. A maximum value for a Quantity is interpreted as an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.
Element `ElementDefinition.maxValue[x]` is mapped to FHIR R4B element `ElementDefinition.maxValue[x]` as `RelatedTo`. The target context `ElementDefinition.maxValue[x]` is a choice-type element and cannot directly hold extensions. The context is moved up to parent element `ElementDefinition`.
The maximum allowed value for the element. The value is inclusive. This is allowed for the types date, dateTime, instant, time, decimal, integer, and Quantity.
Except for date/date/instant, the type of the maxValue[x] SHALL be the same as the specified type of the element. For the date/dateTime/instant values, the type of maxValue[x] SHALL be either the same, or a a [Duration](https://hl7.org/fhir/datatypes.html#duration) which specifies a relative time limit to the current time. The duration value is positive, and is added to the current clock to determine the maximum allowable value. A maximum value for a Quantity is interpreted as an canonical maximum - e.g. you cannot provide 10g if the maximum value is 50mg.
Element `ElementDefinition.maxLength` is mapped to FHIR R4B element `ElementDefinition.maxLength` as `Equivalent`. Receivers are not required to reject instances that exceed the maximum length. The full length could be stored. In some cases, data might be truncated, though truncation should be undertaken with care and an understanding of the consequences of doing so. If not specified, there is no conformance expectation for length support.
Element `ElementDefinition.maxLength` is mapped to FHIR R4B element `ElementDefinition.maxLength` as `Equivalent`.
Indicates the maximum length in characters that is permitted to be present in conformant instances and which is expected to be supported by conformant consumers that support the element.
Receivers are not required to reject instances that exceed the maximum length. The full length could be stored. In some cases, data might be truncated, though truncation should be undertaken with care and an understanding of the consequences of doing so. If not specified, there is no conformance expectation for length support.
Element `ElementDefinition.condition` is mapped to FHIR R4B element `ElementDefinition.condition` as `Equivalent`.
A reference to an invariant that may make additional statements about the cardinality or value in the instance.
Element `ElementDefinition.constraint` is mapped to FHIR R4B element `ElementDefinition.constraint` as `Equivalent`. Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.
Element `ElementDefinition.constraint` is mapped to FHIR R4B element `ElementDefinition.constraint` as `Equivalent`.
STU3: `ElementDefinition.constraint.key`
Element `ElementDefinition.constraint.key` is mapped to FHIR R4B element `ElementDefinition.constraint.key` as `Equivalent`.
Allows identification of which elements have their cardinalities impacted by the constraint. Will not be referenced for constraints that do not affect cardinality.
STU3: `ElementDefinition.constraint.requirements`
Element `ElementDefinition.constraint.requirements` is mapped to FHIR R4B element `ElementDefinition.constraint.requirements` as `Equivalent`. To be used if the reason for the constraint may not be intuitive to all implementers.
Element `ElementDefinition.constraint.requirements` is mapped to FHIR R4B element `ElementDefinition.constraint.requirements` as `Equivalent`.
Why this constraint is necessary or appropriate
Description of why this constraint is necessary or appropriate.
To be used if the reason for the constraint may not be intuitive to all implementers.
STU3: `ElementDefinition.constraint.severity`
Element `ElementDefinition.constraint.severity` is mapped to FHIR R4B element `ElementDefinition.constraint.severity` as `Equivalent`. This allows constraints to be asserted as "shall" (error) and "should" (warning).
Element `ElementDefinition.constraint.severity` is mapped to FHIR R4B element `ElementDefinition.constraint.severity` as `Equivalent`.
Identifies the impact constraint violation has on the conformance of the instance.
This allows constraints to be asserted as "shall" (error) and "should" (warning).
SHALL applications comply with this constraint?
STU3: `ElementDefinition.constraint.human`
Element `ElementDefinition.constraint.human` is mapped to FHIR R4B element `ElementDefinition.constraint.human` as `Equivalent`. Should be expressed in business terms as much as possible.
Element `ElementDefinition.constraint.human` is mapped to FHIR R4B element `ElementDefinition.constraint.human` as `Equivalent`.
Text that can be used to describe the constraint in messages identifying that the constraint has been violated.
Should be expressed in business terms as much as possible.
STU3: `ElementDefinition.constraint.expression`
Element `ElementDefinition.constraint.expression` is mapped to FHIR R4B element `ElementDefinition.constraint.expression` as `Equivalent`.
Used by validation tooling tests of the validity of the resource. Element `ElementDefinition.constraint.expression` is mapped to FHIR R4B element `ElementDefinition.constraint.expression` as `Equivalent`.
A [FHIRPath](http://hl7.org/fluentpath) expression of constraint that can be executed to see if this constraint is met.
STU3: `ElementDefinition.constraint.xpath`
Element `ElementDefinition.constraint.xpath` is mapped to FHIR R4B element `ElementDefinition.constraint.xpath` as `Equivalent`. Elements SHALL use "f" as the namespace prefix for the FHIR namespace, and "x" for the xhtml namespace, and SHALL NOT use any other prefixes. Note: we are considering deprecating the xpath element. Implementer feedback is welcome.
Used in Schematron tests of the validity of the resource. Element `ElementDefinition.constraint.xpath` is mapped to FHIR R4B element `ElementDefinition.constraint.xpath` as `Equivalent`.
An XPath expression of constraint that can be executed to see if this constraint is met.
Elements SHALL use "f" as the namespace prefix for the FHIR namespace, and "x" for the xhtml namespace, and SHALL NOT use any other prefixes. Note: we are considering deprecating the xpath element. Implementer feedback is welcome.
STU3: `ElementDefinition.constraint.source`
Element `ElementDefinition.constraint.source` is mapped to FHIR R4B element `ElementDefinition.constraint.source` as `Equivalent`. This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.
Element `ElementDefinition.constraint.source` is mapped to FHIR R4B element `ElementDefinition.constraint.source` as `Equivalent`.
Reference to original source of constraint
A reference to the original source of the constraint, for traceability purposes.
This is used when, e.g. rendering, where it is not useful to present inherited constraints when rendering the snapshot.
Element `ElementDefinition.mustSupport` is mapped to FHIR R4B element `ElementDefinition.mustSupport` as `Equivalent`. "Something useful" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. This is done in [Resource Profiles](https://hl7.org/fhir/profiling.ht.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of "support" is required, as this can mean many things. Note that an element that has the property IsModifier is not necessarily a "key" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.
Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints. Element `ElementDefinition.mustSupport` is mapped to FHIR R4B element `ElementDefinition.mustSupport` as `Equivalent`.
If true, implementations that produce or consume resources SHALL provide "support" for the element in some meaningful way. If false, the element may be ignored and not supported.
"Something useful" is context dependent and impossible to describe in the base FHIR specification. For this reason, tue mustSupport flag is never set to true by the FHIR specification itself - it is only set to true in profiles. This is done in [Resource Profiles](https://hl7.org/fhir/profiling.ht.html#mustsupport), where the profile labels an element as mustSupport=true. When a profile does this, it SHALL also make clear exactly what kind of "support" is required, as this can mean many things. Note that an element that has the property IsModifier is not necessarily a "key" element (e.g. one of the important elements to make use of the resource), nor is it automatically mustSupport - however both of these things are more likely to be true for IsModifier elements than for other elements.
Element `ElementDefinition.isModifier` is mapped to FHIR R4B element `ElementDefinition.isModifier` as `Equivalent`. Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.
Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them. Element `ElementDefinition.isModifier` is mapped to FHIR R4B element `ElementDefinition.isModifier` as `Equivalent`.
If this modifies the meaning of other elements
If true, the value of this element affects the interpretation of the element or resource that contains it, and the value of the element cannot be ignored. Typically, this is used for status, negation and qualification codes. The effect of this is that the element cannot be ignored by systems: they SHALL either recognize the element and process it, and/or a pre-determination has been made that it is not relevant to their particular system.
Only the definition of an element can set IsModifier true - either the specification itself or where an extension is originally defined. Once set, it cannot be changed in derived profiles. An element/extension that has isModifier=true SHOULD also have a minimum cardinality of 1, so that there is no lack of clarity about what to do if it is missing. If it can be missing, the definition SHALL make the meaning of a missing element clear.
Element `ElementDefinition.isSummary` is mapped to FHIR R4B element `ElementDefinition.isSummary` as `Equivalent`. Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers may not support per-profile use of the isSummary flag. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. Modifier elements or elements with minimum cardinality = 1 must be marked as summary elements.
Allow clients to search through large resources quickly. Element `ElementDefinition.isSummary` is mapped to FHIR R4B element `ElementDefinition.isSummary` as `Equivalent`.
Whether the element should be included if a client requests a search with the parameter _summary=true.
Some resources include a set of simple metadata, and some very large data. This element is used to reduce the quantity of data returned in searches. Note that servers may pre-cache summarized resources for optimal performance, so servers may not support per-profile use of the isSummary flag. When a request is made with _summary=true, serailisers only include elements marked as 'isSummary = true'. Other than Attachment.data, all data type properties are included in the summary form. Modifier elements or elements with minimum cardinality = 1 must be marked as summary elements.
Element `ElementDefinition.binding` is mapped to FHIR R4B element `ElementDefinition.binding` as `Equivalent`. For a CodeableConcept, when no codes are allowed - only text, use a binding of strength "required" with a description explaining that no coded values are allowed and what sort of information to put in the "text" element.
Element `ElementDefinition.binding` is mapped to FHIR R4B element `ElementDefinition.binding` as `Equivalent`.
STU3: `ElementDefinition.binding.strength`
Element `ElementDefinition.binding.strength` is mapped to FHIR R4B element `ElementDefinition.binding.strength` as `Equivalent`. For further discussion, see [Using Terminologies](https://hl7.org/fhir/terminologies.html).
Element `ElementDefinition.binding.strength` is mapped to FHIR R4B element `ElementDefinition.binding.strength` as `Equivalent`.
required | extensible | preferred | example
Indicates the degree of conformance expectations associated with this binding - that is, the degree to which the provided value set must be adhered to in the instances.
For further discussion, see [Using Terminologies](https://hl7.org/fhir/terminologies.html).
Indication of the degree of conformance expectations associated with a binding.
STU3: `ElementDefinition.binding.description`
Element `ElementDefinition.binding.description` is mapped to FHIR R4B element `ElementDefinition.binding.description` as `Equivalent`.
Describes the intended use of this particular set of codes.
STU3: Source of value set additional types
STU3: `ElementDefinition.binding.valueSet[x]` additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet)) additional types from child elements (display, identifier, reference)
Element `ElementDefinition.binding.valueSet[x]` is mapped to FHIR R4B element `ElementDefinition.binding.valueSet` as `SourceIsBroaderThanTarget`. The mappings for `ElementDefinition.binding.valueSet[x]` do not cover the following types: Reference. The mappings for `ElementDefinition.binding.valueSet[x]` do not cover the following types based on type expansion: display, identifier, reference. For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
Element `ElementDefinition.binding.valueSet[x]` is mapped to FHIR R4B element `ElementDefinition.binding.valueSet` as `SourceIsBroaderThanTarget`. The mappings for `ElementDefinition.binding.valueSet[x]` do not cover the following types: Reference. The mappings for `ElementDefinition.binding.valueSet[x]` do not cover the following types based on type expansion: display, identifier, reference.
Points to the value set or external definition (e.g. implicit value set) that identifies the set of codes to be used. If the binding refers to an explicit value set - the normal case - then use a Reference(ValueSet) preferably containing the canonical URL for the value set. If the reference is to an implicit value set - usually, an IETF RFC that defines a grammar, such as mime types - then use a uri.
For value sets with a referenceResource, the display can contain the value set description. The reference may be version-specific or not.
Element `ElementDefinition.mapping` is mapped to FHIR R4B element `ElementDefinition.mapping` as `Equivalent`. Mappings are not necessarily specific enough for safe translation.
Provides guidance to implementers familiar with or converting content from other specifications. Element `ElementDefinition.mapping` is mapped to FHIR R4B element `ElementDefinition.mapping` as `Equivalent`.
STU3: `ElementDefinition.mapping.identity`
Element `ElementDefinition.mapping.identity` is mapped to FHIR R4B element `ElementDefinition.mapping.identity` as `Equivalent`.
An internal reference to the definition of a mapping.
STU3: `ElementDefinition.mapping.language`
Element `ElementDefinition.mapping.language` is mapped to FHIR R4B element `ElementDefinition.mapping.language` as `Equivalent`. If omitted, then there can be no expectation of computational interpretation of the mapping.
Element `ElementDefinition.mapping.language` is mapped to FHIR R4B element `ElementDefinition.mapping.language` as `Equivalent`.
Identifies the computable language in which mapping.map is expressed.
If omitted, then there can be no expectation of computational interpretation of the mapping.
Element `ElementDefinition.mapping.map` is mapped to FHIR R4B element `ElementDefinition.mapping.map` as `Equivalent`. For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.
Element `ElementDefinition.mapping.map` is mapped to FHIR R4B element `ElementDefinition.mapping.map` as `Equivalent`.
Expresses what part of the target specification corresponds to this element.
For most mappings, the syntax is undefined. Syntax will be provided for mappings to the RIM. Multiple mappings may be possible and may include constraints on other resource elements that identify when a particular mapping applies.
STU3: `ElementDefinition.mapping.comment`
Element `ElementDefinition.mapping.comment` is mapped to FHIR R4B element `ElementDefinition.mapping.comment` as `Equivalent`.
Comments that provide information about the mapping or its use.