Validated Healthcare Directory
1.0.0 - STU1 International flag

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

Resource Profile: VhDir Validation

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/vhdir-validation Version: 1.0.0
Active as of 2017-12-10 Computable Name: VhdirValidation

Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

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

This profile sets minimum expectations for searching for and fetching information associated with validation. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the VerificationResult resource when using this profile.

Background & Scope

This implementation guide was developed to support the need for validated provider data in many different healthcare workflows. It profiles the verificationResult resource to convey information about the validation status of any data in a validated healthcare directory, including how it was validated, who validated it, and where the data came from.

This profile modifies the base VerificationResult resource in the following manner:

  • Constrains the cardinality of VerificationResult.target (1..), verificationResult.need (1..1), verificationResult.statusDate (1..1), verificationResult.validationType (1..1), verificationResult.validationProcess (1..), verificationResult.failureAction (1..1), verificationResult.primarySource.type (1..*), verificationResult.attestation.communicatonMethod (1..1), verificationResult.attestation.date (1..1)

  • All references SHALL conform to the appropriate Validated Healthcare Directory Implementation Guide profile

Examples:

The following are example uses for the vhdir-validation profile:

Mandatory Data Elements

The following data-elements are mandatory (i.e data MUST be present). These are presented below in a simple human-readable explanation. The Formal Profile Definition below provides the formal summary, definitions, and terminology requirements.

Each VerificationResult resource must have:

  1. At least one target in verificationResult.target
  2. A coded representation of how often the target is validated in verificationResult.need
  3. A coded representation of the target's current validation status in verificationResult.status
  4. A date/time when the target's validation status was last updated in verificationResult.statusDate
  5. A coded representation of whether the target is validated against a primary source(s) in verificationResult.validationType
  6. At least one coded/text representation of the process by which the target was validated in verificationResult.validationProcess
  7. A coded representation of what happens if validation of the target fails in verificationResult.failureAction
  8. For each primary source described:
    1. At least one coded/text representation of the type of primary source in verificationResult.primarySource.type
  9. Information about the source of the attested information in VerificationResult.attestation, including a reference to a Practitioner, PractitionerRole, or Organization resource representing the source of the information in VerificationResult.attestation.who
  10. For each validator described:
    1. One reference to the Organization resource for the validator in verificationResult.validator.organization

Profile specific implementation guidance:

The core of the verificationResult resource includes basic information about how data was validated:

  • verificationResult.target and verificationResult.targetLocation provide a means to describe the specific data that has been validated. The target is a reference to any resource, and the targetLocation is a FHIRpath expression indicating which specific element(s) in that resource have been validated.
  • verificationResult.need and verificationResult.frequency describe when the target should be validated, and how often it must be revalidated
  • verificationResult.status describes the current status of validation for the target. verificationResult.statusDate indicates when the validation status was last updated.
  • verificationResult.validationType describes what the target is validated against (i.e. whether it is validated against a single primary source, whether it is validated against multiple sources, or whether it wasn't validated because attested information is sufficient)
  • verificationResult.validationProcess describes the validation processes for validating the target
  • verificationResult.lastPerformed and verificationResult.nextScheduled describe the last completed and next scheduled dates of validation for the target
  • verificationResult.failureAction describes what happens if validation of the target fails

The resource also provides information about entities involved in the validation process:

verificationResult.primarySource provides information about the primary source(s) the target was validated against

  • who identifies the primary source, and type indicates what the primary source is
  • communicationMethod indicates how an entity can communicate with the primary source
  • validationStatus, and validationDate describe the status of the validation of the target against the primary source
  • canPushUpdates and pushTypeAvailable indicate whether a primary source can push updates or alerts (e.g. alerting the validated healthcare directory if a license board suspends a practitioner's license)

verificationResult.attestation provides information about who attested to the information being validated

  • who identifies the source of the attested information (a practitioner, practitionerRole, or organization), onBehalfOf identifies an entity the "who" is attesting on behalf of.
  • communicationMethod indicates how attested information is submitted/retrieved
  • date indicates when the information was attested to
  • sourceIdentityCertificate and proxyIdentityCertificate assert the identity of the individual attesting to information and any proxy providing attested information on their behalf.
  • sourceSignature and proxySignature assert that information was attested to/provided by the entity with the right to do so. verificationResult.validator provides information about the entity performing the validation of the target
  • organization identifies the validating organization, and identityCertificate asserts their identity
  • attestationSignature asserts that the validator has validated the target

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from VerificationResult

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... target S 1..* Reference(Resource) A resource that was validated
... targetLocation S 0..* string The fhirpath location(s) within the resource that was validated
... need S 1..1 CodeableConcept none | initial | periodic
... status S 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
... statusDate S 1..1 dateTime When the validation status was updated
... validationType S 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess S 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction S 1..1 CodeableConcept fatal | warn | rec-only | none
... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type S 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod S 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates S 0..1 CodeableConcept yes | no | undetermined
.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... who S 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf S 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod S 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date S 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) A resource that was validated
... targetLocation SΣ 0..* string The fhirpath location(s) within the resource that was validated
... need SΣ 1..1 CodeableConcept none | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ 1..1 dateTime When the validation status was updated
... validationType SΣ 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess SΣ 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction SΣ 1..1 CodeableConcept fatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type SΣ 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates SΣ 0..1 CodeableConcept yes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who SΣ 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf SΣ 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerificationResult.needpreferredneed
http://hl7.org/fhir/ValueSet/verificationresult-need
from the FHIR Standard
VerificationResult.statusrequiredstatus
http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1
from the FHIR Standard
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.failureActionpreferredfailure-action
http://hl7.org/fhir/ValueSet/verificationresult-failure-action
from the FHIR Standard
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.primarySource.validationStatuspreferredvalidation-status
http://hl7.org/fhir/ValueSet/verificationresult-validation-status
from the FHIR Standard
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates
from the FHIR Standard
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
http://hl7.org/fhir/ValueSet/verificationresult-push-type-available
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) A resource that was validated
... targetLocation SΣ 0..* string The fhirpath location(s) within the resource that was validated
... need SΣ 1..1 CodeableConcept none | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ 1..1 dateTime When the validation status was updated
... validationType SΣ 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess SΣ 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction SΣ 1..1 CodeableConcept fatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type SΣ 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates SΣ 0..1 CodeableConcept yes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who SΣ 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf SΣ 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerificationResult.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
VerificationResult.needpreferredneed
http://hl7.org/fhir/ValueSet/verificationresult-need
from the FHIR Standard
VerificationResult.statusrequiredstatus
http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1
from the FHIR Standard
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.failureActionpreferredfailure-action
http://hl7.org/fhir/ValueSet/verificationresult-failure-action
from the FHIR Standard
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.primarySource.validationStatuspreferredvalidation-status
http://hl7.org/fhir/ValueSet/verificationresult-validation-status
from the FHIR Standard
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates
from the FHIR Standard
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
http://hl7.org/fhir/ValueSet/verificationresult-push-type-available
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard

