Data Model Libraries
    Preparing search index...

    VerificationResult Class

    Describes validation requirements, source(s), status and dates for one or more elements.

    FHIR Specification

    • Short: Describes validation requirements, source(s), status and dates for one or more elements
    • Definition: Describes validation requirements, source(s), status and dates for one or more elements.
    • FHIR Version: 4.0.1

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getTarget setTarget addTarget hasTarget getTargetLocationElement setTargetLocationElement addTargetLocationElement hasTargetLocationElement getTargetLocation setTargetLocation addTargetLocation hasTargetLocation getNeed setNeed hasNeed getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getStatusDateElement setStatusDateElement hasStatusDateElement getStatusDate setStatusDate hasStatusDate getValidationType setValidationType hasValidationType getValidationProcess setValidationProcess addValidationProcess hasValidationProcess getFrequency setFrequency hasFrequency getLastPerformedElement setLastPerformedElement hasLastPerformedElement getLastPerformed setLastPerformed hasLastPerformed getNextScheduledElement setNextScheduledElement hasNextScheduledElement getNextScheduled setNextScheduled hasNextScheduled getFailureAction setFailureAction hasFailureAction getPrimarySource setPrimarySource addPrimarySource hasPrimarySource getAttestation setAttestation hasAttestation getValidator setValidator addValidator hasValidator fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initTarget initTargetLocation initValidationProcess initPrimarySource initValidator

    Constructors

    Properties

    target?: Reference[]

    VerificationResult.target Element

    FHIR Specification

    targetLocation?: StringType[]

    VerificationResult.targetLocation Element

    FHIR Specification

    • Short: The fhirpath location(s) within the resource that was validated
    • Definition: The fhirpath location(s) within the resource that was validated.
    • FHIR Type: string
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    VerificationResult.need Element

    FHIR Specification

    • Short: none | initial | periodic
    • Definition: The frequency with which the target must be validated (none; initial; periodic).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    statusEnum: StatusEnum

    FHIR CodeSystem: Status

    status: null | EnumCodeType

    VerificationResult.status Element

    FHIR Specification

    • Short: attested | validated | in-process | req-revalid | val-fail | reval-fail
    • Definition: The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: StatusEnum

    statusDate?: DateTimeType

    VerificationResult.statusDate Element

    FHIR Specification

    • Short: When the validation status was updated
    • Definition: When the validation status was updated.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    validationType?: CodeableConcept

    VerificationResult.validationType Element

    FHIR Specification

    • Short: nothing | primary | multiple
    • Definition: What the target is validated against (nothing; primary source; multiple sources).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    validationProcess?: CodeableConcept[]

    VerificationResult.validationProcess Element

    FHIR Specification

    • Short: The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
    • Definition: The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    frequency?: Timing

    VerificationResult.frequency Element

    FHIR Specification

    • Short: Frequency of revalidation
    • Definition: Frequency of revalidation.
    • FHIR Type: Timing
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    lastPerformed?: DateTimeType

    VerificationResult.lastPerformed Element

    FHIR Specification

    • Short: The date/time validation was last completed (including failed validations)
    • Definition: The date/time validation was last completed (including failed validations).
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    nextScheduled?: DateType

    VerificationResult.nextScheduled Element

    FHIR Specification

    • Short: The date when target is next validated, if appropriate
    • Definition: The date when target is next validated, if appropriate.
    • FHIR Type: date
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    failureAction?: CodeableConcept

    VerificationResult.failureAction Element

    FHIR Specification

    • Short: fatal | warn | rec-only | none
    • Definition: The result if validation fails (fatal; warning; record only; none).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    VerificationResult.primarySource Element

    FHIR Specification

    • Short: Information about the primary source(s) involved in validation
    • Definition: Information about the primary source(s) involved in validation.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    VerificationResult.attestation Element

    FHIR Specification

    • Short: Information about the entity attesting to information
    • Definition: Information about the entity attesting to information.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    VerificationResult.validator Element

    FHIR Specification

    • Short: Information about the entity validating information
    • Definition: Information about the entity validating information.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR VerificationResult

      • OptionaloptSourceField: string

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

      Returns undefined | VerificationResult

      VerificationResult data model or undefined for VerificationResult

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property 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

    • 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

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has 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 modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

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