Data Model Libraries
    Preparing search index...

    ElementDefinition Class

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

    FHIR Specification

    • Short: Definition of an element in a resource or extension
    • Definition: Captures constraints on each element within the resource, profile, or extension.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getPathElement setPathElement hasPathElement getPath setPath hasPath getRepresentationEnumType setRepresentationEnumType addRepresentationEnumType hasRepresentationEnumType getRepresentationElement setRepresentationElement addRepresentationElement hasRepresentationElement getRepresentation setRepresentation addRepresentation hasRepresentation getSliceNameElement setSliceNameElement hasSliceNameElement getSliceName setSliceName hasSliceName getSliceIsConstrainingElement setSliceIsConstrainingElement hasSliceIsConstrainingElement getSliceIsConstraining setSliceIsConstraining hasSliceIsConstraining getLabelElement setLabelElement hasLabelElement getLabel setLabel hasLabel getCode setCode addCode hasCode getSlicing setSlicing hasSlicing getShortElement setShortElement hasShortElement getShort setShort hasShort getDefinitionElement setDefinitionElement hasDefinitionElement getDefinition setDefinition hasDefinition getCommentElement setCommentElement hasCommentElement getComment setComment hasComment getRequirementsElement setRequirementsElement hasRequirementsElement getRequirements setRequirements hasRequirements getAliasElement setAliasElement addAliasElement hasAliasElement getAlias setAlias addAlias hasAlias getMinElement setMinElement hasMinElement getMin setMin hasMin getMaxElement setMaxElement hasMaxElement getMax setMax hasMax getBase setBase hasBase getContentReferenceElement setContentReferenceElement hasContentReferenceElement getContentReference setContentReference hasContentReference getType setType addType hasType getDefaultValue setDefaultValue hasDefaultValue getDefaultValueBase64BinaryType hasDefaultValueBase64BinaryType getDefaultValueBooleanType hasDefaultValueBooleanType getDefaultValueCanonicalType hasDefaultValueCanonicalType getDefaultValueCodeType hasDefaultValueCodeType getDefaultValueDateType hasDefaultValueDateType getDefaultValueDateTimeType hasDefaultValueDateTimeType getDefaultValueDecimalType hasDefaultValueDecimalType getDefaultValueIdType hasDefaultValueIdType getDefaultValueInstantType hasDefaultValueInstantType getDefaultValueIntegerType hasDefaultValueIntegerType getDefaultValueMarkdownType hasDefaultValueMarkdownType getDefaultValueOidType hasDefaultValueOidType getDefaultValuePositiveIntType hasDefaultValuePositiveIntType getDefaultValueStringType hasDefaultValueStringType getDefaultValueTimeType hasDefaultValueTimeType getDefaultValueUnsignedIntType hasDefaultValueUnsignedIntType getDefaultValueUriType hasDefaultValueUriType getDefaultValueUrlType hasDefaultValueUrlType getDefaultValueUuidType hasDefaultValueUuidType getDefaultValueAddress hasDefaultValueAddress getDefaultValueAge hasDefaultValueAge getDefaultValueAnnotation hasDefaultValueAnnotation getDefaultValueAttachment hasDefaultValueAttachment getDefaultValueCodeableConcept hasDefaultValueCodeableConcept getDefaultValueCoding hasDefaultValueCoding getDefaultValueContactPoint hasDefaultValueContactPoint getDefaultValueCount hasDefaultValueCount getDefaultValueDistance hasDefaultValueDistance getDefaultValueDuration hasDefaultValueDuration getDefaultValueHumanName hasDefaultValueHumanName getDefaultValueIdentifier hasDefaultValueIdentifier getDefaultValueMoney hasDefaultValueMoney getDefaultValuePeriod hasDefaultValuePeriod getDefaultValueQuantity hasDefaultValueQuantity getDefaultValueRange hasDefaultValueRange getDefaultValueRatio hasDefaultValueRatio getDefaultValueReference hasDefaultValueReference getDefaultValueSampledData hasDefaultValueSampledData getDefaultValueSignature hasDefaultValueSignature getDefaultValueTiming hasDefaultValueTiming getDefaultValueContactDetail hasDefaultValueContactDetail getDefaultValueContributor hasDefaultValueContributor getDefaultValueDataRequirement hasDefaultValueDataRequirement getDefaultValueExpression hasDefaultValueExpression getDefaultValueParameterDefinition hasDefaultValueParameterDefinition getDefaultValueRelatedArtifact hasDefaultValueRelatedArtifact getDefaultValueTriggerDefinition hasDefaultValueTriggerDefinition getDefaultValueUsageContext hasDefaultValueUsageContext getDefaultValueDosage hasDefaultValueDosage getDefaultValueMeta hasDefaultValueMeta getMeaningWhenMissingElement setMeaningWhenMissingElement hasMeaningWhenMissingElement getMeaningWhenMissing setMeaningWhenMissing hasMeaningWhenMissing getOrderMeaningElement setOrderMeaningElement hasOrderMeaningElement getOrderMeaning setOrderMeaning hasOrderMeaning getFixed setFixed hasFixed getFixedBase64BinaryType hasFixedBase64BinaryType getFixedBooleanType hasFixedBooleanType getFixedCanonicalType hasFixedCanonicalType getFixedCodeType hasFixedCodeType getFixedDateType hasFixedDateType getFixedDateTimeType hasFixedDateTimeType getFixedDecimalType hasFixedDecimalType getFixedIdType hasFixedIdType getFixedInstantType hasFixedInstantType getFixedIntegerType hasFixedIntegerType getFixedMarkdownType hasFixedMarkdownType getFixedOidType hasFixedOidType getFixedPositiveIntType hasFixedPositiveIntType getFixedStringType hasFixedStringType getFixedTimeType hasFixedTimeType getFixedUnsignedIntType hasFixedUnsignedIntType getFixedUriType hasFixedUriType getFixedUrlType hasFixedUrlType getFixedUuidType hasFixedUuidType getFixedAddress hasFixedAddress getFixedAge hasFixedAge getFixedAnnotation hasFixedAnnotation getFixedAttachment hasFixedAttachment getFixedCodeableConcept hasFixedCodeableConcept getFixedCoding hasFixedCoding getFixedContactPoint hasFixedContactPoint getFixedCount hasFixedCount getFixedDistance hasFixedDistance getFixedDuration hasFixedDuration getFixedHumanName hasFixedHumanName getFixedIdentifier hasFixedIdentifier getFixedMoney hasFixedMoney getFixedPeriod hasFixedPeriod getFixedQuantity hasFixedQuantity getFixedRange hasFixedRange getFixedRatio hasFixedRatio getFixedReference hasFixedReference getFixedSampledData hasFixedSampledData getFixedSignature hasFixedSignature getFixedTiming hasFixedTiming getFixedContactDetail hasFixedContactDetail getFixedContributor hasFixedContributor getFixedDataRequirement hasFixedDataRequirement getFixedExpression hasFixedExpression getFixedParameterDefinition hasFixedParameterDefinition getFixedRelatedArtifact hasFixedRelatedArtifact getFixedTriggerDefinition hasFixedTriggerDefinition getFixedUsageContext hasFixedUsageContext getFixedDosage hasFixedDosage getFixedMeta hasFixedMeta getPattern setPattern hasPattern getPatternBase64BinaryType hasPatternBase64BinaryType getPatternBooleanType hasPatternBooleanType getPatternCanonicalType hasPatternCanonicalType getPatternCodeType hasPatternCodeType getPatternDateType hasPatternDateType getPatternDateTimeType hasPatternDateTimeType getPatternDecimalType hasPatternDecimalType getPatternIdType hasPatternIdType getPatternInstantType hasPatternInstantType getPatternIntegerType hasPatternIntegerType getPatternMarkdownType hasPatternMarkdownType getPatternOidType hasPatternOidType getPatternPositiveIntType hasPatternPositiveIntType getPatternStringType hasPatternStringType getPatternTimeType hasPatternTimeType getPatternUnsignedIntType hasPatternUnsignedIntType getPatternUriType hasPatternUriType getPatternUrlType hasPatternUrlType getPatternUuidType hasPatternUuidType getPatternAddress hasPatternAddress getPatternAge hasPatternAge getPatternAnnotation hasPatternAnnotation getPatternAttachment hasPatternAttachment getPatternCodeableConcept hasPatternCodeableConcept getPatternCoding hasPatternCoding getPatternContactPoint hasPatternContactPoint getPatternCount hasPatternCount getPatternDistance hasPatternDistance getPatternDuration hasPatternDuration getPatternHumanName hasPatternHumanName getPatternIdentifier hasPatternIdentifier getPatternMoney hasPatternMoney getPatternPeriod hasPatternPeriod getPatternQuantity hasPatternQuantity getPatternRange hasPatternRange getPatternRatio hasPatternRatio getPatternReference hasPatternReference getPatternSampledData hasPatternSampledData getPatternSignature hasPatternSignature getPatternTiming hasPatternTiming getPatternContactDetail hasPatternContactDetail getPatternContributor hasPatternContributor getPatternDataRequirement hasPatternDataRequirement getPatternExpression hasPatternExpression getPatternParameterDefinition hasPatternParameterDefinition getPatternRelatedArtifact hasPatternRelatedArtifact getPatternTriggerDefinition hasPatternTriggerDefinition getPatternUsageContext hasPatternUsageContext getPatternDosage hasPatternDosage getPatternMeta hasPatternMeta getExample setExample addExample hasExample getMinValue setMinValue hasMinValue getMinValueDateType hasMinValueDateType getMinValueDateTimeType hasMinValueDateTimeType getMinValueInstantType hasMinValueInstantType getMinValueTimeType hasMinValueTimeType getMinValueDecimalType hasMinValueDecimalType getMinValueIntegerType hasMinValueIntegerType getMinValuePositiveIntType hasMinValuePositiveIntType getMinValueUnsignedIntType hasMinValueUnsignedIntType getMinValueQuantity hasMinValueQuantity getMaxValue setMaxValue hasMaxValue getMaxValueDateType hasMaxValueDateType getMaxValueDateTimeType hasMaxValueDateTimeType getMaxValueInstantType hasMaxValueInstantType getMaxValueTimeType hasMaxValueTimeType getMaxValueDecimalType hasMaxValueDecimalType getMaxValueIntegerType hasMaxValueIntegerType getMaxValuePositiveIntType hasMaxValuePositiveIntType getMaxValueUnsignedIntType hasMaxValueUnsignedIntType getMaxValueQuantity hasMaxValueQuantity getMaxLengthElement setMaxLengthElement hasMaxLengthElement getMaxLength setMaxLength hasMaxLength getConditionElement setConditionElement addConditionElement hasConditionElement getCondition setCondition addCondition hasCondition getConstraint setConstraint addConstraint hasConstraint getMustSupportElement setMustSupportElement hasMustSupportElement getMustSupport setMustSupport hasMustSupport getIsModifierElement setIsModifierElement hasIsModifierElement getIsModifier setIsModifier hasIsModifier getIsModifierReasonElement setIsModifierReasonElement hasIsModifierReasonElement getIsModifierReason setIsModifierReason hasIsModifierReason getIsSummaryElement setIsSummaryElement hasIsSummaryElement getIsSummary setIsSummary hasIsSummary getBinding setBinding hasBinding getMapping setMapping addMapping hasMapping fhirType isEmpty isRequiredFieldsEmpty copy isComplexDataType dataTypeName toJSON getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initRepresentation initCode initAlias initType initExample initCondition initConstraint initMapping

    Constructors

    Properties

    path: null | StringType

    ElementDefinition.path Element

    FHIR Specification

    • Short: Path of the element in the hierarchy of elements
    • Definition: The path identifies the element and is expressed as a "."-separated list of ancestor elements, beginning with the name of the resource or extension.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    propertyRepresentationEnum: PropertyRepresentationEnum

    FHIR CodeSystem: PropertyRepresentation

    representation?: EnumCodeType[]

    ElementDefinition.representation Element

    FHIR Specification

    • Short: xmlAttr | xmlText | typeAttr | cdaText | xhtml
    • Definition: Codes that define how this element is represented in instances, when the deviation varies from the normal case.
    • Comment: 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.).
    • FHIR Type: code
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: PropertyRepresentationEnum

    sliceName?: StringType

    ElementDefinition.sliceName Element

    FHIR Specification

    • Short: Name for this particular element (in a set of slices)
    • Definition: 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.
    • Comment: 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.).
    • Requirements: May also be used for code generation purposes.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    sliceIsConstraining?: BooleanType

    ElementDefinition.sliceIsConstraining Element

    FHIR Specification

    • Short: If this slice definition constrains an inherited slice definition (or not)
    • Definition: 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.
    • Comment: If set to true, an ancestor profile SHALL have a slicing definition with this name. If set to false, no ancestor profile is permitted to have a slicing definition with this name.
    • Requirements: Allows detection of a situation where an ancestor profile adds or removes slicing with the same name where that might impact the child profile.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    label?: StringType

    ElementDefinition.label Element

    FHIR Specification

    • Short: Name for element to display with or prompt for element
    • Definition: 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.
    • Comment: See also the extension (http://hl7.org/fhir/StructureDefinition/elementdefinition-question)[extension-elementdefinition-question.html].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    code?: Coding[]

    ElementDefinition.code Element

    FHIR Specification

    • Short: Corresponding codes in terminologies
    • Definition: A code that has the same meaning as the element in a particular terminology.
    • Comment: 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.
    • Requirements: Links the meaning of an element to an external terminology, and is very useful for searching and indexing.
    • FHIR Type: Coding
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    ElementDefinition.slicing Element

    FHIR Specification

    • Short: This element is sliced - slices follow
    • Definition: Indicates that the element is sliced into a set of alternative definitions (i.e. in a structure definition, there are multiple different constraints on a single element in the base resource). Slicing can be used in any resource that has cardinality ..* on the base resource, or any resource with a choice of types. The set of slices is any elements that come after this in the element sequence that have the same path, until a shorter path occurs (the shorter path terminates the set).
    • Comment: 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.
    • FHIR Type: Element
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    short?: StringType

    ElementDefinition.short Element

    FHIR Specification

    • Short: Concise definition for space-constrained presentation
    • Definition: A concise description of what this element means (e.g. for use in autogenerated summaries).
    • Comment: It is easy for a different short definition to change the meaning of an element and this can have nasty downstream consequences. Please be careful when providing short definitions in a profile.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    definition?: MarkdownType

    ElementDefinition.definition Element

    FHIR Specification

    • Short: Full formal definition as narrative text
    • 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).
    • Comment: 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 in a profile.
    • Requirements: To allow a user to state the usage of an element in a particular context.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    comment?: MarkdownType

    ElementDefinition.comment Element

    FHIR Specification

    • Short: Comments about the use of this element
    • Definition: 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).
    • Comment: If it is possible to capture usage rules using constraints, that mechanism should be used in preference to this element.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    requirements?: MarkdownType

    ElementDefinition.requirements Element

    FHIR Specification

    • Short: Why this resource has been created
    • Definition: 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.
    • Comment: 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.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    alias?: StringType[]

    ElementDefinition.alias Element

    FHIR Specification

    • Short: Other names
    • Definition: Identifies additional names by which this element might also be known.
    • Requirements: Allows for better easier recognition of the element by multiple communities, including international communities.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    ElementDefinition.min Element

    FHIR Specification

    • Short: Minimum Cardinality
    • Definition: The minimum number of times this element SHALL appear in the instance.
    • FHIR Type: unsignedInt
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.max Element

    FHIR Specification

    • Short: Maximum Cardinality (a number or *)
    • Definition: The maximum number of times this element is permitted to appear in the instance.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.base Element

    FHIR Specification

    • Short: Base definition information for tools
    • Definition: 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.
    • Comment: 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. For tooling simplicity, the base information must always be populated in element definitions in snap shots, even if it is the same.
    • FHIR Type: Element
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contentReference?: UriType

    ElementDefinition.contentReference Element

    FHIR Specification

    • Short: Reference to definition of content for the element
    • Definition: Identifies an element defined elsewhere in the definition whose content rules should be applied to the current element. ContentReferences bring across all the rules that are in the ElementDefinition for the element, including definitions, cardinality constraints, bindings, invariants etc.
    • Comment: ContentReferences can only be defined in specializations, not constrained types, and they cannot be changed and always reference the non-constrained definition.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.type Element

    FHIR Specification

    • Short: Data type and Profile for this element
    • Definition: The data type or resource that the value of this element is permitted to be.
    • Comment: 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).
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    defaultValue?: IDataType

    ElementDefinition.defaultValue[x] Element

    @ChoiceDataTypesMeta('ElementDefinition.defaultValue[x]', ['base64Binary','boolean','canonical','code','date','dateTime','decimal','id','instant','integer','markdown','oid','positiveInt','string','time','unsignedInt','uri','url','uuid','Address','Age','Annotation','Attachment','CodeableConcept','Coding','ContactPoint','Count','Distance','Duration','HumanName','Identifier','Money','Period','Quantity','Range','Ratio','Reference','SampledData','Signature','Timing','ContactDetail','Contributor','DataRequirement','Expression','ParameterDefinition','RelatedArtifact','TriggerDefinition','UsageContext','Dosage','Meta',]

    FHIR Specification

    • Short: Specified value if missing from instance
    • Definition: 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').
    • Comment: 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, or changed in constraints on content models. Defining default values creates many difficulties in implementation (e.g. when is a value missing?). For these reasons, default values are (and should be) used extremely sparingly. No default values are ever defined in the FHIR specification, nor can they be defined in constraints ("profiles") on data types or resources. This element only exists so that default values may be defined in logical models.
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'Contributor', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Dosage', 'Meta',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    meaningWhenMissing?: MarkdownType

    ElementDefinition.meaningWhenMissing Element

    FHIR Specification

    • Short: Implicit meaning when this element is missing
    • Definition: The Implicit meaning that is to be understood when this element is missing (e.g. 'when this element is missing, the period is ongoing').
    • Comment: 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.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    orderMeaning?: StringType

    ElementDefinition.orderMeaning Element

    FHIR Specification

    • Short: What the order of the elements means
    • Definition: 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.
    • Comment: 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    fixed?: IDataType

    ElementDefinition.fixed[x] Element

    @ChoiceDataTypesMeta('ElementDefinition.fixed[x]', ['base64Binary','boolean','canonical','code','date','dateTime','decimal','id','instant','integer','markdown','oid','positiveInt','string','time','unsignedInt','uri','url','uuid','Address','Age','Annotation','Attachment','CodeableConcept','Coding','ContactPoint','Count','Distance','Duration','HumanName','Identifier','Money','Period','Quantity','Range','Ratio','Reference','SampledData','Signature','Timing','ContactDetail','Contributor','DataRequirement','Expression','ParameterDefinition','RelatedArtifact','TriggerDefinition','UsageContext','Dosage','Meta',]

    FHIR Specification

    • Short: Value must be exactly this
    • Definition: 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.
    • Comment: This is not recommended for Coding and CodeableConcept since these often have highly contextual properties such as version or display.
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'Contributor', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Dosage', 'Meta',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    pattern?: IDataType

    ElementDefinition.pattern[x] Element

    @ChoiceDataTypesMeta('ElementDefinition.pattern[x]', ['base64Binary','boolean','canonical','code','date','dateTime','decimal','id','instant','integer','markdown','oid','positiveInt','string','time','unsignedInt','uri','url','uuid','Address','Age','Annotation','Attachment','CodeableConcept','Coding','ContactPoint','Count','Distance','Duration','HumanName','Identifier','Money','Period','Quantity','Range','Ratio','Reference','SampledData','Signature','Timing','ContactDetail','Contributor','DataRequirement','Expression','ParameterDefinition','RelatedArtifact','TriggerDefinition','UsageContext','Dosage','Meta',]

    FHIR Specification

    • Short: Value must have at least these property values
    • Definition: 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. When pattern[x] is used to constrain a primitive, it means that the value provided in the pattern[x] must match the instance value exactly. When pattern[x] is used to constrain an array, it means that each element provided in the pattern[x] array must (recursively) match at least one element from the instance array. When pattern[x] is used to constrain a complex object, it means that each property in the pattern must be present in the complex object, and its value must recursively match -- i.e., 1. If primitive: it must match exactly the pattern value 2. If a complex object: it must match (recursively) the pattern value 3. If an array: it must match (recursively) the pattern value.
    • Comment: Mostly used for fixing values of CodeableConcept. In general, pattern[x] is not intended for use with primitive types, where is has the same meaning as fixed[x].
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'Contributor', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Dosage', 'Meta',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.example Element

    FHIR Specification

    • Short: Example value (as defined for type)
    • Definition: A sample value for this element demonstrating the type of information that would typically be found in the element.
    • Comment: 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.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    minValue?: IDataType

    ElementDefinition.minValue[x] Element

    @ChoiceDataTypesMeta('ElementDefinition.minValue[x]', ['date','dateTime','instant','time','decimal','integer','positiveInt','unsignedInt','Quantity',]

    FHIR Specification

    • Short: Minimum Allowed Value (for some types)
    • Definition: 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.
    • Comment: 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 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.
    • FHIR Types: 'date', 'dateTime', 'instant', 'time', 'decimal', 'integer', 'positiveInt', 'unsignedInt', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxValue?: IDataType

    ElementDefinition.maxValue[x] Element

    @ChoiceDataTypesMeta('ElementDefinition.maxValue[x]', ['date','dateTime','instant','time','decimal','integer','positiveInt','unsignedInt','Quantity',]

    FHIR Specification

    • Short: Maximum Allowed Value (for some types)
    • Definition: 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.
    • Comment: 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 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.
    • FHIR Types: 'date', 'dateTime', 'instant', 'time', 'decimal', 'integer', 'positiveInt', 'unsignedInt', 'Quantity',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    maxLength?: IntegerType

    ElementDefinition.maxLength Element

    FHIR Specification

    • Short: Max length for strings
    • Definition: 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.
    • Comment: 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.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    condition?: IdType[]

    ElementDefinition.condition Element

    FHIR Specification

    • Short: Reference to invariant about presence
    • Definition: A reference to an invariant that may make additional statements about the cardinality or value in the instance.
    • FHIR Type: id
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    ElementDefinition.constraint Element

    FHIR Specification

    • Short: Condition that must evaluate to true
    • Definition: Formal constraints such as co-occurrence and other constraints that can be computationally evaluated within the context of the instance.
    • Comment: Constraints should be declared on the "context" element - the lowest element in the hierarchy that is common to all nodes referenced by the constraint.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    mustSupport?: BooleanType

    ElementDefinition.mustSupport Element

    FHIR Specification

    • Short: If the element must be supported
    • Definition: 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.
    • Comment: "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. A profile on a type can always make musSupport = true if it is false in the base type but cannot make mustSupport = false if it is true in the base type. This is done in Resource Profiles, 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.
    • Requirements: Allows a profile to set expectations for system capabilities beyond merely respecting cardinality constraints.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isModifier?: BooleanType

    ElementDefinition.isModifier Element

    FHIR Specification

    • Short: If this modifies the meaning of other elements
    • Definition: 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.
    • Comment: 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.
    • Requirements: Allows elements to be introduced into a specification that can't safely be ignored by applications that don't recognize them.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isModifierReason?: StringType

    ElementDefinition.isModifierReason Element

    FHIR Specification

    • Short: Reason that this element is marked as a modifier
    • Definition: Explains how that element affects the interpretation of the resource or element that contains it.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    isSummary?: BooleanType

    ElementDefinition.isSummary Element

    FHIR Specification

    • Short: Include when _summary = true?
    • Definition: Whether the element should be included if a client requests a search with the parameter _summary=true.
    • Comment: 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 might 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. In resource and data type definitions, if an element is at the root or has a parent that is 'mustSupport' and the minimum cardinality is 1 or the element is a modifier, it must be marked as isSummary=true.
    • Requirements: Allow clients to search through large resources quickly.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.binding Element

    FHIR Specification

    • Short: ValueSet details if this is coded
    • Definition: Binds to a value set if this element is coded (code, Coding, CodeableConcept, Quantity), or the data types (string, uri).
    • Comment: 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.
    • FHIR Type: Element
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    ElementDefinition.mapping Element

    FHIR Specification

    • Short: Map element to another set of definitions
    • Definition: Identifies a concept from an external specification that roughly corresponds to this element.
    • Comment: Mappings are not necessarily specific enough for safe translation.
    • Requirements: Provides guidance to implementers familiar with or converting content from other specifications.
    • FHIR Type: Element
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided ElementDefinition JSON to instantiate the ElementDefinition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ElementDefinition

      Returns undefined | ElementDefinition

      ElementDefinition data model or undefined for ElementDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Determines if modifierExtension property exists for the provided url

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if the modifierExtension property exists and has at least one element; false otherwise

    • Adds the provided Extension to the modifierExtension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the modifierExtension property array

      Returns this

      this

    • Removes the Extension having the provided url from the modifierExtension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if the instance is a FHIR resource; false otherwise

    • Returns boolean

      true if the instance is a FHIR primitive datatype; false otherwise