Identifies how the ElementDefinition data type is used when it appears within a data element
Subclass of hl7.model.ElementDefinition (Base StructureDefinition for ElementDefinition Type: Captures constraints on each element within the resource, profile, or extension.)
- Value Params
- `type`
- The data type or resource that the value of this element is permitted to be.
- alias
- Identifies additional names by which this element might also be known.
- base
- Information about the base definition of the element, provided to make it unnecessary for tools to trace the deviation of the element through the derived and related profiles. When the element definition is not the original definition of an element - i.g. either in a constraint on another type, or for elements from a super type in a snap shot - then the information in provided in the element definition may be different to the base definition. On the original definition of the element, it will be same.
- binding
- Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
- code
- A code that has the same meaning as the element in a particular terminology.
- comment
- Explanatory notes and implementation guidance about the data element, including notes about how to use the data properly, exceptions to proper use, etc. (Note: The text you are reading is specified in ElementDefinition.comment).
- condition
- A reference to an invariant that may make additional statements about the cardinality or value in the instance.
- constraint
- Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
- defaultValue
- 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').
- definition
- 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. (Note: The text you are reading is specified in ElementDefinition.definition).
- example
- A sample value for this element demonstrating the type of information that would typically be found in the element.
- extension
- 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.
- id
- Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
- isModifierReason
- Explains how that element affects the interpretation of the resource or element that contains it.
- label
- 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.
- mapping
- Identifies a concept from an external specification that roughly corresponds to this element.
- max
- The maximum number of times this element is permitted to appear in the instance.
- maxLength
- 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.
- maxValue
- 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.
- meaningWhenMissing
- The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
- min
- The minimum number of times this element SHALL appear in the instance.
- minValue
- 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.
- modifierExtension
- May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
- mustSupport
- 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. If false, whether to populate or use the data element in any way is at the discretion of the implementation.
- orderMeaning
- 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.
- path
- The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
- requirements
- 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.
- sliceIsConstraining
- If true, indicates that this slice definition is constraining a slice definition with the same name in an inherited profile. If false, the slice is not overriding any slice in an inherited profile. If missing, the slice might or might not be overriding a slice in an inherited profile, depending on the sliceName.
- sliceName
- 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.
- Constructor
Inherits all params from parent. Forbids the use of the following fields which were optional in the parent: short, fixed, isSummary, pattern, isModifier, representation, contentReference, slicing.
- Companion
- object
Value members
Inherited methods
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:
T
should not be a Choice[_], a LitSeq[_] or an Option[_]- It may require a type parameter sometimes (e.g.
sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET }
)
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract
- Inherited from
- FHIRObject
- Inherited from
- Utils
- Inherited from
- Utils
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.
- Inherited from
- FHIRObject
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^
- Inherited from
- FHIRObject
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
Bit faster than >>
, but still much slower than using update$foo
when possible. If you must use it, then:
T
should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject
- Inherited from
- FHIRObject