Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4

Patient Administration Work GroupMaturity Level: 0 Trial UseSecurity Category: Business Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the VerificationResult resource.

VerificationResult
Element IdVerificationResult
Definition

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

Short DisplayDescribes validation requirements, source(s), status and dates for one or more elements
Cardinality0..*
TypeDomainResource
Summaryfalse
VerificationResult.target
Element IdVerificationResult.target
Definition

A resource that was validated.

Short DisplayA resource that was validated
Cardinality0..*
TypeReference(Any)
Summarytrue
VerificationResult.targetLocation
Element IdVerificationResult.targetLocation
Definition

The fhirpath location(s) within the resource that was validated.

Short DisplayThe fhirpath location(s) within the resource that was validated
Cardinality0..*
Typestring
Summarytrue
VerificationResult.need
Element IdVerificationResult.need
Definition

The frequency with which the target must be validated (none; initial; periodic).

Short Displaynone | initial | periodic
Cardinality0..1
Terminology Bindingneed (Preferred)
TypeCodeableConcept
Summarytrue
VerificationResult.status
Element IdVerificationResult.status
Definition

The validation status of the target (attested; validated; in process; requires revalidation; validation failed; revalidation failed).

Short Displayattested | validated | in-process | req-revalid | val-fail | reval-fail
Cardinality1..1
Terminology Bindingstatus (Required)
Typecode
Summarytrue
VerificationResult.statusDate
Element IdVerificationResult.statusDate
Definition

When the validation status was updated.

Short DisplayWhen the validation status was updated
Cardinality0..1
TypedateTime
Summarytrue
VerificationResult.validationType
Element IdVerificationResult.validationType
Definition

What the target is validated against (nothing; primary source; multiple sources).

Short Displaynothing | primary | multiple
Cardinality0..1
Terminology Bindingvalidation-type (Preferred)
TypeCodeableConcept
Summarytrue
VerificationResult.validationProcess
Element IdVerificationResult.validationProcess
Definition

The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context).

Short DisplayThe primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Cardinality0..*
Terminology Bindingvalidation-process (Example)
TypeCodeableConcept
Summarytrue
VerificationResult.frequency
Element IdVerificationResult.frequency
Definition

Frequency of revalidation.

Short DisplayFrequency of revalidation
Cardinality0..1
TypeTiming
Summaryfalse
VerificationResult.lastPerformed
Element IdVerificationResult.lastPerformed
Definition

The date/time validation was last completed (including failed validations).

Short DisplayThe date/time validation was last completed (including failed validations)
Cardinality0..1
TypedateTime
Summaryfalse
VerificationResult.nextScheduled
Element IdVerificationResult.nextScheduled
Definition

The date when target is next validated, if appropriate.

Short DisplayThe date when target is next validated, if appropriate
Cardinality0..1
Typedate
Summaryfalse
VerificationResult.failureAction
Element IdVerificationResult.failureAction
Definition

The result if validation fails (fatal; warning; record only; none).

Short Displayfatal | warn | rec-only | none
Cardinality0..1
Terminology Bindingfailure-action (Preferred)
TypeCodeableConcept
Summarytrue
VerificationResult.primarySource
Element IdVerificationResult.primarySource
Definition

Information about the primary source(s) involved in validation.

Short DisplayInformation about the primary source(s) involved in validation
Cardinality0..*
Summaryfalse
VerificationResult.primarySource.who
Element IdVerificationResult.primarySource.who
Definition

Reference to the primary source.

Short DisplayReference to the primary source
Cardinality0..1
TypeReference(Organization | Practitioner | PractitionerRole)
Summaryfalse
VerificationResult.primarySource.type
Element IdVerificationResult.primarySource.type
Definition

Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source).

Short DisplayType of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
Cardinality0..*
Terminology Bindingprimary-source-type (Example)
TypeCodeableConcept
Summarytrue
VerificationResult.primarySource.communicationMethod
Element IdVerificationResult.primarySource.communicationMethod
Definition

Method for communicating with the primary source (manual; API; Push).

Short DisplayMethod for exchanging information with the primary source
Cardinality0..*
Terminology BindingVerificationResult Communication Method (Example)
TypeCodeableConcept
Summarytrue
VerificationResult.primarySource.validationStatus
Element IdVerificationResult.primarySource.validationStatus
Definition

Status of the validation of the target against the primary source (successful; failed; unknown).