Differential View

This structure is derived from VerificationResult

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... target S 1..* Reference(Resource) A resource that was validated
... targetLocation S 0..* string The fhirpath location(s) within the resource that was validated
... need S 1..1 CodeableConcept none | initial | periodic
... status S 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
... statusDate S 1..1 dateTime When the validation status was updated
... validationType S 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess S 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction S 1..1 CodeableConcept fatal | warn | rec-only | none
... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type S 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod S 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates S 0..1 CodeableConcept yes | no | undetermined
.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... who S 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf S 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod S 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date S 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) A resource that was validated
... targetLocation SΣ 0..* string The fhirpath location(s) within the resource that was validated
... need SΣ 1..1 CodeableConcept none | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ 1..1 dateTime When the validation status was updated
... validationType SΣ 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess SΣ 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction SΣ 1..1 CodeableConcept fatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type SΣ 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates SΣ 0..1 CodeableConcept yes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who SΣ 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf SΣ 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerificationResult.needpreferredneed
http://hl7.org/fhir/ValueSet/verificationresult-need
from the FHIR Standard
VerificationResult.statusrequiredstatus
http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1
from the FHIR Standard
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.failureActionpreferredfailure-action
http://hl7.org/fhir/ValueSet/verificationresult-failure-action
from the FHIR Standard
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.primarySource.validationStatuspreferredvalidation-status
http://hl7.org/fhir/ValueSet/verificationresult-validation-status
from the FHIR Standard
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates
from the FHIR Standard
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
http://hl7.org/fhir/ValueSet/verificationresult-push-type-available
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..* VerificationResult Validation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..* Reference(Resource) A resource that was validated
... targetLocation SΣ 0..* string The fhirpath location(s) within the resource that was validated
... need SΣ 1..1 CodeableConcept none | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

... status SΣ 1..1 code attested | validated | in-process | req-revalid | val-fail | reval-fail
Binding: status (required): The validation status of the target.

... statusDate SΣ 1..1 dateTime When the validation status was updated
... validationType SΣ 1..1 CodeableConcept nothing|single|multiple
Binding: validation-type (example)
... validationProcess SΣ 1..* CodeableConcept The process(es) by which the target is validated
Binding: VhDir Validation Process (example)
... frequency S 0..1 Timing Frequency of revalidation
... lastPerformed S 0..1 dateTime The date/time validation was last completed (including failed validations)
... nextScheduled S 0..1 date The date when target is next validated, if appropriate
... failureAction SΣ 1..1 CodeableConcept fatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S 0..* BackboneElement Information about the primary source(s) involved in validation
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who S 0..1 Reference(VhDir Organization | VhDir Practitioner | VhDir Practitioner Role) Reference to the primary source
.... type SΣ 1..* CodeableConcept Type of primary source
Binding: primary-source-type (example)
.... communicationMethod SΣ 0..* CodeableConcept Method for exchanging information with the primary source
Binding: verificationresult-communication-method (example)
.... validationStatus S 0..1 CodeableConcept successful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

