Administrative Incubator
0.1.0 - International flag

Administrative Incubator, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/admin-incubator/ and changes regularly. See the Directory of published versions

Resource: Verification Result

Official URL: http://hl7.org/fhir/StructureDefinition/VerificationResult Version: 0.1.0
Standards status: Trial-use Draft as of 2021-01-02 Maturity Level: 1 Computable Name: VerificationResult
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1433

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

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.

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
[%stu-note dstu%] 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. [%end-note%]
It is not typically expected that other resources would reference VerificationResult

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Resource Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerificationResult 0..* 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(Resource) 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): The frequency with which the target must be validated.
... statusDate Σ 0..1 dateTime When the validation status was updated
... validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Binding: ValidationType (preferred): What the target is validated against.
... validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Binding: ValidationProcess (example): The primary process by which the target is validated.
... 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: FailureAction (preferred): The result if validation fails.
... 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: PrimarySourceType (example): Type of the validation primary source.
.... communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: VerificationresultCommunicationMethod (example): Method for communicating with the data source (manual; API; Push).
.... validationStatus 0..1 CodeableConcept successful | failed | unknown
Binding: ValidationStatus (preferred): Status of the validation of the target against the primary source.
.... validationDate 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Binding: CanPushUpdates (preferred): Ability of the primary source to push updates/alerts.
.... pushTypeAvailable 0..* CodeableConcept specific | any | source
Binding: PushTypeAvailable (preferred): Type of alerts/updates the primary source can send.
... 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: VerificationresultCommunicationMethod (example): Method for communicating with the data source (manual; API; Push).
.... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
VerificationResult.need Base preferred need 📦6.0.0-ballot3 FHIR Std.
VerificationResult.status Base required Verification Result status 📦6.0.0-ballot3 FHIR Std.
VerificationResult.validationType Base preferred validation-type 📦6.0.0-ballot3 FHIR Std.
VerificationResult.validationProcess Base example validation-process 📦6.0.0-ballot3 FHIR Std.
VerificationResult.failureAction Base preferred failure-action 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​type Base example primary-source-type 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​communicationMethod Base example VerificationResult Communication Method 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​validationStatus Base preferred validation-status 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​canPushUpdates Base preferred can-push-updates 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable Base preferred push-type-available 📦6.0.0-ballot3 FHIR Std.
VerificationResult.attestation.​communicationMethod Base example VerificationResult Communication Method 📦6.0.0-ballot3 FHIR Std.
<VerificationResult xmlns="http://hl7.org/fhir"> doco
 <id value="[id]"/><!-- 0..1 * Logical id of this artifact  -->
 <meta><!-- I 0..1 * Metadata about the resource  --></meta>
 <implicitRules value="[uri]"/><!-- I 0..1 * A set of rules under which this content was created  -->
 <language value="[code]"/><!-- I 0..1 * Language of the resource content  -->
 <text><!-- I 0..1 * Text summary of the resource, for human interpretation  --></text>
 <contained><!-- 0..* * Contained, inline Resources  --></contained>
 <extension><!-- See Extensions  Additional content defined by implementations  --></extension>
 <modifierExtension><!-- I 0..* * Extensions that cannot be ignored  --></modifierExtension>
 <target><!-- 0..* * A resource that was validated  --></target>
 <targetLocation value="[string]"/><!-- 0..* * The fhirpath location(s) within the resource that was validated  -->
 <need><!-- 0..1 * none | initial | periodic  --></need>
 <status value="[code]"/><!-- 1..1 * attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error  -->
 <statusDate value="[dateTime]"/><!-- 0..1 * When the validation status was updated  -->
 <validationType><!-- 0..1 * nothing | primary | multiple  --></validationType>
 <validationProcess><!-- 0..* * The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)  --></validationProcess>
 <frequency><!-- 0..1 * Frequency of revalidation  --></frequency>
 <lastPerformed value="[dateTime]"/><!-- 0..1 * The date/time validation was last completed (including failed validations)  -->
 <nextScheduled value="[date]"/><!-- 0..1 * The date when target is next validated, if appropriate  -->
 <failureAction><!-- 0..1 * fatal | warn | rec-only | none  --></failureAction>
 <primarySource> I 0..* *  <!-- I 0..* Information about the primary source(s) involved in validation -->
  <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <who><!-- 0..1 * Reference to the primary source   --></who>
  <type><!-- 0..* * Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)   --></type>
  <communicationMethod><!-- 0..* * Method for exchanging information with the primary source   --></communicationMethod>
  <validationStatus><!-- 0..1 * successful | failed | unknown   --></validationStatus>
  <validationDate value="[dateTime]"/><!-- 0..1 * When the target was validated against the primary source   -->
  <canPushUpdates><!-- 0..1 * yes | no | undetermined   --></canPushUpdates>
  <pushTypeAvailable><!-- 0..* * specific | any | source   --></pushTypeAvailable>
 </primarySource>
 <attestation> I 0..1 *  <!-- I 0..1 Information about the entity attesting to information -->
  <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <who><!-- 0..1 * The individual or organization attesting to information   --></who>
  <onBehalfOf><!-- 0..1 * When the who is asserting on behalf of another (organization or individual)   --></onBehalfOf>
  <communicationMethod><!-- 0..1 * The method by which attested information was submitted/retrieved   --></communicationMethod>
  <date value="[date]"/><!-- 0..1 * The date the information was attested to   -->
  <sourceIdentityCertificate value="[string]"/><!-- 0..1 * A digital identity certificate associated with the attestation source   -->
  <proxyIdentityCertificate value="[string]"/><!-- 0..1 * A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source   -->
  <proxySignature><!-- 0..1 * Proxy signature (digital or image)   --></proxySignature>
  <sourceSignature><!-- 0..1 * Attester signature (digital or image)   --></sourceSignature>
 </attestation>
 <validator> I 0..* *  <!-- I 0..* Information about the entity validating information -->
  <id value="[id]"/><!-- 0..1 * Unique id for inter-element referencing   -->
  <extension><!-- See Extensions  Additional content defined by implementations   --></extension>
  <modifierExtension><!-- I 0..* * Extensions that cannot be ignored even if unrecognized   --></modifierExtension>
  <organization><!-- 1..1 * Reference to the organization validating information   --></organization>
  <identityCertificate value="[string]"/><!-- 0..1 * A digital identity certificate associated with the validator   -->
  <attestationSignature><!-- 0..1 * Validator signature (digital or image)   --></attestationSignature>
 </validator>
