National Directory of Healthcare Providers & Services (NDH) Implementation Guide
1.0.0-ballot - ballot United States of America flag

This page is part of the National Directory of Healthcare Providers and Services (NDH) Implementation Guide (v1.0.0-ballot: STU1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: NDH Base Verification

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Verification Version: 1.0.0-ballot
Active as of 2023-01-22 Computable Name: NdhVerification

Copyright/Legal: HL7 International

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

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

Scope and Usage

Verification is critical for ensuring that users of a healthcare directory can rely upon the data in the directory as being accurate, not just meeting a technical specification. This Profile was developed to support the need for attested and/or verified provider data in many different healthcare workflows. It profiles the verificationResult resource to convey information about the attestation and/or verification status of any data in the National Directory of Healthcare Providers & Services (NDH), including how it was attested/verified, who attested/verified it, and where the data came from.

The Verification Resource Instance is created in two ways: either at the time of verification in the NDH or generated from the internal log files upon a request from the distributed work directories. For a given resource instance, it may be associated with multiple Verification resource instances. A given Verification resource instance may contain multiple target resources, which are related and are verified together at a given date time.

Relationship between VerificationResult Profile and Verification status Extension

The verification status extension is utilized in all NDH resource profiles, except for Restriction and Verification. Its purpose is to indicate the verification status of a given instance of an NDH resource.

The VerificationResult resource instances provide information on which verification process was performed, what was verified, when the verification took place, who performed the verification, and how it was verified for a given instance of a resource.

It is important to note that even if a resource instance has a verification status of “not-required,” there shall still be a VerificationResult resource instance associated with it. The VerificationResult would provide details on why the verification was not required, how it was determined that verification was not required, and any other relevant information related to the verification process.

Verification Value
.target Location/123
.need none
.status attested
.statusDate 2023/04/04
.validationType nothing
.validationProcess in-context
.failureAction none
.attestation.who Organization/123
.attestation.communicationMetod manual, portal
.attestation.date 2023/04/04

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..*VerificationResultVerification
... target S1..*Reference(Resource)The resource instance was verified or attested
... targetLocation S0..*stringThe fhirpath location(s) within the resource instance that was verified or attested
... need S1..1CodeableConceptnone | initial | periodic
... statusDate S1..1dateTimeWhen the validation status was updated
... validationType S1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess S1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction S1..1CodeableConceptfatal | warn | rec-only | none
... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type S1..*CodeableConceptType 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 (extensible)
.... communicationMethod S0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
.... validationDate S0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates S0..1CodeableConceptyes | no | undetermined
.... pushTypeAvailable S0..*CodeableConceptspecific | any | source
... attestation S1..1BackboneElementInformation about the entity attesting to information
.... who S1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod S1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date S1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*VerificationResultVerification
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The resource instance was verified or attested
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

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

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType 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 (extensible)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

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

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


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
VerificationResult.needpreferredneed
VerificationResult.statusrequiredstatus
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.failureActionpreferredfailure-action
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.primarySource.validationStatuspreferredvalidation-status
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*VerificationResultVerification
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The resource instance was verified or attested
... targetLocation SΣ0..*stringThe fhirpath location(s) within the resource instance that was verified or attested
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

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

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType 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 (extensible)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

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

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


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
VerificationResult.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
VerificationResult.needpreferredneed
VerificationResult.statusrequiredstatus
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.failureActionpreferredfailure-action
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.primarySource.validationStatuspreferredvalidation-status
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)

Differential View

This structure is derived from VerificationResult

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*VerificationResultVerification
... target S1..*Reference(Resource)The resource instance was verified or attested
... targetLocation S0..*stringThe fhirpath location(s) within the resource instance that was verified or attested
... need S1..1CodeableConceptnone | initial | periodic
... statusDate S1..1dateTimeWhen the validation status was updated
... validationType S1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess S1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction S1..1CodeableConceptfatal | warn | rec-only | none
... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type S1..*CodeableConceptType 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 (extensible)
.... communicationMethod S0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
.... validationDate S0..1dateTimeWhen the target was validated against the primary source
.... canPushUpdates S0..1CodeableConceptyes | no | undetermined
.... pushTypeAvailable S0..*CodeableConceptspecific | any | source
... attestation S1..1BackboneElementInformation about the entity attesting to information
.... who S1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod S1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date S1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*VerificationResultVerification
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The resource instance was verified or attested
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

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

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType 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 (extensible)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

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

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


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
VerificationResult.needpreferredneed
VerificationResult.statusrequiredstatus
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.failureActionpreferredfailure-action
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.primarySource.validationStatuspreferredvalidation-status
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. VerificationResult 0..*VerificationResultVerification
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... target SΣ1..*Reference(Resource)The resource instance was verified or attested
... targetLocation SΣ0..*stringThe fhirpath location(s) within the resource instance that was verified or attested
... need SΣ1..1CodeableConceptnone | initial | periodic
Binding: need (preferred): The frequency with which the target must be validated.

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

