Data Model Libraries
    Preparing search index...

    ElementDefinitionExampleComponent Class

    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.

    Hierarchy (View Summary)

    • DataType
      • ElementDefinitionExampleComponent

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getLabelElement setLabelElement hasLabelElement getLabel setLabel hasLabel getValue setValue hasValue getValueBase64BinaryType hasValueBase64BinaryType getValueBooleanType hasValueBooleanType getValueCanonicalType hasValueCanonicalType getValueCodeType hasValueCodeType getValueDateType hasValueDateType getValueDateTimeType hasValueDateTimeType getValueDecimalType hasValueDecimalType getValueIdType hasValueIdType getValueInstantType hasValueInstantType getValueIntegerType hasValueIntegerType getValueInteger64Type hasValueInteger64Type getValueMarkdownType hasValueMarkdownType getValueOidType hasValueOidType getValuePositiveIntType hasValuePositiveIntType getValueStringType hasValueStringType getValueTimeType hasValueTimeType getValueUnsignedIntType hasValueUnsignedIntType getValueUriType hasValueUriType getValueUrlType hasValueUrlType getValueUuidType hasValueUuidType getValueAddress hasValueAddress getValueAge hasValueAge getValueAnnotation hasValueAnnotation getValueAttachment hasValueAttachment getValueCodeableConcept hasValueCodeableConcept getValueCodeableReference hasValueCodeableReference getValueCoding hasValueCoding getValueContactPoint hasValueContactPoint getValueCount hasValueCount getValueDistance hasValueDistance getValueDuration hasValueDuration getValueHumanName hasValueHumanName getValueIdentifier hasValueIdentifier getValueMoney hasValueMoney getValuePeriod hasValuePeriod getValueQuantity hasValueQuantity getValueRange hasValueRange getValueRatio hasValueRatio getValueRatioRange hasValueRatioRange getValueReference hasValueReference getValueSampledData hasValueSampledData getValueSignature hasValueSignature getValueTiming hasValueTiming getValueContactDetail hasValueContactDetail getValueDataRequirement hasValueDataRequirement getValueExpression hasValueExpression getValueParameterDefinition hasValueParameterDefinition getValueRelatedArtifact hasValueRelatedArtifact getValueTriggerDefinition hasValueTriggerDefinition getValueUsageContext hasValueUsageContext getValueAvailability hasValueAvailability getValueExtendedContactDetail hasValueExtendedContactDetail getValueDosage hasValueDosage getValueMeta hasValueMeta fhirType isEmpty isRequiredFieldsEmpty copy dataTypeName toJSON isDataType getId setId hasId getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension isResource isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues

    Constructors

    Properties

    label: null | StringType

    ElementDefinition.example.label Element

    FHIR Specification

    • Short: Describes the purpose of this example
    • Definition: Describes the purpose of this example among the set of examples.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    value: null | IDataType

    ElementDefinition.example.value[x] Element

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

    FHIR Specification

    • Short: Value of Example (one of allowed types)
    • Definition: The actual value for the element, which must be one of the types allowed for this element.
    • FHIR Types: 'base64Binary', 'boolean', 'canonical', 'code', 'date', 'dateTime', 'decimal', 'id', 'instant', 'integer', 'integer64', 'markdown', 'oid', 'positiveInt', 'string', 'time', 'unsignedInt', 'uri', 'url', 'uuid', 'Address', 'Age', 'Annotation', 'Attachment', 'CodeableConcept', 'CodeableReference', 'Coding', 'ContactPoint', 'Count', 'Distance', 'Duration', 'HumanName', 'Identifier', 'Money', 'Period', 'Quantity', 'Range', 'Ratio', 'RatioRange', 'Reference', 'SampledData', 'Signature', 'Timing', 'ContactDetail', 'DataRequirement', 'Expression', 'ParameterDefinition', 'RelatedArtifact', 'TriggerDefinition', 'UsageContext', 'Availability', 'ExtendedContactDetail', 'Dosage', 'Meta',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ElementDefinitionExampleComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ElementDefinitionExampleComponent

      ElementDefinitionExampleComponent data model or undefined for ElementDefinitionExampleComponent

      JsonError if the provided JSON is not a valid JSON object

    • 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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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

    • Returns boolean

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