National Directory of Healthcare Providers & Services (NDH) Implementation Guide
2.0.0-current - ci-build

National Directory of Healthcare Providers & Services (NDH) Implementation Guide, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 2.0.0-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ndh/ and changes regularly. See the Directory of published versions

## Resource Profile: NDH Verification

Official URL: http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Verification | Version: 2.0.0-current
Standards status: Trial-use | Maturity Level: 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/Verify-Hospital-2, VerificationResult/Verify-Hospital, VerificationResult/Verify-JoeSmith-2... Show 2 more, VerificationResult/Verify-JoeSmith and VerificationResult/Verify-JoeSmithHospitalRole
- CapabilityStatements using this Profile: NDH Server Capability Statement

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.need | Base | preferred | Need | 📍4.0.1 | FHIR Std.
VerificationResult.status | Base | required | Status | 📍4.0.1 | FHIR Std.
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.failureAction | Base | preferred | Failure-action | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.primarySource.​validationStatus | Base | preferred | Validation-status | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​canPushUpdates | Base | preferred | Can-push-updates | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable | Base | preferred | Push-type-available | 📍4.0.1 | FHIR Std.
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | VerificationResult | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | VerificationResult | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | VerificationResult | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from VerificationResult

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
target | S | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
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 Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
VerificationResult.need | Base | preferred | Need | 📍4.0.1 | FHIR Std.
VerificationResult.status | Base | required | Status | 📍4.0.1 | FHIR Std.
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.failureAction | Base | preferred | Failure-action | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.primarySource.​validationStatus | Base | preferred | Validation-status | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​canPushUpdates | Base | preferred | Can-push-updates | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable | Base | preferred | Push-type-available | 📍4.0.1 | FHIR Std.
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | VerificationResult | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | VerificationResult | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | VerificationResult | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from VerificationResult

Summary

Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 32 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Practitioner Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner)
- NDH PractitionerRole (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified

Maturity: 4

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.need | Base | preferred | Need | 📍4.0.1 | FHIR Std.
VerificationResult.status | Base | required | Status | 📍4.0.1 | FHIR Std.
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.failureAction | Base | preferred | Failure-action | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.primarySource.​validationStatus | Base | preferred | Validation-status | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​canPushUpdates | Base | preferred | Can-push-updates | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable | Base | preferred | Push-type-available | 📍4.0.1 | FHIR Std.
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | VerificationResult | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | VerificationResult | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | VerificationResult | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from VerificationResult

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
target | S | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | VerificationResult | Verification
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 Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:cms-enrollment-in-good-standing |  | 0..1 | boolean | CMS Enrollment In Good Standing URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
extension:cms-ial2-verified |  | 0..1 | boolean | CMS IAL2 Verified URL: http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | The resource instance was verified or attested
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource instance that was verified or attested
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 | Whether the target was verified against primary source(s), mutually attested between resource(s), or nothing Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target was verified Binding: NDH Verification Process Value Set (extensible)
frequency | S | 0..1 | Timing | Frequency of verification
lastPerformed | S | 0..1 | dateTime | The date/time verification was last completed (including failed verifications)
nextScheduled | S | 0..1 | date | The date when target is next verified, 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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type 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..* | CodeableConcept | Method for exchanging information with the primary source Binding: VerificationResult_communication_method (1.0.0) (extensible)
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(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(NDH Organization Profile | NDH Practitioner Profile | NDH PractitionerRole) | 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 (1.0.0) (extensible)
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(NDH Organization Profile) | 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
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
VerificationResult.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
VerificationResult.need | Base | preferred | Need | 📍4.0.1 | FHIR Std.
VerificationResult.status | Base | required | Status | 📍4.0.1 | FHIR Std.
VerificationResult.validationType | Base | required | Validation-type | 📦4.0.1 | FHIR Std.
VerificationResult.validationProcess | Base | extensible | NDH Verification Process Value Set | 📦2.0.0-current | This IG
VerificationResult.failureAction | Base | preferred | Failure-action | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​type | Base | extensible | Primary-source-type | 📦4.0.1 | FHIR Std.
VerificationResult.primarySource.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1
VerificationResult.primarySource.​validationStatus | Base | preferred | Validation-status | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​canPushUpdates | Base | preferred | Can-push-updates | 📍4.0.1 | FHIR Std.
VerificationResult.primarySource.​pushTypeAvailable | Base | preferred | Push-type-available | 📍4.0.1 | FHIR Std.
VerificationResult.attestation.​communicationMethod | Base | extensible | VerificationResult Communication Method | 📍1.0.0 | THO v7.1

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | VerificationResult | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | VerificationResult | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | VerificationResult | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | VerificationResult | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from VerificationResult

Summary

Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 32 elements

Structures

This structure refers to these other structures:

- NDH Organization Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Organization)
- NDH Practitioner Profile (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-Practitioner)
- NDH PractitionerRole (http://hl7.org/fhir/us/ndh/StructureDefinition/ndh-PractitionerRole)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-enrollment-in-good-standing
- http://hl7.org/fhir/us/ndh/StructureDefinition/base-ext-cms-ial2-verified

Maturity: 4

Other representations of profile: CSV, Excel, Schematron

### Notes:

### Search Parameters

#### Search Parameter defined by the NDH IG

SearchParameter Name | Type | Example
--- | --- | ---
attestation-who | reference | `GET [base]/VerificationResult?attestation-who=[id]`
primarysource-validation-status | token | `GET [base]/VerificationResult?primarysource-validation-status=[code]`
primarysource-type | token | `GET [base]/VerificationResult?primarysource-type=[code]`
status | token | `GET [base]/VerificationResult?status=[code]`
target | reference | `GET [base]/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:target`
VerificationResult:verificationresult-attestation-who | `GET [base]/VerificationResult?_include=VerificationResult:attestation-who`

#### _revInclude Search Parameter

None