# NDH Verification - National Directory of Healthcare Providers & Services (NDH) Implementation Guide v2.0.0-current

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **NDH Verification**

## Resource Profile: NDH Verification 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Verification | *Version*:2.0.0-current | |
| * Standards status: *[Trial-use](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 4 | *Computable Name*:NdhVerification |

 
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 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 |

**Usages:**

* Examples for this Profile: [VerificationResult/Example-license](VerificationResult-Example-license.md), [VerificationResult/Verify-Hospital-2](VerificationResult-Verify-Hospital-2.md), [VerificationResult/Verify-Hospital](VerificationResult-Verify-Hospital.md), [VerificationResult/Verify-JoeSmith-2](VerificationResult-Verify-JoeSmith-2.md)... Show 2 more, [VerificationResult/Verify-JoeSmith](VerificationResult-Verify-JoeSmith.md) and [VerificationResult/Verify-JoeSmithHospitalRole](VerificationResult-Verify-JoeSmithHospitalRole.md)
* CapabilityStatements using this Profile: [NDH Server Capability Statement](CapabilityStatement-ndh-server.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/hl7.fhir.us.ndh|current/StructureDefinition/ndh-Verification)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-ndh-Verification.csv), [Excel](StructureDefinition-ndh-Verification.xlsx), [Schematron](StructureDefinition-ndh-Verification.sch) 

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

| | | |
| :--- | :--- | :--- |
| [attestation-who](SearchParameter-verificationresult-attestation-who.md) | reference | `GET [base]/VerificationResult?attestation-who=[id]` |
| [primarysource-validation-status](SearchParameter-verificationresult-primarysource-validation-status.md) | token | `GET [base]/VerificationResult?primarysource-validation-status=[code]` |
| [primarysource-type](SearchParameter-verificationresult-primarysource-type.md) | token | `GET [base]/VerificationResult?primarysource-type=[code]` |
| [status](SearchParameter-verificationresult-status.md) | token | `GET [base]/VerificationResult?status=[code]` |
| [target](SearchParameter-verificationresult-target.md) | reference | `GET [base]/VerificationResult?target=[id]` |

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

None

#### _include Search Parameter

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

#### _revInclude Search Parameter

None



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "ndh-Verification",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
    "valueCode" : "pa"
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 4,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "trial-use",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org/fhir/us/ndh/ImplementationGuide/hl7.fhir.us.ndh"
      }]
    }
  }],
  "url" : "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Verification",
  "version" : "2.0.0-current",
  "name" : "NdhVerification",
  "title" : "NDH Verification",
  "status" : "active",
  "date" : "2023-01-22T12:42:47.483-05:00",
  "publisher" : "HL7 International / Patient Administration",
  "contact" : [{
    "name" : "HL7 International / Patient Administration",
    "telecom" : [{
      "system" : "url",
      "value" : "http://www.hl7.org/Special/committees/pafm"
    },
    {
      "system" : "email",
      "value" : "pafm@lists.hl7.org"
    }]
  }],
  "description" : "Describes Verification requirements, source(s), status and dates for one or more elements",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "US",
      "display" : "United States of America"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "ndh-to-plannet-verification",
    "uri" : "http://hl7.org/fhir/us/davinci-pdex-plan-net",
    "name" : "There is no mapping between NDH and Plan-Net for Verification structure, since Plan-Net does not have a direct equivalent.",
    "comment" : "Plan-Net does not have a direct equivalent for NDH Verification."
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  },
  {
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "VerificationResult",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/VerificationResult",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "VerificationResult",
      "path" : "VerificationResult",
      "short" : "Verification",
      "definition" : "Describes Verification requirements, source(s), status and dates for one or more elements"
    },
    {
      "id" : "VerificationResult.target",
      "path" : "VerificationResult.target",
      "short" : "The resource instance was verified or attested",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.targetLocation",
      "path" : "VerificationResult.targetLocation",
      "short" : "The fhirpath location(s) within the resource instance that was verified or attested",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.need",
      "path" : "VerificationResult.need",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.status",
      "path" : "VerificationResult.status",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.statusDate",
      "path" : "VerificationResult.statusDate",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.validationType",
      "path" : "VerificationResult.validationType",
      "short" : "Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing",
      "min" : 1,
      "mustSupport" : true,
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-validation-type"
      }
    },
    {
      "id" : "VerificationResult.validationProcess",
      "path" : "VerificationResult.validationProcess",
      "short" : "The process(es) by which the target was verified",
      "min" : 1,
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/us/ndh/ValueSet/VerificationProcessVS"
      }
    },
    {
      "id" : "VerificationResult.frequency",
      "path" : "VerificationResult.frequency",
      "short" : "Frequency of verification",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.lastPerformed",
      "path" : "VerificationResult.lastPerformed",
      "short" : "The date/time verification was last completed (including failed verifications)",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.nextScheduled",
      "path" : "VerificationResult.nextScheduled",
      "short" : "The date when target is next verified, if appropriate",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.failureAction",
      "path" : "VerificationResult.failureAction",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource",
      "path" : "VerificationResult.primarySource",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource.who",
      "path" : "VerificationResult.primarySource.who",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource.type",
      "path" : "VerificationResult.primarySource.type",
      "definition" : "Type of primary source",
      "min" : 1,
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org/fhir/ValueSet/verificationresult-primary-source-type"
      }
    },
    {
      "id" : "VerificationResult.primarySource.communicationMethod",
      "path" : "VerificationResult.primarySource.communicationMethod",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://terminology.hl7.org/ValueSet/verificationresult-communication-method|1.0.0"
      }
    },
    {
      "id" : "VerificationResult.primarySource.validationStatus",
      "path" : "VerificationResult.primarySource.validationStatus",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource.validationDate",
      "path" : "VerificationResult.primarySource.validationDate",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource.canPushUpdates",
      "path" : "VerificationResult.primarySource.canPushUpdates",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.primarySource.pushTypeAvailable",
      "path" : "VerificationResult.primarySource.pushTypeAvailable",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation",
      "path" : "VerificationResult.attestation",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.who",
      "path" : "VerificationResult.attestation.who",
      "min" : 1,
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.onBehalfOf",
      "path" : "VerificationResult.attestation.onBehalfOf",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner",
        "http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.communicationMethod",
      "path" : "VerificationResult.attestation.communicationMethod",
      "min" : 1,
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://terminology.hl7.org/ValueSet/verificationresult-communication-method|1.0.0"
      }
    },
    {
      "id" : "VerificationResult.attestation.date",
      "path" : "VerificationResult.attestation.date",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.sourceIdentityCertificate",
      "path" : "VerificationResult.attestation.sourceIdentityCertificate",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.proxyIdentityCertificate",
      "path" : "VerificationResult.attestation.proxyIdentityCertificate",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.proxySignature",
      "path" : "VerificationResult.attestation.proxySignature",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.attestation.sourceSignature",
      "path" : "VerificationResult.attestation.sourceSignature",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.validator",
      "path" : "VerificationResult.validator",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.validator.organization",
      "path" : "VerificationResult.validator.organization",
      "type" : [{
        "code" : "Reference",
        "targetProfile" : ["http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.validator.identityCertificate",
      "path" : "VerificationResult.validator.identityCertificate",
      "mustSupport" : true
    },
    {
      "id" : "VerificationResult.validator.attestationSignature",
      "path" : "VerificationResult.validator.attestationSignature",
      "mustSupport" : true
    }]
  }
}

```
