FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

8.39 Resource VerificationResult - Content

Patient Administration icon Work GroupMaturity Level: 1 Trial UseSecurity Category: Business Compartments: No defined compartments

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

8.39.1 Scope and Usage

The VerificationResult can be used where content (such as found in a directory) is aggregated between systems, and the details and results of this verification process needs to be recorded, to determine the likely accuracy/confidence in the content.
It does not represent the workflows or tasks related, but does cover the result of who did what when, why, and when it needs to be done again.

There are often multiple instances of the VerificationResult over time that reference the same resource, even if the resource has not changed, as the content was verified as still current. Alternately the process may discover that the content was no longer valid (i.e. the practitioner was not able to be verified was still working at the location) and therefore the instance could be updated to not be active, or even removed from the directory.

8.39.2 Boundaries and Relationships

AuditEvent Details of where/who the resource came from, along with technical data - typically system adminisrtrative data, often not externally accessible.
Provenance Business level details of where the content came from and what it can be used for.
VerificationResult Details of checks/workflow results that were performed to verify the accuracy of the referenced resource. This informs if the data should be trusted, or how current the information is.

(A similar concept exists outside of healthcare in Art/Musical Equipment in Appraisals vs Provenance, the provenance of the piece covers its chain of ownership, where an appraisal covers how it was check for its authenticity)

Although the resource uses a Reference(any), the initial usage is in the directory space against:

  • Organization
  • OrganizationAffiliation
  • Location
  • Practitioner
  • PractitionerRole
  • HealthcareService

Note to Implementers: Other resources may use this approach for verifying currency too, and may be updated to be included here in future versions of fhir, or in fhir implementation guides.


It is not typically expected that other resources would reference VerificationResult

8.39.3 References to this Resource

No references for this Resource.

8.39.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult TU DomainResource Describes validation requirements, source(s), status and dates for one or more elements

Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... target Σ 0..* Reference(Any) A resource that was validated

... targetLocation Σ 0..* string The fhirpath location(s) within the resource that was validated

... need Σ 0..1 CodeableConcept none | initial | periodic
Binding: need (Preferred)
... statusDate Σ 0..1 dateTime When the validation status was updated
... validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Binding: validation-type (Preferred)
... validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Binding: validation-process (Example)

... frequency 0..1 Timing Frequency of revalidation
... lastPerformed 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled 0..1 date The date when target is next validated, if appropriate
... failureAction Σ 0..1 CodeableConcept fatal | warn | rec-only | none
Binding: failure-action (Preferred)
... primarySource 0..* BackboneElement Information about the primary source(s) involved in validation

.... who 0..1 Reference(Organization | Practitioner | PractitionerRole) Reference to the primary source
.... type Σ 0..* CodeableConcept Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
Binding: primary-source-type (Example)

.... communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: VerificationResult Communication Method (Example)

.... validationStatus 0..1 CodeableConcept successful | failed | unknown
Binding: validation-status (Preferred)
.... validationDate 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Binding: can-push-updates (Preferred)
.... pushTypeAvailable 0..* CodeableConcept specific | any | source
Binding: push-type-available (Preferred)

... attestation 0..1 BackboneElement Information about the entity attesting to information
.... who Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) The individual or organization attesting to information
.... onBehalfOf Σ 0..1 Reference(Organization | Practitioner | PractitionerRole) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod Σ 0..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: VerificationResult Communication Method (Example)
.... date Σ 0..1 date The date the information was attested to
.... sourceIdentityCertificate 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature 0..1 Signature Proxy signature (digital or image)
.... sourceSignature 0..1 Signature Attester signature (digital or image)
... validator 0..* BackboneElement Information about the entity validating information

.... organization 1..1 Reference(Organization) Reference to the organization validating information
.... identityCertificate 0..1 string A digital identity certificate associated with the validator
.... attestationSignature 0..1 Signature Validator signature (digital or image)

doco Documentation for this format icon

See the Extensions for this resource

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions, the spreadsheet version & the dependency analysis

8.39.4.1 Terminology Bindings

Path ValueSet Type Documentation
VerificationResult.need Need Preferred

The frequency with which the target must be validated
VerificationResult.status VerificationResultStatus (a valid code from status) Required

The validation status of the target
VerificationResult.validationType ValidationType (a valid code from Validation-type icon) Preferred

What the target is validated against
VerificationResult.validationProcess ValidationProcess (a valid code from Validation-process icon) Example

The primary process by which the target is validated
VerificationResult.failureAction FailureAction (a valid code from Failure-action icon) Preferred

The result if validation fails
VerificationResult.primarySource.type PrimarySourceType (a valid code from Primary-source-type icon) Example

Type of the validation primary source
VerificationResult.primarySource.communicationMethod VerificationresultCommunicationMethod Example

Attested information may be validated by process that are manual or automated. For automated processes it may accomplished by the system of record reaching out through another system's API or information may be sent to the system of record. This value set defines a set of codes to describing the process, the how, a resource or data element is validated.
VerificationResult.primarySource.validationStatus ValidationStatus (a valid code from Validation-status icon) Preferred

Status of the validation of the target against the primary source
VerificationResult.primarySource.canPushUpdates CanPushUpdates (a valid code from Can-push-updates icon) Preferred

Ability of the primary source to push updates/alerts
VerificationResult.primarySource.pushTypeAvailable PushTypeAvailable (a valid code from Push-type-available icon) Preferred

Type of alerts/updates the primary source can send
VerificationResult.attestation.communicationMethod VerificationresultCommunicationMethod Example

Attested information may be validated by process that are manual or automated. For automated processes it may accomplished by the system of record reaching out through another system's API or information may be sent to the system of record. This value set defines a set of codes to describing the process, the how, a resource or data element is validated.

8.39.5 Notes:

8.39.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
attestation-method token Select validation information for data that was attested to using the specified method VerificationResult.attestation.communicationMethod
attestation-onbehalfof reference Select validation information for data that was attested to on behalf of the specified source VerificationResult.attestation.onBehalfOf
(Practitioner, Organization, PractitionerRole)
attestation-who reference Select validation information for data that was attested to by the specified source VerificationResult.attestation.who
(Practitioner, Organization, PractitionerRole)
primarysource-date date Select validation information for data that was validated against a primary source on the specified date VerificationResult.primarySource.validationDate
primarysource-type token Select validation information for data that was validated against the specified type of primary source organization VerificationResult.primarySource.type
primarysource-who reference Select validation information for data that was validated against the specified primary source VerificationResult.primarySource.who
(Practitioner, Organization, PractitionerRole)
status token Select validation information with the specified status VerificationResult.status
status-date date Select validation information with a validation status that occurred at the specified date/time VerificationResult.statusDate
target reference A resource that was validated VerificationResult.target
(Any)
validator-organization reference Select validation information for data that was validated by the specified organization VerificationResult.validator.organization
(Organization)