... statusDate SΣ1..1dateTimeWhen the validation status was updated
... validationType SΣ1..1CodeableConceptWhether the target was verified against primary source(s), mutually attested between resource(s), or nothing
Binding: validation-type (required)
... validationProcess SΣ1..*CodeableConceptThe process(es) by which the target was verified
Binding: NDH Verification Process Value Set (extensible)
... frequency S0..1TimingFrequency of verification
... lastPerformed S0..1dateTimeThe date/time verification was last completed (including failed verifications)
... nextScheduled S0..1dateThe date when target is next verified, if appropriate
... failureAction SΣ1..1CodeableConceptfatal | warn | rec-only | none
Binding: failure-action (preferred): The result if validation fails.

... primarySource S0..*BackboneElementInformation about the primary source(s) involved in validation
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who S0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)Reference to the primary source
.... type SΣ1..*CodeableConceptType 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 (extensible)
.... communicationMethod SΣ0..*CodeableConceptMethod for exchanging information with the primary source
Binding: NDH Verification Communication Method Value Set (extensible)
.... validationStatus S0..1CodeableConceptsuccessful | failed | unknown
Binding: validation-status (preferred): Status of the validation of the target against the primary source.

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

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


... attestation S1..1BackboneElementInformation about the entity attesting to information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... who SΣ1..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)The individual or organization attesting to information
.... onBehalfOf SΣ0..1Reference(NDH Base Organization Profile | NDH Base Practitioner Profile | NDH Base PractitionerRole)When the who is asserting on behalf of another (organization or individual)
.... communicationMethod SΣ1..1CodeableConceptThe method by which attested information was submitted/retrieved
Binding: NDH Verification Communication Method Value Set (extensible)
.... date SΣ1..1dateThe date the information was attested to
.... sourceIdentityCertificate S0..1stringA digital identity certificate associated with the attestation source
.... proxyIdentityCertificate S0..1stringA digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
.... proxySignature S0..1SignatureProxy signature
.... sourceSignature S0..1SignatureAttester signature
... validator S0..*BackboneElementInformation about the entity validating information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... organization S1..1Reference(NDH Base Organization Profile)Reference to the organization validating information
.... identityCertificate S0..1stringA digital identity certificate associated with the validator
.... attestationSignature S0..1SignatureValidator signature

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
VerificationResult.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
VerificationResult.needpreferredneed
VerificationResult.statusrequiredstatus
VerificationResult.validationTyperequiredvalidation-type
VerificationResult.validationProcessextensibleNdhVerificationProcessVS (a valid code from NDH Verification Process Code System)
VerificationResult.failureActionpreferredfailure-action
VerificationResult.primarySource.typeextensibleprimary-source-type
VerificationResult.primarySource.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)
VerificationResult.primarySource.validationStatuspreferredvalidation-status
VerificationResult.primarySource.canPushUpdatespreferredcan-push-updates
VerificationResult.primarySource.pushTypeAvailablepreferredpush-type-available
VerificationResult.attestation.communicationMethodextensibleNdhVerificationCommunicationMethodVS (a valid code from NDH Verification Communication Method Code System)

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Search Parameters

Search Parameter defined by the NDH IG

SearchParameter Name Type Example
verificationresult-attestation-who reference GET [base]/VerificationResult?verificationresult-attestation-who=[id]
verificationresult-primarysource-validation-status token GET [base]/VerificationResult?verificationresult-primarysource-validation-status=[code]
verificationresult-primarysource-type token GET [base]/VerificationResult?verificationresult-primarysource-type=[code]
verificationresult-status token GET [base]/VerificationResult?verificationresult-status=[code]
verificationresult-target reference GET [base]/VerificationResult?verificationresult-target=[id]

Search Parameter defined by FHIR Search Parameter Registry and used by the NDH IG

None

_include Search Parameter

_include Example
VerificationResult:verificationresult-target GET [base]/VerificationResult?_include=VerificationResult:verificationresult-target
VerificationResult:verificationresult-attestation-who GET [base]/VerificationResult?_include=VerificationResult:verificationresult-attestation-who

_revInclude Search Parameter

None