Name | Flags | Card. | Type |
Description & Constraints
|
---|---|---|---|---|
|
Σ N | Element | Definition of an element in a resource or extension
+ Rule: Min <= Max + Rule: if the element definition has a contentReference, it cannot have type, defaultValue, fixed, pattern, example, minValue, maxValue, maxLength, or binding + Rule: Fixed value may only be specified if there is one type + Rule: Pattern may only be specified if there is one type + Rule: Pattern and fixed are mutually exclusive + Rule: Binding can only be present for coded elements, string, and uri if using FHIR-defined types + Rule: Types must be unique by code + Rule: Constraints must be unique by key + Rule: default value and meaningWhenMissing are mutually exclusive + Rule: sliceName must be composed of proper tokens separated by "/" + Rule: Must have a modifier reason if isModifier = true + Rule: Element path SHALL be expressed as a set of '.'-separated components with each component restricted to a maximum of 64 characters and with some limits on the allowed choice of characters + Warning: The first component of the path should be UpperCamelCase. Additional components (following a '.') should be lowerCamelCase. If this syntax is not adhered to, code generation tools may be broken. Logical models may be less concerned about this implication. + Rule: sliceIsConstraining can only appear if slicename is present + Guideline: pattern[x] should be used rather than fixed[x] + Warning: Order has no meaning (and cannot be asserted to have meaning), so enforcing rules on order is improper + Warning: Mappings SHOULD be unique by key + Rule: Can't have valueAlternatives if mustHaveValue is true Elements defined in Ancestors: id, extension, modifierExtension |
|
|
Σ C | 1..1 | string | Path of the element in the hierarchy of elements
|
|
Σ | 0..* | code | xmlAttr | xmlText | typeAttr | cdaText | xhtml
Binding: PropertyRepresentation ( Required) |
|
Σ C | 0..1 | string | Name for this particular element (in a set of slices)
|
|
Σ C TU | 0..1 | boolean | If this slice definition constrains an inherited slice definition (or not)
|
|
Σ T | 0..1 | string | Name for element to display with or prompt for element
|
|
Σ | 0..* | Coding | Corresponding codes in terminologies
Binding: ElementDefinitionCode ( Example) |
|
Σ C | 0..1 | Element | This element is sliced - slices follow
|
|
Σ | 0..* | Element | Element values that are used to distinguish the slices
|
|
Σ | 1..1 | code | value | exists | type | profile | position
Binding: DiscriminatorType ( Required) |
|
Σ | 1..1 | string | Path to element value
|
|
Σ T | 0..1 | string | Text description of how slicing works (or not)
|
|
Σ C | 0..1 | boolean | If elements must be in same order as slices
|
|
Σ C | 1..1 | code | closed | open | openAtEnd
Binding: SlicingRules ( Required) |
|
Σ T | 0..1 | string | Concise definition for space-constrained presentation
|
|
Σ T | 0..1 | markdown | Full formal definition as narrative text
|
|
Σ T | 0..1 | markdown | Comments about the use of this element
|
|
Σ T | 0..1 | markdown | Why this resource has been created
|
|
Σ T | 0..* | string | Other names
|
|
Σ C | 0..1 | unsignedInt | Minimum Cardinality
|
|
Σ C | 0..1 | string | Maximum Cardinality (a number or *)
+ Rule: Max SHALL be a number or "*" |
|
Σ | 0..1 | Element | Base definition information for tools
|
|
Σ | 1..1 | string | Path that identifies the base element
|
|
Σ | 1..1 | unsignedInt | Min cardinality of the base element
|
|
Σ | 1..1 | string | Max cardinality of the base element
|
|
Σ C | 0..1 | uri | Reference to definition of content for the element
|
|
Σ C | 0..* | Element | Data type and Profile for this element
+ Rule: Aggregation may only be specified if one of the allowed types for the element is a reference + Rule: targetProfile is only allowed if the type is Reference or canonical |
|
Σ C | 1..1 | uri | Data type or Resource (reference to definition)
Binding: Element Definition Types ( Extensible) |
|
Σ | 0..* | canonical( StructureDefinition | ImplementationGuide) | Profiles (StructureDefinition or IG) - one must apply
|
|
Σ C | 0..* | canonical( StructureDefinition | ImplementationGuide) | Profile (StructureDefinition or IG) on the Reference/canonical target - one must apply
|
|
Σ C | 0..* | code | contained | referenced | bundled - how aggregated
Binding: AggregationMode ( Required) |
|
Σ | 0..1 | code | either | independent | specific
Binding: ReferenceVersionRules ( Required) |
|
Σ C | 0..1 | * | Specified value if missing from instance
|
|
Σ T C | 0..1 | markdown | Implicit meaning when this element is missing
|
|
Σ C | 0..1 | string | What the order of the elements means
|
|
Σ C | 0..1 | * | Value must be exactly this
|
|
Σ C | 0..1 | * | Value must have at least these property values
|
|
Σ C | 0..* | Element | Example value (as defined for type)
|
|
Σ T | 1..1 | string | Describes the purpose of this example
|
|
Σ | 1..1 | * | Value of Example (one of allowed types)
|
|
Σ C | 0..1 | Minimum Allowed Value (for some types)
|
|
|
date | |||
|
dateTime | |||
|
instant | |||
|
time | |||
|
decimal | |||
|
integer | |||
|
integer64 | |||
|
positiveInt | |||
|
unsignedInt | |||
|
Quantity | |||
|
Σ C | 0..1 | Maximum Allowed Value (for some types)
|
|
|
date | |||
|
dateTime | |||
|
instant | |||
|
time | |||
|
decimal | |||
|
integer | |||
|
integer64 | |||
|
positiveInt | |||
|
unsignedInt | |||
|
Quantity | |||
|
Σ C | 0..1 | integer | Max length for string type data
|
|
Σ | 0..* | id | Reference to invariant about presence
|
|
Σ C | 0..* | Element | Condition that must evaluate to true
+ Warning: Constraints should have an expression or else validators will not be able to enforce them + Rule: Errors cannot be suppressed |
|
Σ C | 1..1 | id | Target of 'condition' reference above
|
|
Σ | 0..1 | markdown | Why this constraint is necessary or appropriate
|
|
Σ C | 1..1 | code | error | warning
Binding: ConstraintSeverity ( Required) |
|
Σ C TU | 0..1 | boolean | Suppress warning or hint in profile
|
|
Σ T | 1..1 | string | Human description of constraint
|
|
Σ C | 0..1 | string | FHIRPath expression of constraint
|
|
Σ | 0..1 | canonical( StructureDefinition) | Reference to original source of constraint
|
|
Σ C TU | 0..1 | boolean | For primitives, that a value must be present - not replaced by an extension
|
|
Σ C TU | 0..* | canonical( StructureDefinition) | Extensions that are allowed to replace a primitive value
|
|
Σ | 0..1 | boolean | If the element must be supported (discouraged - see obligations)
|
|
Σ C | 0..1 | boolean | If this modifies the meaning of other elements
|
|
Σ C | 0..1 | string | Reason that this element is marked as a modifier
|
|
Σ | 0..1 | boolean | Include when _summary = true?
|
|
Σ C | 0..1 | Element | ValueSet details if this is coded
+ Rule: ValueSet SHALL start with http:// or https:// or urn: or # + Rule: binding SHALL have either description or valueSet |
|
Σ | 1..1 | code | required | extensible | preferred | example
Binding: BindingStrength ( Required) |
|
Σ T C | 0..1 | markdown | Intended use of codes in the bound value set
|
|
Σ C | 0..1 | canonical( ValueSet) | Source of value set
|
|
Σ TU | 0..* | Element | Additional Bindings - more rules about the binding
|
|
Σ | 1..1 | code | maximum | minimum | required | extensible | candidate | current | preferred | ui | starter | component
Binding: Additional Binding Purpose ValueSet ( Required) |
|
Σ | 1..1 | canonical( ValueSet) | The value set for the additional binding
|
|
Σ | 0..1 | markdown | Documentation of the purpose of use of the binding
|
|
Σ | 0..1 | string | Concise documentation - for summary tables
|
|
Σ | 0..* | UsageContext | Qualifies the usage - jurisdiction, gender, workflow status etc.
|
|
Σ | 0..1 | boolean | Whether binding can applies to all repeats, or just one
|
|
Σ C | 0..* | Element | Map element to another set of definitions
|
|
Σ C | 1..1 | id | Reference to mapping declaration
|
|
Σ | 0..1 | code | Computable language of mapping
Binding: Mime Types ( Required) |
|
Σ | 1..1 | string | Details of the mapping
|
|
Σ | 0..1 | markdown | Comments about the mapping or its use
|
|