Short Displaysuccessful | failed | unknown
Cardinality0..1
Terminology Bindingvalidation-status (Preferred)
TypeCodeableConcept
Summaryfalse
VerificationResult.primarySource.validationDate
Element IdVerificationResult.primarySource.validationDate
Definition

When the target was validated against the primary source.

Short DisplayWhen the target was validated against the primary source
Cardinality0..1
TypedateTime
Summaryfalse
VerificationResult.primarySource.canPushUpdates
Element IdVerificationResult.primarySource.canPushUpdates
Definition

Ability of the primary source to push updates/alerts (yes; no; undetermined).

Short Displayyes | no | undetermined
Cardinality0..1
Terminology Bindingcan-push-updates (Preferred)
TypeCodeableConcept
Summarytrue
VerificationResult.primarySource.pushTypeAvailable
Element IdVerificationResult.primarySource.pushTypeAvailable
Definition

Type of alerts/updates the primary source can send (specific requested changes; any changes; as defined by source).

Short Displayspecific | any | source
Cardinality0..*
Terminology Bindingpush-type-available (Preferred)
TypeCodeableConcept
Summaryfalse
VerificationResult.attestation
Element IdVerificationResult.attestation
Definition

Information about the entity attesting to information.

Short DisplayInformation about the entity attesting to information
Cardinality0..1
Summaryfalse
VerificationResult.attestation.who
Element IdVerificationResult.attestation.who
Definition

The individual or organization attesting to information.

Short DisplayThe individual or organization attesting to information
Cardinality0..1
TypeReference(Practitioner | PractitionerRole | Organization)
Summarytrue
VerificationResult.attestation.onBehalfOf
Element IdVerificationResult.attestation.onBehalfOf
Definition

When the who is asserting on behalf of another (organization or individual).

Short DisplayWhen the who is asserting on behalf of another (organization or individual)
Cardinality0..1
TypeReference(Organization | Practitioner | PractitionerRole)
Summarytrue
VerificationResult.attestation.communicationMethod
Element IdVerificationResult.attestation.communicationMethod
Definition

The method by which attested information was submitted/retrieved (manual; API; Push).

Short DisplayThe method by which attested information was submitted/retrieved
Cardinality0..1
Terminology BindingVerificationResult Communication Method (Example)
TypeCodeableConcept
Summarytrue
VerificationResult.attestation.date
Element IdVerificationResult.attestation.date
Definition

The date the information was attested to.

Short DisplayThe date the information was attested to
Cardinality0..1
Typedate
Summarytrue
VerificationResult.attestation.sourceIdentityCertificate
Element IdVerificationResult.attestation.sourceIdentityCertificate
Definition

A digital identity certificate associated with the attestation source.

Short DisplayA digital identity certificate associated with the attestation source
Cardinality0..1
Typestring
Summaryfalse
VerificationResult.attestation.proxyIdentityCertificate
Element IdVerificationResult.attestation.proxyIdentityCertificate
Definition

A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source.

Short DisplayA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
Cardinality0..1
Typestring
Summaryfalse
VerificationResult.attestation.proxySignature
Element IdVerificationResult.attestation.proxySignature
Definition

Signed assertion by the proxy entity indicating that they have the right to submit attested information on behalf of the attestation source.

Short DisplayProxy signature
Cardinality0..1
TypeSignature
Summaryfalse
VerificationResult.attestation.sourceSignature
Element IdVerificationResult.attestation.sourceSignature
Definition

Signed assertion by the attestation source that they have attested to the information.

Short DisplayAttester signature
Cardinality0..1
TypeSignature
Summaryfalse
VerificationResult.validator
Element IdVerificationResult.validator
Definition

Information about the entity validating information.

Short DisplayInformation about the entity validating information
Cardinality0..*
Summaryfalse
VerificationResult.validator.organization
Element IdVerificationResult.validator.organization
Definition

Reference to the organization validating information.

Short DisplayReference to the organization validating information
Cardinality1..1
TypeReference(Organization)
Summaryfalse
VerificationResult.validator.identityCertificate
Element IdVerificationResult.validator.identityCertificate
Definition

A digital identity certificate associated with the validator.

Short DisplayA digital identity certificate associated with the validator
Cardinality0..1
Typestring
Summaryfalse
VerificationResult.validator.attestationSignature
Element IdVerificationResult.validator.attestationSignature
Definition

Signed assertion by the validator that they have validated the information.

Short DisplayValidator signature
Cardinality0..1
TypeSignature
Summaryfalse