National Healthcare Directory Exchange
1.0.0-ballot - ballot

National Healthcare Directory Exchange, published by HL7 Patient Administration Working Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-exchange/ and changes regularly. See the Directory of published versions

## Resource Profile: National Directory Validation

Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Validation | Version: 1.0.0-ballot
Active as of 2022-12-08 | Computable Name: NatlDirExValidation

Validation describes details about…

Usage:

- Examples for this Resource Profile: VerificationResult/ProviderAttestation

### Formal Views of Profile Content

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

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

This structure is derived from NatlDirEndpointQryVerification

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | Verification
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | Verification
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | A resource that was validated
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource that was validated
need | S Σ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated.
status | S Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target.
statusDate | S Σ | 1..1 | dateTime | When the validation status was updated
validationType | S Σ | 1..1 | CodeableConcept | nothing|single|multiple Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target is validated Binding: Validation Type Value Set (example)
frequency | S | 0..1 | Timing | Frequency of revalidation
lastPerformed | S | 0..1 | dateTime | The date/time validation was last completed (including failed validations)
nextScheduled | S | 0..1 | date | The date when target is next validated, if appropriate
failureAction | S Σ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails.
primarySource | S | 0..* | BackboneElement | Information about the primary source(s) involved in validation
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type of primary source Binding: primary-source-type (example)
communicationMethod | S Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example)
validationStatus | S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source.
validationDate | S | 0..1 | dateTime | When the target was validated against the primary source
canPushUpdates | S Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.
pushTypeAvailable | S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.
attestation | S | 1..1 | BackboneElement | Information about the entity attesting to information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(Organization | Practitioner | 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 (example)
date | S Σ | 1..1 | date | The date the information was attested to
sourceIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the attestation source
proxyIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
proxySignature | S | 0..1 | Signature | Proxy signature
sourceSignature | S | 0..1 | Signature | Attester signature
validator | S | 0..* | BackboneElement | Information about the entity validating information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
organization | S | 1..1 | Reference(Organization) | Reference to the organization validating information
identityCertificate | S | 0..1 | string | A digital identity certificate associated with the validator
attestationSignature | S | 0..1 | Signature | Validator signature
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
VerificationResult.need | preferred | need
VerificationResult.status | required | status
VerificationResult.validationType | required | validation-type
VerificationResult.validationProcess | example | ValidationProcessVS
VerificationResult.failureAction | preferred | failure-action
VerificationResult.primarySource.type | example | primary-source-type
VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-method
VerificationResult.primarySource.validationStatus | preferred | validation-status
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updates
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-available
VerificationResult.attestation.communicationMethod | example | verificationresult-communication-method

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | A resource that was validated
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource that was validated
need | S Σ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated.
status | S Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target.
statusDate | S Σ | 1..1 | dateTime | When the validation status was updated
validationType | S Σ | 1..1 | CodeableConcept | nothing|single|multiple Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target is validated Binding: Validation Type Value Set (example)
frequency | S | 0..1 | Timing | Frequency of revalidation
lastPerformed | S | 0..1 | dateTime | The date/time validation was last completed (including failed validations)
nextScheduled | S | 0..1 | date | The date when target is next validated, if appropriate
failureAction | S Σ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails.
primarySource | S | 0..* | BackboneElement | Information about the primary source(s) involved in validation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type of primary source Binding: primary-source-type (example)
communicationMethod | S Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example)
validationStatus | S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source.
validationDate | S | 0..1 | dateTime | When the target was validated against the primary source
canPushUpdates | S Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.
pushTypeAvailable | S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.
attestation | S | 1..1 | BackboneElement | Information about the entity attesting to information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(Organization | Practitioner | 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 (example)
date | S Σ | 1..1 | date | The date the information was attested to
sourceIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the attestation source
proxyIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
proxySignature | S | 0..1 | Signature | Proxy signature
sourceSignature | S | 0..1 | Signature | Attester signature
validator | S | 0..* | BackboneElement | Information about the entity validating information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
organization | S | 1..1 | Reference(Organization) | Reference to the organization validating information
identityCertificate | S | 0..1 | string | A digital identity certificate associated with the validator
attestationSignature | S | 0..1 | Signature | Validator signature
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
VerificationResult.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
VerificationResult.need | preferred | need
VerificationResult.status | required | status
VerificationResult.validationType | required | validation-type
VerificationResult.validationProcess | example | ValidationProcessVS
VerificationResult.failureAction | preferred | failure-action
VerificationResult.primarySource.type | example | primary-source-type
VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-method
VerificationResult.primarySource.validationStatus | preferred | validation-status
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updates
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-available
VerificationResult.attestation.communicationMethod | example | verificationresult-communication-method

This structure is derived from NatlDirEndpointQryVerification

Summary

Differential View

This structure is derived from NatlDirEndpointQryVerification

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | Verification
Documentation for this format

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | Verification
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | A resource that was validated
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource that was validated
need | S Σ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated.
status | S Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target.
statusDate | S Σ | 1..1 | dateTime | When the validation status was updated
validationType | S Σ | 1..1 | CodeableConcept | nothing|single|multiple Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target is validated Binding: Validation Type Value Set (example)
frequency | S | 0..1 | Timing | Frequency of revalidation
lastPerformed | S | 0..1 | dateTime | The date/time validation was last completed (including failed validations)
nextScheduled | S | 0..1 | date | The date when target is next validated, if appropriate
failureAction | S Σ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails.
primarySource | S | 0..* | BackboneElement | Information about the primary source(s) involved in validation
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type of primary source Binding: primary-source-type (example)
communicationMethod | S Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example)
validationStatus | S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source.
validationDate | S | 0..1 | dateTime | When the target was validated against the primary source
canPushUpdates | S Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.
pushTypeAvailable | S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.
attestation | S | 1..1 | BackboneElement | Information about the entity attesting to information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(Organization | Practitioner | 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 (example)
date | S Σ | 1..1 | date | The date the information was attested to
sourceIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the attestation source
proxyIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
proxySignature | S | 0..1 | Signature | Proxy signature
sourceSignature | S | 0..1 | Signature | Attester signature
validator | S | 0..* | BackboneElement | Information about the entity validating information
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
organization | S | 1..1 | Reference(Organization) | Reference to the organization validating information
identityCertificate | S | 0..1 | string | A digital identity certificate associated with the validator
attestationSignature | S | 0..1 | Signature | Validator signature
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
VerificationResult.need | preferred | need
VerificationResult.status | required | status
VerificationResult.validationType | required | validation-type
VerificationResult.validationProcess | example | ValidationProcessVS
VerificationResult.failureAction | preferred | failure-action
VerificationResult.primarySource.type | example | primary-source-type
VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-method
VerificationResult.primarySource.validationStatus | preferred | validation-status
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updates
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-available
VerificationResult.attestation.communicationMethod | example | verificationresult-communication-method

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
VerificationResult |  | 0..* | NatlDirEndpointQryVerification | 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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
target | S Σ | 1..* | Reference(Resource) | A resource that was validated
targetLocation | S Σ | 0..* | string | The fhirpath location(s) within the resource that was validated
need | S Σ | 1..1 | CodeableConcept | none | initial | periodic Binding: need (preferred): The frequency with which the target must be validated.
status | S Σ | 1..1 | code | attested | validated | in-process | req-revalid | val-fail | reval-fail Binding: status (required): The validation status of the target.
statusDate | S Σ | 1..1 | dateTime | When the validation status was updated
validationType | S Σ | 1..1 | CodeableConcept | nothing|single|multiple Binding: validation-type (required)
validationProcess | S Σ | 1..* | CodeableConcept | The process(es) by which the target is validated Binding: Validation Type Value Set (example)
frequency | S | 0..1 | Timing | Frequency of revalidation
lastPerformed | S | 0..1 | dateTime | The date/time validation was last completed (including failed validations)
nextScheduled | S | 0..1 | date | The date when target is next validated, if appropriate
failureAction | S Σ | 1..1 | CodeableConcept | fatal | warn | rec-only | none Binding: failure-action (preferred): The result if validation fails.
primarySource | S | 0..* | BackboneElement | Information about the primary source(s) involved in validation
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S | 0..1 | Reference(Organization | Practitioner | PractitionerRole) | Reference to the primary source
type | S Σ | 1..* | CodeableConcept | Type of primary source Binding: primary-source-type (example)
communicationMethod | S Σ | 0..* | CodeableConcept | Method for exchanging information with the primary source Binding: verificationresult-communication-method (example)
validationStatus | S | 0..1 | CodeableConcept | successful | failed | unknown Binding: validation-status (preferred): Status of the validation of the target against the primary source.
validationDate | S | 0..1 | dateTime | When the target was validated against the primary source
canPushUpdates | S Σ | 0..1 | CodeableConcept | yes | no | undetermined Binding: can-push-updates (preferred): Ability of the primary source to push updates/alerts.
pushTypeAvailable | S | 0..* | CodeableConcept | specific | any | source Binding: push-type-available (preferred): Type of alerts/updates the primary source can send.
attestation | S | 1..1 | BackboneElement | Information about the entity attesting to information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
who | S Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | The individual or organization attesting to information
onBehalfOf | S Σ | 0..1 | Reference(Organization | Practitioner | 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 (example)
date | S Σ | 1..1 | date | The date the information was attested to
sourceIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the attestation source
proxyIdentityCertificate | S | 0..1 | string | A digital identity certificate associated with the proxy entity submitting attested information on behalf of the attestation source
proxySignature | S | 0..1 | Signature | Proxy signature
sourceSignature | S | 0..1 | Signature | Attester signature
validator | S | 0..* | BackboneElement | Information about the entity validating information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
organization | S | 1..1 | Reference(Organization) | Reference to the organization validating information
identityCertificate | S | 0..1 | string | A digital identity certificate associated with the validator
attestationSignature | S | 0..1 | Signature | Validator signature
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
VerificationResult.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
VerificationResult.need | preferred | need
VerificationResult.status | required | status
VerificationResult.validationType | required | validation-type
VerificationResult.validationProcess | example | ValidationProcessVS
VerificationResult.failureAction | preferred | failure-action
VerificationResult.primarySource.type | example | primary-source-type
VerificationResult.primarySource.communicationMethod | example | verificationresult-communication-method
VerificationResult.primarySource.validationStatus | preferred | validation-status
VerificationResult.primarySource.canPushUpdates | preferred | can-push-updates
VerificationResult.primarySource.pushTypeAvailable | preferred | push-type-available
VerificationResult.attestation.communicationMethod | example | verificationresult-communication-method

This structure is derived from NatlDirEndpointQryVerification

Summary

Other representations of profile: CSV, Excel, Schematron