.... validationDate S 0..1 dateTime When the target was validated against the primary source
.... canPushUpdates SΣ 0..1 CodeableConcept yes | no | undetermined
Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.

.... pushTypeAvailable S 0..* CodeableConcept specific | any | source
Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.


... attestation S 1..1 BackboneElement Information about the entity attesting to information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who SΣ 1..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) The individual or organization attesting to information
.... onBehalfOf SΣ 0..1 Reference(VhDir Practitioner | VhDir Organization | VhDir Practitioner Role) When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ 1..1 CodeableConcept The method by which attested information was submitted/retrieved
Binding: verificationresult-communication-method (example)
.... date SΣ 1..1 date The date the information was attested to
.... sourceIdentityCertificate S 0..1 string A digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S 0..1 string A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S 0..1 Signature Proxy signature
.... sourceSignature S 0..1 Signature Attester signature
... validator S 0..* BackboneElement Information about the entity validating information
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... organization S 1..1 Reference(VhDir Organization) Reference to the organization validating information
.... identityCertificate S 0..1 string A digital identity certificate associated with the validator
.... attestationSignature S 0..1 Signature Validator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
VerificationResult.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
VerificationResult.needpreferredneed
http://hl7.org/fhir/ValueSet/verificationresult-need
from the FHIR Standard
VerificationResult.statusrequiredstatus
http://hl7.org/fhir/ValueSet/verificationresult-status|4.0.1
from the FHIR Standard
VerificationResult.validationTypeexamplevalidation-type
http://hl7.org/fhir/ValueSet/verificationresult-validation-type
from the FHIR Standard
VerificationResult.validationProcessexampleVhDirValidationProcess
http://hl7.org/fhir/uv/vhdir/ValueSet/validationprocess
from this IG
VerificationResult.failureActionpreferredfailure-action
http://hl7.org/fhir/ValueSet/verificationresult-failure-action
from the FHIR Standard
VerificationResult.primarySource.typeexampleprimary-source-type
http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type
from the FHIR Standard
VerificationResult.primarySource.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard
VerificationResult.primarySource.validationStatuspreferredvalidation-status
http://hl7.org/fhir/ValueSet/verificationresult-validation-status
from the FHIR Standard
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
http://hl7.org/fhir/ValueSet/verificationresult-can-push-updates
from the FHIR Standard
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
http://hl7.org/fhir/ValueSet/verificationresult-push-type-available
from the FHIR Standard
VerificationResult.attestation.communicationMethodexampleverificationresult-communication-method
http://hl7.org/fhir/ValueSet/verificationresult-communication-method
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Searches

  1. GET [base]/VerificationResult?attestation-who=[id]

    Support: SHALL support search by the attestation-who parameter

    • with a target type: Practitioner, Organization, PractitionerRole
    • including the modifiers: type
    • including these search paramaters which may be chained: attestation-who.identifier, attestation-who.address, attestation-who.name, attestation-who.partof, attestation-who.location, attestation-who.organization, attestation-who.practitioner

  1. GET [base]/VerificationResult?attestation-method=[code]

    Support: SHOULD support search by the attestation-method parameter

    • including the modifiers: text

  1. GET [base]/VerificationResult?attestation-onbehalfof=[id]

    Support: SHALL support search by the attestation-onbehalfof parameter

    • with a target type: Practitioner, Organization, PractitionerRole
    • including the modifiers: type
    • including these search paramaters which may be chained: attestation-onbehalfof.identifier, attestation-onbehalfof.address, attestation-onbehalfof.name, attestation-onbehalfof.partof, attestation-onbehalfof.location, attestation-onbehalfof.organization, attestation-onbehalfof.practitioner

  1. GET [base]/VerificationResult?primarysource-date=[dateTime]

    Support: SHOULD support search by the primarysource-date parameter

    • including the comparators: eq, gt, lt, ge, le, sa, eb

  1. GET [base]/VerificationResult?primarysource-who=[id]

    Support: SHALL support search by the primarysource-who parameter

    • with a target type: Practitioner, Organization, PractitionerRole
    • including the modifiers: type
    • including these search paramaters which may be chained: primarysource-who.identifier, primarysource-who.address, primarysource-who.name, primarysource-who.partof, primarysource-who.location, primarysource-who.organization, primarysource-who.practitioner

  1. GET [base]/VerificationResult?primarysource-type=[code]

    Support: SHOULD support search by the primarysource-type parameter

    • including the modifiers: text

  1. GET [base]/VerificationResult?status-date=[dateTime]

    Support: SHOULD support search by the status-date parameter

    • including the comparators: eq, gt, lt, ge, le, sa, eb

  1. GET [base]/VerificationResult?target=[id]

    Support: SHALL support search by the target parameter

    • with a target type: Any
    • including the modifier: type

  1. GET [base]/VerificationResult?status=[code]

    Support: SHALL support search by the validation-status parameter

  1. GET [base]/VerificationResult?validator-organization=[id]

    Support: SHALL support search by the validator-organization parameter

    • with a target type: Organization
    • including the modifiers: above, below
    • including these search paramaters which may be chained: validator-organization.identifier, validator-organization.name