</VerificationResult>

{doco
  "resourceType" : "VerificationResult",
  "id" : "<id>", // 0..1 Logical id of this artifact
  "meta" : { Meta }, // I 0..1 Metadata about the resource
  "implicitRules" : "<uri>", // I 0..1 A set of rules under which this content was created
  "language" : "<code>", // I 0..1 Language of the resource content
  "text" : { Narrative }, // I 0..1 Text summary of the resource, for human interpretation
  "contained" : [{ Resource }], // 0..* Contained, inline Resources
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
  "target" : [{ Reference(Resource) }], // 0..* A resource that was validated
  "targetLocation" : ["<string>"], // 0..* The fhirpath location(s) within the resource that was validated
  "need" : { CodeableConcept }, // 0..1 none | initial | periodic
  "status" : "<code>", // 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error
  "statusDate" : "<dateTime>", // 0..1 When the validation status was updated
  "validationType" : { CodeableConcept }, // 0..1 nothing | primary | multiple
  "validationProcess" : [{ CodeableConcept }], // 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
  "frequency" : { Timing }, // 0..1 Frequency of revalidation
  "lastPerformed" : "<dateTime>", // 0..1 The date/time validation was last completed (including failed validations)
  "nextScheduled" : "<date>", // 0..1 The date when target is next validated, if appropriate
  "failureAction" : { CodeableConcept }, // 0..1 fatal | warn | rec-only | none
  "primarySource" : [{ BackboneElement }], // I 0..* Information about the primary source(s) involved in validation
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // 0..1 Reference to the primary source
    "type" : [{ CodeableConcept }], // 0..* Type of primary source (License Board; Primary Education; Continuing Education; Postal Service; Relationship owner; Registration Authority; legal source; issuing source; authoritative source)
    "communicationMethod" : [{ CodeableConcept }], // 0..* Method for exchanging information with the primary source
    "validationStatus" : { CodeableConcept }, // 0..1 successful | failed | unknown
    "validationDate" : "<dateTime>", // 0..1 When the target was validated against the primary source
    "canPushUpdates" : { CodeableConcept }, // 0..1 yes | no | undetermined
    "pushTypeAvailable" : [{ CodeableConcept }] // 0..* specific | any | source
  }
  "attestation" : { BackboneElement }, // I 0..1 Information about the entity attesting to information
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "who" : { Reference(Organization|Practitioner|PractitionerRole) }, // 0..1 The individual or organization attesting to information
    "onBehalfOf" : { Reference(Organization|Practitioner|PractitionerRole) }, // 0..1 When the who is asserting on behalf of another (organization or individual)
    "communicationMethod" : { CodeableConcept }, // 0..1 The method by which attested information was submitted/retrieved
    "date" : "<date>", // 0..1 The date the information was attested to
    "sourceIdentityCertificate" : "<string>", // 0..1 A digital identity certificate associated with the attestation source
    "proxyIdentityCertificate" : "<string>", // 0..1 A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
    "proxySignature" : { Signature }, // 0..1 Proxy signature (digital or image)
    "sourceSignature" : { Signature } // 0..1 Attester signature (digital or image)
  }
  "validator" : [{ BackboneElement }] // I 0..* Information about the entity validating information
    "id" : "<id>", // 0..1 Unique id for inter-element referencing
  (Extensions - see JSON page)
  (Modifier Extensions - see JSON page)
    "organization" : { Reference(Organization) }, // 1..1 Reference to the organization validating information
    "identityCertificate" : "<string>", // 0..1 A digital identity certificate associated with the validator
    "attestationSignature" : { Signature } // 0..1 Validator signature (digital or image)
  }
}

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:VerificationResult;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  fhir:id [ id ] ; # 0..1 Logical id of this artifact
  fhir:meta [ Meta ] ; # 0..1 I Metadata about the resource
  fhir:implicitRules [ uri ] ; # 0..1 I A set of rules under which this content was created
  fhir:language [ code ] ; # 0..1 I Language of the resource content
  fhir:text [ Narrative ] ; # 0..1 I Text summary of the resource, for human interpretation
  fhir:contained  ( [ Resource ] ... ) ; # 0..* Contained, inline Resources
  fhir:extension  ( [ Extension ] ... ) ; # 0..* I Additional content defined by implementations
  fhir:modifierExtension  ( [ Extension ] ... ) ; # 0..* I Extensions that cannot be ignored
  fhir:target  ( [ Reference(Resource) ] ... ) ; # 0..* A resource that was validated
  fhir:targetLocation  ( [ string ] ... ) ; # 0..* The fhirpath location(s) within the resource that was validated
  fhir:need [ CodeableConcept ] ; # 0..1 none | initial | periodic
  fhir:status [ code ] ; # 1..1 attested | validated | in-process | req-revalid | val-fail | reval-fail | entered-in-error
  fhir:statusDate [ dateTime ] ; # 0..1 When the validation status was updated
  fhir:validationType [ CodeableConcept ] ; # 0..1 nothing | primary | multiple
  fhir:validationProcess  ( [ CodeableConcept ] ... ) ; # 0..* The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
  fhir:frequency [ Timing ] ; # 0..1 Frequency of revalidation
  fhir:lastPerformed [ dateTime ] ; # 0..1 The date/time validation was last completed (including failed validations)
  fhir:nextScheduled [ date ] ; # 0..1 The date when target is next validated, if appropriate
  fhir:failureAction [ CodeableConcept ] ; # 0..1 fatal | warn | rec-only | none
  fhir:primarySource  ( [ BackboneElement ] ... ) ; # 0..* I Information about the primary source(s) involved in validation
  fhir:attestation [ BackboneElement ] ; # 0..1 I Information about the entity attesting to information
  fhir:validator  ( [ BackboneElement ] ... ) ; # 0..* I Information about the entity validating information
]

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. VerificationResult 0..* 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(Resource) 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): The frequency with which the target must be validated.
... statusDate Σ 0..1 dateTime When the validation status was updated
... validationType Σ 0..1 CodeableConcept nothing | primary | multiple
Binding: ValidationType (preferred): What the target is validated against.
... validationProcess Σ 0..* CodeableConcept The primary process by which the target is validated (edit check; value set; primary source; multiple sources; standalone; in context)
Binding: ValidationProcess (example): The primary process by which the target is validated.
... 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: FailureAction (preferred): The result if validation fails.
... 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: PrimarySourceType (example): Type of the validation primary source.
.... communicationMethod Σ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: VerificationresultCommunicationMethod (example): Method for communicating with the data source (manual; API; Push).
.... validationStatus 0..1 CodeableConcept successful | failed | unknown
Binding: ValidationStatus (preferred): Status of the validation of the target against the primary source.
.... validationDate 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates Σ 0..1 CodeableConcept yes | no | undetermined
Binding: CanPushUpdates (preferred): Ability of the primary source to push updates/alerts.
.... pushTypeAvailable 0..* CodeableConcept specific | any | source
Binding: PushTypeAvailable (preferred): Type of alerts/updates the primary source can send.
... 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: VerificationresultCommunicationMethod (example): Method for communicating with the data source (manual; API; Push).
.... 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

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
VerificationResult.need Base preferred need 📦6.0.0-ballot3 FHIR Std.
VerificationResult.status Base required Verification Result status 📦6.0.0-ballot3 FHIR Std.
VerificationResult.validationType Base preferred validation-type 📦6.0.0-ballot3 FHIR Std.
VerificationResult.validationProcess Base example validation-process 📦6.0.0-ballot3 FHIR Std.
VerificationResult.failureAction Base preferred failure-action 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​type Base example primary-source-type 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​communicationMethod Base example VerificationResult Communication Method 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​validationStatus Base preferred validation-status 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​canPushUpdates Base preferred can-push-updates 📦6.0.0-ballot3 FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable Base preferred push-type-available 📦6.0.0-ballot3 FHIR Std.
VerificationResult.attestation.​communicationMethod Base example VerificationResult Communication Method 📦6.0.0-ballot3 FHIR Std.

 

Other representations of resource: CSV, Excel

Notes:

Notes:

Name Type Description Expression
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
attestation-who reference

Select validation information for data that was attested to by the specified source

VerificationResult.attestation.who
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
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
validator-organization reference

Select validation information for data that was validated by the specified organization

VerificationResult.validator.organization